K8SPG-914 Documented naming conventions for Helm resources.#358
K8SPG-914 Documented naming conventions for Helm resources.#358nastena1606 wants to merge 6 commits into2.0from
Conversation
Improved Helm install steps, extended custom install page
new file: docs/assets/fragments/what-you-install.txt
modified: docs/custom-install.md
modified: docs/helm.md
modified: docs/kubectl.md
modified: docs/update-operator.md
There was a problem hiding this comment.
Pull request overview
Updates installation documentation to consistently describe Percona Operator for PostgreSQL usage, clarifies Helm/kubectl install guidance, and adds naming conventions for Helm-generated resources.
Changes:
- Refined Helm and kubectl install pages, including a shared “What you will install” fragment.
- Expanded custom Helm installation docs with
--set/values.yamlexamples plus resource naming conventions. - Updated operator upgrade wording for consistency.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/update-operator.md | Tweaks upgrade step wording for Operator naming consistency. |
| docs/kubectl.md | Renames page/title and adds shared “What you will install” fragment. |
| docs/helm.md | Expands Helm install guidance and clarifies required charts and prerequisites. |
| docs/custom-install.md | Extends custom Helm install docs and documents Helm naming override conventions. |
| docs/assets/fragments/what-you-install.txt | New shared fragment describing installed components and defaults. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/kubectl.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| To install Percona Distribution for PostgreSQL, you need the following: |
There was a problem hiding this comment.
The page title/introduction was updated to ‘Percona Operator for PostgreSQL’, but this prerequisite line still says ‘Percona Distribution for PostgreSQL’. Consider updating it to match the page scope (e.g., ‘To install Percona Operator for PostgreSQL…’), or explicitly mention both Operator and database cluster if that’s the intent.
| The default Percona Distribution for PostgreSQL configuration includes: | ||
|
|
||
| * 3 PostgreSQL servers, one Primary and two replicas. | ||
| * a pgBouncer instance - a lightweight connection pooler for PostgreSQL that sits between client applications and the database server to manage and reuse connections efficiently. |
There was a problem hiding this comment.
actually 3 pgBouncer instances
|
|
||
| * 3 PostgreSQL servers, one Primary and two replicas. | ||
| * a pgBouncer instance - a lightweight connection pooler for PostgreSQL that sits between client applications and the database server to manage and reuse connections efficiently. | ||
| * a pgBackRest instance - a backup and restore utility for PostgreSQL that provides a way to backup and restore your database. |
There was a problem hiding this comment.
pgbackrest runs inside database pods. by default operator deploys a repo host instances for filesystem backups
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Improved Helm install steps, extended custom install page
new file: docs/assets/fragments/what-you-install.txt
modified: docs/custom-install.md
modified: docs/helm.md
modified: docs/kubectl.md
modified: docs/update-operator.md