K8SPG-760 Fixed the description if the WATCH_NAMESPACE env var #356
+191
−9
Conversation
This file contains hidden or 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
scription if the WATCH_NAMESPACE env var
dquote>
dquote> Added documentation on env vars in the Operator and how to define them
modified: docs/cluster-wide.md
new file: docs/env-var-cluster.md
new file: docs/env-var-operator.md
new file: docs/env-vars.md
modified: mkdocs-base.yml
nastena1606
requested review from
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
nmarukovich,
pooknull and
valmiranogueira
as code owners
There was a problem hiding this comment.
Pull request overview
Adds new documentation pages describing how to define environment variables for the Operator and for cluster components, and updates the cluster-wide deployment docs accordingly.
Changes:
- Added new docs pages for env var overview and configuration (Operator + cluster components)
- Updated cluster-wide deployment docs to clarify
WATCH_NAMESPACEbehavior - Updated MkDocs navigation to include the new documentation section
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs-base.yml | Adds nav entries for the new environment variable documentation pages |
| docs/env-vars.md | Introduces an overview page describing env var types and use cases |
| docs/env-var-operator.md | Documents Operator env vars and how to update them |
| docs/env-var-cluster.md | Documents where to define env vars for cluster components in the CR |
| docs/cluster-wide.md | Clarifies WATCH_NAMESPACE behavior and links to the new env var docs |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+10
to
+13
| | Type | Use cases | | ||
| | ------------------------------------- | --------- | | ||
| | Operator environment variables | * Control logging for debugging and log aggregation <br> * Manage telemetry <br> * Configure which namespaces the Operator watches (single-namespace vs cluster-wide) <br> * Set the number of concurrent reconciliation workers for multi-cluster environments <br> * Enable feature gates such as auto-growable volumes | | ||
| | Cluster component environment variables | * Customize PostgreSQL, pgBackRest, or pgBouncer behavior <br> * Pass configuration or secrets into Pods <br> * Integrate with external systems or monitoring. | |
There was a problem hiding this comment.
The Markdown table uses || at the start of each row, which typically renders as an extra empty column (or breaks table formatting). Use a single leading | for each row to produce a standard 2-column table.
docs/env-var-operator.md
Outdated
| * If set to an empty String "", the operator watches all the namespaces of the kubernetes cluster(cluster-wide mode). | ||
|
|
||
| In Cluster-wide mode,operator should be associated with appropriate ClusterRole. | ||
| Read more about deployment methods here (./2.1.6.1_namespace_modes.md) |
There was a problem hiding this comment.
This is not a valid Markdown link (it’s just a parenthesized path). Convert it to a proper Markdown link, and prefer the MkDocs-relative doc path (consistent with how other pages are linked) so it renders and navigates correctly.
Suggested change
| Read more about deployment methods here (./2.1.6.1_namespace_modes.md) | |
| Read more about deployment methods [here](2.1.6.1_namespace_modes.md). |
Co-authored-by: Copilot <[email protected]>
egegunes
approved these changes
Feb 13, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Added documentation on env vars in the Operator and how to define them
modified: docs/cluster-wide.md
new file: docs/env-var-cluster.md
new file: docs/env-var-operator.md
new file: docs/env-vars.md
modified: mkdocs-base.yml