Skip to content

Commit ee7a38b

Browse files
xenophenesxenophenes
committed
restructure/reorganize content
1 parent aece3cb commit ee7a38b

File tree

1 file changed

+25
-34
lines changed

1 file changed

+25
-34
lines changed

‎README.asciidoc

Lines changed: 25 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ The PostgreSQL Operator provides a Kubernetes operator capability for managing P
77

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

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

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

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

@@ -23,9 +23,9 @@ Once the objects are detected, the PostgreSQL Operator enables users to perform
2323
* Test Connections
2424
* Clone a Cluster
2525

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

3030
== Requirements
3131

@@ -35,9 +35,24 @@ are documented in detail here link:docs/strategies.asciidoc[Deployment Strategie
3535
* link:https://hub.docker.com/r/crunchydata/crunchy-backup/[PostgreSQL Backup Container]
3636
* link:https://hub.docker.com/r/crunchydata/crunchy-upgrade/[PostgreSQL Upgrade Container]
3737

38+
== Build and Setup Instructions
39+
40+
With the operator deployed, the *pgo* command line
41+
interface can execute commands that the *postgres-operator* understands
42+
and reacts to.
43+
44+
You can download a pre-built *pgo* CLI binary from
45+
the link:https://github.com/CrunchyData/postgres-operator/releases[Releases] page on the github repository or build
46+
it yourself using the build instructions, documented on the link:docs/build.asciidoc[Build and Setup] page.
47+
48+
== Configuration
49+
50+
You can configure both the client and the operator. The
51+
configuration options are documented on the link:docs/config.asciidoc[Configuration] page.
52+
3853
== Example Commands Usage
3954

40-
Some examples of using the command line interface:
55+
Some examples of using the *pgo* command line interface are as follows.
4156

4257
.Display Cluster Information
4358
[source,bash]
@@ -81,7 +96,7 @@ pgo create cluster myrestore --secret-from=foo --backup-pvc=mypvc --backup-path=
8196
.Upgrade Cluster (minor Postgres version upgrade)
8297
[source,bash]
8398
----
84-
pgo create upgrade mycluster
99+
pgo create upgrade mycluster
85100
----
86101

87102
.Upgrade Cluster (major Postgres version upgrade from 9.5 to 9.6)
@@ -108,8 +123,8 @@ pgo test mycluster
108123
pgo clone mycluster --name=myclone
109124
----
110125

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

114129

115130
== postgres-operator Container
@@ -123,31 +138,7 @@ image::docs/operator-diagram.png?raw=true[]
123138

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

128143
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-
144+
the build instructions located on the link:docs/build.asciidoc[Build and Setup] page.

0 commit comments

Comments
 (0)