Merge branch 'master' into default-db-roles

docs/administrator.md

@@ -458,6 +458,17 @@ from numerous escape characters in the latter log entry, view it in CLI with
 `PodTemplate` used by the operator is yet to be updated with the default values
 used internally in K8s.
 
+The operator also support lazy updates of the Spilo image. That means the pod
+template of a PG cluster's stateful set is updated immediately with the new
+image, but no rolling update follows. This feature saves you a switchover - and
+hence downtime - when you know pods are re-started later anyway, for instance
+due to the node rotation. To force a rolling update, disable this mode by
+setting the `enable_lazy_spilo_upgrade` to `false` in the operator configuration
+and restart the operator pod. With the standard eager rolling updates the
+operator checks during Sync all pods run images specified in their respective
+statefulsets. The operator triggers a rolling upgrade for PG clusters that
+violate this condition.
+
 ## Logical backups
 
 The operator can manage K8s cron jobs to run logical backups of Postgres
@@ -509,9 +520,8 @@ A secret can be pre-provisioned in different ways:
 
 ## Sidecars for Postgres clusters
 
-A list of sidecars is added to each cluster created by the
-operator. The default is empty list.
-
+A list of sidecars is added to each cluster created by the operator. The default
+is empty.
 
 ```yaml
 kind: OperatorConfiguration
@@ -527,7 +537,8 @@ configuration:
   - ...
 ```
 
-In addition to any environment variables you specify, the following environment variables are always passed to sidecars:
+In addition to any environment variables you specify, the following environment
+variables are always passed to sidecars:
 
   - `POD_NAME` - field reference to `metadata.name`
   - `POD_NAMESPACE` - field reference to `metadata.namespace`

docs/reference/command_line_and_environment.md

@@ -45,7 +45,7 @@ The following environment variables are accepted by the operator:
   all namespaces. Empty value defaults to the operator namespace. Overrides the
   `watched_namespace` operator parameter.
 
-* **SCALYR_API_KEY**
+* **SCALYR_API_KEY** (*deprecated*)
   the value of the Scalyr API key to supply to the pods. Overrides the
   `scalyr_api_key` operator parameter.
 

docs/reference/operator_parameters.md

@@ -75,6 +75,10 @@ Those are top-level keys, containing both leaf keys and groups.
   [OpenAPI v3 schema validation](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#validation)
   The default is `true`.
 
+* **enable_lazy_spilo_upgrade**
+  Instruct operator to update only the statefulsets with the new image without immediately doing the rolling update. The assumption is pods will be re-started later with the new image, for example due to the node rotation.
+  The default is `false`.
+
 * **etcd_host**
   Etcd connection string for Patroni defined as `host:port`. Not required when
   Patroni native Kubernetes support is used. The default is empty (use
@@ -93,17 +97,18 @@ Those are top-level keys, containing both leaf keys and groups.
   repository](https://github.com/zalando/spilo).
 
 * **sidecar_docker_images**
-  *deprecated*: use **sidecars** instead. A map of sidecar names to Docker images to 
-  run with Spilo. In case of the name conflict with the definition in the cluster 
-  manifest the cluster-specific one is preferred.
+  *deprecated*: use **sidecars** instead. A map of sidecar names to Docker
+  images to run with Spilo. In case of the name conflict with the definition in
+  the cluster manifest the cluster-specific one is preferred.
 
 * **sidecars**
-  a list of sidecars to run with Spilo, for any cluster (i.e. globally defined sidecars). 
-  Each item in the list is of type 
+  a list of sidecars to run with Spilo, for any cluster (i.e. globally defined
+  sidecars). Each item in the list is of type
   [Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).
-  Globally defined sidecars can be overwritten by specifying a sidecar in the custom resource with 
-  the same name. Note: This field is not part of the schema validation. If the container specification 
-  is invalid, then the operator fails to create the statefulset.
+  Globally defined sidecars can be overwritten by specifying a sidecar in the
+  Postgres manifest with the same name.
+  Note: This field is not part of the schema validation. If the container
+  specification is invalid, then the operator fails to create the statefulset.
 
 * **enable_shm_volume**
   Instruct operator to start any new database pod without limitations on shm
@@ -141,8 +146,8 @@ Those are top-level keys, containing both leaf keys and groups.
   at the cost of overprovisioning memory and potential scheduling problems for
   containers with high memory limits due to the lack of memory on Kubernetes
   cluster nodes. This affects all containers created by the operator (Postgres,
-  Scalyr sidecar, and other sidecars except **sidecars** defined in the operator 
-  configuration); to set resources for the operator's own container, change the 
+  Scalyr sidecar, and other sidecars except **sidecars** defined in the operator
+  configuration); to set resources for the operator's own container, change the
   [operator deployment manually](../../manifests/postgres-operator.yaml#L20).
   The default is `false`.
 
@@ -215,12 +220,13 @@ configuration they are grouped under the `kubernetes` key.
   Default is true.
 
 * **enable_init_containers**
-  global option to allow for creating init containers in the cluster manifest to 
+  global option to allow for creating init containers in the cluster manifest to
   run actions before Spilo is started. Default is true.
 
 * **enable_sidecars**
-  global option to allow for creating sidecar containers in the cluster manifest 
-  to run alongside Spilo on the same pod. Globally defined sidecars are always enabled. Default is true.
+  global option to allow for creating sidecar containers in the cluster manifest
+  to run alongside Spilo on the same pod. Globally defined sidecars are always
+  enabled. Default is true.
 
 * **secret_name_template**
   a template for the name of the database user secrets generated by the
@@ -585,11 +591,12 @@ configuration they are grouped under the `logging_rest_api` key.
 * **cluster_history_entries**
   number of entries in the cluster history ring buffer. The default is `1000`.
 
-## Scalyr options
+## Scalyr options (*deprecated*)
 
 Those parameters define the resource requests/limits and properties of the
 scalyr sidecar. In the CRD-based configuration they are grouped under the
-`scalyr` key.
+`scalyr` key. Note, that this section is deprecated. Instead, define Scalyr as
+a global sidecar under the `sidecars` key in the configuration.
 
 * **scalyr_api_key**
   API key for the Scalyr sidecar. The default is empty.