Skip to content

Commit c4ca3d6

Browse files
author
Jeff McCormick
committed
update README
1 parent f4218e0 commit c4ca3d6

File tree

1 file changed

+20
-27
lines changed

1 file changed

+20
-27
lines changed

README.asciidoc

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= PostgreSQL Operator
2-
v1.5.2, {docdate}
2+
v2.0, {docdate}
33

44
== Table of Contents
55

@@ -17,15 +17,11 @@ The PostgreSQL Operator provides a Kubernetes operator capability for managing P
1717

1818
image::docs/tty.gif?raw=true[]
1919

20-
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource types such as:
20+
The PostgreSQL Operator leverages Kubernetes Custom Resource Definitions to define custom resource types such as:
2121

2222
* *pgcluster*
2323
* *pgbackups*
24-
* *pgupgrades*
25-
* *pgclones*
2624
* *pgpolicies*
27-
* *pgpolicylogs*
28-
2925

3026
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
3127

@@ -41,36 +37,35 @@ Once the objects are detected, the PostgreSQL Operator enables users to perform
4137
* Upgrade a PostgreSQL Cluster
4238
* View PVC
4339
* Test Connections to a PostgreSQL Cluster
44-
* Clone a PostgreSQL Cluster
4540
* Create a SQL-based Policy
4641
* Apply a SQL-based Policy to a PostgreSQL Cluster
4742
* Perform User Management
4843
* Apply User Defined Labels to PostgreSQL Clusters
4944
* Perform Password Management
5045

51-
What actually gets created on the Kubernetes cluster for a
52-
*pgcluster* resource is defined as a *deployment strategy*. Strategies
53-
are documented in detail in link:docs/design.asciidoc#postgresql-operator-deployment-strategies[Deployment Strategies].
5446

5547
[#Requirements]
5648
== Requirements
5749

58-
These versions of Kubernetes and OpenShift are required due to the use of ThirdPartyResources which first emerged in
59-
these versions.
50+
CRD (custom resource definitions) are supported starting with Kube 1.7.X.
51+
NOTE: Along with this new major version, changes were made to the configuration
52+
settings from the prior version of the Operator.
6053

61-
* *Kubernetes 1.5.3+*
62-
* *OpenShift Origin 1.5.1+*
63-
* *OpenShift Container Platform 3.5*
54+
If you require an older version of Kube (< 1.7), you can work
55+
with the operator version 1.5.2 which resides in the github 1.5.X branch.
56+
Note however, that the older operator will be deprecated and no longer
57+
maintained in the future.
6458

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.
59+
The CRD version of the operator is tested on the following platforms:
6860

69-
* *Golang 1.8.x*
61+
* *Kubernetes 1.7.X+*
62+
* *Kubernetes 1.8.0+*
63+
64+
Support for Openshift is in progress.
7065

7166
The Operator makes use of the following containers:
7267

73-
* link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.5+ Container]
68+
* link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.6.5 Container]
7469
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
7570
* link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container]
7671
* link:https://hub.docker.com/r/crunchydata/lspvc/[PostgreSQL PVC Listing Container]
@@ -165,12 +160,6 @@ pgo show pvc mypvc
165160
pgo test mycluster
166161
----
167162

168-
.Clone Cluster
169-
[source,bash]
170-
----
171-
pgo clone mycluster --name=myclone
172-
----
173-
174163
.Create a Policy
175164
[source,bash]
176165
----
@@ -189,7 +178,7 @@ pgo apply policy1 --selector=name=mycluster
189178
Details on the *pgo* commands and complex examples are found in the
190179
link:docs/user-guide.asciidoc[User Guide]
191180

192-
[#PostgreSQL Operator Container]
181+
#PostgreSQL Operator Container]
193182
== PostgreSQL Operator Container
194183

195184
In the following diagram, the PostgreSQL operator client, *pgo*, is
@@ -203,5 +192,9 @@ The operator functionality runs in a Kubernetes Deployment on your
203192
Kubernetes cluster. The *postgres-operator* Docker container image
204193
is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Dockerhub].
205194

195+
What actually gets created on the Kubernetes cluster for a
196+
*pgcluster* resource is defined as a *deployment strategy*. Strategies
197+
are documented in detail in link:docs/design.asciidoc#postgresql-operator-deployment-strategies[Deployment Strategies].
198+
206199
You can also build the Docker image for *postgres-operator* using
207200
the build instructions located on the link:docs/build.asciidoc[Build and Setup] page.

0 commit comments

Comments
 (0)