@@ -13,7 +13,7 @@ v1.5.2, {docdate}
13
13
[#Overview]
14
14
== Overview
15
15
16
- The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes.
16
+ The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes environment .
17
17
18
18
image::docs/tty.gif?raw=true[]
19
19
@@ -48,30 +48,43 @@ Once the objects are detected, the PostgreSQL Operator enables users to perform
48
48
* Apply User Defined Labels to PostgreSQL Clusters
49
49
* Perform Password Management
50
50
51
- What actually gets created on the Kube cluster for a
51
+ What actually gets created on the Kubernetes cluster for a
52
52
*pgcluster* resource is defined as a *deployment strategy*. Strategies
53
53
are documented in detail in link:docs/design.asciidoc#postgresql-operator-deployment-strategies[Deployment Strategies].
54
54
55
55
[#Requirements]
56
56
== Requirements
57
57
58
- Version requirements, these versions of Kubernetes and Openshift are
59
- required due to the use of ThirdPartyResources which first emerged in
58
+ These versions of Kubernetes and OpenShift are required due to the use of ThirdPartyResources which first emerged in
60
59
these versions.
61
60
62
- * greater than Kubernetes 1.5.3+
63
- * greater than Openshift Origin 1.5.1+ and Openshift Container Platform 3.5
61
+ * *Kubernetes 1.5.3+*
62
+ * *OpenShift Origin 1.5.1+*
63
+ * *OpenShift Container Platform 3.5*
64
+
65
+ The operator is developed with the following specific version of Golang; you can find this distribution on the official
66
+ link:https://golang.org/dl/[Golang website]. Because Go binaries essentially have Go runtime bundled with them, it is
67
+ important to build on a platform that is compatible with the target deployment platform.
68
+
69
+ * *Golang 1.8.x*
64
70
65
71
The Operator makes use of the following containers:
66
72
67
73
* link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.5+ Container]
68
74
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
69
75
* link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container]
76
+ * link:https://hub.docker.com/r/crunchydata/lspvc/[PostgreSQL PVC Listing Container]
77
+ * link:https://hub.docker.com/r/crunchydata/postgres-operator/[postgres-operator Container]
78
+
79
+ This Operator has also been tested on the following operating systems:
80
+
81
+ * *CentOS 7*
82
+ * *RHEL 7*
70
83
71
84
[#Build and Install Instructions]
72
85
== Build and Install Instructions
73
86
74
- To build and deploy the Operator on your Kube system, follow
87
+ To build and deploy the Operator on your Kubernetes system, follow
75
88
the instructions documented on the link:docs/build.asciidoc[Build and Install] page.
76
89
77
90
With the operator deployed, the *pgo* command line
@@ -81,7 +94,7 @@ and reacts to.
81
94
[#Configuration]
82
95
== Configuration
83
96
84
- You can configure both the client and the operator. The
97
+ The operator is template-driven; this makes it simple to configure both the client and the operator. The
85
98
configuration options are documented on the link:docs/config.asciidoc[Configuration] page.
86
99
87
100
[#Examples]
@@ -179,10 +192,10 @@ link:docs/user-guide.asciidoc[User Guide]
179
192
[#PostgreSQL Operator Container]
180
193
== PostgreSQL Operator Container
181
194
182
- In the following diagram, the postgres operator client, *pgo*, is
183
- shown interacting with the postgres operator that runs within
195
+ In the following diagram, the PostgreSQL operator client, *pgo*, is
196
+ shown interacting with the PostgreSQL operator that runs within
184
197
a Kubernetes cluster. The operator is responsible for creating
185
- or modifying PostgreSQL databases deployed within the Kube cluster.
198
+ or modifying PostgreSQL databases deployed within the Kubernetes cluster.
186
199
187
200
image::docs/operator-diagram.png?raw=true[]
188
201
0 commit comments