Skip to content

Commit 13f7e02

Browse files
cahoonpworkJeff McCormick
authored andcommitted
documentation updates (#818)
* updated readme to list references for 3.5.3 and 4.0.0 documentation (#808) * updated to list references for 3.5.3 and 4.0.0 documentation * removed extra space and dash for bullet point * README wording (#809) * cleaning up wording to point users to particular sections of the documentation. * updated link and hugo theme (#811) * fixed link to Ansible install, updated hugo theme * updated getting started and internal links (#812) * updated links to point directly to current release version * update link to 4.0.0 (#813) * updated link * removed hard coded links as links will be generated via hugo generation (#814) * updated how to get Ansible roles (#815) * updated how to get Ansible roles * updating location for pgo client binaries. (#817) * updating location for pgo client binaries.
1 parent 7fb5f61 commit 13f7e02

File tree

9 files changed

+60
-91
lines changed

9 files changed

+60
-91
lines changed

README.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,52 @@ The Operator is validated for deployment on Kubernetes, OpenShift, and VMware En
2525

2626
The Operator includes various components that get deployed to your
2727
Kubernetes cluster as shown in the following diagram and detailed
28-
in the [Design](https://crunchydata.github.io/postgres-operator/stable/design/).
28+
in the Design section of the documentation for the version you are running.
2929

30-
![Reference](https://crunchydata.github.io/postgres-operator/stable/Operator-Architecture.png)
30+
![Reference](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/Operator-Architecture.png)
3131

3232
The Operator is developed and tested on CentOS and RHEL linux platforms but is known to run on other Linux variants.
3333

34-
## Documentation
35-
36-
- [Getting Started](https://crunchydata.github.io/postgres-operator/stable/gettingstarted/)
37-
- [pgo CLI Syntax and Examples](https://crunchydata.github.io/postgres-operator/stable/operator-cli/)
38-
- [Installation](https://crunchydata.github.io/postgres-operator/stable/installation/)
39-
- [Configuration](https://crunchydata.github.io/postgres-operator/stable/configuration/configuration/)
40-
- [pgo.yaml Description](https://crunchydata.github.io/postgres-operator/stable/configuration/pgo-yaml-configuration/)
41-
- [Security](https://crunchydata.github.io/postgres-operator/stable/security/)
42-
- [Design](https://crunchydata.github.io/postgres-operator/stable/design/)
43-
- [Developing](https://crunchydata.github.io/postgres-operator/stable/developer-setup/)
44-
- [Upgrading the Operator](https://crunchydata.github.io/postgres-operator/stable/upgrade/)
34+
## Documentation 4.0.0
35+
36+
If you are new to the Crunchy PostgreSQL Operator and interested in installing the Crunchy PostgreSQL Operator in your environment, please start here:
37+
- [Installation via Bash](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/installation/operator-install/)
38+
- [Installation via Ansible](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/installation/install-with-ansible/)
39+
40+
If you have the Crunchy PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here:
41+
[PGO Client Install](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/installation/install-pgo-client/)
42+
43+
If you have the Crunchy PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
44+
- [PGO CLI Overview](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/operatorcli/pgo-overview/)
45+
46+
Want to contribute to the product find more info here:
47+
- [Developer Setup](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/installation/developer-setup/)
48+
- Development for the 4.0 code base is on the develop branch.
49+
- GitHub issues and Pull Request information
50+
- [Submitting Issues](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/contributing/issues/)
51+
- [Submitting Pull Request](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/contributing/pull-requests/)
52+
53+
## Documentation 3.5.3
54+
55+
If you are new to the Crunchy PostgreSQL Operator and interested in installing the Crunchy PostgreSQL Operator in your environment, please start here:
56+
- [Installation via Bash](https://access.crunchydata.com/documentation/postgres-operator/3.5.3/installation/)
57+
58+
If you have the Crunchy PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here:
59+
[PGO Client Install](https://access.crunchydata.com/documentation/postgres-operator/3.5.3/installation/#pgo-cli-installation)
60+
61+
If you have the Crunchy PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
62+
- [PGO CLI Overview](https://access.crunchydata.com/documentation/postgres-operator/3.5.3/operator-cli/)
63+
64+
Want to contribute to the product find more info here:
65+
- [Developer Setup](https://access.crunchydata.com/documentation/postgres-operator/3.5.3/developer-setup/)
66+
- Development on 3.5 codebase is on the develop-3.5 branch.
67+
- GitHub issues and Pull Request information
68+
- [Submitting Issues](https://access.crunchydata.com/documentation/postgres-operator/3.5.3/contributing/issues/)
69+
- [Submitting Pull Request](https://access.crunchydata.com/documentation/postgres-operator/3.5.3/contributing/pull-requests/)
70+
71+
72+
73+
Documentation for previous releases can be found at the [Crunchy Data Access Portal](https://access.crunchydata.com/documentation)
4574

4675

4776
If you are looking for the latest documentation, please see the develop branch which is considered unstable. The development

hugo/content/Installation/install-pgo-client/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The following will setup the `pgo` client to be used on a Windows system.
3333
### Installing the Client
3434

3535
First, download the `pgo.exe` client from the
36-
[GitHub official releases](https://github.com/CrunchyData/postgres-operator/releases).
36+
[GitHub official releases](https://github.com/CrunchyData/postgres-operator/releases). Crunchy Enterprise Customers can download the pgo binaries from https://access.crunchydata.com/ on the downloads page.
3737

3838
Next, install `pgo` in `/usr/local/bin` by running the following:
3939

hugo/content/Installation/install-with-ansible/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 1
88
# Crunchy Data PostgreSQL Operator Playbooks
99

1010
The Crunchy Data PostgreSQL Operator Playbooks contain [Ansible](https://www.ansible.com/)
11-
roles for installing and managing the [Crunchy Data PostgreSQL Operator](https://crunchydata.github.io/postgres-operator/stable/).
11+
roles for installing and managing the [Crunchy Data PostgreSQL Operator](https://access.crunchydata.com/documentation/postgres-operator/4.0.0/installation/install-with-ansible/).
1212

1313
## Features
1414

hugo/content/Installation/install-with-ansible/prerequisites.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -44,40 +44,16 @@ can install:
4444

4545
## Obtaining Operator Ansible Role
4646

47-
There are two ways to obtain the Crunchy PostgreSQL Operator Roles:
47+
The Crunchy PostgreSQL Operator Roles are available here:
48+
49+
* Clone the [postgres-operator project](https://github.com/CrunchyData/postgres-operator)
4850

49-
* Cloning the [postgres-operator project](https://github.com/CrunchyData/postgres-operator)
50-
* `postgres-operator-playbooks` RPM provided for Crunchy customers via the [Crunchy Access Portal](https://access.crunchydata.com/).
5151

5252
### GitHub Installation
5353

5454
All necessary files (inventory, main playbook and roles) can be found in the `ansible`
5555
directory in the [postgres-operator project](https://github.com/CrunchyData/postgres-operator).
5656

57-
### RPM Installation using Yum
58-
59-
Available to Crunchy customers is an RPM containing all the necessary Ansible roles
60-
and files required for installation using Ansible. The RPM can be found in Crunchy's
61-
yum repository. For information on setting up `yum` to use the Crunchy repoistory,
62-
see the [Crunchy Access Portal](https://access.crunchydata.com/).
63-
64-
To install the Crunchy PostgreSQL Operator Ansible roles using `yum`, run the following
65-
command on a RHEL or CentOS host:
66-
67-
```bash
68-
sudo yum install postgres-operator-playbooks
69-
```
70-
71-
* Ansible roles can be found in: `/usr/share/ansible/roles/crunchydata`
72-
* Ansible playbooks/inventory files can be found in: `/usr/share/ansible/postgres-operator/playbooks`
73-
74-
Once installed users should take a copy of the `inventory` file included in the installation
75-
using the following command:
76-
77-
```bash
78-
cp /usr/share/ansible/postgres-operator/playbooks/inventory ${HOME?}
79-
```
80-
8157
## Configuring the Inventory File
8258

8359
The `inventory` file included with the PostgreSQL Operator Playbooks allows installers
@@ -217,7 +193,7 @@ database in a new PostgreSQL cluster is provisioned in the same zone as the node
217193
containing the PostgreSQL primary pod that will be using it.
218194

219195
For instructions on setting up storage classes for multi-zone environments, see
220-
the [PostgreSQL Operator Documentation](https://crunchydata.github.io/postgres-operator/stable/design/).
196+
the [PostgreSQL Operator Documentation](/gettingstarted/design/designoverview/).
221197

222198
### Examples
223199

hugo/content/Installation/operator-install.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ A full installation of the Operator includes the following steps:
1414
- deploy the operator
1515
- install pgo CLI (end user command tool)
1616

17-
Operator end-users are only required to install the pgo CLI client on their host and can skip the server-side installation steps. pgo CLI clients are provided
18-
on the Github Releases page for Linux, Mac, and Windows clients.
17+
Operator end-users are only required to install the pgo CLI client on their host and can skip the server-side installation steps. pgo CLI clients are provided for Linux, Mac, and Windows clients.
1918

2019
The Operator can be deployed by multiple methods including:
2120

@@ -240,7 +239,7 @@ created previously.
240239

241240

242241
## pgo CLI Installation
243-
Most users will work with the Operator using the *pgo* CLI tool. That tool is downloaded from the GitHub Releases page for the Operator (https://github.com/crunchydata/postgres-operator/releases).
242+
Most users will work with the Operator using the *pgo* CLI tool. That tool is downloaded from the GitHub Releases page for the Operator (https://github.com/crunchydata/postgres-operator/releases). Crunchy Enterprise Customer can download the pgo binaries from https://access.crunchydata.com/ on the downloads page.
244243

245244
The *pgo* client is provided in Mac, Windows, and Linux binary formats,
246245
download the appropriate client to your local laptop or workstation to work

hugo/content/contributing/documentation-updates.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ weight: 901
77

88
## Documentation
99

10-
The [documentation website](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/) is generated using [Hugo](https://gohugo.io/) and
11-
https://pages.github.com/)[GitHub Pages]().
10+
The [documentation website](/) is generated using [Hugo](https://gohugo.io/).
1211

1312
## Hosting Hugo Locally (Optional)
1413

hugo/content/gettingstarted/_index.md

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

8-
Operator users typically will just need to install the *pgo* client
9-
in order to work with an already deployed Postgres Operator.
8+
If you are new to the Crunchy PostgreSQL Operator and interested in installing the Crunchy PostgreSQL Operator in your environment, please start here:
9+
- [Installation via Bash](/installation/operator-install/)
10+
- [Installation via Ansible](/installation/install-with-ansible/)
1011

11-
For installing the Operator on the Kubernetes server, see
12-
the [Installation Guide](https://crunchydata.github.io/postgres-operator/stable/installation/).
12+
If you have the Crunchy PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here:
13+
- [PGO Client Install](/installation/install-pgo-client/)
1314

14-
### pgo Client Installation
15-
16-
The *pgo* binary is pre-compiled and available to download from the projects
17-
github repository [Releases](https://github.com/crunchydata/postgres-operator) page.
18-
19-
Add the *pgo* binary to your PATH and make it executable.
20-
21-
Next, create a *.pgouser* file in your $HOME directory or
22-
set the PGOUSER environment variable to point to a *.pgouser*
23-
file location:
24-
25-
export PGOUSER=/somepath/.pgouser
26-
27-
Alternatively, if you create a *.pgouser* file in your $HOME, the *pgo*
28-
client will find the file there.
29-
30-
Set the name of the Kubernetes namespace that you want to
31-
access, on a Linux host you would enter:
32-
33-
export PGO_NAMESPACE=pgouser1
34-
35-
Set the URL of the Operator REST API, in this example the Operator is running
36-
on a host with IP address 192.168.0.120, see your administrator for
37-
the correct IP address, on a Linux host you would enter:
38-
39-
export PGO_APISERVER_URL=https://192.168.0.120:8443
40-
41-
Next, add the TLS keys required for the *pgo* client to connect to the
42-
Operator REST API, see your administrator for access to these keys, on a Linux host you would enter:
43-
44-
export PGO_CA_CERT=/somepath/someserver.crt
45-
export PGO_CLIENT_CERT=/somepath/someserver.crt
46-
export PGO_CLIENT_KEY=/somepath/someserver.key
47-
48-
Lastly, test out the connection:
49-
50-
pgo version
15+
If you have the Crunchy PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
16+
- [PGO CLI Overview](/operatorcli/pgo-overview/)

hugo/content/operatorcli/pgo-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ into your Postgres cluster pod as follows:
386386
Note: backend metric storage such as Prometheus and front end
387387
visualization software such as Grafana are not created automatically
388388
by the PostgreSQL Operator. For instructions on installing Grafana and
389-
Prometheus in your environment, see the [Crunchy Container Suite documentation](http://crunchydata.github.io/crunchy-containers/stable/examples/metrics/metrics/).
389+
Prometheus in your environment, see the [Crunchy Container Suite documentation](https://access.crunchydata.com/documentation/crunchy-containers/2.4.0/examples/metrics/metrics/).
390390

391391
### Scheduled Tasks
392392

0 commit comments

Comments
 (0)