Skip to content

Commit e18f5de

Browse files
rimuszrimusz
committed
[feature] add helm chart
1 parent 3aaf429 commit e18f5de

17 files changed

+757
-0
lines changed

‎chart/postgres-operator/.helmignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Patterns to ignore when building packages.
2+
# This supports shell glob matching, relative path matching, and
3+
# negation (prefixed with !). Only one pattern per line.
4+
.DS_Store
5+
# Common VCS dirs
6+
.git/
7+
.gitignore
8+
.bzr/
9+
.bzrignore
10+
.hg/
11+
.hgignore
12+
.svn/
13+
# Common backup files
14+
*.swp
15+
*.bak
16+
*.tmp
17+
*~
18+
# Various IDEs
19+
.project
20+
.idea/
21+
*.tmproj

‎chart/postgres-operator/Chart.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
apiVersion: v1
2+
description: CrunchyData Postgres Operator Helm chart
3+
name: postgres-operator
4+
version: 0.1.0
5+
keywords:
6+
- postgresql
7+
- postgres
8+
- database
9+
- sql
10+
home: https://www.crunchydata.com/
11+
icon: http://trusted-charts-logos.stackpoint.io/crunchy_logo.png
12+
sources:
13+
- https://github.com/CrunchyData/postgres-operator
14+
- https://github.com/CrunchyData/crunchy-containers
15+
maintainers:
16+
- name: rimusz
17+
email: [email protected]

