From 429ae360dbf9633da450218333fc844517a7b130 Mon Sep 17 00:00:00 2001 From: Felix Kunde Date: Mon, 1 Apr 2019 15:24:06 +0200 Subject: [PATCH] fix typos and cluster creation description --- docs/administrator.md | 6 +++--- docs/developer.md | 6 +++--- docs/quickstart.md | 11 ++++++----- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/administrator.md b/docs/administrator.md index 095a26364..32a749e36 100644 --- a/docs/administrator.md +++ b/docs/administrator.md @@ -24,9 +24,9 @@ If you prefer to build the image yourself follow up down below. ### - Helm chart -You can install postgres-operator with also with a [Helm](https://helm.sh/) -chart. This requires installing the Helm CLI, first and then initializing it -in the cluster. +You can install postgres-operator also with a [Helm](https://helm.sh/) chart. +This requires installing the Helm CLI first and then initializing it in the +cluster. ```bash $ helm init diff --git a/docs/developer.md b/docs/developer.md index 760caeae1..294d06ebf 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -47,9 +47,9 @@ If you prefer to build the image yourself follow up down below. ### - Helm chart -You can install postgres-operator with also with a [Helm](https://helm.sh/) -chart. This requires installing the Helm CLI, first and then initializing it -in the cluster. +You can install postgres-operator also with a [Helm](https://helm.sh/) chart. +This requires installing the Helm CLI first and then initializing it in the +cluster. ```bash $ helm init diff --git a/docs/quickstart.md b/docs/quickstart.md index bf6c7481a..244f45b54 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -11,7 +11,7 @@ for Mac to follow the steps of this tutorial. You would have to replace `minikube start` and `minikube delete` with your launch actions for the Docker built-in Kubernetes support. -Clone the the repository and change to the directory. Then start minikube. +Clone the repository and change to the directory. Then start minikube. ```bash git clone https://github.com/zalando/postgres-operator.git @@ -60,12 +60,13 @@ kubectl get pod -l app.kubernetes.io/name=postgres-operator kubectl create -f manifests/minimal-postgres-manifest.yaml ``` -After the cluster manifest is submitted a StatefulSet will be created which -rolls out the database instances (Pods and Services). They are named like the +After the cluster manifest is submitted the operator will create Service and +Endpoint resources and a StatefulSet which spins up new Pod(s) given the number +of instances specified in the manifest. All resources are named like the cluster. The database pods can be identified by their number suffix, starting from `-0`. They run the [Spilo](https://github.com/zalando/spilo) container -image by Zalando. As for the service resources, there will be one for the master -pod and another one for all the replicas (`-repl` suffix). Check if all +image by Zalando. As for the services and endpoints, there will be one for the +master pod and another one for all the replicas (`-repl` suffix). Check if all components are coming up. Use the label `application=spilo` to filter and list the label `spilo-role` to see who is currently the master.