Skip to content

Commit 9575c9d

Browse files
author
Sergey Dudoladov
committed
Create Quickstart section for the docs
1 parent 545d5d9 commit 9575c9d

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,36 @@ Update example: After changing the Docker image inside the operator's configurat
2626
it manages and updates them with the new Docker image; afterwards, all pods from each StatefulSet are killed one by one
2727
and the replacements are spawned automatically by each StatefulSet with the new Docker image. This is called the Rolling update.
2828

29+
30+
## Quickstart
31+
32+
Prerequisites: [minikube](https://github.com/kubernetes/minikube/releases) and [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-binary-via-native-package-management)
33+
34+
### Local execution
35+
36+
```bash
37+
git clone https://github.com/zalando-incubator/postgres-operator.git
38+
cd postgres-operator
39+
40+
minikube start
41+
kubectl config set-context minikube
42+
43+
kubectl create -f manifests/configmap.yaml # operator config
44+
kubectl create -f manifests/serviceaccount.yaml # operator pod identity
45+
kubectl create -f manifests/postgres-operator.yaml # start the operator
46+
47+
# startup may last a few seconds
48+
49+
kubectl create -f manifests/minimal-postgres-manifest.yaml # submit a PG cluster
50+
minikube delete # tear down cleanly
51+
```
52+
53+
We have automated these steps for you:
54+
```bash
55+
cd postgres-operator
56+
./run_operator_locally.sh
57+
```
58+
2959
## Scope
3060

3161
The scope of the postgres operator is on provisioning, modifying configuration and cleaning up Postgres clusters that use Patroni, basically to make it easy and convenient to run Patroni based clusters on Kubernetes.

0 commit comments

Comments
 (0)