Skip to content

Commit 20f608f

Browse files
Jonathan S. Katzjkatz
authored andcommitted
Rewrite and reorganization of the installation section
This accounts for the new `pgo-deployer` container and tries to present the instructions in an easy to follow way.
1 parent 885edec commit 20f608f

23 files changed

+392
-282
lines changed

docs/content/Installation/_index.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/content/Installation/common-env.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

docs/content/Installation/postgres-operator-installer/_index.md

Lines changed: 0 additions & 139 deletions
This file was deleted.

docs/content/Installation/prereq/_index.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

docs/content/Upgrade/upgrade35to4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Delete the 3.5.x version of the operator by executing:
5454
##### Step 3
5555
Log in as your new Linux user and install the 4.3.0 Postgres Operator.
5656

57-
[Bash Installation] ( {{< relref "installation/operator-install.md" >}})
57+
[Bash Installation] ( {{< relref "installation/other/bash.md" >}})
5858

5959
Be sure to add the existing namespace to the Operator's list of watched namespaces (see the [Namespace] ( {{< relref "architecture/namespace.md" >}}) section of this document for more information) and make sure to avoid overwriting any existing data storage.
6060

docs/content/Upgrade/upgrade4xto42_ansible.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,12 @@ Save a copy of your current inventory file with a new name (such as `inventory.b
5151

5252

5353
##### Step 2
54-
Update the new inventory file with the appropriate values for your new Operator installation, as described in the [Ansible Install Prerequisites] ( {{< relref "installation/install-with-ansible/prerequisites.md" >}}) and the [Compatibility Requirements Guide] ( {{< relref "configuration/compatibility.md" >}}).
54+
Update the new inventory file with the appropriate values for your new Operator installation, as described in the [Ansible Install Prerequisites] ( {{< relref "installation/other/ansible/prerequisites.md" >}}) and the [Compatibility Requirements Guide] ( {{< relref "configuration/compatibility.md" >}}).
5555

5656

5757
##### Step 3
5858

59-
Now you can upgrade your Operator installation and configure your connection settings as described in the [Ansible Update Page] ( {{< relref "installation/install-with-ansible/updating-operator.md" >}}).
59+
Now you can upgrade your Operator installation and configure your connection settings as described in the [Ansible Update Page] ( {{< relref "installation/other/ansible/updating-operator.md" >}}).
6060

6161

6262
##### Step 4
@@ -87,6 +87,6 @@ cluster : mycluster
8787
primary (mycluster-7d49d98665-7zxzd): UP
8888
```
8989
##### Step 7
90-
Scale up to the required number of replicas, as needed.
90+
Scale up to the required number of replicas, as needed.
9191

9292
It is also recommended to take full backups of each pgcluster once the upgrade is completed due to version differences between the old and new clusters.

docs/content/Upgrade/upgrade4xto42_bash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ You will need to edit the `$PGOROOT/deploy/install-bootstrap-creds.sh` file to c
119119
export PGOADMIN_USERNAME=pgoadmin
120120
export PGOADMIN_PASSWORD=examplepassword
121121
```
122-
You will need to update the `$HOME/.pgouser`file to match the values you set in order to use the Operator. Additional accounts can be created later following the steps described in the 'Operator Security' section of the main [Bash Installation Guide] ( {{< relref "installation/operator-install.md" >}}). Once these accounts are created, you can change this file to login in via the PGO CLI as that user.
122+
You will need to update the `$HOME/.pgouser`file to match the values you set in order to use the Operator. Additional accounts can be created later following the steps described in the 'Operator Security' section of the main [Bash Installation Guide] ( {{< relref "installation/other/bash.md" >}}). Once these accounts are created, you can change this file to login in via the PGO CLI as that user.
123123

124124
##### Step 6
125125

docs/content/_index.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ draft: false
1212

1313
Latest Release: 4.3.0
1414

15-
The Crunchy PostgreSQL Operator automates and simplifies deploying and managing open source PostgreSQL clusters on Kubernetes and other Kubernetes-enabled Platforms by providing the essential features you need to keep your PostgreSQL clusters up and running, including:
15+
The [Crunchy PostgreSQL Operator](https://www.crunchydata.com/developers/download-postgres/containers/postgres-operator) automates and simplifies deploying and managing open source PostgreSQL clusters on Kubernetes and other Kubernetes-enabled Platforms by providing the essential features you need to keep your PostgreSQL clusters up and running, including:
1616

1717
#### PostgreSQL Cluster Provisioning
1818

@@ -96,23 +96,21 @@ The Crunchy PostgreSQL Operator extends Kubernetes to provide a higher-level abs
9696

9797
The Crunchy PostgreSQL Operator is tested on the following Platforms:
9898

99-
- Kubernetes 1.13 - 1.15 (See note about 1.16 and beyond)
99+
- Kubernetes 1.13+
100100
- OpenShift 3.11+
101101
- Google Kubernetes Engine (GKE), including Anthos
102102
- VMware Enterprise PKS 1.3+
103103

104-
**NOTE**: At present, while the Crunchy PostgreSQL Operator has compatibility for Kubernetes 1.16 and beyond, it has not been verified for the v4.3.0 release.
105-
106104
## Storage
107105

108106
The Crunchy PostgreSQL Operator is tested with a variety of different types of Kubernetes storage and Storage Classes, including:
109107

110-
- Google Compute Engine persistent volumes
111-
- HostPath
112-
- NFS
113108
- Rook
114109
- StorageOS
110+
- Google Compute Engine persistent volumes
111+
- NFS
112+
- HostPath
115113

116-
and more.
114+
and more. We have had reports of people using the PostgreSQL Operator with other [Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) as well.
117115

118-
We know there are a variety of different types of [Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) available for Kubernetes and we do our best to test each one, but due to the breadth of this area we are unable to verify PostgreSQL Operator functionality in each one. With that said, the PostgreSQL Operator is designed to be storage class agnostic and has been demonstrated to work with additional Storage Classes.
116+
We know there are a variety of different types of [Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/) available for Kubernetes and we do our best to test each one, but due to the breadth of this area we are unable to verify PostgreSQL Operator functionality in each one. With that said, the PostgreSQL Operator is designed to be storage class agnostic and has been demonstrated to work with additional Storage Classes. Storage is a rapidly evolving field in Kubernetes and we will continue to adapt the PostgreSQL Operator to modern Kubernetes storage standards.

docs/content/Installation/developer-setup.md renamed to docs/content/contributing/developer-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
2-
title: "Developer Setup"
2+
title: "Development Environment"
33
date:
44
draft: false
55
weight: 305
66
---
77

8-
The [Postgres-Operator](https://github.com/crunchydata/postgres-operator) is an open source project hosted on GitHub.
8+
The [PostgreSQL Operator](https://github.com/crunchydata/postgres-operator) is an open source project hosted on GitHub.
99

1010
This guide is intended for those wanting to build the Operator from source or contribute via pull requests.
1111

1212

1313
# Prerequisites
14+
1415
The target development host for these instructions is a CentOS 7 or RHEL 7 host. Others operating systems
1516
are possible, however we do not support building or running the Operator on others at this time.
1617

@@ -66,7 +67,6 @@ The setup target ensures the presence of:
6667
* NSQ messaging binaries
6768
* `docker` container tool
6869
* `buildah` OCI image building tool
69-
* `expenv` config tool
7070

7171
By default, docker is not configured to run its daemon. Refer to the [docker post-installation instructions](https://docs.docker.com/install/linux/linux-postinstall/) to configure it to run once or at system startup. This is not done automatically.
7272

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Installation"
3+
date:
4+
draft: false
5+
weight: 40
6+
---
7+
8+
There are several different ways to install and deploy the [PostgreSQL Operator](https://www.crunchydata.com/developers/download-postgres/containers/postgres-operator)
9+
based upon your use case.
10+
11+
For the vast majority of use cases, we recommend using the [PostgreSQL Operator Installer]({{< relref "/installation/postgres-operator-installer/_index.md" >}}),
12+
which uses the `pgo-deployer` container to set up all of the objects required to
13+
run the PostgreSQL Operator.
14+
15+
For advanced use cases, such as for development, one may want to set up a
16+
[development environment]({{< relref "/contributing/developer-setup.md" >}})
17+
that is created using a series of scripts controlled by the Makefile.
18+
19+
Before selecting your installation method, it's important that you first read
20+
the [prerequisites]({{< relref "/installation/prerequisites.md" >}}) for your
21+
deployment environment to ensure that your setup meets the needs for installing
22+
the PostgreSQL Operator.

0 commit comments

Comments
 (0)