K8SPS-666 Documented env vars and how to define custom env vars#189
K8SPS-666 Documented env vars and how to define custom env vars#189nastena1606 merged 3 commits intomainfrom
Conversation
Documented HAProxy FD limit in examples
There was a problem hiding this comment.
Pull request overview
Adds documentation pages and navigation for configuring Operator and cluster component environment variables, including HAProxy FD limit details, and links telemetry docs to the new Operator env var reference.
Changes:
- Added new docs pages for env var overview, Operator env vars, and cluster component env vars.
- Updated MkDocs navigation and added a cross-link from telemetry docs.
- Added two root-level “materials” text files containing draft/duplicate env var documentation.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs-base.yml | Adds nav entries for the new environment variables documentation section. |
| docs/env-vars.md | New overview page that routes readers to Operator vs cluster-component env var docs. |
| docs/env-vars-operator.md | New reference page documenting supported Operator Deployment environment variables and update workflow. |
| docs/env-vars-custom.md | New page explaining how to set/tune cluster component env vars via CR fields (env/envFrom). |
| docs/telemetry.md | Adds link to the Operator env var documentation from telemetry docs. |
| materials.txt | Adds a root-level draft/alternate env var doc (currently unreferenced). |
| materials1.txt | Adds a root-level draft/alternate env var doc (currently unreferenced). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. Encode your sensitive values before adding them to a Secret, as Kubernetes stores Secret data in base64-encoded form. This helps prevent accidental exposure of sensitive information in plaintext, even though it is not a secure encryption method. | ||
|
|
There was a problem hiding this comment.
This section suggests manually base64-encoding secret values and implies it helps protect them. Base64 is not a security measure, and when using stringData users should provide the raw value (Kubernetes encodes it into .data). Please adjust the guidance to avoid manual base64 and to set correct expectations about secrecy.
| haproxy: | ||
| env: | ||
| - name: HA_CONNECTION_TIMEOUT | ||
| value: "30" |
There was a problem hiding this comment.
HA_CONNECTION_TIMEOUT is documented as milliseconds, but the example sets it to "30", which would be 30ms. If the intent is 30 seconds, the example should use "30000" (or clarify the units next to the example value).
| value: "30" | |
| value: "30000" |
| 3. Create a ConfigMap object: | ||
|
|
||
| ```bash | ||
| kubectl apply -f mysql-configmap.yaml -n $NAMESPACE |
There was a problem hiding this comment.
The fenced code block for the ConfigMap apply command is missing a closing triple-backtick. This causes step 4+ to render as part of the code block; please close the fence after the kubectl apply line.
| kubectl apply -f mysql-configmap.yaml -n $NAMESPACE | |
| kubectl apply -f mysql-configmap.yaml -n $NAMESPACE | |
| ``` |
| name: ps-app-env | ||
| type: Opaque | ||
| stringData: | ||
| MY_INTEGRATION_TOKEN: "your-base64-encoded-token" | ||
| ``` |
There was a problem hiding this comment.
The example uses stringData but the sample value is described as base64-encoded. With stringData, the value should be the plaintext token; if you want to show base64, use the data field instead (otherwise users may double-encode and break consumers).
196ab0c to
9b6667f
Compare
9b6667f to
aeb9309
Compare
Documented HAProxy FD limit in examples