You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# 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!
9
9
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
[Create, Scale, & Delete PostgreSQL clusters with ease][provisioning], while fully customizing your
17
22
Pods and PostgreSQL configuration!
@@ -33,7 +38,7 @@ Set how long you want your backups retained for. Works great with very large dat
33
38
#### TLS
34
39
35
40
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.
37
42
38
43
#### [Monitoring][monitoring]
39
44
@@ -76,16 +81,22 @@ the S3 protocol. The PostgreSQL Operator can backup, restore, and create new clu
76
81
77
82
#### Multi-Namespace Support
78
83
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:
80
85
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`
85
93
86
94
#### Full Customizability
87
95
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:
89
100
90
101
- Selecting different storage classes for your primary, replica, and backup storage
91
102
- 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
94
105
- Bring your own trusted certificate authority (CA) for use with the Operator API server
95
106
- Override your PostgreSQL configuration for each cluster
@@ -119,51 +129,59 @@ The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Se
119
129
120
130
## Deployment Requirements
121
131
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.
123
136
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
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.
131
145
132
146
### Supported Platforms
133
147
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:
135
151
136
152
- Kubernetes 1.17+
137
153
- Openshift 4.4+
138
154
- OpenShift 3.11
139
155
- Google Kubernetes Engine (GKE), including Anthos
140
156
- Amazon EKS
141
157
- Microsoft AKS
142
-
- VMware Enterprise PKS 1.3+
158
+
- VMware Tanzu
143
159
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.
145
163
146
164
### Storage
147
165
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.
157
168
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.
159
175
160
176
## Installation
161
177
162
-
### PostgreSQL Operator Installation
178
+
### Postgres Operator (PGO) Installation
163
179
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.
165
182
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
@@ -229,20 +247,24 @@ Additional containers that are not directly integrated with the PostgreSQL Opera
229
247
230
248
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.
231
249
232
-
## Using the PostgreSQL Operator
250
+
## Using the PostgreSQL Operator (PGO)
233
251
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
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,
0 commit comments