Install Install Percona Distribution for PostgreSQL on Azure Kubernetes Service (AKS)¶

This guide shows you how to deploy Percona Operator for PostgreSQL on Microsoft Azure Kubernetes Service (AKS). The document assumes some experience with the platform. For more information on the AKS, see the Microsoft AKS official documentation .

Prerequisites¶

The following tools are used in this guide and therefore should be preinstalled:

Azure Command Line Interface (Azure CLI) for interacting with the different parts of AKS. You can install it following the official installation instructions for your system .
kubectl to manage and deploy applications on Kubernetes. Install it following the official installation instructions .

Also, you need to sign in with Azure CLI using your credentials according to the official guide .

Create and configure the AKS cluster¶

To create your Kubernetes cluster, you will need the following data:

name of your AKS cluster,
an Azure resource group , in which resources of your cluster will be deployed and managed.
the amount of nodes you would like tho have.

You can create your cluster via command line using az aks create command. The following command will create a 3-node cluster named cluster1 within some already existing resource group named my-resource-group:

$ az aks create --resource-group my-resource-group --name  cluster1 --enable-managed-identity --node-count 3 --node-vm-size Standard_B4ms --node-osdisk-size 30 --network-plugin kubenet  --generate-ssh-keys --outbound-type loadbalancer

Other parameters in the above example specify that we are creating a cluster with machine type of Standard_B4ms and OS disk size reduced to 30 GiB. You can see detailed information about cluster creation options in the AKS official documentation .

You may wait a few minutes for the cluster to be generated.

Now you should configure the command-line access to your newly created cluster to make kubectl be able to use it.

az aks get-credentials --resource-group my-resource-group --name  cluster1

Install the Operator and deploy your PostgreSQL cluster¶

Create the Kubernetes namespace for your cluster. It is a good practice to isolate workloads in Kubernetes by installing the Operator in a custom namespace. For example, let’s name it postgres-operator:
```
$ kubectl create namespace postgres-operator
```
Expected output
```
namespace/postgres-operator was created
```
We will use this namespace further on in this document. If you used another name, make sure to replace it in the following commands.

Deploy the Operatorusing the following command:

$ kubectl apply --server-side -f https://raw.githubusercontent.com/percona/percona-postgresql-operator/v2.5.0/deploy/bundle.yaml -n postgres-operator

Expected output

customresourcedefinition.apiextensions.k8s.io/perconapgbackups.pgv2.percona.com serverside-applied
customresourcedefinition.apiextensions.k8s.io/perconapgclusters.pgv2.percona.com serverside-applied
customresourcedefinition.apiextensions.k8s.io/perconapgrestores.pgv2.percona.com serverside-applied
customresourcedefinition.apiextensions.k8s.io/postgresclusters.postgres-operator.crunchydata.com serverside-applied
serviceaccount/percona-postgresql-operator serverside-applied
role.rbac.authorization.k8s.io/percona-postgresql-operator serverside-applied
rolebinding.rbac.authorization.k8s.io/service-account-percona-postgresql-operator serverside-applied
deployment.apps/percona-postgresql-operator serverside-applied

At this point, the Operator Pod is up and running.

The operator has been started, and you can deploy Percona Distribution for PostgreSQL:
```
$ kubectl apply -f https://raw.githubusercontent.com/percona/percona-postgresql-operator/v2.5.0/deploy/cr.yaml -n postgres-operator
```
Expected output
```
perconapgcluster.pgv2.percona.com/cluster1 created
```
Note

This deploys default Percona Distribution for PostgreSQL configuration. Please see deploy/cr.yaml and Custom Resource Options for the configuration options. You can clone the repository with all manifests and source code by executing the following command:
```
$ git clone -b v2.5.0 https://github.com/percona/percona-postgresql-operator
```
After editing the needed options, apply your modified deploy/cr.yaml file as follows:
```
$ kubectl apply -f deploy/cr.yaml -n postgres-operator
```
The creation process may take some time. When the process is over your cluster will obtain the ready status. You can check it with the following command:
```
$ kubectl get pg
```
Expected output
```
NAME       ENDPOINT                         STATUS   POSTGRES   PGBOUNCER   AGE
cluster1   cluster1-pgbouncer.default.svc   ready    3          3           30m
```

Verifying the cluster operation¶

It may take ten minutes to get the cluster started. When kubectl get pg command finally shows you the cluster status as ready, you can try to connect to the cluster.

During the installation, the Operator has generated several secrets , including the one with password for default PostgreSQL user. This default user has the same login name as the cluster name.

Use kubectl get secrets command to see the list of Secrets objects. The Secrets object you are interested in is named as <cluster_name>-pguser-<cluster_name> (substitute <cluster_name> with the name of your Percona Distribution for PostgreSQL Cluster). The default variant will be cluster1-pguser-cluster1.

Use the following command to get the password of this user. Replace the <cluster_name> and <namespace> placeholders with your values:

$ kubectl get secret <cluster_name>-<user_name>-<cluster_name> -n <namespace> --template='{{.data.password | base64decode}}{{"\n"}}'

Create a pod and start Percona Distribution for PostgreSQL inside. The following command will do this, naming the new Pod pg-client:
```
$ kubectl run -i --rm --tty pg-client --image=perconalab/percona-distribution-postgresql:16.4 --restart=Never -- bash -il
```
Executing it may require some time to deploy the corresponding Pod.

Run a container with psql tool and connect its console output to your terminal. The following command will connect you as a cluster1 user to a cluster1 database via the PostgreSQL interactive terminal.

[postgres@pg-client /]$ PGPASSWORD='pguser_password' psql -h cluster1-pgbouncer.postgres-operator.svc -p 5432 -U cluster1 cluster1

Sample output

psql (16.4)
SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off)
Type "help" for help.
pgdb=>

Removing the AKS cluster¶

To delete your cluster, you will need the following data:

name of your AKS cluster,
AWS region in which you have deployed your cluster.

You can clean up the cluster with the az aks delete command as follows (with real names instead of <resource group> and <cluster name> placeholders):

$ az aks delete --name <cluster name> --resource-group <resource group> --yes --no-wait

It may take ten minutes to get the cluster actually deleted after executing this command.

Warning

After deleting the cluster, all data stored in it will be lost!

Get expert help¶

If you need assistance, visit the community forum for comprehensive and free database knowledge, or contact our Percona Database Experts for professional support and services. Join K8S Squad to benefit from early access to features and “ask me anything” sessions with the Experts.

Community Forum Get a Percona Expert Join K8S Squad

Last update: 2024-11-13