Skip to content

Commit ea3ce14

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

File tree

3 files changed

+128
-65
lines changed

3 files changed

+128
-65
lines changed

README.md

Lines changed: 82 additions & 40 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
@@ -117,47 +127,58 @@ The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Se
117127

118128
## Deployment Requirements
119129

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

122-
The PostgreSQL Operator includes various components that get deployed to your
123-
Kubernetes cluster as shown in the following diagram and detailed
124-
in the Design section of the documentation for the version you are running.
135+
PGO includes various components that get deployed to your Kubernetes cluster as
136+
shown in the following diagram and detailed in the Design section of the
137+
documentation for the version you are running.
125138

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

128-
The PostgreSQL Operator is developed and tested on CentOS and RHEL linux platforms but is known to run on other Linux variants.
141+
PGO is developed and tested on CentOS and RHEL linux platforms but is known to
142+
run on other Linux variants.
129143

130144
### Supported Platforms
131145

132-
The Crunchy PostgreSQL Operator is tested on the following Platforms:
146+
PGO, the Postgres Operator, is Kubernetes-native and maintains backwards
147+
compatibility to Kubernetes 1.11 and is tested is tested against the following
148+
platforms:
133149

134150
- Kubernetes 1.13+
135151
- OpenShift 3.11+
136152
- Google Kubernetes Engine (GKE), including Anthos
137153
- Amazon EKS
138-
- VMware Enterprise PKS 1.3+
139-
140-
### Storage
154+
- Microsoft AKS
155+
- VMware Tanzu
141156

142-
The Crunchy PostgreSQL Operator is tested with a variety of different types of Kubernetes storage and Storage Classes, including:
157+
This list only includes the platforms that the Postgres Operator is specifically
158+
tested on as part of the release process: PGO works on other Kubernetes
159+
distributions as well.
143160

144-
- Google Compute Engine persistent volumes
145-
- HostPath
146-
- NFS
147-
- Rook
148-
- StorageOS
161+
### Storage
149162

150-
and more.
163+
PGO, the Postgres Operator, is tested with a variety of different types of
164+
Kubernetes storage and Storage Classes, as well as hostPath and NFS.
151165

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

154173
## Installation
155174

156-
### PostgreSQL Operator Installation
175+
### Postgres Operator (PGO) Installation
157176

158-
The PostgreSQL Operator provides a few different methods for installation based on your use case.
177+
PGO provides a few different methods for installation methods to get up and
178+
running with cloud native Postgres.
159179

160-
Based on your storage settings in your Kubernetes environment, you may be able to start as quickly as:
180+
Based on your storage settings in your Kubernetes environment, you may be able
181+
to start as quickly as:
161182

