Skip to content

Update all the cluster chart documentation links #780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jessebot wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update all the cluster chart documentation links #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b40c4f
Update values.yaml - update all the documentation links
jessebot Jan 18, 2026
83d1c7d
Update Getting Started.md - update doc links
jessebot Jan 18, 2026
83120d0
Update values.yaml - fix link to certificates docs
jessebot Jan 18, 2026
9a213fe
Apply updated security doc links from code review
jessebot Jan 21, 2026
9472314
Merge branch 'main' into patch-1
jessebot Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions charts/cluster/docs/Getting Started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ you still need to configure backups and monitoring separately. The chart will no

_**Note,**_ that this is an opinionated chart. It does not support all configuration options that CNPG supports. If you
need a highly customized setup, you should manage your cluster via a Kubernetes CNPG cluster manifest instead of this chart.
Refer to the [CNPG documentation](https://cloudnative-pg.io/documentation/current/) in that case.
Refer to the [CNPG documentation](https://cloudnative-pg.io/docs/1.28/) in that case.

## Installing the operator

To begin, make sure you install the CNPG operator in you cluster. It can be installed via a Helm chart as shown below or
ir can be installed via a Kubernetes manifest. For more information see the [CNPG documentation](https://cloudnative-pg.io/documentation/current/installation_upgrade/).
ir can be installed via a Kubernetes manifest. For more information see the [CNPG documentation](https://cloudnative-pg.io/docs/1.28/installation_upgrade/).

```console
helm repo add cnpg https://cloudnative-pg.github.io/charts
Expand Down
30 changes: 15 additions & 15 deletions charts/cluster/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ recovery:
# -- Name of the backup credentials secret
name: ""

# See https://cloudnative-pg.io/documentation/current/bootstrap/#bootstrap-from-a-live-cluster-pg_basebackup
# See https://cloudnative-pg.io/docs/1.28/bootstrap/#bootstrap-from-a-live-cluster-pg_basebackup
pgBaseBackup:
# -- Name of the database used by the application. Default: `app`.
database: app
Expand Down Expand Up @@ -132,10 +132,10 @@ recovery:
name: ""
key: ""

# See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-Import
# See: https://cloudnative-pg.io/docs/1.28/cloudnative-pg.v1/#postgresql-cnpg-io-v1-Import
import:
# -- One of `microservice` or `monolith.`
# See: https://cloudnative-pg.io/documentation/current/database_import/#how-it-works
# See: https://cloudnative-pg.io/docs/1.28/database_import/#how-it-works
type: "microservice"
# -- Databases to import
databases: []
Expand Down Expand Up @@ -198,7 +198,7 @@ cluster:
imagePullPolicy: IfNotPresent

# -- The list of pull secrets to be used to pull the images.
# See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-LocalObjectReference
# See: https://cloudnative-pg.io/docs/1.28/cloudnative-pg.v1/#postgresql-cnpg-io-v1-LocalObjectReference
imagePullSecrets: []

storage:
Expand All @@ -216,7 +216,7 @@ cluster:
# -- The GID of the postgres user inside the image, defaults to 26
postgresGID: -1

# -- Customization of service definitions. Please refer to https://cloudnative-pg.io/documentation/current/service_management/
# -- Customization of service definitions. Please refer to https://cloudnative-pg.io/docs/1.28/service_management/
services: {}

# -- Resources requirements of every generated Pod.
Expand Down Expand Up @@ -245,7 +245,7 @@ cluster:
logLevel: "info"

# -- Affinity/Anti-affinity rules for Pods.
# See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-AffinityConfiguration
# See: https://cloudnative-pg.io/docs/1.28/cloudnative-pg.v1/#postgresql-cnpg-io-v1-AffinityConfiguration
affinity:
topologyKey: topology.kubernetes.io/zone

Expand Down Expand Up @@ -276,7 +276,7 @@ cluster:
# optional: true

# -- The configuration for the CA and related certificates.
# See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-CertificatesConfiguration
# See: https://cloudnative-pg.io/docs/1.28/certificates
certificates: {}

# -- When this option is enabled, the operator will use the SuperuserSecret to update the postgres user password.
Expand All @@ -287,12 +287,12 @@ cluster:
superuserSecret: ""

# -- Allow to disable PDB, mainly useful for upgrade of single-instance clusters or development purposes
# See: https://cloudnative-pg.io/documentation/current/kubernetes_upgrade/#pod-disruption-budgets
# See: https://cloudnative-pg.io/docs/1.28/kubernetes_upgrade/#pod-disruption-budgets
enablePDB: true

# -- This feature enables declarative management of existing roles, as well as the creation of new roles if they are not
# already present in the database.
# See: https://cloudnative-pg.io/documentation/current/declarative_role_management/
# See: https://cloudnative-pg.io/docs/1.28/declarative_role_management/
roles: []
# - name: dante
# ensure: present
Expand Down Expand Up @@ -364,9 +364,9 @@ cluster:
# -- Lists of shared preload libraries to add to the default ones
shared_preload_libraries: []
# - pgaudit
# -- PostgreSQL LDAP configuration (see https://cloudnative-pg.io/documentation/current/postgresql_conf/#ldap-configuration)
# -- PostgreSQL LDAP configuration (see https://cloudnative-pg.io/docs/1.28/postgresql_conf/#ldap-configuration)
ldap: {}
# https://cloudnative-pg.io/documentation/current/postgresql_conf/#ldap-configuration
# https://cloudnative-pg.io/docs/1.28/postgresql_conf/#ldap-configuration
# server: 'openldap.default.svc.cluster.local'
# bindSearchAuth:
# baseDN: 'ou=org,dc=example,dc=com'
Expand All @@ -378,8 +378,8 @@ cluster:


# -- BootstrapInitDB is the configuration of the bootstrap process when initdb is used.
# See: https://cloudnative-pg.io/documentation/current/bootstrap/
# See: https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-bootstrapinitdb
# See: https://cloudnative-pg.io/docs/1.28/bootstrap/
# See: https://cloudnative-pg.io/docs/1.28/cloudnative-pg.v1/#postgresql-cnpg-io-v1-bootstrapinitdb
initdb: {}
# database: app
# owner: "" # Defaults to the database name
Expand All @@ -396,11 +396,11 @@ cluster:
serviceAccountTemplate: {}

# -- Configure the Pod Security Context.
# See: https://cloudnative-pg.io/documentation/preview/security/
# See: https://cloudnative-pg.io/docs/1.28/security/
podSecurityContext: {}

# -- Configure Container Security Context.
# See: https://cloudnative-pg.io/documentation/preview/security/
# See: https://cloudnative-pg.io/docs/1.28/security/
securityContext: {}

additionalLabels: {}
Expand Down