You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.asciidoc
+22-14Lines changed: 22 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,25 +15,33 @@ v1.4, {docdate}
15
15
16
16
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes.
17
17
18
-
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource type *pgcluster*, *pgbackups*, and *pgupgrades*.
18
+
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource types such as:
19
+
20
+
* *pgcluster*
21
+
* *pgbackups*
22
+
* *pgupgrades*
23
+
* *pgclones*
24
+
* *pgpolicies*
25
+
* *pgpolicylogs*
26
+
19
27
20
28
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
21
29
22
-
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created or removed.
30
+
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created, updated, or removed.
23
31
24
32
Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:
25
33
26
-
* Create Cluster
27
-
* Destroy Cluster
28
-
* Backup Cluster
29
-
* Scale a Cluster
30
-
* Restore Cluster
31
-
* Upgrade Cluster
34
+
* Create a PostgreSQL Cluster
35
+
* Destroy a PostgreSQL Cluster
36
+
* Backup a PostgreSQL Cluster
37
+
* Scale a a PostgreSQL Cluster
38
+
* Restore a PostgreSQL Cluster
39
+
* Upgrade a PostgreSQL Cluster
32
40
* View PVC
33
-
* Test Connections
34
-
* Clone a Cluster
35
-
* Create a Policy
36
-
* Apply a Policy
41
+
* Test Connections to a PostgreSQL Cluster
42
+
* Clone a PostgreSQL Cluster
43
+
* Create a SQL-based Policy
44
+
* Apply a SQL-based Policy to a PostgreSQL Cluster
37
45
38
46
What actually gets created on the Kube cluster for a
39
47
*pgcluster* resource is defined as a *deployment strategy*. Strategies
@@ -167,8 +175,8 @@ or modifying PostgreSQL databases deployed within the Kube cluster.
167
175
168
176
image::docs/operator-diagram.png?raw=true[]
169
177
170
-
The operator functionality runs in a Pod deployed to your
171
-
Kubernetes cluster. The *postgres-operator* Docker container
178
+
The operator functionality runs in a Kubernetes Deployment on your
179
+
Kubernetes cluster. The *postgres-operator* Docker container image
172
180
is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Dockerhub].
173
181
174
182
You can also build the Docker image for *postgres-operator* using
0 commit comments