Skip to content

Commit 125e9f6

Browse files
Merge pull request CrunchyData#49 from xenophenes/master
Regarding issue CrunchyData#34 & issue CrunchyData#38
2 parents 366127a + 56a9a20 commit 125e9f6

File tree

3 files changed

+229
-148
lines changed

3 files changed

+229
-148
lines changed

README.asciidoc

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ v1.5.2, {docdate}
55

66
* <<Overview>>
77
* <<Requirements>>
8-
* <<Build and Setup Instructions>>
8+
* <<Build and Install Instructions>>
99
* <<Configuration>>
1010
* <<Examples>>
1111
* <<PostgreSQL Operator Container>>
1212

1313
[#Overview]
1414
== Overview
1515

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.
1717

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

@@ -48,30 +48,43 @@ Once the objects are detected, the PostgreSQL Operator enables users to perform
4848
* Apply User Defined Labels to PostgreSQL Clusters
4949
* Perform Password Management
5050

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

5555
[#Requirements]
5656
== Requirements
5757

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
6059
these versions.
6160

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*
6470

6571
The Operator makes use of the following containers:
6672

6773
* link:https://hub.docker.com/r/crunchydata/crunchy-postgres/[PostgreSQL 9.5+ Container]
6874
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
6975
* 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*
7083

7184
[#Build and Install Instructions]
7285
== Build and Install Instructions
7386

74-
To build and deploy the Operator on your Kube system, follow
87+
To build and deploy the Operator on your Kubernetes system, follow
7588
the instructions documented on the link:docs/build.asciidoc[Build and Install] page.
7689

7790
With the operator deployed, the *pgo* command line
@@ -81,7 +94,7 @@ and reacts to.
8194
[#Configuration]
8295
== Configuration
8396

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
8598
configuration options are documented on the link:docs/config.asciidoc[Configuration] page.
8699

87100
[#Examples]
@@ -179,10 +192,10 @@ link:docs/user-guide.asciidoc[User Guide]
179192
[#PostgreSQL Operator Container]
180193
== PostgreSQL Operator Container
181194

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
184197
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.
186199

187200
image::docs/operator-diagram.png?raw=true[]
188201

0 commit comments

Comments
 (0)