OperatorHub.io
If your Kubernetes cluster is already running the Operator Lifecycle Manager, the PostgreSQL Operator can be installed as part of Crunchy PostgreSQL for Kubernetes that is available in OperatorHub.io.
Before You Begin
There are some optional Secrets you can add before installing the PostgreSQL Operator into your cluster.
Secrets (optional)
If you plan to use AWS S3 to store backups and would like to have the keys available for every backup, you can create a Secret as described below:
kubectl -n "$PGO_OPERATOR_NAMESPACE" create secret generic pgo-backrest-repo-config \
--from-literal=aws-s3-key="<your-aws-s3-key>" \
--from-literal=aws-s3-key-secret="<your-aws-s3-key-secret>"
Certificates (optional)
The PostgreSQL Operator has an API that uses TLS to communicate securely with clients. If you have a certificate bundle validated by your organization, you can install it now. If not, the API will automatically generate and use a self-signed certificate.
kubectl -n "$PGO_OPERATOR_NAMESPACE" create secret tls pgo.tls \
--cert=/path/to/server.crt \
--key=/path/to/server.key
Installation
Create an OperatorGroup
and a Subscription
in your chosen namespace.
Make sure the source
and sourceNamespace
match the CatalogSource from earlier.
kubectl -n "$PGO_OPERATOR_NAMESPACE" create -f- <<YAML
---
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
name: postgresql
spec:
targetNamespaces: ["$PGO_OPERATOR_NAMESPACE"]
---
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: postgresql
spec:
name: postgresql
channel: stable
source: operatorhubio-catalog
sourceNamespace: olm
startingCSV: postgresoperator.v4.6.1
YAML
After You Install
Once the PostgreSQL Operator is installed in your Kubernetes cluster, you will need to do a few things to use the PostgreSQL Operator Client.
Install the first set of client credentials and download the pgo
binary and client certificates.
PGO_CMD=kubectl ./deploy/install-bootstrap-creds.sh
PGO_CMD=kubectl ./installers/kubectl/client-setup.sh
The client needs to be able to reach the PostgreSQL Operator API from outside the Kubernetes cluster. Create an external service or forward a port locally.
kubectl -n "$PGO_OPERATOR_NAMESPACE" expose deployment postgres-operator --type=LoadBalancer
export PGO_APISERVER_URL="https://$(
kubectl -n "$PGO_OPERATOR_NAMESPACE" get service postgres-operator \
-o jsonpath="{.status.loadBalancer.ingress[*]['ip','hostname']}"
):8443"
or
kubectl -n "$PGO_OPERATOR_NAMESPACE" port-forward deployment/postgres-operator 8443
export PGO_APISERVER_URL="https://127.0.0.1:8443"
Verify connectivity using the pgo
command.
pgo version
# pgo client version 4.6.1
# pgo-apiserver version 4.6.1