ewilliams28/releases
1
0
Fork 0
mirror of https://github.com/open-policy-agent/opa.git synced 2026-08-13 03:42:35 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add manual trigger to integration docs (#7473)

Browse Source 
Following: https://github.com/orgs/open-policy-agent/discussions/685

This comes up often enough that it should be documented.

Based on the handy example in: https://github.com/open-policy-agent/opa/issues/3828#issuecomment-1013211919

Signed-off-by: Charlie Egan <charlie@styra.com>
This commit is contained in:
Charlie Egan
2025-03-31 11:07:32 +00:00
committed by GitHub
parent c34a941204
commit aa2a16f139
2 changed files with 44 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/configuration.md
+1 -1
View File
@@ -757,7 +757,7 @@ included in the actual bundle gzipped tarball.
| `bundles[_].service` | `string` | Yes | Name of service to use to contact remote server. |
| `bundles[_].polling.min_delay_seconds` | `int64` | No (default: `60`) | Minimum amount of time to wait between bundle downloads. |
| `bundles[_].polling.max_delay_seconds` | `int64` | No (default: `120`) | Maximum amount of time to wait between bundle downloads. |
| `bundles[_].trigger` | `string` (default: `periodic`) | No | Controls how bundle is downloaded from the remote server. Allowed values are `periodic` and `manual` (`manual` triggers are only possible when using OPA as a Go package). |
| `bundles[_].trigger` | `string` (default: `periodic`) | No | Controls how bundle is downloaded from the remote server. Allowed values are `periodic` and `manual` ([`manual` triggers](./integration/#manually-triggering-bundle-reloads) are only possible when running OPA as a SDK instance from the Go package). |
| `bundles[_].polling.long_polling_timeout_seconds` | `int64` | No | Maximum amount of time the server should wait before issuing a timeout if there's no update available. |
| `bundles[_].persist` | `bool` | No | Persist activated bundles to disk. |
| `bundles[_].signing.keyid` | `string` | No | Name of the key to use for bundle signature verification. |
docs/content/integration.md
+43 -6
View File
@@ -183,11 +183,17 @@ The [reference documentation](../rest-api) is also a good place to start.
### Integrating with the Go SDK
{{< info >}}
This section documents the v1 SDK package.
Please see [v0 Backwards Compatibility](../v0-compatibility) for notes on using
the v0 SDK package.
{{< /info >}}
The [SDK](https://pkg.go.dev/github.com/open-policy-agent/opa/sdk) package contains high-level APIs for embedding OPA
inside of Go programs and obtaining the output of query evaluation. To get started, import the `sdk` package:
```go
import "github.com/open-policy-agent/opa/sdk"
import "github.com/open-policy-agent/opa/v1/sdk"
```
A typical workflow when using the `sdk` package would involve first creating a new `sdk.OPA` object by calling
@@ -273,11 +279,42 @@ Setting an `ID` in `sdk.Options` is optional, but recommended. If you do not set
for the system. While this is fine for testing, it makes it difficult to monitor the system over time, as a new ID will
be created each time the SDK is initialized, such as when the process is restarted.
{{< info >}}
This section documents the v1 SDK package.
Please see [v0 Backwards Compatibility](../v0-compatibility) for notes on using
the v0 SDK package.
{{< /info >}}
#### Manually Triggering Bundle Reloads
Users of the SDK can
[manually trigger](./configuration/#bundles)
the SDK's Bundle plugin to load new bundles immediately based on external
events. When doing so, it's recommended to set `bundles[_].trigger` to `manual`
if you want to disable periodic bundle polling.
In this short example, the `bundle` plugin is loaded from the SDK instance and
triggered to check for new bundles. Do this sparingly, it is not intended to be
used as a replacement for periodic bundle polling. For best performance, only
trigger the bundle plugin when you know that new bundles are available.
```go
options := sdk.Options{
Config: bytes.NewReader(config),
Logger: logger,
Ready: make(chan struct{}), // <-- needed or else sdk.New will block
}
opa, err := sdk.New(ctx, options)
if err != nil {
log.Fatal(err)
}
defer opa.Stop(ctx)
bundle, ok := opa.Plugin("bundle").(*bundle.Plugin)
if !ok {
log.Fatal("bundle plugin not found")
}
err = bundle.Trigger(ctx)
if err != nil {
log.Fatal(err)
}
```
### Integrating with the Go API