Skip to content

Commit 8bad0af

Browse files
author
Jonathan S. Katz
committed
Update general descriptions
This provides some updates around the geneal description for PGO.
1 parent 70ddf53 commit 8bad0af

File tree

3 files changed

+111
-69
lines changed

3 files changed

+111
-69
lines changed

README.md

Lines changed: 66 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1-
<h1 align="center">Crunchy Data PostgreSQL Operator</h1>
1+
<h1 align="center">PGO: The Postgres Operator from Crunchy Data</h1>
22
<p align="center">
33
<img width="150" src="crunchy_logo.png" alt="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)
77

8-
# Run your own production-grade PostgreSQL-as-a-Service on Kubernetes!
8+
# Run Cloud Native PostgreSQL on Kubernetes with PGO: The Postgres Operator from Crunchy Data!
99

10-
The [Crunchy PostgreSQL Operator][documentation] automates and simplifies deploying and managing
11-
open source PostgreSQL clusters on Kubernetes and other Kubernetes-enabled Platforms by providing
12-
the essential features you need to keep your PostgreSQL clusters up and running, including:
10+
[PGO][documentation], the [Postgres Operator][documentation] developed by
11+
[Crunchy Data](https://crunchydata.com/) and included in [Crunchy PostgreSQL for Kubernetes](https://www.crunchydata.com/products/crunchy-postgresql-for-kubernetes/), automates and simplifies deploying and managing open source
12+
PostgreSQL clusters on Kubernetes.
1313

14-
#### PostgreSQL Cluster [Provisioning][provisioning]
14+
Whether you need to get a simple Postgres cluster up and running, need to deploy
15+
a high availability, fault tolerant cluster in production, or are running your
16+
own database-as-a-service, the PostgreSQL Operator provides the essential
17+
features you need to keep your cloud native Postgres clusters healthy, including:
18+
19+
#### Postgres Cluster [Provisioning][provisioning]
1520

1621
[Create, Scale, & Delete PostgreSQL clusters with ease][provisioning], while fully customizing your
1722
Pods and PostgreSQL configuration!
@@ -33,7 +38,7 @@ Set how long you want your backups retained for. Works great with very large dat
3338
#### TLS
3439

3540
Secure communication between your applications and data servers by [enabling TLS for your PostgreSQL servers][pgo-task-tls],
36-
including the ability to enforce that all of your connections to use TLS.
41+
including the ability to enforce all of your connections to use TLS.
3742

3843
#### [Monitoring][monitoring]
3944

@@ -76,16 +81,22 @@ the S3 protocol. The PostgreSQL Operator can backup, restore, and create new clu
7681

7782
#### Multi-Namespace Support
7883

79-
You can control how the PostgreSQL Operator leverages [Kubernetes Namespaces][k8s-namespaces] with several different deployment models:
84+
You can control how PGO, the Postgres Operator, leverages [Kubernetes Namespaces][k8s-namespaces] with several different deployment models:
8085

81-
- Deploy the PostgreSQL Operator and all PostgreSQL clusters to the same namespace
82-
- Deploy the PostgreSQL Operator to one namespaces, and all PostgreSQL clusters to a different namespace
83-
- Deploy the PostgreSQL Operator to one namespace, and have your PostgreSQL clusters managed across multiple namespaces
84-
- Dynamically add and remove namespaces managed by the PostgreSQL Operator using the `pgo create namespace` and `pgo delete namespace` commands
86+
- Deploy PGO and all PostgreSQL clusters to the same namespace
87+
- Deploy PGO to one namespaces, and all PostgreSQL clusters to a different
88+
namespace
89+
- Deploy PGO to one namespace, and have your PostgreSQL clusters managed across
90+
multiple namespaces
91+
- Dynamically add and remove namespaces managed by the PostgreSQL Operator using
92+
the `pgo` client to run `pgo create namespace` and `pgo delete namespace`
8593

8694
#### Full Customizability
8795

88-
The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Service up and running on Kubernetes-enabled platforms, but we know that there are further customizations that you can make. As such, the Crunchy PostgreSQL Operator allows you to further customize your deployments, including:
96+
The Postgres Operator (PGO) makes it easy to get Postgres up and running on
97+
Kubernetes-enabled platforms, but we know that there are further customizations
98+
that you can make. As such, PGO allows you to further customize your
99+
deployments, including:
89100

90101
- Selecting different storage classes for your primary, replica, and backup storage
91102
- Select your own container resources class for each PostgreSQL cluster deployment; differentiate between resources applied for primary and replica clusters!
@@ -94,7 +105,6 @@ The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Se
94105
- Bring your own trusted certificate authority (CA) for use with the Operator API server
95106
- Override your PostgreSQL configuration for each cluster
96107

97-
98108
[disaster-recovery]: https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/disaster-recovery/
99109
[disaster-recovery-s3]: https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/disaster-recovery/#using-s3
100110
[disaster-recovery-scheduling]: https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/disaster-recovery/#scheduling-backups
@@ -119,51 +129,59 @@ The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Se
119129

120130
## Deployment Requirements
121131

122-
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.
132+
PGO, the Postgres Operator, is validated for deployment on Kubernetes,
133+
OpenShift, GKE, Anthos, AKS, EKS, and VMware Tanzu clusters. PGO is cloud native
134+
and storage agnostic, working with a wide variety of storage classes, hostPath,
135+
and NFS.
123136

124-
The PostgreSQL Operator includes various components that get deployed to your
125-
Kubernetes cluster as shown in the following diagram and detailed
126-
in the Design section of the documentation for the version you are running.
137+
PGO includes various components that get deployed to your Kubernetes cluster as
138+
shown in the following diagram and detailed in the Design section of the
139+
documentation for the version you are running.
127140

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

130-
The PostgreSQL Operator is developed and tested on CentOS and RHEL linux platforms but is known to run on other Linux variants.
143+
PGO is developed and tested on CentOS and RHEL linux platforms but is known to
144+
run on other Linux variants.
131145

132146
### Supported Platforms
133147

134-
The Crunchy PostgreSQL Operator maintains backwards compatibility to Kubernetes 1.11 and is tested is tested against the following Platforms:
148+
PGO, the Postgres Operator, is Kubernetes-native and maintains backwards
149+
compatibility to Kubernetes 1.11 and is tested is tested against the following
150+
platforms:
135151

136152
- Kubernetes 1.17+
137153
- Openshift 4.4+
138154
- OpenShift 3.11
139155
- Google Kubernetes Engine (GKE), including Anthos
140156
- Amazon EKS
141157
- Microsoft AKS
142-
- VMware Enterprise PKS 1.3+
158+
- VMware Tanzu
143159

144-
This list only includes the platforms that the PostgreSQL Operator is specifically tested on as part of the release process: the PostgreSQL Operator works on other Kubernetes distributions as well.
160+
This list only includes the platforms that the Postgres Operator is specifically
161+
tested on as part of the release process: PGO works on other Kubernetes
162+
distributions as well.
145163

146164
### Storage
147165

148-
The Crunchy PostgreSQL Operator is tested with a variety of different types of Kubernetes storage and Storage Classes, including:
149-
150-
- Google Compute Engine persistent volumes
151-
- HostPath
152-
- NFS
153-
- Rook
154-
- StorageOS
155-
156-
and more.
166+
PGO, the Postgres Operator, is tested with a variety of different types of
167+
Kubernetes storage and Storage Classes, as well as hostPath and NFS.
157168

158-
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.
169+
We know there are a variety of different types of [Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/)
170+
available for Kubernetes and we do our best to test each one, but due to the
171+
breadth of this area we are unable to verify Postgres Operator functionality in
172+
each one. With that said, the PostgreSQL Operator is designed to be storage
173+
class agnostic and has been demonstrated to work with additional Storage
174+
Classes.
159175

160176
## Installation
161177

162-
### PostgreSQL Operator Installation
178+
### Postgres Operator (PGO) Installation
163179

164-
The PostgreSQL Operator provides a few different methods for installation based on your use case.
180+
PGO provides a few different methods for installation methods to get up and
181+
running with cloud native Postgres.
165182

166-
Based on your storage settings in your Kubernetes environment, you may be able to start as quickly as:
183+
Based on your storage settings in your Kubernetes environment, you may be able
184+
to start as quickly as:
167185

168186
```shell
169187
kubectl create namespace pgo
@@ -182,7 +200,7 @@ Installations methods include:
182200

183201
### `pgo` Client Installation
184202

185-
If you have the PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here:
203+
If you have the Postgres Operator installed in your environment, and are interested in installation of the client interface, please start here:
186204

187205
- [pgo Client Install](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/pgo-client/)
188206

@@ -229,20 +247,24 @@ Additional containers that are not directly integrated with the PostgreSQL Opera
229247

230248
For more information about which versions of the PostgreSQL Operator include which components, please visit the [compatibility](https://access.crunchydata.com/documentation/postgres-operator/latest/configuration/compatibility/) section of the documentation.
231249

232-
## Using the PostgreSQL Operator
250+
## Using the PostgreSQL Operator (PGO)
233251

234-
If you are new to the PostgreSQL Operator, you can follow along the [tutorial](https://access.crunchydata.com/documentation/postgres-operator/latest/tutorial/) to learn how to install the PostgreSQL Operator and how to use many of its features!
252+
If you are new to PGO, you can follow along the [tutorial](https://access.crunchydata.com/documentation/postgres-operator/latest/tutorial/)
253+
to learn how to install the PostgreSQL Operator and how to use many of its
254+
features!
235255

236256
- [PostgreSQL Operator Tutorial](https://access.crunchydata.com/documentation/postgres-operator/latest/tutorial/)
237257

238-
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:
258+
If you have the PostgreSQL and client interface installed in your environment
259+
and are interested in guidance on the use of the Crunchy PostgreSQL Operator,
260+
please start here:
239261

240-
- [PostgreSQL Operator Documentation](https://access.crunchydata.com/documentation/postgres-operator/)
262+
- [PostgreSQL Operator (PGO) Documentation](https://access.crunchydata.com/documentation/postgres-operator/)
241263
- [`pgo` Client User Guide](https://access.crunchydata.com/documentation/postgres-operator/latest/pgo-client/)
242264

243265
## Contributing to the Project
244266

245-
Want to contribute to the PostgreSQL Operator project? Great! We've put together
267+
Want to contribute to the PGO Project? Great! We've put together
246268
as set of contributing guidelines that you can review here:
247269

248270
- [Contributing Guidelines](CONTRIBUTING.md)
@@ -275,7 +297,7 @@ For other information, please visit the [Support](https://access.crunchydata.com
275297
## Documentation
276298

277299
For additional information regarding design, configuration and operation of the
278-
PostgreSQL Operator, pleases see the [Official Project Documentation][documentation].
300+
PostgreSQL Operator (PGO), please see the [Official Project Documentation][documentation].
279301

280302
If you are looking for the [nightly builds of the documentation](https://crunchydata.github.io/postgres-operator/latest/), you can view them at:
281303

@@ -289,7 +311,8 @@ Documentation for previous releases can be found at the [Crunchy Data Access Por
289311

290312
## Releases
291313

292-
When a PostgreSQL Operator general availability (GA) release occurs, the container images are distributed on the following platforms in order:
314+
When a PGO general availability (GA) release occurs, the container images are
315+
distributed on the following platforms in order:
293316

294317
- [Crunchy Data Customer Portal](https://access.crunchydata.com/)
295318
- [Crunchy Data Developer Portal](https://www.crunchydata.com/developers)

docs/config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ baseURL= ""
22

33
languageCode = "en-us"
44
DefaultContentLanguage = "en"
5-
title = "Crunchy PostgreSQL Operator Documentation"
5+
title = "PGO: PostgreSQL Operator from Crunchy Data Documentation"
66
theme = "crunchy-hugo-theme"
77
pygmentsCodeFences = true
88
pygmentsStyle = "monokailight"

0 commit comments

Comments
 (0)