From 3d715513a7f220db33c177c974d25573062ea460 Mon Sep 17 00:00:00 2001 From: thilak reddy Date: Sun, 9 Jun 2024 20:17:14 +0530 Subject: [PATCH] remove extra columns improperly mentioned in opal client config vars mdx, adjust indentation accordingly --- .../docs/getting-started/configuration.mdx | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/documentation/docs/getting-started/configuration.mdx b/documentation/docs/getting-started/configuration.mdx index bb253d0c..5cd2ed4c 100644 --- a/documentation/docs/getting-started/configuration.mdx +++ b/documentation/docs/getting-started/configuration.mdx @@ -119,24 +119,24 @@ Please use this table as a reference. ## OPAL Client Configuration Variables -| Variables | Description | Example | -| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | --- | --- | -| POLICY_STORE_TYPE | | | -| POLICY_STORE_AUTH_TYPE | The authentication method for connecting to the policy store. Possible values are `oauth` or `token` | | -| POLICY_STORE_AUTH_TOKEN | The authentication (bearer) token OPAL client will use to authenticate against the policy store (i.e: OPA agent). | | -| POLICY_STORE_AUTH_OAUTH_SERVER | The authentication server OPAL client will use to authenticate against for retrieving the access_token. | | -| POLICY_STORE_AUTH_OAUTH_CLIENT_ID | The client id OPAL will use to authenticate against the OAuth server. | | -| POLICY_STORE_AUTH_OAUTH_CLIENT_SECRET | The client secret OPAL will use to authenticate against the OAuth server. | | -| POLICY_STORE_CONN_RETRY | Retry options when connecting to the policy store (i.e. the agent that handles the policy, e.g. OPA). | | -| POLICY_STORE_POLICY_PATHS_TO_IGNORE | Which policy paths pushed to the client should be ignored. List of glob style paths, or paths without wildcards but ending with "/\*\*" indicating a parent path (ignoring all under it). | | -| INLINE_OPA_ENABLED | Whether or not OPAL should run OPA by itself in the same container. | | -INLINE_OPA_CONFIG | If inline OPA is indeed enabled, the user can set the [server configuration options](https://docs.opal.ac/getting-started/running-opal/run-opal-client/opa-runner-parameters) that affects how OPA will start when running `opa run --server` inline. Watch escaping quotes. | \{"config_file":"/mnt/opa/config"\} -| INLINE_OPA_LOG_FORMAT | | | -| KEEP_ALIVE_INTERVAL | | | -| OFFLINE_MODE_ENABLED | If set, opal client will try to load policy store from backup file and operate even if server is unreachable. Ignored if INLINE_OPA_ENABLED=False | | -| STORE_BACKUP_PATH | Path to backup policy store's data to | | -| STORE_BACKUP_INTERVAL | Interval in seconds to backup policy store's data | -| POLICY_UPDATER_ENABLED | If set to `FALSE`, OPAL Client will not fetch policies or listen to policy updates. | | | | +| Variables | Description | Example | +| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | +| POLICY_STORE_TYPE | | | +| POLICY_STORE_AUTH_TYPE | The authentication method for connecting to the policy store. Possible values are `oauth` or `token` | | +| POLICY_STORE_AUTH_TOKEN | The authentication (bearer) token OPAL client will use to authenticate against the policy store (i.e: OPA agent). | | +| POLICY_STORE_AUTH_OAUTH_SERVER | The authentication server OPAL client will use to authenticate against for retrieving the access_token. | | +| POLICY_STORE_AUTH_OAUTH_CLIENT_ID | The client id OPAL will use to authenticate against the OAuth server. | | +| POLICY_STORE_AUTH_OAUTH_CLIENT_SECRET | The client secret OPAL will use to authenticate against the OAuth server. | | +| POLICY_STORE_CONN_RETRY | Retry options when connecting to the policy store (i.e. the agent that handles the policy, e.g. OPA). | | +| POLICY_STORE_POLICY_PATHS_TO_IGNORE | Which policy paths pushed to the client should be ignored. List of glob style paths, or paths without wildcards but ending with "/\*\*" indicating a parent path (ignoring all under it). | | +| INLINE_OPA_ENABLED | Whether or not OPAL should run OPA by itself in the same container. | | +| INLINE_OPA_CONFIG | If inline OPA is indeed enabled, the user can set the [server configuration options](https://docs.opal.ac/getting-started/running-opal/run-opal-client/opa-runner-parameters) that affects how OPA will start when running `opa run --server` inline. Watch escaping quotes. | \{"config_file":"/mnt/opa/config"\} | +| INLINE_OPA_LOG_FORMAT | | | +| KEEP_ALIVE_INTERVAL | | | +| OFFLINE_MODE_ENABLED | If set, opal client will try to load policy store from backup file and operate even if server is unreachable. Ignored if INLINE_OPA_ENABLED=False | | +| STORE_BACKUP_PATH | Path to backup policy store's data to | | +| STORE_BACKUP_INTERVAL | Interval in seconds to backup policy store's data | | +| POLICY_UPDATER_ENABLED | If set to `FALSE`, OPAL Client will not fetch policies or listen to policy updates. | | ## Policy Updater Configuration Variables