Skip to content

Commit c1a0edd

Browse files
committed
merging PR #954
1 parent b3d6d7a commit c1a0edd

File tree

7 files changed

+268
-368
lines changed

7 files changed

+268
-368
lines changed

README.md

Lines changed: 55 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,57 +21,83 @@ Use the postgres-operator to:
2121

2222
## Deployment Requirements
2323

24-
The Operator is validated for deployment on Kubernetes, OpenShift, and VMware Enterprise PKS clusters. Some form of storage is required, NFS, hostPath, and Storage Classes are currently supported.
24+
The PostgreSQL Operator is validated for deployment on Kubernetes, OpenShift, and VMware Enterprise PKS clusters. Some form of storage is required, NFS, hostPath, and Storage Classes are currently supported.
2525

26-
The Operator includes various components that get deployed to your
26+
The PostgreSQL Operator includes various components that get deployed to your
2727
Kubernetes cluster as shown in the following diagram and detailed
2828
in the Design section of the documentation for the version you are running.
2929

3030
![Reference](https://access.crunchydata.com/documentation/postgres-operator/latest/Operator-Architecture.png)
3131

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

34-
## Documentation 4.1.0
34+
## Installation
35+
36+
### PostgreSQL Operator Installation
37+
38+
The PostgreSQL Operator provides a few different methods for installation.
39+
40+
For an automated deployment using Ansible playbooks, please start here:
3541

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/latest/installation/operator-install/)
3842
- [Installation via Ansible](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/install-with-ansible/)
43+
44+
For a step by step customer installation using Bash, please start here:
45+
46+
- [Installation via Bash](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/operator-install/)
47+
48+
For a quick start deployment using OperatorHub.io, please see instructions here:
49+
50+
- [OperatorHub.io Guidance](https://operatorhub.io/operator/postgresql)
51+
52+
For a quick start deployment to Google Kubernetes Engine (GKE), please see instructions here:
53+
54+
- [GKE Quickstart Guidance](https://info.crunchydata.com/blog/install-postgres-operator-kubernetes-on-gke-ansible)
55+
56+
57+
### PGO CLI Installation
58+
59+
If you have the PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here:
60+
61+
- [PGO Client Install](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/install-pgo-client/)
3962

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/latest/installation/install-pgo-client/)
4263

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:
64+
### Using the PostgreSQL Operator
65+
66+
If you have the PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
67+
4468
- [PGO CLI Overview](https://access.crunchydata.com/documentation/postgres-operator/latest/operatorcli/pgo-overview/)
4569

46-
Want to contribute to the product find more info here:
47-
- [Developer Setup](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/developer-setup/)
48-
- Development for the 4.x code base is on the develop branch.
49-
- GitHub issues and Pull Request information
50-
- [Submitting Issues](https://access.crunchydata.com/documentation/postgres-operator/latest/contributing/issues/)
51-
- [Submitting Pull Request](https://access.crunchydata.com/documentation/postgres-operator/latest/contributing/pull-requests/)
5270

53-
## Documentation 3.5.4
71+
## Contributing to the Project
5472

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.4/installation/)
73+
Want to contribute to the PostgreSQL Operator project? Please review information here:
5774

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.4/installation/#pgo-cli-installation)
75+
- [Developer Setup](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/developer-setup/)
6076

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.4/operator-cli/)
77+
Development for the PostgreSQL Operator 4.0 code base is on the develop branch. In order to submit a Pull Request, please follow guidance here:
6378

64-
Want to contribute to the product find more info here:
65-
- [Developer Setup](https://access.crunchydata.com/documentation/postgres-operator/3.5.4/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.4/contributing/issues/)
69-
- [Submitting Pull Request](https://access.crunchydata.com/documentation/postgres-operator/3.5.4/contributing/pull-requests/)
79+
- [Submitting Pull Request](https://access.crunchydata.com/documentation/postgres-operator/latest/contributing/pull-requests/)
80+
7081

82+
## Submitting an Issue
7183

84+
Please use GitHub to submit an issue for the PostgreSQL Operator project.
7285

73-
Documentation for previous releases can be found at the [Crunchy Data Access Portal](https://access.crunchydata.com/documentation)
86+
If you would like to work the issue, please add that information in the issue so that we can confirm we are not already working no need to duplicate efforts.
7487

88+
If you have any question you can submit a Support - Question and Answer issue and we will work with you on how you can get more involved.
89+
90+
91+
## Complete Documentation
92+
93+
For additional information regarding design, configuration and operation of the PostgreSQL Operator, pleases see the [Official Project Documentation](https://access.crunchydata.com/documentation/postgres-operator/latest/)
7594

7695
If you are looking for the latest documentation, please see the develop branch which is considered unstable. The development
7796
documentation can be reviewed at https://crunchydata.github.io/postgres-operator/latest/.
97+
98+
99+
## Past Versions
100+
101+
Documentation for previous releases can be found at the [Crunchy Data Access Portal](https://access.crunchydata.com/documentation)
102+
103+

examples/envs.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
export GOPATH=$HOME/odev
22
export GOBIN=$GOPATH/bin
33
export PATH=$PATH:$GOBIN
4-
54
# NAMESPACE is the list of namespaces the Operator will watch
65
export NAMESPACE=pgouser1,pgouser2
76

hugo/content/Installation/operator-install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ When you install the Operator you must make choices as to what kind of storage t
106106
Here are some common examples of configuration changes most installers would make:
107107

108108
### Storage
109-
Inside `conf/postgresql-operator/pgo.yaml` there are various storage configurations defined.
109+
Inside `conf/postgres-operator/pgo.yaml` there are various storage configurations defined.
110110

111111
PrimaryStorage: gce
112112
XlogStorage: gce

0 commit comments

Comments
 (0)