|
8 | 8 |
|
9 | 9 | <img src="docs/diagrams/logo.png" width="200"> |
10 | 10 |
|
11 | | -## Introduction to the Postgres Operator |
| 11 | +The Postgres Operator enables highly-available [PostgreSQL](https://www.postgresql.org/) |
| 12 | +clusters on Kubernetes (K8s) powered by [Patroni](https://github.com/zalando/spilo). |
| 13 | +It is configured only through manifests to ease integration into automated CI/CD |
| 14 | +pipelines with no access to Kubernetes directly. |
12 | 15 |
|
13 | | -The Postgres [operator](https://coreos.com/blog/introducing-operators.html) |
14 | | -manages PostgreSQL clusters on Kubernetes: |
| 16 | +The Postgres Operator has been developed at Zalando and is being used in |
| 17 | +production for over two years. |
15 | 18 |
|
16 | | -1. The operator watches additions, updates, and deletions of PostgreSQL cluster |
17 | | - manifests and changes the running clusters accordingly. For example, when a |
18 | | - user submits a new manifest, the operator spawns a new Postgres cluster with |
19 | | - necessary entities such as StatefulSets, Services, and also Postgres roles. See this |
20 | | - [Postgres cluster manifest](manifests/complete-postgres-manifest.yaml) |
21 | | - for settings that a manifest may contain. |
| 19 | +## Getting started |
22 | 20 |
|
23 | | -2. The operator also watches updates to [its own configuration](manifests/configmap.yaml) |
24 | | - and alters running Postgres clusters if necessary. For instance, if a pod |
25 | | - Docker image is changed, the operator carries out the rolling update. That |
26 | | - is, the operator re-spawns one-by-one pods of each StatefulSet it manages |
27 | | - with the new Docker image. |
| 21 | +For a quick first impression follow the instructions of this |
| 22 | +[tutorial](docs/quickstart.md). |
28 | 23 |
|
29 | | -3. Finally, the operator periodically synchronizes the actual state of each |
30 | | - Postgres cluster with the desired state defined in the cluster's manifest. |
| 24 | +## Documentation |
31 | 25 |
|
32 | | -4. The operator aims to be hands free and configuration happens only via manifests and its own config. |
33 | | - This enables easy integration in automated deploy pipelines with no access to Kubernetes directly. |
| 26 | +There is a browser-friendly version of this documentation at |
| 27 | +[postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io) |
34 | 28 |
|
35 | | -# Getting started |
| 29 | +* [How it works](docs/index.md) |
| 30 | +* [The Postgres experience on K8s](docs/user.md) |
| 31 | +* [DBA options - from RBAC to backup](docs/administrator.md) |
| 32 | +* [Debug and extend the operator](docs/developer.md) |
| 33 | +* [Configuration options](docs/reference/operator_parameters.md) |
| 34 | +* [Postgres manifest reference](docs/reference/cluster_manifest.md) |
| 35 | +* [Command-line options and environment variables](docs/reference/command_line_and_environment.md) |
36 | 36 |
|
37 | | -For a quick first impression follow the instructions of [this](docs/quickstart.md) |
38 | | -tutorial. |
| 37 | +## Google Summer of Code |
39 | 38 |
|
40 | | -# Google Summer of Code |
| 39 | +The Postgres Operator made it to the [Google Summer of Code 2019](https://summerofcode.withgoogle.com/organizations/5429926902104064/)! |
| 40 | +Check [our ideas](docs/gsoc-2019/ideas.md#google-summer-of-code-2019) |
| 41 | +and start discussions in [the issue tracker](https://github.com/zalando/postgres-operator/issues). |
41 | 42 |
|
42 | | -The Postgres Operator made it to the [Google Summer of Code 2019](https://summerofcode.withgoogle.com/)! As a brand new mentoring organization, we are now looking for our first mentees. Check [our ideas](https://github.com/zalando/postgres-operator/blob/master/docs/gsoc-2019/ideas.md#google-summer-of-code-2019) and start discussion in [the issue tracker](https://github.com/zalando/postgres-operator/issues). And don't forget to spread a word about our GSoC participation to attract even more students. |
43 | | - |
44 | | -## Table of contents |
45 | | - |
46 | | -* [concepts](docs/index.md) |
47 | | -* [user documentation](docs/user.md) |
48 | | -* [administrator documentation](docs/administrator.md) |
49 | | -* [developer documentation](docs/developer.md) |
50 | | -* [operator configuration reference](docs/reference/operator_parameters.md) |
51 | | -* [cluster manifest reference](docs/reference/cluster_manifest.md) |
52 | | -* [command-line options and environment variables](docs/reference/command_line_and_environment.md) |
53 | | - |
54 | | -The rest of this document is a tutorial to get you up and running locally with the operator on Minikube. |
55 | | - |
56 | | -## Overview of involved entities |
57 | | - |
58 | | -Here is a diagram, that summarizes what would be created by the operator, when a |
59 | | -new Postgres cluster CRD is submitted: |
60 | | - |
61 | | - |
62 | | - |
63 | | -This picture is not complete without an overview of what is inside a single cluster pod, so |
64 | | -let's zoom in: |
65 | | - |
66 | | - |
67 | | - |
68 | | -These two diagrams should help you to understand the basics of what kind of |
69 | | -functionality the operator provides. |
70 | | - |
71 | | -There is a browser-friendly version of this documentation at [postgres-operator.readthedocs.io](https://postgres-operator.readthedocs.io) |
72 | | - |
73 | | -## Community |
| 43 | +## Community |
74 | 44 |
|
75 | 45 | There are two places to get in touch with the community: |
76 | 46 | 1. The [GitHub issue tracker](https://github.com/zalando/postgres-operator/issues) |
|
0 commit comments