@@ -34,7 +34,7 @@ specify all of the configuration files. It is entirely up to your use case
3434to determine which to use.
3535
3636An example set of configuration files and a script to create the
37- global configMap is found at
37+ global configMap is found at
3838```
3939$PGOROOT/examples/custom-config
4040```
@@ -79,7 +79,7 @@ and avoid defining a global configMap.
7979## Modifying PostgreSQL Cluster Configuration
8080
8181Once a PostgreSQL cluster has been initialized, its configuration settings
82- can be updated and modified as needed. This done by modifying the
82+ can be updated and modified as needed. This done by modifying the
8383` <clusterName>-pgha-config ` ConfigMap that is created for each individual
8484PostgreSQL cluster.
8585
@@ -94,7 +94,7 @@ and cluster's configuration can be
9494[ found here] ( https://access.crunchydata.com/documentation/patroni/latest/settings/index.html#settings ) .
9595Please proceed with caution when modiying configuration, especially those settings
9696applied by default by Operator. Certain settings are required for normal operation
97- of the Operator and the PostgreSQL clusters it creates, and altering these
97+ of the Operator and the PostgreSQL clusters it creates, and altering these
9898settings could result in expected behavior.
9999
100100### Types of Configuration
@@ -104,15 +104,15 @@ Within the `<clusterName>-pgha-config` ConfigMap are two forms of configuration:
104104- ** Distributed Configuration Store (DCS):** Cluster-wide
105105configuration settings that are applied to all database servers in the PostgreSQL
106106cluster
107- - ** Local Database:** Configuration settings that are applied
108- individually to each database server (i.e. the primary and each replica) within
107+ - ** Local Database:** Configuration settings that are applied
108+ individually to each database server (i.e. the primary and each replica) within
109109the cluster.
110110
111111The DCS configuration settings are stored within the ` <clusterName>-pgha-config `
112- ConfigMap in a configuration named ` <clusterName>-dcs-config ` , while the local
112+ ConfigMap in a configuration named ` <clusterName>-dcs-config ` , while the local
113113database configurations are stored in one or more configurations named
114- ` <severName>-dcs -config ` (with one local configuration for the primary and each
115- replica within the cluster). Please note that
114+ ` <serverName>-local -config ` (with one local configuration for the primary and each
115+ replica within the cluster). Please note that
116116[ as described here] ( https://access.crunchydata.com/documentation/patroni/latest/dynamic_configuration/ ) ,
117117certain settings can only be applied via the DCS to ensure they are uniform among
118118the primary and all replicas within the cluster.
@@ -121,7 +121,7 @@ The following is an example of the both the DCS and primary configuration settin
121121as stored in the ` <clusterName>-pgha-config ` ConfigMap for a cluster named ` mycluster ` .
122122Please note the ` mycluster-dcs-config ` configuration defining the DCS configuration
123123for ` mycluster ` , along with the ` mycluster-local-config ` configuration defining the
124- local configuration for the database server named ` mycluster ` , which is the current
124+ local configuration for the database server named ` mycluster ` , which is the current
125125primary within the PostgreSQL cluster.
126126
127127``` bash
@@ -190,11 +190,11 @@ postgresql:
190190
191191In order to update a cluster's configuration settings and then apply
192192those settings (e.g. to the DCS and/or any individual database servers), the
193- DCS and local configuration settings within the ` <clusterName>-pgha-config `
194- ConfigMap can be modified. This can be done using the various commands
193+ DCS and local configuration settings within the ` <clusterName>-pgha-config `
194+ ConfigMap can be modified. This can be done using the various commands
195195available using the ` kubectl ` client (or the ` oc ` client if using OpenShift)
196196for modifying Kubernetes resources. For instance, the following command can be
197- utilized to open the ConfigMap in a local text editor, and then update the
197+ utilized to open the ConfigMap in a local text editor, and then update the
198198various cluster configurations as needed:
199199
200200``` bash
@@ -219,7 +219,7 @@ postgresql:
219219` ` `
220220
221221The various key/value pairs provided within the ` paramters` section result in the
222- configuration of the same settings within the `postgresql.conf` file. Please note that
222+ configuration of the same settings within the `postgresql.conf` file. Please note that
223223settings applied locally to a database server take precendence over those set via the DCS (with the
224224exception being those that must be set via the DCS, as
225225[described here](https://access.crunchydata.com/documentation/patroni/latest/dynamic_configuration/)).
@@ -247,7 +247,7 @@ $ kubectl exec -it mycluster-6f89d8bb85-pnlwz -- patronictl list
247247+-----------------------------+-----------+--------+---------+----+-----------+-----------------+
248248` ` `
249249
250- Here we can see that the ` mycluster-6f89d8bb85-pnlwz` server is pending a restart,
250+ Here we can see that the ` mycluster-6f89d8bb85-pnlwz` server is pending a restart,
251251which can then be accomplished as follows :
252252
253253` ` ` bash
@@ -259,7 +259,7 @@ $ kubectl exec -it mycluster-6f89d8bb85-pnlwz -- patronictl restart mycluster my
259259+-----------------------------+-----------+--------+---------+----+-----------+
260260When should the restart take place (e.g. 2020-04-29T17:23) [now]: now
261261Are you sure you want to restart members mycluster-6f89d8bb85-pnlwz? [y/N]: y
262- Restart if the PostgreSQL version is less than provided (e.g. 9.5.2) []:
262+ Restart if the PostgreSQL version is less than provided (e.g. 9.5.2) []:
263263Success: restart on member mycluster-6f89d8bb85-pnlwz
264264` ` `
265265
@@ -268,15 +268,15 @@ database container within the PostgreSQL cluster being updated.
268268
269269# ## Refreshing Configuration Settings
270270
271- If necessary, it is possible to refresh the configuration stored within the
271+ If necessary, it is possible to refresh the configuration stored within the
272272` <clusterName>-pgha-config` ConfigMap with a fresh copy of either the DCS
273273configuration and/or the configuration for one or more local database servers.
274- This is specifically done by fully deleting a configuration from the
274+ This is specifically done by fully deleting a configuration from the
275275` <clusterName>-pgha-config` ConfigMap. Once a configuration has been deleted,
276- the Operator will detect this and refresh the ConfigMap with a fresh copy of
276+ the Operator will detect this and refresh the ConfigMap with a fresh copy of
277277that specific configuration.
278278
279- For instance, the following `kubectl patch` command can be utilized to
279+ For instance, the following `kubectl patch` command can be utilized to
280280remove the `mycluster-dcs-config` configuration from the example above,
281281causing that specific configuration to be refreshed with a fresh copy of
282282the DCS configuration settings for `mycluster` :
0 commit comments