Add descriptions to all configuration variables #702
Merged
Conversation
This file contains 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
Related to permitio#40 Add descriptions to missing configuration variables in `opal-common`, `opal-client`, and `opal-server` configuration files. * **opal-common/config.py**: - Add descriptions to `LOG_FORMAT_INCLUDE_PID`, `FETCH_PROVIDER_MODULES`, `FETCHING_WORKER_COUNT`, `FETCHING_CALLBACK_TIMEOUT`, `FETCHING_ENQUEUE_TIMEOUT`, `GIT_SSH_KEY_FILE`, `AUTH_PUBLIC_KEY_FORMAT`, `AUTH_PUBLIC_KEY`, `AUTH_JWT_AUDIENCE`, `AUTH_JWT_ISSUER`, `ENABLE_METRICS`. * **opal-client/config.py**: - Add descriptions to `POLICY_STORE_TYPE`, `POLICY_STORE_URL`, `POLICY_STORE_AUTH_TYPE`, `POLICY_STORE_AUTH_TOKEN`, `POLICY_STORE_AUTH_OAUTH_SERVER`, `POLICY_STORE_AUTH_OAUTH_CLIENT_ID`, `POLICY_STORE_AUTH_OAUTH_CLIENT_SECRET`, `POLICY_STORE_CONN_RETRY`, `POLICY_UPDATER_CONN_RETRY`, `DATA_STORE_CONN_RETRY`, `DATA_UPDATER_CONN_RETRY`, `POLICY_STORE_POLICY_PATHS_TO_IGNORE`, `POLICY_STORE_TLS_CLIENT_CERT`, `POLICY_STORE_TLS_CLIENT_KEY`, `POLICY_STORE_TLS_CA`, `EXCLUDE_POLICY_STORE_SECRETS`, `INLINE_OPA_ENABLED`, `INLINE_OPA_CONFIG`, `INLINE_OPA_LOG_FORMAT`, `INLINE_CEDAR_ENABLED`, `INLINE_CEDAR_CONFIG`, `INLINE_CEDAR_LOG_FORMAT`, `KEEP_ALIVE_INTERVAL`, `SERVER_URL`, `SERVER_WS_URL`, `SERVER_PUBSUB_URL`, `CLIENT_TOKEN`, `POLICY_SUBSCRIPTION_DIRS`, `DATA_UPDATER_ENABLED`, `DEFAULT_UPDATE_CALLBACK`, `DEFAULT_UPDATE_CALLBACKS`, `SCOPE_ID`. * **opal-server/config.py**: - Add descriptions to `WS_LOCAL_URL`, `WS_TOKEN`, `BROADCAST_URI`, `BROADCAST_CHANNEL_NAME`, `BROADCAST_CONN_LOSS_BUGFIX_EXPERIMENT_ENABLED`, `AUTH_PRIVATE_KEY_FORMAT`, `AUTH_PRIVATE_KEY_PASSPHRASE`, `AUTH_PRIVATE_KEY`, `AUTH_JWKS_URL`, `AUTH_JWKS_STATIC_DIR`, `AUTH_MASTER_TOKEN`, `POLICY_SOURCE_TYPE`, `POLICY_REPO_REUSE_CLONE_PATH`, `POLICY_REPO_MAIN_BRANCH`, `POLICY_REPO_SSH_KEY`, `POLICY_REPO_MANIFEST_PATH`, `POLICY_REPO_CLONE_TIMEOUT`, `LEADER_LOCK_FILE_PATH`, `POLICY_BUNDLE_SERVER_TYPE`, `REPO_WATCHER_ENABLED`, `PUBLISHER_ENABLED`, `BROADCAST_KEEPALIVE_INTERVAL`, `ALL_DATA_TOPIC`, `ALL_DATA_ROUTE`, `ALL_DATA_URL`, `POLICY_REPO_WEBHOOK_SECRET`, `POLICY_REPO_WEBHOOK_ENFORCE_BRANCH`, `POLICY_REPO_WEBHOOK_PARAMS`, `POLICY_REPO_POLLING_INTERVAL`, `ALLOWED_ORIGINS`, `FILTER_FILE_EXTENSIONS`, `BUNDLE_IGNORE`, `NO_RPC_LOGS`, `SERVER_WORKER_COUNT`, `ENABLE_DATADOG_APM`, `SCOPES`, `SCOPES_REPO_CLONES_SHARDS`, `REDIS_URL`, `BASE_DIR`. * Add a test in `opal-common/tests/test_config.py` to check for missing descriptions in configuration variables.
✅ Deploy Preview for opal-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
💵 To receive payouts, sign up on Algora, link your Github account and connect with Stripe. |
danyi1212
requested changes
Nov 17, 2024
* **opal-server/config.py** - Add example to `FILTER_FILE_EXTENSIONS` description * **opal-common/tests/test_config.py** - Convert tests to use pytest - Add tests to check for missing descriptions in configuration variables - Cover `opal_common_config`, `opal_client_config`, and `opal_server_config`
danyi1212
approved these changes
Dec 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related to #40
Add descriptions to missing configuration variables in
opal-common,opal-client, andopal-serverconfiguration files.opal-common/config.py:
LOG_FORMAT_INCLUDE_PID,FETCH_PROVIDER_MODULES,FETCHING_WORKER_COUNT,FETCHING_CALLBACK_TIMEOUT,FETCHING_ENQUEUE_TIMEOUT,GIT_SSH_KEY_FILE,AUTH_PUBLIC_KEY_FORMAT,AUTH_PUBLIC_KEY,AUTH_JWT_AUDIENCE,AUTH_JWT_ISSUER,ENABLE_METRICS.opal-client/config.py:
POLICY_STORE_TYPE,POLICY_STORE_URL,POLICY_STORE_AUTH_TYPE,POLICY_STORE_AUTH_TOKEN,POLICY_STORE_AUTH_OAUTH_SERVER,POLICY_STORE_AUTH_OAUTH_CLIENT_ID,POLICY_STORE_AUTH_OAUTH_CLIENT_SECRET,POLICY_STORE_CONN_RETRY,POLICY_UPDATER_CONN_RETRY,DATA_STORE_CONN_RETRY,DATA_UPDATER_CONN_RETRY,POLICY_STORE_POLICY_PATHS_TO_IGNORE,POLICY_STORE_TLS_CLIENT_CERT,POLICY_STORE_TLS_CLIENT_KEY,POLICY_STORE_TLS_CA,EXCLUDE_POLICY_STORE_SECRETS,INLINE_OPA_ENABLED,INLINE_OPA_CONFIG,INLINE_OPA_LOG_FORMAT,INLINE_CEDAR_ENABLED,INLINE_CEDAR_CONFIG,INLINE_CEDAR_LOG_FORMAT,KEEP_ALIVE_INTERVAL,SERVER_URL,SERVER_WS_URL,SERVER_PUBSUB_URL,CLIENT_TOKEN,POLICY_SUBSCRIPTION_DIRS,DATA_UPDATER_ENABLED,DEFAULT_UPDATE_CALLBACK,DEFAULT_UPDATE_CALLBACKS,SCOPE_ID.opal-server/config.py:
WS_LOCAL_URL,WS_TOKEN,BROADCAST_URI,BROADCAST_CHANNEL_NAME,BROADCAST_CONN_LOSS_BUGFIX_EXPERIMENT_ENABLED,AUTH_PRIVATE_KEY_FORMAT,AUTH_PRIVATE_KEY_PASSPHRASE,AUTH_PRIVATE_KEY,AUTH_JWKS_URL,AUTH_JWKS_STATIC_DIR,AUTH_MASTER_TOKEN,POLICY_SOURCE_TYPE,POLICY_REPO_REUSE_CLONE_PATH,POLICY_REPO_MAIN_BRANCH,POLICY_REPO_SSH_KEY,POLICY_REPO_MANIFEST_PATH,POLICY_REPO_CLONE_TIMEOUT,LEADER_LOCK_FILE_PATH,POLICY_BUNDLE_SERVER_TYPE,REPO_WATCHER_ENABLED,PUBLISHER_ENABLED,BROADCAST_KEEPALIVE_INTERVAL,ALL_DATA_TOPIC,ALL_DATA_ROUTE,ALL_DATA_URL,POLICY_REPO_WEBHOOK_SECRET,POLICY_REPO_WEBHOOK_ENFORCE_BRANCH,POLICY_REPO_WEBHOOK_PARAMS,POLICY_REPO_POLLING_INTERVAL,ALLOWED_ORIGINS,FILTER_FILE_EXTENSIONS,BUNDLE_IGNORE,NO_RPC_LOGS,SERVER_WORKER_COUNT,ENABLE_DATADOG_APM,SCOPES,SCOPES_REPO_CLONES_SHARDS,REDIS_URL,BASE_DIR.Add a test in
opal-common/tests/test_config.pyto check for missing descriptions in configuration variables./claim #40