Skip to content

Commit bcd1d41

Browse files
author
Jonathan S. Katz
committed
Updates to installation instructions and other guidance
A periodic pass through the installation instructions and other general updates to the documentation.
1 parent ea3ce14 commit bcd1d41

File tree

31 files changed

+167
-162
lines changed

31 files changed

+167
-162
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h1 align="center">PGO: The Postgres Operator from Crunchy Data</h1>
22
<p align="center">
3-
<img width="150" src="crunchy_logo.png" alt="Crunchy Data"/>
3+
<img width="150" src="./docs/static/pgo.svg" alt="PGO: The Postgres Operator from Crunchy Data"/>
44
</p>
55

66
[![Go Report Card](https://goreportcard.com/badge/github.com/CrunchyData/postgres-operator)](https://goreportcard.com/report/github.com/CrunchyData/postgres-operator)

crunchy_logo.png

-165 KB
Binary file not shown.

docs/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ draft: false
66

77
# PGO: The Postgres Operator from Crunchy Data
88

9-
<img width="25%" src="crunchy_logo.png"/>
9+
<img width="25%" src="pgo.svg" alt="PGO: The Postgres Operator from Crunchy Data" />
1010

1111
## Run [Cloud Native PostgreSQL on Kubernetes](https://www.crunchydata.com/products/crunchy-postgresql-for-kubernetes/) with PGO: The [Postgres Operator](https://github.com/CrunchyData/postgres-operator) from [Crunchy Data](https://www.crunchydata.com/)!
1212

docs/content/installation/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ draft: false
55
weight: 40
66
---
77

8-
There are several different ways to install and deploy the [PostgreSQL Operator](https://www.crunchydata.com/developers/download-postgres/containers/postgres-operator)
8+
There are several different ways to install and deploy the [PGO, the Postgres Operator](https://www.crunchydata.com/developers/download-postgres/containers/postgres-operator)
99
based upon your use case.
1010

11-
For the vast majority of use cases, we recommend using the [PostgreSQL Operator Installer]({{< relref "/installation/postgres-operator.md" >}}),
11+
For the vast majority of use cases, we recommend using the [Postgres Operator Installer]({{< relref "/installation/postgres-operator.md" >}}),
1212
which uses the `pgo-deployer` container to set up all of the objects required to
1313
run the PostgreSQL Operator.
1414

docs/content/installation/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ draft: false
55
weight: 40
66
---
77

8-
# PostgreSQL Operator Installer Configuration
8+
# PGO Installer Configuration
99

10-
When installing the PostgreSQL Operator you have many configuration options, these
10+
When installing PGO, the Postgres Operator you have many configuration options, these
1111
options are listed in this section.
1212

1313
## General Configuration

docs/content/installation/metrics/other/ansible/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ draft: false
55
weight: 10
66
---
77

8-
# Crunchy Data PostgreSQL Operator Monitoring Playbooks
8+
# PGO: Postgres Operator Monitoring Playbooks
99

10-
The Crunchy Data PostgreSQL Operator Monitoring Playbooks contain [Ansible](https://www.ansible.com/)
10+
PGO, the Postgres Operator from Crunchy Data, Monitoring Playbooks contain [Ansible](https://www.ansible.com/)
1111
roles for installing and managing the [Crunchy Data PostgreSQL Operator Monitoring infrastructure]({{< relref "/installation/other/ansible/installing-operator.md" >}}).
1212

1313
## Features
1414

1515
The playbooks provided allow users to:
1616

17-
* install PostgreSQL Operator Monitoring on Kubernetes and OpenShift
18-
* install PostgreSQL Operator from a Linux, Mac or Windows (Ubuntu subsystem) host
17+
* install PGO Monitoring on Kubernetes and OpenShift
18+
* install PGO from a Linux, Mac or Windows (Ubuntu subsystem) host
1919
* support a variety of deployment models
2020

2121
## Resources

docs/content/installation/other/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ weight: 50
66
---
77

88
Though the years, we have built up several other methods for installing the
9-
PostgreSQL Operator. The next few sections provide some alternative ways of
9+
PGO. The next few sections provide some alternative ways of
1010
deploying the PostgreSQL Operator. Some of these methods are deprecated and may
1111
be removed in a future release.

docs/content/installation/other/ansible/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ draft: false
55
weight: 100
66
---
77

8-
# Crunchy Data PostgreSQL Operator Playbooks
8+
# PGO: Postgres Operator Playbooks
99

10-
The Crunchy Data PostgreSQL Operator Playbooks contain [Ansible](https://www.ansible.com/)
10+
PGO, the Postgres Operator from Crunchy Data, Playbooks contain [Ansible](https://www.ansible.com/)
1111
roles for installing and managing the [Crunchy Data PostgreSQL Operator]({{< relref "/installation/other/ansible/installing-operator.md" >}}).
1212

1313
## Features
1414

1515
The playbooks provided allow users to:
1616

17-
* install PostgreSQL Operator on Kubernetes and OpenShift
18-
* install PostgreSQL Operator from a Linux, Mac or Windows (Ubuntu subsystem) host
17+
* install PGO on Kubernetes and OpenShift
18+
* install PGO from a Linux, Mac or Windows (Ubuntu subsystem) host
1919
* generate TLS certificates required by the PostgreSQL Operator
2020
* support a variety of deployment models
2121

docs/content/installation/other/bash.md

Lines changed: 39 additions & 37 deletions
Large diffs are not rendered by default.

docs/content/installation/other/google-cloud-marketplace.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ draft: false
55
weight: 200
66
---
77

8-
The PostgreSQL Operator is installed as part of [Crunchy PostgreSQL for GKE][gcm-listing]
8+
PGO: the PostgreSQL Operator from Crunchy Data is installed as part of [Crunchy PostgreSQL for GKE][gcm-listing]
99
that is available in the Google Cloud Marketplace.
1010

1111
[gcm-listing]: https://console.cloud.google.com/marketplace/details/crunchydata/crunchy-postgresql-operator
@@ -16,7 +16,6 @@ that is available in the Google Cloud Marketplace.
1616
Install [Crunchy PostgreSQL for GKE][gcm-listing] to a Google Kubernetes Engine cluster using
1717
Google Cloud Marketplace.
1818

19-
2019
## Step 2: Verify Installation
2120

2221
Install `kubectl` using the `gcloud components` command of the [Google Cloud SDK][sdk-install] or
@@ -25,7 +24,7 @@ by following the [Kubernetes documentation][kubectl-install].
2524
[kubectl-install]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
2625
[sdk-install]: https://cloud.google.com/sdk/docs/install
2726

28-
Using the `gcloud` utility, ensure you are logged into the GKE cluster in which you installed the
27+
Using the `gcloud` utility, ensure you are logged into the GKE cluster in which you installed PGO, the
2928
PostgreSQL Operator, and see that it is running in the namespace in which you installed it.
3029
For example, in the `pgo` namespace:
3130

@@ -44,7 +43,7 @@ pod/postgres-operator-56d6ccb97-tmz7m 4/4 Running 0 2m
4443
```
4544

4645

47-
## Step 3: Install the PostgreSQL Operator User Keys
46+
## Step 3: Install the PGO User Keys
4847

4948
You will need to get TLS keys used to secure the Operator REST API. Again, in the `pgo` namespace:
5049

@@ -54,9 +53,9 @@ kubectl -n pgo get secret pgo.tls -o 'go-template={{ index .data "tls.key" | bas
5453
```
5554

5655

57-
## Step 4: Setup PostgreSQL Operator User
56+
## Step 4: Setup PGO User
5857

59-
The PostgreSQL Operator implements its own role-based access control (RBAC) system for authenticating and authorization PostgreSQL Operator users access to its REST API. A default PostgreSQL Operator user (aka a "pgouser") is created as part of the marketplace installation (these credentials are set during the marketplace deployment workflow).
58+
PGO implements its own role-based access control (RBAC) system for authenticating and authorization PostgreSQL Operator users access to its REST API. A default PostgreSQL Operator user (aka a "pgouser") is created as part of the marketplace installation (these credentials are set during the marketplace deployment workflow).
6059

6160
Create the pgouser file in `${HOME?}/.pgo/<operatornamespace>/pgouser` and insert the user and password you created on deployment of the PostgreSQL Operator via GCP Marketplace. For example, if you set up a user with the username of `username` and a password of `hippo`:
6261

@@ -67,7 +66,7 @@ username:hippo
6766

6867
## Step 5: Setup Environment variables
6968

70-
The PostgreSQL Operator Client uses several environmental variables to make it easier for interfacing with the PostgreSQL Operator.
69+
The `pgo` Client uses several environmental variables to make it easier for interfacing with the PGO, the Postgres Operator.
7170

7271
Set the environmental variables to use the key / certificate pair that you pulled in Step 3 was deployed via the marketplace. Using the previous examples, You can set up environment variables with the following command:
7372

@@ -98,23 +97,23 @@ source ~/.bashrc
9897
**NOTE**: For macOS users, you must use `~/.bash_profile` instead of `~/.bashrc`
9998

10099

101-
## Step 6: Install the PostgreSQL Operator Client `pgo`
100+
## Step 6: Install the `pgo` Client
102101

103-
The [`pgo` client](/pgo-client/) provides a helpful command-line interface to perform key operations on a PostgreSQL Operator, such as creating a PostgreSQL cluster.
102+
The [`pgo` client](/pgo-client/) provides a helpful command-line interface to perform key operations on a PGO Deployment, such as creating a PostgreSQL cluster.
104103

105104
The `pgo` client can be downloaded from GitHub [Releases](https://github.com/crunchydata/postgres-operator/releases) (subscribers can download it from the [Crunchy Data Customer Portal](https://access.crunchydata.com)).
106105

107-
Note that the `pgo` client's version must match the version of the PostgreSQL Operator that you have deployed. For example, if you have deployed version {{< param operatorVersion >}} of the PostgreSQL Operator, you must use the `pgo` for {{< param operatorVersion >}}.
106+
Note that the `pgo` client's version must match the deployed version of PGO. For example, if you have deployed version {{< param operatorVersion >}} of the PostgreSQL Operator, you must use the `pgo` for {{< param operatorVersion >}}.
108107

109108
Once you have download the `pgo` client, change the permissions on the file to be executable if need be as shown below:
110109

111110
```shell
112111
chmod +x pgo
113112
```
114113

115-
## Step 7: Connect to the PostgreSQL Operator
114+
## Step 7: Connect to PGO
116115

117-
Finally, let's see if we can connect to the PostgreSQL Operator from the `pgo` client. In order to communicate with the PostgreSQL Operator API server, you will first need to set up a [port forward](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) to your local environment.
116+
Finally, let's see if we can connect to the Postgres Operator from the `pgo` client. In order to communicate with the PGO API server, you will first need to set up a [port forward](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) to your local environment.
118117

119118
In a new console window, run the following command to set up a port forward:
120119

@@ -137,7 +136,7 @@ pgo-apiserver version {{< param operatorVersion >}}
137136

138137
## Step 8: Create a Namespace
139138

140-
We are almost there! You can optionally add a namespace that can be managed by the PostgreSQL Operator to watch and to deploy a PostgreSQL cluster into.
139+
We are almost there! You can optionally add a namespace that can be managed by PGO to watch and to deploy a PostgreSQL cluster into.
141140

142141
```shell
143142
pgo create namespace wateringhole
@@ -194,4 +193,3 @@ cluster : hippo
194193
```
195194

196195
The `pgo test` command provides you the basic information you need to connect to your PostgreSQL cluster from within your Kubernetes environment. For more detailed information, you can use `pgo show cluster -n wateringhole hippo`.
197-

0 commit comments

Comments
 (0)