Skip to content

Commit 248745e

Browse files
Jonathan S. Katzjkatz
authored andcommitted
Reorganization of the custom configuration
This brings it further up the funnel so people can find it, given it is a fairly important and common task.
1 parent 2f89711 commit 248745e

File tree

5 files changed

+27
-0
lines changed

5 files changed

+27
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Se
7777
- Selecting different storage classes for your primary, replica, and backup storage
7878
- Select your own container resources class for each PostgreSQL cluster deployment; differentiate between resources applied for primary and replica clusters!
7979
- Use your own container image repository, including support `imagePullSecrets` and private repositories
80+
- [Customize your PostgreSQL configuration](https://access.crunchydata.com/documentation/postgres-operator/latest/advanced/custom-configuration.md)
8081
- Bring your own trusted certificate authority (CA) for use with the Operator API server
8182
- Override your PostgreSQL configuration for each cluster
8283

docs/content/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Se
8282
- Selecting different storage classes for your primary, replica, and backup storage
8383
- Select your own container resources class for each PostgreSQL cluster deployment; differentiate between resources applied for primary and replica clusters!
8484
- Use your own container image repository, including support `imagePullSecrets` and private repositories
85+
- [Customize your PostgreSQL configuration]({{< relref "/advanced/custom-configuration.md" >}})
8586
- Bring your own trusted certificate authority (CA) for use with the Operator API server
8687
- Override your PostgreSQL configuration for each cluster
8788

File renamed without changes.

docs/content/architecture/provisioning.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,22 @@ deleted
112112
- The Kubernetes Deployment associated with the replica is removed, as well as
113113
any other Kubernetes objects that are specifically associated with this replcia
114114

115+
## [Custom Configuration]({{< relref "/advanced/custom-configuration.md" >}})
116+
117+
PostgreSQL workloads often need tuning and additional configuration in production
118+
environments, and the PostgreSQL Operator allows for this via its ability to
119+
manage [custom PostgreSQL configuration]({{< relref "/advanced/custom-configuration.md" >}}).
120+
121+
The custom configuration can be edit from a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/)
122+
that follows the pattern of `<clusterName>-pgha-config`, where `<clusterName>`
123+
would be `hippo` in `pgo create cluster hippo`. When the ConfigMap is edited,
124+
the changes are automatically pushed out to all of the PostgreSQL instances
125+
within a cluster.
126+
127+
For more information on how this works and what configuration settings are
128+
editable, please visit the "[Custom PostgreSQL configuration]({{< relref "/advanced/custom-configuration.md" >}})"
129+
section of the documentation.
130+
115131
## Deprovisioning
116132

117133
There may become a point where you need to completely deprovision, or delete, a

docs/content/pgo-client/common-tasks.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,6 +1028,15 @@ If you try to connect to a PostgreSQL cluster that is deployed using the
10281028
`--tls-only` with TLS disabled (i.e. `PGSSLMODE=disable`), you will receive an
10291029
error that connections without TLS are unsupported.
10301030

1031+
## [Custom PostgreSQL Configuration]({{< relref "/advanced/custom-configuration.md" >}})
1032+
1033+
Customizing PostgreSQL configuration is currently not subject to the `pgo`
1034+
client, but given it is a common question, we thought it may be helpful to link
1035+
to how to do it from here. To find out more about how to
1036+
[customize your PostgreSQL configuration]({{< relref "/advanced/custom-configuration.md" >}}),
1037+
please refer to the [Custom PostgreSQL Configuration]({{< relref "/advanced/custom-configuration.md" >}})
1038+
section of the documentation.
1039+
10311040
## Standby Clusters: Multi-Cluster Kubernetes Deployments
10321041

10331042
A [standby PostgreSQL cluster]({{< relref "/architecture/high-availability/multi-cluster-kubernetes.md" >}})

0 commit comments

Comments
 (0)