The Postgres Operator made it to the [Google Summer of Code 2019](https://summerofcode.withgoogle.com/)! As a brand new mentoring organization, we are now looking for our first mentees. Check [our ideas](https://github.com/zalando/postgres-operator/blob/master/docs/gsoc-2019/ideas.md#google-summer-of-code-2019) and start discussion in [the issue tracker](https://github.com/zalando/postgres-operator/issues). And don't forget to spread a word about our GSoC participation to attract even more students.
## Introduction
The Postgres [operator](https://coreos.com/blog/introducing-operators.html)
The Postgres [operator](https://coreos.com/blog/introducing-operators.html)
manages PostgreSQL clusters on Kubernetes:
manages PostgreSQL clusters on Kubernetes:
1. The operator watches additions, updates, and deletions of PostgreSQL cluster
1. The operator watches additions, updates, and deletions of PostgreSQL cluster
manifests and changes the running clusters accordingly. For example, when a
manifests and changes the running clusters accordingly. For example, when a
user submits a new manifest, the operator fetches that manifest and spawns a
user submits a new manifest, the operator spawns a new Postgres cluster with
new Postgres cluster along with all necessary entities such as Kubernetes
necessary entities such as StatefulSets, Services, and also Postgres roles. See this
2. The operator also watches updates to [its own configuration](manifests/configmap.yaml)
2. The operator also watches updates to [its own configuration](manifests/configmap.yaml)
and alters running Postgres clusters if necessary. For instance, if a pod
and alters running Postgres clusters if necessary. For instance, if a pod
docker image is changed, the operator carries out the rolling update. That
Docker image is changed, the operator carries out the rolling update. That
is, the operator re-spawns one-by-one pods of each StatefulSet it manages
is, the operator re-spawns one-by-one pods of each StatefulSet it manages
with the new Docker image.
with the new Docker image.
3. Finally, the operator periodically synchronizes the actual state of each
3. Finally, the operator periodically synchronizes the actual state of each
Postgres cluster with the desired state defined in the cluster's manifest.
Postgres cluster with the desired state defined in the cluster's manifest.
Here is a diagram, that summarizes what would be created by the operator, when a
4. The operator aims to be hands free and configuration happens only via manifests and its own config.
new Postgres cluster CRD was submitted:
This enables easy integration in automated deploy pipelines with no access to Kubernetes directly.
![postgresql-operator](docs/diagrams/operator.png"K8S resources, created by operator")
This picture is not complete without an overview of what is inside a pod, so
let's zoom in:
![pod](docs/diagrams/pod.png"Database pod components")
These two diagrams should help you to understand the basics of what kind of
# Google Summer of Code
functionality the operator provides. Below we discuss all everything in more
details.
There is a browser-friendly version of this documentation at [postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io)
The Postgres Operator made it to the [Google Summer of Code 2019](https://summerofcode.withgoogle.com/)! As a brand new mentoring organization, we are now looking for our first mentees. Check [our ideas](https://github.com/zalando/postgres-operator/blob/master/docs/gsoc-2019/ideas.md#google-summer-of-code-2019) and start discussion in [the issue tracker](https://github.com/zalando/postgres-operator/issues). And don't forget to spread a word about our GSoC participation to attract even more students.
## Table of contents
## Table of contents
...
@@ -61,8 +46,24 @@ There is a browser-friendly version of this documentation at [postgres-operator.
...
@@ -61,8 +46,24 @@ There is a browser-friendly version of this documentation at [postgres-operator.
