@@ -16,12 +16,12 @@ how the operator is built and how it operates.
1616
1717For most users of the Operator who simply want to deploy
1818it on a running Kube cluster will find the Quickstart
19- script useful https://github.com/CrunchyData/postgres-operator/blob/pre25 /examples/quickstart.sh
19+ script useful https://github.com/CrunchyData/postgres-operator/blob/master /examples/quickstart.sh
2020
2121Executing that script will deploy the Operator to your Kube
2222cluster and also set up your local user environment with the
2323*pgo* client in about 10 seconds. More details on the Quickstart
24- is at the end of this document.
24+ is at the end of this document <<Quickstart>> .
2525
2626
2727== Requirements
@@ -37,15 +37,14 @@ these versions.
3737The operator is developed with the Golang versions great than or equal to version 1.8 See
3838link:https://golang.org/dl/[Golang website] for details on installing golang.
3939
40- Pre-compiled versions of the Operator *pgo* client are provided for the x86_64 and Mac OSX
41- hosts.
40+ Pre-compiled versions of the Operator *pgo* client are provided for the x86_64, Mac OSX, and Windows hosts.
4241
43- As of version 2.0, the Operator uses the following PostgreSQL containers:
42+ As of version 2.0, the Operator uses the following Crunchy containers (+1.6.0) :
4443
45- * link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.6+ Container] version 1.6.0 or later (e.g. centos7-10.1-1.7.0)
46- * link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container] version 1.6.0 or later (e.g. centos7-10.1-1.7.0)
47- * link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container] version 1.6.0 or later (e.g. centos7-10.1-1.7.0)
48- * link:https://hub.docker.com/r/crunchydata/crunchy-collect/[PostgreSQL Metrics Collection Container] version 1.6.0 or later (e.g. centos7-10.1-1.7.0)
44+ * link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.6+ Container]
45+ * link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
46+ * link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container]
47+ * link:https://hub.docker.com/r/crunchydata/crunchy-collect/[PostgreSQL Metrics Collection Container]
4948
5049The Operator project builds and operates with the following containers:
5150
@@ -55,27 +54,18 @@ The Operator project builds and operates with the following containers:
5554* link:https://hub.docker.com/r/crunchydata/pgo-apiserver/[apiserver Container]
5655* link:https://hub.docker.com/r/crunchydata/pgo-load/[file load Container]
5756
58- This Operator is developed on and has also been tested on the following operating systems:
57+ This Operator is developed and tested on the following operating systems:
5958
6059* *CentOS 7*
6160* *RHEL 7*
6261
6362=== Kubernetes Environment
6463
6564To test the *postgres-operator*, it is required to have a Kubernetes cluster
66- environment. The Operator is tested on Kubeadm Kubernetes installed clusters. Other
67- Kubernetes installation methods have been known to work as well.
65+ environment. The Operator is tested on Kubeadm Kubernetes installed clusters. Other Kubernetes installation methods have been known to work as well.
6866
6967link:https://kubernetes.io/docs/setup/independent/install-kubeadm/[Installing kubeadm - Official Kubernetes Documentation]
7068
71-
72- On kubeadm, you'll need to let non-root users have access to the
73- kubeconfig admin directory and files as follows:
74- ....
75- sudo chmod o+rwx /etc/kubernetes/
76- sudo chmod o+rwx /etc/kubernetes/admin.conf
77- ....
78-
7969== Installation
8070
8171=== Create Project and Clone
@@ -132,16 +122,16 @@ containers, you can pre-pull them as follows:
132122
133123For PostgreSQL version 10.1:
134124....
135- docker pull crunchydata/crunchy-postgres:centos7-10.1-1.7.0
136- docker pull crunchydata/crunchy-backup:centos7-10.1-1.7.0
137- docker pull crunchydata/crunchy-upgrade:centos7-10.1-1.7.0
125+ docker pull crunchydata/crunchy-postgres:centos7-10.1-1.7.1
126+ docker pull crunchydata/crunchy-backup:centos7-10.1-1.7.1
127+ docker pull crunchydata/crunchy-upgrade:centos7-10.1-1.7.1
138128....
139129
140130For PostgreSQL version 9.6:
141131....
142- docker pull crunchydata/crunchy-postgres:centos7-9.6.6-1.7.0
143- docker pull crunchydata/crunchy-backup:centos7-9.6.6-1.7.0
144- docker pull crunchydata/crunchy-upgrade:centos7-9.6.6-1.7.0
132+ docker pull crunchydata/crunchy-postgres:centos7-9.6.6-1.7.1
133+ docker pull crunchydata/crunchy-backup:centos7-9.6.6-1.7.1
134+ docker pull crunchydata/crunchy-upgrade:centos7-9.6.6-1.7.1
145135....
146136
147137=== Get Prebuilt Images
@@ -221,13 +211,13 @@ The sample service account and cluster role bindings specify
221211the *demo* namespace. Edit the yaml definitions of these to match
222212the namespace you are deploying the operator into.
223213
224- Edit the following, updating the namespace if not using *demo* :
214+ If you are not using the *demo* namespace, you will edit the following :
225215
226- $COROOT/conf/apiserver/pgo.yaml
227- $COROOT/deploy/service-account.yaml
228- $COROOT/deploy/cluster-role-binding.yaml
216+ * $COROOT/conf/apiserver/pgo.yaml
217+ * $COROOT/deploy/service-account.yaml
218+ * $COROOT/deploy/cluster-role-binding.yaml
229219
230- likewise, specify your *CO_NAMESPACE* environment variable will specify *demo*;
220+ likewise, specify your *CO_NAMESPACE* environment variable:
231221
232222....
233223export CO_NAMESPACE=demo
@@ -249,21 +239,14 @@ persistence configuration.
249239There are example scripts provided that will create PV and PVC resources
250240that can be used in your testing.
251241
252- These utilize HostPath and NFS volume types. Other types are not currently
253- supported, but can be manually defined.
242+ These example scripts can create sample HostPath and NFS volumes.
254243
255244To create sample HostPath Persistent Volumes and CLaims use the following scripts:
256245....
257246cd $COROOT/pv
258247./create-pv.sh
259- kubectl create -f ./crunchy-pvc.json
260- kubectl create -f ./csv-pvc.json
261248....
262249
263- Note that this example will create a PVC called *crunchy-pvc* that is
264- referenced in the examples and *pgo.yaml* configuration file as the
265- desired PVC to use when databases and clusters are created.
266-
267250=== Security
268251==== Configure Basic Authentication
269252
@@ -849,7 +832,7 @@ essentially cloning a database with an existing backup archive.
849832
850833For example, to restore a database from a backup archive:
851834....
852- pgo create cluster restoredb --backup-path=mycluster-backups/2017-03-27-13-56-49 --backup-pvc=crunchy -pvc --secret-from=mycluster
835+ pgo create cluster restoredb --backup-path=mycluster-backups/2017-03-27-13-56-49 --backup-pvc=mycluster -pvc --secret-from=mycluster
853836....
854837
855838This will create a new database called *restoredb* based on the
@@ -1008,16 +991,16 @@ pgo delete upgrade
1008991
1009992You can view the files on a PVC as follows:
1010993....
1011- pgo show pvc crunchy -pvc
994+ pgo show pvc mycluster -pvc
1012995....
1013996
1014- In this example, the PVC is *crunchy -pvc*. This command is useful
997+ In this example, the PVC is *mycluster -pvc*. This command is useful
1015998in some cases to examine what files are on a given PVC.
1016999
10171000In the case where you want to list a specific path on a PVC
10181001you can specify the path option as follows:
10191002....
1020- pgo show pvc crunchy -pvc --pvc-root=mycluster-backups
1003+ pgo show pvc mycluster -pvc --pvc-root=mycluster-backups
10211004....
10221005
10231006=== pgo show cluster
0 commit comments