Skip to content

Commit 7925b04

Browse files
author
Jeff McCormick
committed
additional rest branch files
1 parent 58e5d9d commit 7925b04

File tree

6 files changed

+369
-643
lines changed

6 files changed

+369
-643
lines changed

README.asciidoc

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= PostgreSQL Operator
2-
v2.0.1, {docdate}
2+
v2.1, {docdate}
33

44
== Table of Contents
55

@@ -13,7 +13,9 @@ v2.0.1, {docdate}
1313
[#Overview]
1414
== Overview
1515

16-
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes environment.
16+
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes environment. The project
17+
also incorporates a REST API and REST client for interfacing with the
18+
Operator.
1719

1820
image::docs/tty.gif?raw=true[]
1921

@@ -23,36 +25,29 @@ The PostgreSQL Operator leverages Kubernetes Custom Resource Definitions to defi
2325
* *pgbackups*
2426
* *pgpolicies*
2527

26-
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
28+
Kubernetes provides the ability to create and manage Custom Resource Definitions similar to any other native Kubernetes object.
2729

28-
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created, updated, or removed.
30+
The PostgreSQL Operator runs within Kubernetes detecting these custom object types as they are created, updated, or removed.
2931

30-
Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:
32+
The PostgreSQL Operator enables users to perform operations, including:
3133

32-
* Create a PostgreSQL Cluster
33-
* Destroy a PostgreSQL Cluster
34-
* Backup a PostgreSQL Cluster
35-
* Scale a a PostgreSQL Cluster
36-
* Restore a PostgreSQL Cluster
34+
* Create, Delete, Scale, Restore, and Backup a PostgreSQL Cluster
3735
* Upgrade a PostgreSQL Cluster
38-
* View PVC
36+
* View PVCs used by PostgreSQL clusters
3937
* Test Connections to a PostgreSQL Cluster
40-
* Create a SQL-based Policy
41-
* Apply a SQL-based Policy to a PostgreSQL Cluster
42-
* Perform User Management
38+
* Create and apply a SQL-based Policy to a PostgreSQL Cluster
39+
* Perform User and Password Management
4340
* Apply User Defined Labels to PostgreSQL Clusters
44-
* Perform Password Management
4541

4642

4743
[#Requirements]
4844
== Requirements
4945

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.
46+
CRD (custom resource definitions) are supported starting with Kube 1.7.X and
47+
with the PostgreSQL Operator version 2.0.
5348

5449
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.
50+
with the PostgreSQL Operator version 1.5.2 which resides in the github 1.5.X branch.
5651
Note however, that the older operator will be deprecated and no longer
5752
maintained in the future.
5853

@@ -64,8 +59,8 @@ The CRD version of the operator is tested on the following platforms:
6459

6560
This Operator has also been tested on the following operating systems:
6661

67-
* *CentOS 7*
68-
* *RHEL 7*
62+
* *CentOS 7.3+*
63+
* *RHEL 7.3+*
6964

7065
[#Build and Install Instructions]
7166
== Build and Install Instructions
@@ -169,23 +164,32 @@ pgo apply policy1 --selector=name=mycluster
169164
Details on the *pgo* commands and complex examples are found in the
170165
link:docs/user-guide.asciidoc[User Guide]
171166

172-
#PostgreSQL Operator Container]
173167
== PostgreSQL Operator Container
174168

175-
In the following diagram, the PostgreSQL operator client, *pgo*, is
169+
The following diagram depicts the components of the PostgreSQL Operator,
170+
here the PostgreSQL operator client, *pgo*, is
176171
shown interacting with the PostgreSQL operator that runs within
177172
a Kubernetes cluster. The operator is responsible for creating
178173
or modifying PostgreSQL databases deployed within the Kubernetes cluster.
179174

180175
image::docs/operator-diagram.png?raw=true[]
181176

177+
The *pgo* client, as of release 2.1, is now a REST client which interacts
178+
with the *apiserver*. The *apiserver* is a REST API that interacts
179+
with the Kube API including creating Custom Resource Definition resources
180+
implemented by the PostgreSQL Operator.
181+
182182
The operator functionality runs in a Kubernetes Deployment on your
183-
Kubernetes cluster. The *postgres-operator* Docker container image
184-
is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Dockerhub].
183+
Kubernetes cluster.
184+
185+
The *postgres-operator* Docker container image is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Dockerhub].
186+
The *postgres-operator-apiserver* Docker container image is available on link:https://hub.docker.com/r/crunchydata/postgres-operator-apiserver/[Dockerhub].
187+
The *pgo* client is available on in the Releases section of
188+
this github repo site.
185189

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

190-
You can also build the Docker image for *postgres-operator* using
194+
You can also build the project Docker images using
191195
the build instructions located on the link:docs/build.asciidoc[Build and Setup] page.

0 commit comments

Comments
 (0)