docs: explain how to use the SDK without a initialising a server #8248
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrewcameronsims
force-pushed
the
acsims/opa-sdk-docs
branch
from
79fb05f to
7bc92fe
Compare
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
docs/docs/integration.md
Outdated
|
|
||
| #### Using the SDK client without a server | ||
|
|
||
| In certain cases, you might want to use the high-level SDK to read in policy from the filesystem instead of a real or mock bundle server. |
Contributor
There was a problem hiding this comment.
Suggested change
| In certain cases, you might want to use the high-level SDK to read in policy from the filesystem instead of a real or mock bundle server. | |
| You might want to use the high-level SDK to load policy from the filesystem instead of a bundle server. This can we useful if you do not have a bundle server, or you ship policy with the application using the SDK. |
docs/docs/integration.md
Outdated
| #### Using the SDK client without a server | ||
|
|
||
| In certain cases, you might want to use the high-level SDK to read in policy from the filesystem instead of a real or mock bundle server. | ||
| In that case, you can use the SDK as per normal, but modify the configuration to use a filepath url instead of the server path. You |
Contributor
There was a problem hiding this comment.
Suggested change
| In that case, you can use the SDK as per normal, but modify the configuration to use a filepath url instead of the server path. You | |
| In that case, you can use the SDK as normal, but modify the configuration to use a file scheme and path, instead of a HTTP server resource path. You |
docs/docs/integration.md
Outdated
| } | ||
| }`, bundleFilePath)) | ||
|
|
||
| // create an instance of the OPA object and use it to get policy decisions as per normal. |
Contributor
There was a problem hiding this comment.
Suggested change
| // create an instance of the OPA object and use it to get policy decisions as per normal. | |
| // create an instance of the OPA object and use it to get policy decisions as normal. |
charlieegan3
approved these changes
Jan 26, 2026
Contributor
charlieegan3
left a comment
charlieegan3
left a comment
There was a problem hiding this comment.
This looks good to me, thanks for writing it up.
andrewcameronsims
force-pushed
the
acsims/opa-sdk-docs
branch
from
7bc92fe to
7fea4a2
Compare
Contributor
Author
|
Thank you for those suggestions, I have accepted all of them. |
It's possible to read in policies from the filesystem, but there's no detail on how to do this in the current documentation. Adding this provides more information for use cases where features of the server (e.g. dynamic bundle loading) are not important to the user. Signed-off-by: Andrew Sims <[email protected]>
andrewcameronsims
force-pushed
the
acsims/opa-sdk-docs
branch
from
7fea4a2 to
e3976ad
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why the changes in this PR are needed?
My team wanted to use the SDK client in a very simple use case without using a bundle server to distribute policy. The documents did not cover this use case and I spent a lot of time figuring out how to do it. Adding this to the documentation will help other users who may later find themselves in this same situation.
What are the changes in this PR?
A short description on the kind of configuration that is needed to instantiate the SDK client without a real or mock bundle server.
Further comments:
Discussion on the community slack: https://openpolicyagent.slack.com/archives/C02L1TLPN59/p1768513465312369