Skip to content

Commit 2d8aed3

Browse files
Merge pull request #198 from xenophenes/master
Updates to Hugo server
2 parents 58a65be + b244b43 commit 2d8aed3

File tree

32 files changed

+819
-218
lines changed

32 files changed

+819
-218
lines changed

README.adoc

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

README.asciidoc

Lines changed: 0 additions & 55 deletions
This file was deleted.

docs/404.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@
6161
</div>
6262

6363
<ul class="topics">
64+
<li data-nav-id="/" class="dd-item">
65+
<a href="https://crunchydata.github.io/postgres-operator/"><i class="fa fa-fw fa-home"></i></a>
66+
</li>
6467
<li data-nav-id="/installation/" class="dd-item haschildren
6568
">
6669
<div>
@@ -112,6 +115,13 @@
112115
</li>
113116
</ul>
114117
</li>
118+
<li data-nav-id="/contributing/" class="dd-item
119+
">
120+
<div>
121+
<a href="https://crunchydata.github.io/postgres-operator/contributing/">Contributing</a>
122+
123+
</div>
124+
</li>
115125
<li data-nav-id="/how-it-works/" class="dd-item
116126
">
117127
<div>
@@ -133,6 +143,7 @@
133143
<li class="" role=""><h3>More</h3><a href="https://github.com/CrunchyData/postgres-operator" target="_blank" rel="noopener"><i class='fa fa-github'></i> <label>Github repo</label></a></li>
134144
<li class="" role=""><a href="https://github.com/CrunchyData/postgres-operator/releases/download/2.6/postgres-operator.2.6.tar.gz" target="_blank" rel="noopener"><i class='fa fa-cloud-download'></i> <label>Download</label></a></li>
135145
<li class="" role=""><a href="https://kubernetes.io/docs/" target="_blank" rel="noopener"><i class='fa fa-bookmark'></i> <label>Kubernetes Documentation</label></a></li>
146+
<li class="" role=""><a href="https://github.com/CrunchyData/postgres-operator/blob/master/LICENSE.md" target="_blank" rel="noopener"><i class='fa fa-file'></i> <label>License</label></a></li>
136147
</section>
137148

138149
<hr />

docs/categories/index.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@
6161
</div>
6262

6363
<ul class="topics">
64+
<li data-nav-id="/" class="dd-item">
65+
<a href="https://crunchydata.github.io/postgres-operator/"><i class="fa fa-fw fa-home"></i></a>
66+
</li>
6467
<li data-nav-id="/installation/" class="dd-item haschildren
6568
">
6669
<div>
@@ -112,6 +115,13 @@
112115
</li>
113116
</ul>
114117
</li>
118+
<li data-nav-id="/contributing/" class="dd-item
119+
">
120+
<div>
121+
<a href="https://crunchydata.github.io/postgres-operator/contributing/">Contributing</a>
122+
123+
</div>
124+
</li>
115125
<li data-nav-id="/how-it-works/" class="dd-item
116126
">
117127
<div>
@@ -133,6 +143,7 @@
133143
<li class="" role=""><h3>More</h3><a href="https://github.com/CrunchyData/postgres-operator" target="_blank" rel="noopener"><i class='fa fa-github'></i> <label>Github repo</label></a></li>
134144
<li class="" role=""><a href="https://github.com/CrunchyData/postgres-operator/releases/download/2.6/postgres-operator.2.6.tar.gz" target="_blank" rel="noopener"><i class='fa fa-cloud-download'></i> <label>Download</label></a></li>
135145
<li class="" role=""><a href="https://kubernetes.io/docs/" target="_blank" rel="noopener"><i class='fa fa-bookmark'></i> <label>Kubernetes Documentation</label></a></li>
146+
<li class="" role=""><a href="https://github.com/CrunchyData/postgres-operator/blob/master/LICENSE.md" target="_blank" rel="noopener"><i class='fa fa-file'></i> <label>License</label></a></li>
136147
</section>
137148

138149
<hr />

0 commit comments

Comments
 (0)