|
1 |
| ---- |
2 |
| -title: "Crunchy Data PostgreSQL Operator" |
3 |
| -date: 2018-04-23T14:52:09-07:00 |
4 |
| -draft: false |
5 |
| ---- |
| 1 | +image::crunchy_logo.png[Crunchy Data Logo] |
6 | 2 |
|
7 |
| -image::crunchy_logo.png[Crunchy Data Logo,width="25%",height="25%", align="center"] |
| 3 | +Latest Release: v3.0, {docdate} |
8 | 4 |
|
9 |
| -v2.6, {docdate} |
| 5 | +== General |
10 | 6 |
|
11 |
| -== Documentation |
| 7 | +The *postgres-operator* is a controller that runs within a Kubernetes cluster that provides a means to deploy and manage PostgreSQL clusters. |
12 | 8 |
|
13 | 9 | Please view the official Crunchy Data PostgreSQL Operator documentation link:https://crunchydata.github.io/postgres-operator/[here]. If you are
|
14 | 10 | interested in contributing or making an update to the documentation, please view the link:https://crunchydata.github.io/postgres-operator/contributing/[Contributing Guidelines].
|
15 | 11 |
|
16 |
| -== What is the Operator? |
17 |
| - |
18 |
| -The *postgres-operator* is a controller that runs within a Kubernetes cluster that provides a means to deploy and manage PostgreSQL clusters. |
19 |
| - |
20 |
| -Use the postgres-operator to - |
21 |
| - |
22 |
| - * deploy PostgreSQL containers including streaming replication clusters |
23 |
| - * scale up PostgreSQL clusters with extra replicas |
24 |
| - * add pgpool and metrics sidecars to PostgreSQL clusters |
25 |
| - * apply SQL policies to PostgreSQL clusters |
26 |
| - * assign metadata tags to PostgreSQL clusters |
27 |
| - * maintain PostgreSQL users and passwords |
28 |
| - * perform minor and major upgrades to PostgreSQL clusters |
29 |
| - * load simple CSV and JSON files into PostgreSQL clusters |
30 |
| - * perform database backups |
31 |
| - |
32 |
| -== Design |
33 |
| - |
34 |
| -The *postgres-operator* design incorporates the following concepts - |
35 |
| - |
36 |
| - * adds Custom Resource Definitions for PostgreSQL to Kubernetes |
37 |
| - * adds controller logic that watches events on PostgreSQL resources |
38 |
| - * provides a command line client (*pgo*) and REST API for interfacing with the postgres-operator |
39 |
| - * provides for very customized deployments including container resources, storage configurations, and PostgreSQL custom configurations |
40 |
| - |
41 |
| -More design information is found on the link:https://crunchydata.github.io/postgres-operator/how-it-works/[How It Works] page. |
42 |
| - |
43 |
| -== Requirements |
44 |
| - |
45 |
| -The postgres-operator runs on any Kubernetes and Openshift platform that supports |
46 |
| -Custom Resource Definitions. |
47 |
| - |
48 |
| -The Operator project builds and operates with the following containers - |
49 |
| - |
50 |
| -* link:https://hub.docker.com/r/crunchydata/pgo-lspvc/[PVC Listing Container] |
51 |
| -* link:https://hub.docker.com/r/crunchydata/pgo-rmdata/[Remove Data Container] |
52 |
| -* link:https://hub.docker.com/r/crunchydata/postgres-operator/[postgres-operator Container] |
53 |
| -* link:https://hub.docker.com/r/crunchydata/pgo-apiserver/[apiserver Container] |
54 |
| -* link:https://hub.docker.com/r/crunchydata/pgo-load/[file load Container] |
55 |
| - |
56 |
| -This Operator is developed and tested on the following operating systems but is known to run on other operating systems - |
57 |
| - |
58 |
| -* *CentOS 7* |
59 |
| -* *RHEL 7* |
| 12 | +[link=https://crunchydata.github.io/postgres-operator/] |
| 13 | +image::btn.png[Official Documentation] |
60 | 14 |
|
61 | 15 | == Installation
|
62 | 16 |
|
63 | 17 | To build and deploy the Operator on your Kubernetes system, follow the instructions documented on the link:https://crunchydata.github.io/postgres-operator/installation/[Installation] page.
|
64 | 18 |
|
65 | 19 | If you're seeking to upgrade your existing Operator installation, please visit the link:https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/[Upgrading the Operator] page.
|
66 | 20 |
|
| 21 | +More design information is found on the link:https://crunchydata.github.io/postgres-operator/how-it-works/[How It Works] page. |
| 22 | + |
67 | 23 | == Configuration
|
68 | 24 |
|
69 | 25 | The operator is template-driven; this makes it simple to configure both the client and the operator. The configuration options are documented on the link:https://crunchydata.github.io/postgres-operator/installation/configuration/[Configuration] page.
|
|
0 commit comments