diff --git a/README.md b/README.md index d7505477d2774e142a668e2989334d333b444b2e..8c6fee81a46bf15a03358eed8ac05b2d7d14106e 100644 --- a/README.md +++ b/README.md @@ -8,48 +8,33 @@ <img src="docs/diagrams/logo.png" width="200"> -# Google Summer of Code - -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 +## Introduction to the Postgres Operator The Postgres [operator](https://coreos.com/blog/introducing-operators.html) manages PostgreSQL clusters on Kubernetes: 1. The operator watches additions, updates, and deletions of PostgreSQL cluster - manifests and changes the running clusters accordingly. For example, when a - user submits a new manifest, the operator fetches that manifest and spawns a - new Postgres cluster along with all necessary entities such as Kubernetes - StatefulSets and Postgres roles. See this + manifests and changes the running clusters accordingly. For example, when a + user submits a new manifest, the operator spawns a new Postgres cluster with + necessary entities such as StatefulSets, Services, and also Postgres roles. See this [Postgres cluster manifest](manifests/complete-postgres-manifest.yaml) for settings that a manifest may contain. 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 - 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 with the new Docker image. 3. Finally, the operator periodically synchronizes the actual state of each 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 -new Postgres cluster CRD was submitted: - - - -This picture is not complete without an overview of what is inside a pod, so -let's zoom in: - - +4. The operator aims to be hands free and configuration happens only via manifests and its own config. + This enables easy integration in automated deploy pipelines with no access to Kubernetes directly. -These two diagrams should help you to understand the basics of what kind of -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) +# Google Summer of Code +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 @@ -61,8 +46,24 @@ There is a browser-friendly version of this documentation at [postgres-operator. * [cluster manifest reference](docs/reference/cluster_manifest.md) * [command-line options and environment variables](docs/reference/command_line_and_environment.md) -the rest of the document is a tutorial to get you up and running with the operator on Minikube. +The rest of this document is a tutorial to get you up and running locally with the operator on Minikube. + +## Overview of involved entities + +Here is a diagram, that summarizes what would be created by the operator, when a +new Postgres cluster CRD is submitted: + + + +This picture is not complete without an overview of what is inside a single cluster pod, so +let's zoom in: + + +These two diagrams should help you to understand the basics of what kind of +functionality the operator provides. + +There is a browser-friendly version of this documentation at [postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io) ## Community