Skip to content

Commit f8f18c5

Browse files
author
Jeff McCormick
committed
Merge branch 'master' of github.com:CrunchyData/postgres-operator
2 parents 56b12d0 + ac2a6ee commit f8f18c5

File tree

1 file changed

+42
-37
lines changed

1 file changed

+42
-37
lines changed

‎README.asciidoc

Lines changed: 42 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
11
= PostgreSQL Operator
22
v1.3.2, {docdate}
33

4+
== Table of Contents
5+
6+
* <<Overview>>
7+
* <<Requirements>>
8+
* <<Build and Setup Instructions>>
9+
* <<Configuration>>
10+
* <<Examples>>
11+
* <<PostgreSQL Operator Container>>
12+
13+
[#Overview]
414
== Overview
515

616
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes.
717

818
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource type *pgcluster*, *pgbackups*, and *pgupgrades*.
919

10-
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
20+
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
1121

12-
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created or removed.
22+
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created or removed.
1323

1424
Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:
1525

@@ -23,10 +33,11 @@ Once the objects are detected, the PostgreSQL Operator enables users to perform
2333
* Test Connections
2434
* Clone a Cluster
2535

26-
What actually gets created on the Kube cluster for a
36+
What actually gets created on the Kube cluster for a
2737
*pgcluster* resource is defined as a *deployment strategy*. Strategies
28-
are documented in detail here link:docs/strategies.asciidoc[Deployment Strategies]
38+
are documented in detail in link:docs/strategies.asciidoc[Deployment Strategies].
2939

40+
[#Requirements]
3041
== Requirements
3142

3243
* Kubernetes 1.5.3+
@@ -35,9 +46,27 @@ are documented in detail here link:docs/strategies.asciidoc[Deployment Strategie
3546
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
3647
* link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container]
3748

38-
== Example Commands Usage
49+
[#Build and Setup Instructions]
50+
== Build and Setup Instructions
3951

40-
Some examples of using the command line interface:
52+
With the operator deployed, the *pgo* command line
53+
interface can execute commands that the *postgres-operator* understands
54+
and reacts to.
55+
56+
You can download a pre-built *pgo* CLI binary from
57+
the link:https://github.com/CrunchyData/postgres-operator/releases[Releases] page on the github repository or build
58+
it yourself using the build instructions, documented on the link:docs/build.asciidoc[Build and Setup] page.
59+
60+
[#Configuration]
61+
== Configuration
62+
63+
You can configure both the client and the operator. The
64+
configuration options are documented on the link:docs/config.asciidoc[Configuration] page.
65+
66+
[#Examples]
67+
== Examples
68+
69+
Some examples of using the *pgo* command line interface are as follows.
4170

4271
.Display Cluster Information
4372
[source,bash]
@@ -81,7 +110,7 @@ pgo create cluster myrestore --secret-from=foo --backup-pvc=mypvc --backup-path=
81110
.Upgrade Cluster (minor Postgres version upgrade)
82111
[source,bash]
83112
----
84-
pgo create upgrade mycluster
113+
pgo create upgrade mycluster
85114
----
86115

87116
.Upgrade Cluster (major Postgres version upgrade from 9.5 to 9.6)
@@ -108,11 +137,11 @@ pgo test mycluster
108137
pgo clone mycluster --name=myclone
109138
----
110139

111-
Details on the *pgo* commands are found in the
112-
link:docs/user-guide.asciidoc[User Guide]
113-
140+
Details on the above *pgo* command examples are found in the
141+
link:docs/user-guide.asciidoc[User Guide].
114142

115-
== postgres-operator Container
143+
[#PostgreSQL Operator Container]
144+
== PostgreSQL Operator Container
116145

117146
In the following diagram, the postgres operator client, *pgo*, is
118147
shown interacting with the postgres operator that runs within
@@ -123,31 +152,7 @@ image::docs/operator-diagram.png?raw=true[]
123152

124153
The operator funtionality runs in a Pod deployed to your
125154
Kubernetes cluster. The *postgres-operator* Docker container
126-
is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Dockerhub].
155+
is available on link:https://hub.docker.com/r/crunchydata/postgres-operator/[Dockerhub].
127156

128157
You can also build the Docker image for *postgres-operator* using
129-
the build instructions link:docs/build.asciidoc[Build and Setup].
130-
131-
== Command Line Interface
132-
133-
With the operator deployed, you can then use the *pgo* command line
134-
interface to execute commands that the *postgres-operator* understands
135-
and reacts to.
136-
137-
You can download a pre-built *pgo* CLI binary from
138-
the Releases page on the github repository or build
139-
it yourself using the build instructions.
140-
141-
142-
== Build and Setup Instructions
143-
144-
Build instructions are documented here.
145-
link:docs/build.asciidoc[Build and Setup]
146-
147-
== Configuration
148-
149-
You can configure both the client and the operator. The
150-
configuration options are documented here.
151-
link:docs/config.asciidoc[Configuration]
152-
153-
158+
the build instructions located on the link:docs/build.asciidoc[Build and Setup] page.

0 commit comments

Comments
 (0)