@@ -93,17 +93,18 @@ Those are top-level keys, containing both leaf keys and groups.
9393  repository] ( https://github.com/zalando/spilo ) .
9494
9595*  ** sidecar_docker_images** 
96-   * deprecated* : use ** sidecars**  instead. A map of sidecar names to Docker images to  
97-   run with Spilo. In case of the name conflict with the definition in the cluster  
98-   manifest the cluster-specific one is preferred.
96+   * deprecated* : use ** sidecars**  instead. A map of sidecar names to Docker
97+   images to  run with Spilo. In case of the name conflict with the definition in
98+   the cluster  manifest the cluster-specific one is preferred.
9999
100100*  ** sidecars** 
101-   a list of sidecars to run with Spilo, for any cluster (i.e. globally defined sidecars).  
102-   Each item in the list is of type  
101+   a list of sidecars to run with Spilo, for any cluster (i.e. globally defined
102+   sidecars).  Each item in the list is of type
103103  [ Container] ( https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core ) .
104-   Globally defined sidecars can be overwritten by specifying a sidecar in the custom resource with 
105-   the same name. Note: This field is not part of the schema validation. If the container specification 
106-   is invalid, then the operator fails to create the statefulset.
104+   Globally defined sidecars can be overwritten by specifying a sidecar in the
105+   Postgres manifest with the same name.
106+   Note: This field is not part of the schema validation. If the container
107+   specification is invalid, then the operator fails to create the statefulset.
107108
108109*  ** enable_shm_volume** 
109110  Instruct operator to start any new database pod without limitations on shm
@@ -141,8 +142,8 @@ Those are top-level keys, containing both leaf keys and groups.
141142  at the cost of overprovisioning memory and potential scheduling problems for
142143  containers with high memory limits due to the lack of memory on Kubernetes
143144  cluster nodes. This affects all containers created by the operator (Postgres,
144-   Scalyr sidecar, and other sidecars except ** sidecars**  defined in the operator  
145-   configuration); to set resources for the operator's own container, change the  
145+   Scalyr sidecar, and other sidecars except ** sidecars**  defined in the operator
146+   configuration); to set resources for the operator's own container, change the
146147  [ operator deployment manually] ( ../../manifests/postgres-operator.yaml#L20 ) .
147148  The default is ` false ` .
148149
@@ -215,12 +216,13 @@ configuration they are grouped under the `kubernetes` key.
215216  Default is true.
216217
217218*  ** enable_init_containers** 
218-   global option to allow for creating init containers in the cluster manifest to  
219+   global option to allow for creating init containers in the cluster manifest to
219220  run actions before Spilo is started. Default is true.
220221
221222*  ** enable_sidecars** 
222-   global option to allow for creating sidecar containers in the cluster manifest 
223-   to run alongside Spilo on the same pod. Globally defined sidecars are always enabled. Default is true.
223+   global option to allow for creating sidecar containers in the cluster manifest
224+   to run alongside Spilo on the same pod. Globally defined sidecars are always
225+   enabled. Default is true.
224226
225227*  ** secret_name_template** 
226228  a template for the name of the database user secrets generated by the
@@ -585,11 +587,12 @@ configuration they are grouped under the `logging_rest_api` key.
585587* **cluster_history_entries** 
586588  number of entries in the cluster history ring buffer. The default is `1000`. 
587589
588- # # Scalyr options
590+ # # Scalyr options (*deprecated*) 
589591
590592Those parameters define the resource requests/limits and properties of the 
591593scalyr sidecar. In the CRD-based configuration they are grouped under the 
592- ` scalyr`   key. 
594+ ` scalyr`   key. Note, that this section is deprecated. Instead, define Scalyr as 
595+ a global sidecar under the `sidecars` key in the configuration. 
593596
594597* **scalyr_api_key** 
595598  API key for the Scalyr sidecar. The default is empty. 
0 commit comments