DOC: Fix formatting of bullet points
This commit is contained in:
		
							parent
							
								
									fa4bc21538
								
							
						
					
					
						commit
						cb53117464
					
				|  | @ -195,12 +195,14 @@ from numerous escape characters in the latter log entry, view it in CLI with | |||
| used internally in K8s. | ||||
| 
 | ||||
| The StatefulSet is replaced if the following properties change: | ||||
| 
 | ||||
| - annotations | ||||
| - volumeClaimTemplates | ||||
| - template volumes | ||||
| 
 | ||||
| The StatefulSet is replaced and a rolling updates is triggered if the following | ||||
| properties differ between the old and new state: | ||||
| 
 | ||||
| - container name, ports, image, resources, env, envFrom, securityContext and volumeMounts | ||||
| - template labels, annotations, service account, securityContext, affinity, priority class and termination grace period | ||||
| 
 | ||||
|  | @ -898,6 +900,7 @@ services: | |||
| There are multiple options to specify service annotations that will be merged | ||||
| with each other and override in the following order (where latter take | ||||
| precedence): | ||||
| 
 | ||||
| 1. Default annotations if LoadBalancer is enabled | ||||
| 2. Globally configured `custom_service_annotations` | ||||
| 3. `serviceAnnotations` specified in the cluster manifest | ||||
|  |  | |||
|  | @ -16,7 +16,7 @@ under the ~/go/src sub directories. | |||
| 
 | ||||
| Given the schema above, the Postgres Operator source code located at | ||||
| `github.com/zalando/postgres-operator` should be put at | ||||
| -`~/go/src/github.com/zalando/postgres-operator`. | ||||
| `~/go/src/github.com/zalando/postgres-operator`. | ||||
| 
 | ||||
| ```bash | ||||
| export GOPATH=~/go | ||||
|  | @ -105,6 +105,7 @@ and K8s-like APIs for its custom resource definitions, namely the | |||
| Postgres CRD and the operator CRD. The usage of the code generation follows | ||||
| conventions from the K8s community. Relevant scripts live in the `hack` | ||||
| directory: | ||||
| 
 | ||||
| * `update-codegen.sh` triggers code generation for the APIs defined in `pkg/apis/acid.zalan.do/`, | ||||
| * `verify-codegen.sh` checks if the generated code is up-to-date (to be used within CI). | ||||
| 
 | ||||
|  | @ -112,6 +113,7 @@ The `/pkg/generated/` contains the resultant code. To make these scripts work, | |||
| you may need to `export GOPATH=$(go env GOPATH)` | ||||
| 
 | ||||
| References for code generation are: | ||||
| 
 | ||||
| * [Relevant pull request](https://github.com/zalando/postgres-operator/pull/369) | ||||
| See comments there for minor issues that can sometimes broke the generation process. | ||||
| * [Code generator source code](https://github.com/kubernetes/code-generator) | ||||
|  | @ -315,6 +317,7 @@ precedence. | |||
| 
 | ||||
| Update the following Go files that obtain the configuration parameter from the | ||||
| manifest files: | ||||
| 
 | ||||
| * [operator_configuration_type.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/operator_configuration_type.go) | ||||
| * [operator_config.go](https://github.com/zalando/postgres-operator/blob/master/pkg/controller/operator_config.go) | ||||
| * [config.go](https://github.com/zalando/postgres-operator/blob/master/pkg/util/config/config.go) | ||||
|  | @ -323,6 +326,7 @@ Postgres manifest parameters are defined in the [api package](https://github.com | |||
| The operator behavior has to be implemented at least in [k8sres.go](https://github.com/zalando/postgres-operator/blob/master/pkg/cluster/k8sres.go). | ||||
| Validation of CRD parameters is controlled in [crds.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/crds.go). | ||||
| Please, reflect your changes in tests, for example in: | ||||
| 
 | ||||
| * [config_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/util/config/config_test.go) | ||||
| * [k8sres_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/cluster/k8sres_test.go) | ||||
| * [util_test.go](https://github.com/zalando/postgres-operator/blob/master/pkg/apis/acid.zalan.do/v1/util_test.go) | ||||
|  | @ -330,6 +334,7 @@ Please, reflect your changes in tests, for example in: | |||
| ### Updating manifest files | ||||
| 
 | ||||
| For the CRD-based configuration, please update the following files: | ||||
| 
 | ||||
| * the default [OperatorConfiguration](https://github.com/zalando/postgres-operator/blob/master/manifests/postgresql-operator-default-configuration.yaml) | ||||
| * the CRD's [validation](https://github.com/zalando/postgres-operator/blob/master/manifests/operatorconfiguration.crd.yaml) | ||||
| * the CRD's validation in the [Helm chart](https://github.com/zalando/postgres-operator/blob/master/charts/postgres-operator/crds/operatorconfigurations.yaml) | ||||
|  | @ -342,6 +347,7 @@ Last but no least, update the [ConfigMap](https://github.com/zalando/postgres-op | |||
| 
 | ||||
| Finally, add a section for each new configuration option and/or cluster manifest | ||||
| parameter in the reference documents: | ||||
| 
 | ||||
| * [config reference](reference/operator_parameters.md) | ||||
| * [manifest reference](reference/cluster_manifest.md) | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue