K8SPXC-1768 Updated the custom installation documentation#302
Open
nastena1606 wants to merge 4 commits intomainfrom
Open
K8SPXC-1768 Updated the custom installation documentation#302nastena1606 wants to merge 4 commits intomainfrom
nastena1606 wants to merge 4 commits intomainfrom
Conversation
Added how to override Helm release names
nastena1606
requested review from
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
mayankshah1607,
nmarukovich,
pooknull and
valmiranogueira
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the “custom installation” documentation to better explain how to customize both the Operator deployment and the Percona XtraDB Cluster, including guidance on overriding Helm-generated resource names.
Changes:
- Expanded kubectl-based customization steps to reference
deploy/bundle.yamlfor Operator deployment configuration anddeploy/cr.yamlfor cluster configuration. - Reworked the Helm section with examples for
--setvsvalues.yamlworkflows. - Added a new section explaining Helm
nameOverride/fullnameOverridenaming behavior and a small “common values” reference table.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+60
to
+87
| ```bash | ||
| helm install my-db percona/pxc-db --version {{ release }} --namespace pxc \ | ||
| --set pxc.volumeSpec.resources.requests.storage=20Gi \ | ||
| --set backup.enabled=false | ||
| ``` | ||
|
|
||
| **Using a `values.yaml` file** | ||
|
|
||
| Create a `values.yaml` file with your custom parameters and pass it to `helm install` with the `-f` or `--values` flag: | ||
|
|
||
| ```bash | ||
| helm install my-db percona/ps-db --version {{ release }} --namespace <namespace> -f values.yaml | ||
| ``` | ||
|
|
||
| You can pass any of the Operator’s [Custom Resource options :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pxc-db#installing-the-chart) as a | ||
| `--set key=value[,key=value]` argument. | ||
| Example `values.yaml`: | ||
|
|
||
| The following example deploys a Percona XtraDB Cluster in the | ||
| `pxc` namespace, with disabled backups and 20 Gi storage: | ||
| ``` yaml title="values.yaml" | ||
| allowUnsafeConfigurations: true | ||
| sharding: | ||
| enabled: false | ||
| pxc: | ||
| size: 3 | ||
| volumeSpec: | ||
| pvc: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| backup: |
There was a problem hiding this comment.
The storage override key path is inconsistent between the --set example (pxc.volumeSpec.resources.requests.storage) and the values.yaml example (pxc.volumeSpec.pvc.resources.requests.storage). Please make these consistent and ensure they match the actual Helm values schema so readers don’t copy an incorrect key.
Comment on lines
+37
to
+47
| 3. To customize Percona XtraDB Cluster, edit the required options in the `deploy/cr.yaml` file and apply it as follows: | ||
|
|
||
| ```bash | ||
| kubectl apply -f deploy/cr.yaml -n <namespace> | ||
| ``` | ||
|
|
||
|
|
||
| === "Helm" | ||
|
|
||
| To install Percona XtraDB Cluster with custom parameters, use the following command: | ||
| You can install the Operator deployment and the Percona XtraDB Cluster with custom parameters using Helm. Find what options you can customize in the [Operator chart documentation :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pxc-operator#installing-the-chart) and the [Percona Server for MySQL chart documentation :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pxc-db#installing-the-chart). | ||
|
|
||
| You can provide custom parameters to Helm using either the `--set` flag or a `values.yaml` file. The `--set` flag is convenient for overriding a small number of parameters directly in the command line, while a `values.yaml` file is preferable when you want to manage many custom settings in one place. Both methods are fully supported by Helm and can be used as needed for your deployment. |
There was a problem hiding this comment.
There are a couple of double-spaces in the prose (e.g., before deploy/cr.yaml and in “Cluster with”), which can cause awkward rendering in some Markdown processors. Please reduce to single spaces for consistency.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
it-percona
temporarily deployed
to
K8SPXC-1768-Doc-name-override-Helm - percona-mysql-operator-pxc PR #302
Render
Destroyed
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
nastena1606
force-pushed
the
K8SPXC-1768-Doc-name-override-Helm
branch
from
106dc34 to
250272b
Compare
eleo007
approved these changes
Apr 27, 2026
egegunes
approved these changes
Apr 28, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 how to override Helm release names