Update docs for v1.2

CONTRIBUTING.md

@@ -4,15 +4,19 @@ Wanna contribute to the Postgres Operator? Yay - here is how!
 
 ## Reporting issues
 
-If you have a question about patroni or have a problem using it, please read the`README` before filing an issue.
-Also double check with the current issues on our [Issues Tracker](https://github.com/zalando/postgres-operator/issues).
+Before filing an issue, if you have a question about Postgres Operator or have
+a problem using it, please read the [concepts](docs/index.md) page or use the
+different guides that we provide for [users](docs/user.md),
+[developers](docs/developer.md) or [admins](docs/administrator). Also double
+check with the current issues on our [Issues Tracker](https://github.com/zalando/postgres-operator/issues).
 
 ## Contributing a pull request
 
-1. Submit a comment to the relevant issue or create a new issue describing your proposed change.
-1. Do a fork, develop and test your code changes.
-1. Include documentation
-1. Submit a pull request.
+1. Submit a comment to the relevant issue or create a new issue describing your
+   proposed change.
+2. Do a fork, develop and test your code changes.
+3. Include documentation
+4. Submit a pull request.
 
 You'll get feedback about your pull request as soon as possible.
 

README.md

@@ -8,69 +8,39 @@
 
 <img src="docs/diagrams/logo.png" width="200">
 
-## Introduction to the Postgres Operator
+The Postgres Operator enables highly-available [PostgreSQL](https://www.postgresql.org/)
+clusters on Kubernetes (K8s) powered by [Patroni](https://github.com/zalando/spilo).
+It is configured only through manifests to ease integration into automated CI/CD
+pipelines with no access to Kubernetes directly.
 
-The Postgres [operator](https://coreos.com/blog/introducing-operators.html)
-manages PostgreSQL clusters on Kubernetes:
+The Postgres Operator has been developed at Zalando and is being used in
+production for over two years.
 
-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 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.
+## Getting started
 
-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
-   is, the operator re-spawns one-by-one pods of each StatefulSet it manages
-   with the new Docker image.
+For a quick first impression follow the instructions of this
+[tutorial](docs/quickstart.md).
 
-3. Finally, the operator periodically synchronizes the actual state of each
-   Postgres cluster with the desired state defined in the cluster's manifest.
+## Documentation
 
-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.
+There is a browser-friendly version of this documentation at
+[postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io)
 
-# Getting started
+* [How it works](docs/index.md)
+* [The Postgres experience on K8s](docs/user.md)
+* [DBA options - from RBAC to backup](docs/administrator.md)
+* [Debug and extend the operator](docs/developer.md)
+* [Configuration options](docs/reference/operator_parameters.md)
+* [Postgres manifest reference](docs/reference/cluster_manifest.md)
+* [Command-line options and environment variables](docs/reference/command_line_and_environment.md)
 
-For a quick first impression follow the instructions of [this](docs/quickstart.md)
-tutorial.
+## Google Summer of Code
 
-# Google Summer of Code
+The Postgres Operator made it to the [Google Summer of Code 2019](https://summerofcode.withgoogle.com/organizations/5429926902104064/)!
+Check [our ideas](docs/gsoc-2019/ideas.md#google-summer-of-code-2019)
+and start discussions in [the issue tracker](https://github.com/zalando/postgres-operator/issues).
 
-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
-
-* [concepts](docs/index.md)
-* [user documentation](docs/user.md)
-* [administrator documentation](docs/administrator.md)
-* [developer documentation](docs/developer.md)
-* [operator configuration reference](docs/reference/operator_parameters.md)
-* [cluster manifest reference](docs/reference/cluster_manifest.md)
-* [command-line options and environment variables](docs/reference/command_line_and_environment.md)
-
-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:
-
-![postgresql-operator](docs/diagrams/operator.png "K8S resources, created by operator")
-
-This picture is not complete without an overview of what is inside a single cluster 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
-functionality the operator provides.
-
-There is a browser-friendly version of this documentation at [postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io)
-
-## Community      
+## Community
 
 There are two places to get in touch with the community:
 1. The [GitHub issue tracker](https://github.com/zalando/postgres-operator/issues)

charts/postgres-operator/Chart.yaml

@@ -3,7 +3,7 @@ name: postgres-operator
 version: 1.2.0
 appVersion: 1.2.0
 home: https://github.com/zalando/postgres-operator
-description: Postgres operator creates and manages PostgreSQL clusters running in Kubernetes
+description: Postgres Operator creates and manages PostgreSQL clusters running in Kubernetes
 keywords:
 - postgres
 - operator
@@ -16,5 +16,5 @@ maintainers:
 - name: kimxogus
   email: kgyoo8232@gmail.com
 sources:
-- https://github.com/zalando-incubator/postgres-operator
+- https://github.com/zalando/postgres-operator
 engine: gotpl

charts/postgres-operator/values-crd.yaml

@@ -243,7 +243,7 @@ serviceAccount:
   create: true
   # The name of the ServiceAccount to use.
   # If not set and create is true, a name is generated using the fullname template
-  # When relying solely on the OperatorConfiguration CRD, set this value to "operator"
+  # When relying solely on the OperatorConfiguration CRD, this value has to be "operator"
   # Otherwise, the operator tries to use the "default" service account which is forbidden
   name: operator
 

charts/postgres-operator/values.yaml

@@ -224,8 +224,6 @@ serviceAccount:
   create: true
   # The name of the ServiceAccount to use.
   # If not set and create is true, a name is generated using the fullname template
-  # When relying solely on the OperatorConfiguration CRD, set this value to "operator"
-  # Otherwise, the operator tries to use the "default" service account which is forbidden
   name:
 
 priorityClassName: ""

docker/Dockerfile

@@ -7,7 +7,7 @@ RUN apk --no-cache add ca-certificates
 COPY build/* /
 
 RUN addgroup -g 1000 pgo
-RUN adduser -D -u 1000 -G pgo -g 'Postgres operator' pgo
+RUN adduser -D -u 1000 -G pgo -g 'Postgres Operator' pgo
 
 USER 1000:1000
 

docker/logical-backup/dump.sh

@@ -7,7 +7,7 @@ set -o pipefail
 IFS=$'\n\t'
 
 # make script trace visible via `kubectl logs`
-set -o xtrace 
+set -o xtrace
 
 ALL_DB_SIZE_QUERY="select sum(pg_database_size(datname)::numeric) from pg_database;"
 PG_BIN=$PG_DIR/$PG_VERSION/bin
@@ -35,7 +35,7 @@ function aws_upload {
 
     # mimic bucket setup from Spilo
     # to keep logical backups at the same path as WAL
-    # NB: $LOGICAL_BACKUP_S3_BUCKET_SCOPE_SUFFIX already contains the leading "/" when set by the Postgres operator
+    # NB: $LOGICAL_BACKUP_S3_BUCKET_SCOPE_SUFFIX already contains the leading "/" when set by the Postgres Operator
     PATH_TO_BACKUP=s3://$LOGICAL_BACKUP_S3_BUCKET"/spilo/"$SCOPE$LOGICAL_BACKUP_S3_BUCKET_SCOPE_SUFFIX"/logical_backups/"$(date +%s).sql.gz
 
     if [ -z "$EXPECTED_SIZE" ]; then