From a3d5a065e2e3a17b7f3868f49a66525c6cdc9620 Mon Sep 17 00:00:00 2001 From: Emily Zall Date: Wed, 22 May 2024 11:52:24 -0400 Subject: [PATCH 1/2] docs(values): explain default value for server.policyRepoMainBranch --- README.md | 21 +++++++++++---------- values.schema.json | 2 +- values.yaml | 2 +- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bd264de..daeaef4 100644 --- a/README.md +++ b/README.md @@ -66,16 +66,17 @@ Then, open http://localhost:8181/v1/data/ in your browser to check OPA data docu This is not a comprehensive list, but includes the main variables you have to think about -| Variable | Description | -| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `server.policyRepoUrl` | Git repository holding policy code (& optionally policy data) to be tracked by OPAL | -| `server.dataConfigSources` | Data sources to be published to clients (and their managed OPAs) | -| `server.dataConfigSources.config.entries` | Static list of data source entries (See [OPAL Docs](https://docs.opal.ac/getting-started/running-opal/run-opal-server/data-sources)) | -| `server.dataConfigSources.external_source_url` | URL to dynamically fetch data sources entries from (See [OPAL Docs](https://docs.opal.ac/tutorials/configure_external_data_sources)) | +| Variable | Description | +| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| `server.policyRepoUrl` | Git repository holding policy code (& optionally policy data) to be tracked by OPAL | +| `server.policyRepoMainBranch` | sets OPAL_POLICY_REPO_MAIN_BRANCH which defaults to `master` | +| `server.dataConfigSources` | Data sources to be published to clients (and their managed OPAs) | +| `server.dataConfigSources.config.entries` | Static list of data source entries (See [OPAL Docs](https://docs.opal.ac/getting-started/running-opal/run-opal-server/data-sources)) | +| `server.dataConfigSources.external_source_url` | URL to dynamically fetch data sources entries from (See [OPAL Docs](https://docs.opal.ac/tutorials/configure_external_data_sources)) | | `server.broadcastUri` | Backend for broadcasting updates across multiple opal-server processes (necessary if either `server.uvicornWorkers` or `server.replicas` is > 1) | -| `server.uvicornWorkers` | Count of gunicorn workers (/processes) per opal-server replica | -| `server.replicas` | opal-server's deployment replica count | -| `server.extraEnv` | Extra configuration for opal-server (see [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal)) | -| `client.extraEnv` | Extra configuration for opal-server [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal) | +| `server.uvicornWorkers` | Count of gunicorn workers (/processes) per opal-server replica | +| `server.replicas` | opal-server's deployment replica count | +| `server.extraEnv` | Extra configuration for opal-server (see [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal)) | +| `client.extraEnv` | Extra configuration for opal-server [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal) | **Note:** If you leave `server.dataConfigSources` with no entries - The chart would automatically set `OPAL_DATA_UPDATER_ENABLED: False` in `client.extraEnv` so client won't report an unhealthy state. diff --git a/values.schema.json b/values.schema.json index f138b52..2e4aafe 100644 --- a/values.schema.json +++ b/values.schema.json @@ -135,7 +135,7 @@ "type": ["null", "string"], "title": "policy clone path","default": null }, "policyRepoMainBranch": { - "type": ["null", "string"], "title": "policy main branch","default": null + "type": ["null", "string"], "title": "sets OPAL_POLICY_REPO_MAIN_BRANCH which defaults to master","default": null }, "pollingInterval": { "type": "integer", "title": "polling interval (sec)", "default": 30 diff --git a/values.yaml b/values.yaml index dd6b9ff..aef0a13 100644 --- a/values.yaml +++ b/values.yaml @@ -15,7 +15,7 @@ server: policyRepoUrl: "https://github.com/permitio/opal-example-policy-repo" policyRepoSshKey: null policyRepoClonePath: null - policyRepoMainBranch: null + policyRepoMainBranch: null # sets OPAL_POLICY_REPO_MAIN_BRANCH which defaults to master pollingInterval: 30 dataConfigSources: # Option #1 - No data sources From f758556bdef6549931f692aa4f1ae15951397de7 Mon Sep 17 00:00:00 2001 From: Emily Zall Date: Wed, 22 May 2024 12:01:30 -0400 Subject: [PATCH 2/2] docs(README): fix table alignment --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index daeaef4..85ee933 100644 --- a/README.md +++ b/README.md @@ -66,17 +66,17 @@ Then, open http://localhost:8181/v1/data/ in your browser to check OPA data docu This is not a comprehensive list, but includes the main variables you have to think about -| Variable | Description | -| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `server.policyRepoUrl` | Git repository holding policy code (& optionally policy data) to be tracked by OPAL | -| `server.policyRepoMainBranch` | sets OPAL_POLICY_REPO_MAIN_BRANCH which defaults to `master` | -| `server.dataConfigSources` | Data sources to be published to clients (and their managed OPAs) | -| `server.dataConfigSources.config.entries` | Static list of data source entries (See [OPAL Docs](https://docs.opal.ac/getting-started/running-opal/run-opal-server/data-sources)) | -| `server.dataConfigSources.external_source_url` | URL to dynamically fetch data sources entries from (See [OPAL Docs](https://docs.opal.ac/tutorials/configure_external_data_sources)) | +| Variable | Description | +| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `server.policyRepoUrl` | Git repository holding policy code (& optionally policy data) to be tracked by OPAL | +| `server.policyRepoMainBranch` | sets OPAL_POLICY_REPO_MAIN_BRANCH which defaults to `master` | +| `server.dataConfigSources` | Data sources to be published to clients (and their managed OPAs) | +| `server.dataConfigSources.config.entries` | Static list of data source entries (See [OPAL Docs](https://docs.opal.ac/getting-started/running-opal/run-opal-server/data-sources)) | +| `server.dataConfigSources.external_source_url` | URL to dynamically fetch data sources entries from (See [OPAL Docs](https://docs.opal.ac/tutorials/configure_external_data_sources)) | | `server.broadcastUri` | Backend for broadcasting updates across multiple opal-server processes (necessary if either `server.uvicornWorkers` or `server.replicas` is > 1) | -| `server.uvicornWorkers` | Count of gunicorn workers (/processes) per opal-server replica | -| `server.replicas` | opal-server's deployment replica count | -| `server.extraEnv` | Extra configuration for opal-server (see [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal)) | -| `client.extraEnv` | Extra configuration for opal-server [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal) | +| `server.uvicornWorkers` | Count of gunicorn workers (/processes) per opal-server replica | +| `server.replicas` | opal-server's deployment replica count | +| `server.extraEnv` | Extra configuration for opal-server (see [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal)) | +| `client.extraEnv` | Extra configuration for opal-server [OPAL Docs](https://docs.opal.ac/tutorials/configure_opal) | **Note:** If you leave `server.dataConfigSources` with no entries - The chart would automatically set `OPAL_DATA_UPDATER_ENABLED: False` in `client.extraEnv` so client won't report an unhealthy state.