You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: hugo/content/Configuration/pgo-yaml-configuration.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,13 +17,14 @@ The *pgo.yaml* file is broken into major sections as described below:
17
17
|BasicAuth | if set to *true* will enable Basic Authentication
18
18
|PrimaryNodeLabel |newly created primary deployments will specify this node label if specified, unless you override it using the --node-label command line flag, if not set, no node label is specifed
19
19
|ReplicaNodeLabel |newly created replica deployments will specify this node label if specified, unless you override it using the --node-label command line flag, if not set, no node label is specifed
20
-
|CCPImageTag |newly created containers will be based on this image version (e.g. centos7-10.4-1.8.3), unless you override it using the --ccp-image-tag command line flag
20
+
|CCPImagePrefix |newly created containers will be based on this image prefix (e.g. crunchydata), update this if you require a custom image prefix
21
+
|CCPImageTag |newly created containers will be based on this image version (e.g. centos7-11.1-2.3.0), unless you override it using the --ccp-image-tag command line flag
21
22
|Port | the PostgreSQL port to use for new containers (e.g. 5432)
22
-
|LogStatement | postgresql.conf log_statement value (required field) (works with crunchy-postgres >= 2.2.0)
23
-
|LogMinDurationStatement | postgresql.conf log_min_duration_statement value (required field) (works with crunchy-postgres >= 2.2.0)
23
+
|LogStatement | postgresql.conf log_statement value (required field)
24
+
|LogMinDurationStatement | postgresql.conf log_min_duration_statement value (required field)
24
25
|User | the PostgreSQL normal user name
25
26
|Strategy | sets the deployment strategy to be used for deploying a cluster, currently there is only strategy *1*
26
-
|Replicas | the number of cluster replicas to create for newly created clusters
27
+
|Replicas | the number of cluster replicas to create for newly created clusters, typically users will scale up replicas on the pgo CLI command line but this global value can be set as well
27
28
|PgmonitorPassword | the password to use for pgmonitor metrics collection if you specify --metrics when creating a PG cluster
28
29
|Metrics | boolean, if set to true will cause each new cluster to include crunchy-collect as a sidecar container for metrics collection, if set to false (default), users can still add metrics on a cluster-by-cluster basis using the pgo command flag --metrics
29
30
|Badger | boolean, if set to true will cause each new cluster to include crunchy-pgbadger as a sidecar container for static log analysis, if set to false (default), users can still add pgbadger on a cluster-by-cluster basis using the pgo create cluster command flag --pgbadger
@@ -34,6 +35,7 @@ The *pgo.yaml* file is broken into major sections as described below:
34
35
|ArchiveTimeout | optional, if set, will determine the archive timeout setting used when ArchiveMode is true, defaults to 60 seconds
35
36
|ServiceType | optional, if set, will determine the service type used when creating primary or replica services, defaults to ClusterIP if not set, can be overridden by the user on the command line as well
36
37
|Backrest | optional, if set, will cause clusters to have the pgbackrest volume PVC provisioned during cluster creation
38
+
|BackrestPort | currently required to be port 2022
37
39
|Autofail | optional, if set, will cause clusters to be checked for auto failover in the event of a non-Ready status
38
40
|AutofailReplaceReplica | optional, default is false, if set, will determine whether a replica is created as part of a failover to replace the promoted replica, the AutofailReplaceReplica setting in *pgo.yaml* is overrode with this command line flag if specified by a user.
39
41
@@ -45,6 +47,7 @@ The *pgo.yaml* file is broken into major sections as described below:
45
47
|BackupStorage |required, the value of the storage configuration to use for backups, including the storage for pgbackrest repo volumes
46
48
|ReplicaStorage |required, the value of the storage configuration to use for the replica PostgreSQL deployments
47
49
|ReplicaStorage |required, the value of the storage configuration to use for the replica PostgreSQL deployments
50
+
|BackrestStorage |required, the value of the storage configuration to use for the pgbackrest shared repository deployment created when a user specifies pgbackrest to be enabled on a cluster
48
51
|StorageClass |for a dynamic storage type, you can specify the storage class used for storage provisioning(e.g. standard, gold, fast)
49
52
|AccessMode |the access mode for new PVCs (e.g. ReadWriteMany, ReadWriteOnce, ReadOnlyMany). See below for descriptions of these.
50
53
|Size |the size to use when creating new PVCs (e.g. 100M, 1Gi)
Copy file name to clipboardExpand all lines: hugo/content/Installation/_index.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,10 @@ A full installation of the Operator includes the following steps:
14
14
- deploy the operator
15
15
- install pgo CLI (end user command tool)
16
16
17
-
Operator end-users are only required to install the pgo CLI client on their host and can skip the server-side installation steps.
17
+
Operator end-users are only required to install the pgo CLI client on their host and can skip the server-side installation steps. pgo CLI clients are provided
18
+
on the Github Releases page for Linux, Mac, and Windows clients.
18
19
19
-
The Operator can also be deployed with a sample Helm chart and also a *quickstart* script. Those installation methods don't provide the same level of customization that the installation provides but are alternatives. Crunchy also provides an Ansible playbook for Crunchy customers.
20
+
The Operator can also be deployed with a sample Helm chart and also a *quickstart* script. Those installation methods don't provide the same level of customization that the installation provides but are alternatives. Crunchy also provides an Ansible playbook for Crunchy customers.
20
21
21
22
See below for details on the Helm and quickstart installation methods.
22
23
@@ -38,7 +39,9 @@ Environment variables control aspects of the Operator installation. You can cop
In this example set of environment variables, the CO_NAMESPACE environment variable is set to *demo* as an example namespace in which the Operator will be deployed. Adjust to suit your needs. There is a Makefile target you can run to create the *demo* namespace if you want:
42
+
In this example set of environment variables, the CO_NAMESPACE environment variable is set to *demo* as an example namespace in which the Operator will be deployed. See the Design section of documentation on the Operator namespace requirements.
43
+
44
+
Adjust the namespace value to suit your needs. There is a Makefile target you can run to create the *demo* namespace if you want:
42
45
43
46
make setupnamespace
44
47
@@ -94,6 +97,10 @@ you wanted to use HostPath for testing:
94
97
./pv/create-pv.sh
95
98
```
96
99
100
+
Adjust the above PV creation scripts to suit your local requirements, the purpose
101
+
of these scripts are solely to produce a test set of Volume to test the
102
+
Operator.
103
+
97
104
Other settings in *pgo.yaml* are described in the [pgo.yaml Configuration](/configuration/pgo-yaml-configuration) section of the documentation.
98
105
99
106
## Operator Security
@@ -132,14 +139,16 @@ At this point, you as a normal Kubernetes user should be able to deploy the Oper
132
139
133
140
This will cause any existing Operator to be removed first, then the configuration to be bundled into a ConfigMap, then the Operator Deployment to be created.
134
141
135
-
This will create a postgres-operator Deployment along with a crunchy-scheduler Deployment, and a postgres-operator Service.
142
+
This will create a postgres-operator Deployment along with a crunchy-scheduler Deployment, and a postgres-operator Service. So, Operator administrators needing
143
+
to make changes to the Operator configuration would run this make target
144
+
to pick up any changes to pgo.yaml or the Operator templates.
136
145
137
146
138
147
## pgo CLI Installation
139
148
Most users will work with the Operator using the *pgo* CLI tool. That tool is downloaded from the GitHub Releases page for the Operator (https://github.com/crunchydata/postgres-operator/releases).
140
149
141
150
The *pgo* client is provided in Mac, Windows, and Linux binary formats, download the appropriate client to your local laptop or workstation to work with a remote Operator.
142
-
Prior to using *pgo*, users will need to specify the
151
+
Prior to using *pgo*, users testing the Operator on a single host can specify the
Copy file name to clipboardExpand all lines: hugo/content/Security/_index.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -119,3 +119,7 @@ This will recreate the *pgo-auth-secret* Secret that stores these files and is m
119
119
The Operator REST API is secured with keys stored in the *pgo-auth-secret* Secret. Adjust the default keys to meet your security requirements using your own keys. The *pgo-auth-secret* Secret is created when you run:
120
120
121
121
make deployoperator
122
+
123
+
The keys are generated when the RBAC script is executed by the cluster admin:
Copy file name to clipboardExpand all lines: hugo/content/Upgrade/_index.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,7 @@ removes the ingest related API endpoints.
28
28
* The pgo.yaml adds the PreferredFailoverNode setting. This is a Kubernetes selector string (e.g. key=value). This value if set, will cause fail-over targets to be preferred based on the node they run on if that node is in the set of *preferred*.
29
29
* The ability to select nodes based on a selector string was added. For this to feature to be used, multiple replicas have to be in a ready state, and also at the same replication status. If those conditions are not met, the default fail-over target selection is used.
30
30
* The pgo.yaml file now includes a new storage configuration, XlogStorage, which when set will cause the xlog volume to be allocated using this storage configuration. If not set, the PrimaryStorage configuration will be used.
31
+
* The pgo.yaml file now includes a new storage configuration, BackrestStorage, will cause the pgbackrest shared repository volume to be allocated using this storage configuration.
31
32
* The pgo.yaml file now includes a setting, AutofailReplaceReplica, which will enable or disable whether a new replica is created as part of a fail-over. This is turned off by default.
32
33
33
34
See the GitHub Release notes for the features and other notes about a specific release.
0 commit comments