162183
```shell
163184
kubectl create namespace pgo
@@ -176,7 +197,7 @@ Installations methods include:
176197

177198
### `pgo` Client Installation
178199

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

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

@@ -223,16 +244,24 @@ Additional containers that are not directly integrated with the PostgreSQL Opera
223244

224245
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.
225246

226-
## Using the PostgreSQL Operator
247+
## Using the PostgreSQL Operator (PGO)
248+
249+
If you are new to PGO, you can follow along the [tutorial](https://access.crunchydata.com/documentation/postgres-operator/latest/tutorial/)
250+
to learn how to install the PostgreSQL Operator and how to use many of its
251+
features!
227252

228-
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:
253+
- [PostgreSQL Operator Tutorial](https://access.crunchydata.com/documentation/postgres-operator/latest/tutorial/)
229254

230-
- [PostgreSQL Operator Documentation](https://access.crunchydata.com/documentation/postgres-operator/)
255+
If you have the PostgreSQL and client interface installed in your environment
256+
and are interested in guidance on the use of the Crunchy PostgreSQL Operator,
257+
please start here:
258+
259+
- [PostgreSQL Operator (PGO) Documentation](https://access.crunchydata.com/documentation/postgres-operator/)
231260
- [`pgo` Client User Guide](https://access.crunchydata.com/documentation/postgres-operator/latest/pgo-client/)
232261

233262
## Contributing to the Project
234263

235-
Want to contribute to the PostgreSQL Operator project? Great! We've put together
264+
Want to contribute to the PGO Project? Great! We've put together
236265
as set of contributing guidelines that you can review here:
237266

238267
- [Contributing Guidelines](CONTRIBUTING.md)
@@ -265,7 +294,7 @@ For other information, please visit the [Support](https://access.crunchydata.com
265294
## Documentation
266295

267296
For additional information regarding design, configuration and operation of the
268-
PostgreSQL Operator, pleases see the [Official Project Documentation][documentation].
297+
PostgreSQL Operator (PGO), please see the [Official Project Documentation][documentation].
269298

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

@@ -276,3 +305,16 @@ https://crunchydata.github.io/postgres-operator/latest/
276305
## Past Versions
277306

278307
Documentation for previous releases can be found at the [Crunchy Data Access Portal](https://access.crunchydata.com/documentation/)
308+
309+
## Releases
310+
311+
When a PGO general availability (GA) release occurs, the container images are
312+
distributed on the following platforms in order:
313+
314+
- [Crunchy Data Customer Portal](https://access.crunchydata.com/)
315+
- [Crunchy Data Developer Portal](https://www.crunchydata.com/developers)
316+
- [DockerHub](https://hub.docker.com/u/crunchydata)
317+
318+
The image rollout can occur over the course of several days.
319+
320+
To stay up-to-date on when releases are made available in the [Crunchy Data Developer Portal](https://www.crunchydata.com/developers), please sign up for the [Crunchy Data Developer Program Newsletter](https://www.crunchydata.com/developers/newsletter)

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"

docs/content/_index.md

Lines changed: 45 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
---
2-
title: "Crunchy PostgreSQL Operator"
2+
title: "PGO: The Postgres Operator from Crunchy Data"
33
date:
44
draft: false
55
---
66

7-
# Crunchy PostgreSQL Operator
7+
# PGO: The Postgres Operator from Crunchy Data
88

99
<img width="25%" src="crunchy_logo.png"/>
1010

11-
## Run your own production-grade PostgreSQL-as-a-Service on Kubernetes!
11+
## 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

1313
Latest Release: {{< param operatorVersion >}}
1414

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:
15+
[PGO](https://www.crunchydata.com/developers/download-postgres/containers/postgres-operator),
16+
the [Postgres Operator](https://github.com/CrunchyData/postgres-operator)
17+
developed by [Crunchy Data](https://crunchydata.com/) and included in
18+
[Crunchy PostgreSQL for Kubernetes](https://www.crunchydata.com/products/crunchy-postgresql-for-kubernetes/),
19+
automates and simplifies deploying and managing open source PostgreSQL clusters
20+
on Kubernetes.
1621

17-
#### PostgreSQL Cluster [Provisioning]({{< relref "/architecture/provisioning.md" >}})
22+
Whether you need to get a simple Postgres cluster up and running, need to deploy
23+
a high availability, fault tolerant cluster in production, or are running your
24+
own database-as-a-service, the PostgreSQL Operator provides the essential
25+
features you need to keep your cloud native Postgres clusters healthy, including:
26+
27+
#### Postgres Cluster [Provisioning]({{< relref "/architecture/provisioning.md" >}})
1828

1929
[Create, Scale, & Delete PostgreSQL clusters with ease](/architecture/provisioning/), while fully customizing your Pods and PostgreSQL configuration!
2030

@@ -30,7 +40,7 @@ Backups and restores leverage the open source [pgBackRest](https://www.pgbackres
3040

3141
#### TLS
3242

33-
Secure communication between your applications and data servers by [enabling TLS for your PostgreSQL servers](/pgo-client/common-tasks/#enable-tls), including the ability to enforce that all of your connections to use TLS.
43+
Secure communication between your applications and data servers by [enabling TLS for your PostgreSQL servers](/pgo-client/common-tasks/#enable-tls), including the ability to enforce all of your connections to use TLS.
3444

3545
#### [Monitoring]({{< relref "/architecture/monitoring.md" >}})
3646

@@ -72,16 +82,22 @@ Choose the type of backup (full, incremental, differential) and [how frequently
7282

7383
#### Multi-Namespace Support
7484

75-
You can control how the PostgreSQL Operator leverages [Kubernetes Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) with several different deployment models:
85+
You can control how PGO, the Postgres Operator, leverages [Kubernetes Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) with several different deployment models:
7686

77-
- Deploy the PostgreSQL Operator and all PostgreSQL clusters to the same namespace
78-
- Deploy the PostgreSQL Operator to one namespaces, and all PostgreSQL clusters to a different namespace
79-
- Deploy the PostgreSQL Operator to one namespace, and have your PostgreSQL clusters managed acrossed multiple namespaces
80-
- Dynamically add and remove namespaces managed by the PostgreSQL Operator using the `pgo create namespace` and `pgo delete namespace` commands
87+
- Deploy PGO and all PostgreSQL clusters to the same namespace
88+
- Deploy PGO to one namespaces, and all PostgreSQL clusters to a different
89+
namespace
90+
- Deploy PGO to one namespace, and have your PostgreSQL clusters managed across
91+
multiple namespaces
92+
- Dynamically add and remove namespaces managed by the PostgreSQL Operator using
93+
the `pgo` client to run `pgo create namespace` and `pgo delete namespace`
8194

8295
#### Full Customizability
8396

84-
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:
97+
The Postgres Operator (PGO) makes it easy to get Postgres up and running on
98+
Kubernetes-enabled platforms, but we know that there are further customizations
99+
that you can make. As such, PGO allows you to further customize your
100+
deployments, including:
85101

86102
- Selecting different storage classes for your primary, replica, and backup storage
87103
- Select your own container resources class for each PostgreSQL cluster deployment; differentiate between resources applied for primary and replica clusters!
@@ -140,24 +156,29 @@ For more information about which versions of the PostgreSQL Operator include whi
140156

141157
# Supported Platforms
142158

143-
The Crunchy PostgreSQL Operator is tested on the following Platforms:
159+
PGO, the Postgres Operator, is Kubernetes-native and maintains backwards
160+
compatibility to Kubernetes 1.11 and is tested is tested against the following
161+
platforms:
144162

145163
- Kubernetes 1.13+
146164
- OpenShift 3.11+
147165
- Google Kubernetes Engine (GKE), including Anthos
148166
- Amazon EKS
149-
- VMware Enterprise PKS 1.3+
150-
151-
## Storage
167+
- Microsoft AKS
168+
- VMware Tanzu
152169

153-
The Crunchy PostgreSQL Operator is tested with a variety of different types of Kubernetes storage and Storage Classes, including:
170+
This list only includes the platforms that the Postgres Operator is specifically
171+
tested on as part of the release process: PGO works on other Kubernetes
172+
distributions as well.
154173

155-
- Rook
156-
- StorageOS
157-
- Google Compute Engine persistent volumes
158-
- NFS
159-
- HostPath
174+
## Storage
160175

161-
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.
176+
PGO, the Postgres Operator, is tested with a variety of different types of
177+
Kubernetes storage and Storage Classes, as well as hostPath and NFS.
162178

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

0 commit comments

Comments
 (0)