PostgreSQL is an object-relational database management system (ORDBMS) with an emphasis on extensibility and on standards-compliance.
This chart bootstraps a PostgreSQL deployment on a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the BKPR.
- Kubernetes 1.10+
- PV provisioner support in the underlying infrastructure
- Kanister controller version 0.72.0 installed in your cluster
- Kanctl CLI installed (https://docs.kanister.io/tooling.html#kanctl)
To install the chart with the release name my-release:
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo update
# If you are using helm v3
$ kubectl create ns postgres-test
$ helm install my-release --namespace postgres-test bitnami/postgresql
# If you are using helm v2
$ helm install --name my-release --namespace postgres-test bitnami/postgresqlThe command deploys PostgreSQL on the Kubernetes cluster in the default configuration.
Tip: List all releases using
helm list
In case, if you don't have Kanister installed already, you can use following commands to do that.
Add Kanister Helm repository and install Kanister operator
$ helm repo add kanister https://charts.kanister.io
$ helm install --name kanister --namespace kasten-io kanister/kanister-operator --set image.tag=0.72.0If you have deployed postgresql application with name other than my-release and namespace other than postgres-test, you need to modify the commands used below to use the correct name and namespace
Create Profile CR if not created already
$ kanctl create profile s3compliant --access-key <aws-access-key-id> \
--secret-key <aws-secret-key> \
--bucket <s3-bucket-name> --region <region-name> \
--namespace postgres-testNOTE:
The command will configure a location where artifacts resulting from Kanister
data operations such as backup should go. This is stored as a profiles.cr.kanister.io
CustomResource (CR) which is then referenced in Kanister ActionSets. Every ActionSet
requires a Profile reference to complete the action. This CR (profiles.cr.kanister.io)
can be shared between Kanister-enabled application instances.
Create Blueprint in the same namespace as the controller
$ kubectl create -f ./postgres-blueprint.yaml -n kasten-ioOnce Postgres is running, you can populate it with some data. Let's add a table called "company" to a "test" database:
## Log in into postgresql container and get shell access
$ kubectl exec -ti my-release-postgresql-0 -n postgres-test -- bash
## use psql cli to add entries in postgresql database
$ PGPASSWORD=${POSTGRES_PASSWORD} psql -U $POSTGRES_USER
psql (11.6)
Type "help" for help.
## Create DATABASE
postgres=# CREATE DATABASE test;
CREATE DATABASE
postgres=# \l
List of databases
Name | Owner | Encoding | Collate | Ctype | Access privileges
-----------+----------+----------+-------------+-------------+-----------------------
postgres | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
template0 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
template1 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
test | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
(4 rows)
## Create table COMPANY in test database
postgres=# \c test
You are now connected to database "test" as user "postgres".
test=# CREATE TABLE COMPANY(
test(# ID INT PRIMARY KEY NOT NULL,
test(# NAME TEXT NOT NULL,
test(# AGE INT NOT NULL,
test(# ADDRESS CHAR(50),
test(# SALARY REAL,
test(# CREATED_AT TIMESTAMP
test(# );
CREATE TABLE
## Insert data into the table
test=# INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY,CREATED_AT) VALUES (10, 'Paul', 32, 'California', 20000.00, now());
INSERT 0 1
test=# select * from company;
id | name | age | address | salary | created_at
----+------+-----+----------------------------------------------------+--------+----------------------------
10 | Paul | 32 | California | 20000 | 2019-09-16 14:39:36.316065
(1 row)
## Add few more entries
test=# INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY,CREATED_AT) VALUES (20, 'Omkar', 32, 'California', 20000.00, now());
INSERT 0 1
test=# INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY,CREATED_AT) VALUES (30, 'Prasad', 32, 'California', 20000.00, now());
INSERT 0 1
test=# select * from company;
id | name | age | address | salary | created_at
----+-------+-----+----------------------------------------------------+--------+----------------------------
10 | Paul | 32 | California | 20000 | 2019-09-16 14:39:36.316065
20 | Omkar | 32 | California | 20000 | 2019-09-16 14:40:52.952459
30 | Omkar | 32 | California | 20000 | 2019-09-16 14:41:06.433487
You can now take a backup of the PostgresDB data using an ActionSet defining backup for this application. Create an ActionSet in the same namespace as the controller.
$ kubectl get profile -n postgres-test
NAME AGE
s3-profile-7d6wt 7m25s
$ kanctl create actionset --action backup --namespace kasten-io --blueprint postgres-bp --statefulset postgres-test/my-release-postgresql --profile postgres-test/s3-profile-7d6wt
actionset backup-llfb8 created
$ kubectl --namespace kasten-io get actionsets.cr.kanister.io
NAME AGE
backup-glptq 38s
# View the status of the actionset
$ kubectl --namespace kasten-io describe actionset backup-glptqLet's say someone accidentally deleted the test database using the following command:
## Log in into postgresql container and get shell access
$ kubectl exec -ti my-release-postgresql-0 -n postgres-test -- bash
## use psql cli to add entries in postgresql database
$ PGPASSWORD=${POSTGRES_PASSWORD} psql -U ${POSTGRES_USER}
psql (11.5)
Type "help" for help.
## Drop database
postgres=# \l
List of databases
Name | Owner | Encoding | Collate | Ctype | Access privileges
-----------+----------+----------+-------------+-------------+-----------------------
postgres | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
template0 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
template1 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
test | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
(4 rows)
postgres=# DROP DATABASE test;
DROP DATABASE
postgres=# \l
List of databases
Name | Owner | Encoding | Collate | Ctype | Access privileges
-----------+----------+----------+-------------+-------------+-----------------------
postgres | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
template0 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
template1 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
(3 rows)To restore the missing data, you should use the backup that you created before. An easy way to do this is to leverage kanctl, a command-line tool that helps create ActionSets that depend on other ActionSets:
$ kanctl --namespace kasten-io create actionset --action restore --from backup-glptq
actionset restore-backup-glptq-6jzt4 created
## Check status
$ kubectl --namespace kasten-io describe actionset restore-backup-glptq-6jzt4Once the ActionSet status is set to "complete", you can see that the data has been successfully restored to PostgreSQL
postgres=# \l
List of databases
Name | Owner | Encoding | Collate | Ctype | Access privileges
-----------+----------+----------+-------------+-------------+-----------------------
postgres | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
template0 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
template1 | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 | =c/postgres +
| | | | | postgres=CTc/postgres
test | postgres | UTF8 | en_US.UTF-8 | en_US.UTF-8 |
(4 rows)
postgres=# \c test;
You are now connected to database "test" as user "postgres".
test=# select * from company;
id | name | age | address | salary | created_at
----+--------+-----+----------------------------------------------------+--------+----------------------------
10 | Paul | 32 | California | 20000 | 2019-12-23 07:13:10.459499
20 | Omkar | 32 | California | 20000 | 2019-12-23 07:13:20.953172
30 | Prasad | 32 | California | 20000 | 2019-12-23 07:13:29.15668
(3 rows)The artifacts created by the backup action can be cleaned up using the following command:
$ kanctl --namespace kasten-io create actionset --action delete --from backup-glptq
actionset delete-backup-glptq-cq6bw created
# View the status of the ActionSet
$ kubectl --namespace kasten-io describe actionset delete-backup-glptq-cq6bwIf you run into any issues with the above commands, you can check the logs of the controller using:
$ kubectl --namespace kasten-io logs -l app=kanister-operatoryou can also check events of the actionset
$ kubectl describe actionset <actionset-name> -n kasten-ioTo uninstall/delete the my-release deployment:
# If you are using helm v2
$ helm delete --purge my-release
# If you are using helm v3
$ helm delete my-release -n postgres-testRemove Blueprint and Profile CR
$ kubectl delete blueprints.cr.kanister.io postgres-bp -n kasten-io
$ kubectl get profiles.cr.kanister.io -n postgres-test
NAME AGE
s3-profile-7d6wt 17m
$ kubectl delete profiles.cr.kanister.io ss3-profile-7d6w -n postgres-test