⚡️ Configuration File
Configuration File structure
OPToggles expects its configuration file in
The basic structure of the yaml configuration file is:
|bind||string||Bind address for OpToggles' HTTP server. This server is use for getting update triggers from |
sources section is a list of policy sources. Currently only an
OPA is supported as a policy
source includes the following attributes
|id||string||To be referenced from the |
|url||string||The url base of |
|token||string||Authorization token for |
|advertisedAddress||string||Address where this instance of |
target section tells
OPToggles where it should create and sync its user-authorized toggles to. Supported
- The LaunchDarkly Feature management platform
- Generic REST API HTTP Server - More Info
target is configured for an instance of
|targetSpec.launchdarklyToken||string||Required if |
API access token associated with your LaunchDarkly account. Should have at least
|targetSpec.endpointUrl||string||Required if |
The RestAPI endpoint used to create (/POST) and update (/PATCH) toggles
|targetSpec.extraHeaders||map||Optional if |
Extra headers to include in the REST API requests (e.g.
toggles section is a list of feature toggles to be managed and continuously updated with the set of allowed
users (queried from a specific rule in one of the policy sources).
toggle includes the following attributes
|key||string||Unique identifier for the feature toggle.|
|usersPolicy.rule||string||The desired policy's rule name. This rule should return a set of user names for which the feature toggle will be enabled|
|spec.name||string||Required if |
User readable name for the feature toggle.
|spec.projKey||string||Required if |
Key of the LaunchDarkly project under which this toggle should be managed.
|spec.environments||list||Required if |
The environments in which the feature would be enabled for the queried set of users. The feature would be disabled for other environments.