‎chart/postgres-operator/README.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
Crunchy Data PostgreSQL Operator
2+
=======
3+
4+
[PostgreSQL](https://postgresql.org) is a powerful, open source object-relational database system. It has more than 15 years of active development and a proven architecture that has earned it a strong reputation for reliability, data integrity, and correctness.
5+
6+
7+
TL;DR;
8+
------
9+
10+
```console
11+
$ helm install --name postgres-operator --namespace=postgres-operator postgres-operator
12+
```
13+
14+
Introduction
15+
------------
16+
17+
This chart bootstraps a PostgreSQL Operator.
18+
19+
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Clusters deployed within a Kubernetes.
20+
The PostgreSQL Operator leverages Kubernetes Third Party Resources to define custom resource types such as:
21+
22+
* *pgcluster*
23+
* *pgbackups*
24+
* *pgupgrades*
25+
* *pgclones*
26+
* *pgpolicies*
27+
* *pgpolicylogs*
28+
29+
30+
Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.
31+
32+
The PostgreSQL Operator runs within Kubernetes detecting these new custom object types being created, updated, or removed.
33+
34+
Once the objects are detected, the PostgreSQL Operator enables users to perform operations across the Kubernetes environment, including:
35+
36+
* Create a PostgreSQL Cluster
37+
* Destroy a PostgreSQL Cluster
38+
* Backup a PostgreSQL Cluster
39+
* Scale a a PostgreSQL Cluster
40+
* Restore a PostgreSQL Cluster
41+
* Upgrade a PostgreSQL Cluster
42+
* View PVC
43+
* Test Connections to a PostgreSQL Cluster
44+
* Clone a PostgreSQL Cluster
45+
* Create a SQL-based Policy
46+
* Apply a SQL-based Policy to a PostgreSQL Cluster
47+
* Perform User Management
48+
* Apply User Defined Labels to PostgreSQL Clusters
49+
* Perform Password Management
50+
51+
What actually gets created on the Kube cluster for a
52+
*pgcluster* resource is defined as a *deployment strategy*. Strategies
53+
are documented in detail in [Deployment Strategies](https://github.com/CrunchyData/postgres-operator/blob/master/docs/design.asciidoc#postgresql-operator-deployment-strategies).
54+
55+
56+
Installing the Chart
57+
--------------------
58+
59+
The chart can be installed as follows:
60+
61+
```console
62+
$ helm install postgres-operator --name postgres-operator --namespace=postgres-operator
63+
```
64+
65+
The command deploys postgres-operator on the Kubernetes cluster in the default configuration.
66+
67+
> **Tip**: List all releases using `helm list`
68+
69+
Uninstalling the Chart
70+
----------------------
71+
72+
To uninstall/delete the `postgres-operator` deployment:
73+
74+
```console
75+
$ helm delete postgres-operator
76+
```
77+
78+
The command removes all the Kubernetes components associated with the chart and deletes the release.
79+
80+
Configuration
81+
-------------
82+
83+
See `values.yaml` for configuration notes. Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
84+
85+
```console
86+
$ helm install postgres-operator --name postgres-operator --namespace=postgres-operator \
87+
--set env.debug=false
88+
```
89+
90+
The above command disables the debugging.
91+
92+
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
93+
94+
```console
95+
$ helm install postgres-operator --name postgres-operator --namespace=postgres-operator \
96+
-f values.yaml
97+
```
98+
99+
> **Tip**: You can use the default [values.yaml](values.yaml)

‎chart/postgres-operator/files/backup-job.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"apiVersion": "batch/v1",
3+
"kind": "Job",
4+
"metadata": {
5+
"name": "backup-{{.Name}}"
6+
},
7+
"spec": {
8+
"template": {
9+
"metadata": {
10+
"name": "{{.Name}}",
11+
"labels": {
12+
"pgbackup": "true",
13+
"pg-database": "{{.Name}}"
14+
}
15+
},
16+
"spec": {
17+
"volumes": [{
18+
"name": "pgdata",
19+
{{.PVC_NAME}}
20+
}],
21+
22+
{{.SECURITY_CONTEXT}}
23+
24+
"containers": [{
25+
"name": "backup",
26+
"image": "crunchydata/crunchy-backup:{{.CCP_IMAGE_TAG}}",
27+
"volumeMounts": [{
28+
"mountPath": "/pgdata",
29+
"name": "pgdata",
30+
"readOnly": false
31+
}],
32+
"env": [{
33+
"name": "BACKUP_HOST",
34+
"value": "{{.BACKUP_HOST}}"
35+
}, {
36+
"name": "BACKUP_USER",
37+
"value": "{{.BACKUP_USER}}"
38+
}, {
39+
"name": "BACKUP_PASS",
40+
"value": "{{.BACKUP_PASS}}"
41+
}, {
42+
"name": "BACKUP_PORT",
43+
"value": "{{.BACKUP_PORT}}"
44+
}]
45+
}],
46+
"restartPolicy": "Never"
47+
}
48+
}
49+
}
50+
}

‎chart/postgres-operator/files/cluster/affinity.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"affinity": {
2+
"nodeAffinity": {
3+
"preferredDuringSchedulingIgnoredDuringExecution": [{
4+
"weight": 1,
5+
"preference": {
6+
"matchExpressions": [{
7+
"key": "kubernetes.io/hostname",
8+
"operator": "{{.OPERATOR}}",
9+
"values": [
10+
"{{.NODE}}"
11+
]
12+
}]
13+
}
14+
}]
15+
}
16+
},

‎chart/postgres-operator/files/cluster/cluster-deployment-1.json‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
{
2+
"kind": "Deployment",
3+
"apiVersion": "extensions/v1beta1",
4+
"metadata": {
5+
"name": "{{.Name}}",
6+
"labels": {
7+
{{.OPERATOR_LABELS }}
8+
}
9+
},
10+
"spec": {
11+
"replicas": 1,
12+
"template": {
13+
"metadata": {
14+
"labels": {
15+
"name": "{{.Name}}",
16+
"master": "true",
17+
"pg-cluster": "{{.ClusterName}}"
18+
}
19+
},
20+
"spec": {
21+
22+
{{.SECURITY_CONTEXT }}
23+
24+
"containers": [{
25+
"name": "database",
26+
"image": "crunchydata/crunchy-postgres:{{.CCP_IMAGE_TAG}}",
27+
"readinessProbe": {
28+
"exec": {
29+
"command": [
30+
"/opt/cpm/bin/readiness.sh"
31+
]
32+
},
33+
"initialDelaySeconds": 15,
34+
"timeoutSeconds": 8
35+
},
36+
"env": [{
37+
"name": "PG_MASTER_PORT",
38+
"value": "{{.Port}}"
39+
}, {
40+
"name": "PG_MODE",
41+
"value": "master"
42+
}, {
43+
"name": "PGDATA_PATH_OVERRIDE",
44+
"value": "{{.PGDATA_PATH_OVERRIDE}}"
45+
}, {
46+
"name": "BACKUP_PATH",
47+
"value": "{{.BACKUP_PATH}}"
48+
}, {
49+
"name": "PG_DATABASE",
50+
"value": "{{.PG_DATABASE}}"
51+
}, {
52+
"name": "PGHOST",
53+
"value": "/tmp"
54+
}],
55+
"volumeMounts": [{
56+
"mountPath": "/pgdata",
57+
"name": "pgdata",
58+
"readOnly": false
59+
}, {
60+
"mountPath": "/backup",
61+
"name": "backup",
62+
"readOnly": true
63+
}, {
64+
"mountPath": "/pguser",
65+
"name": "pguser-volume"
66+
}, {
67+
"mountPath": "/pgmaster",
68+
"name": "pgmaster-volume"
69+
}, {
70+
"mountPath": "/pgroot",
71+
"name": "pgroot-volume"
72+
}
73+
74+
],
75+
76+
"ports": [{
77+
"containerPort": 5432,
78+
"protocol": "TCP"
79+
}],
80+
"resources": {},
81+
"imagePullPolicy": "IfNotPresent"
82+
}],
83+
"volumes": [{
84+
"name": "pgdata",
85+
{{.PVC_NAME}}
86+
}, {
87+
"name": "backup",
88+
{{.BACKUP_PVC_NAME}}
89+
}, {
90+
"name": "pguser-volume",
91+
"secret": {
92+
"secretName": "{{.PGUSER_SECRET_NAME}}"
93+
}
94+
}, {
95+
"name": "pgmaster-volume",
96+
"secret": {
97+
"secretName": "{{.PGMASTER_SECRET_NAME}}"
98+
}
99+
}, {
100+
"name": "pgroot-volume",
101+
"secret": {
102+
"secretName": "{{.PGROOT_SECRET_NAME}}"
103+
}
104+
}
105+
106+
],
107+
108+
{{.NODE_SELECTOR}}
109+
110+
"restartPolicy": "Always",
111+
"dnsPolicy": "ClusterFirst"
112+
}
113+
},
114+
"strategy": {
115+
"type": "RollingUpdate",
116+
"rollingUpdate": {
117+
"maxUnavailable": 1,
118+
"maxSurge": 1
119+
}
120+
}
121+
}
122+
}

0 commit comments

Comments
 (0)