Docs/reference (#323)

Document operator command-line options and environment variables.
This commit is contained in:
Oleksii Kliukin
2018-06-12 19:12:11 +02:00
committed by zerg-junior
parent b518a31d0c
commit 5d02c57e04
11 changed files with 187 additions and 71 deletions
+19 -6
View File
@@ -26,6 +26,20 @@ manages PostgreSQL clusters on Kubernetes:
3. Finally, the operator periodically synchronizes the actual state of each
Postgres cluster with the desired state defined in the cluster's manifest.
There is a browser-friendly version of this documentation at
[postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io)
## 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 the document is a tutorial to get you up and running with the operator on Minikube.
## Quickstart
@@ -34,6 +48,11 @@ Prerequisites:
* [minikube](https://github.com/kubernetes/minikube/releases)
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-binary-via-curl)
Note that you can also use built-in Kubernetes support in the Docker Desktop
for Mac to follow the steps of this tutorial. You would have to replace
`minikube start` and `minikube delete` with your launch actionsfor the Docker
built-in Kubernetes support.
### Local execution
```bash
@@ -77,10 +96,4 @@ Minikube is a tool to run Kubernetes cluster locally.
The operator can be configured with the provided ConfigMap (`manifests/configmap.yaml`).
## Table of contents
* [concepts](docs/concepts.md)
* [user documentation](docs/user.md)
* [administrator documentation](docs/administrator.md)
* [developer documentation](docs/developer.md)
* [reference](docs/reference.md)