Skip to content

Commit 403fc12

Browse files
author
Jeff McCormick
committed
Merge branch 'master' into pre27
Conflicts: README.asciidoc docs/build.asciidoc docs/gke-notes.asciidoc docs/install.asciidoc docs/operator-testing.asciidoc hugo/content/getting-started/_index.adoc hugo/content/installation/configuration.adoc hugo/content/installation/quick-installation.adoc
2 parents cc3ec40 + d854090 commit 403fc12

File tree

613 files changed

+90851
-964
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

613 files changed

+90851
-964
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.

‎crunchy_logo.png‎

201 KB
Loading

‎docs/404.html‎

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>Crunchy Data PostgreSQL Operator Documentation</title>
5+
6+
<meta charset="utf-8">
7+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
8+
<meta name="generator" content="Hugo 0.40" />
9+
10+
<title>404 Page not found :: Crunchy Data PostgreSQL Operator Documentation</title>
11+
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />
12+
<link href="https://crunchydata.github.io/postgres-operator/css/nucleus.css" rel="stylesheet">
13+
<link href="https://crunchydata.github.io/postgres-operator/css/font-awesome.min.css" rel="stylesheet">
14+
<link href="https://crunchydata.github.io/postgres-operator/css/hybrid.css" rel="stylesheet">
15+
<link href="https://crunchydata.github.io/postgres-operator/css/featherlight.min.css" rel="stylesheet">
16+
<link href="https://crunchydata.github.io/postgres-operator/css/auto-complete.css" rel="stylesheet">
17+
<link href="https://crunchydata.github.io/postgres-operator/theme-original/style.css" rel="stylesheet">
18+
19+
<link rel="stylesheet" href="https://crunchydata.github.io/postgres-operator/css/bootstrap.min.css">
20+
<script src="https://crunchydata.github.io/postgres-operator/js/jquery-2.x.min.js"></script>
21+
<style type="text/css">
22+
:root #header + #content > #left > #rlblock_left {
23+
display:none !important;
24+
}
25+
</style>
26+
<meta name="description" content="">
27+
28+
29+
30+
</head>
31+
<body data-url="">
32+
33+
<div id="headermain"></div>
34+
<nav id="sidebar" class="">
35+
36+
37+
38+
<div class="highlightable">
39+
<div id="header-wrapper">
40+
<div id="header">
41+
42+
43+
44+
<a class="baselink" href="https://crunchydata.github.io/postgres-operator/">Crunchy Data PostgreSQL Operator Documentation</a>
45+
46+
47+
</div>
48+
<div class="searchbox">
49+
<label for="search-by"><i class="fa fa-search"></i></label>
50+
<input data-search-input id="search-by" type="text" placeholder="Search...">
51+
<span data-search-clear=""><i class="fa fa-close"></i></span>
52+
</div>
53+
<script type="text/javascript" src="https://crunchydata.github.io/postgres-operator/js/lunr.min.js"></script>
54+
<script type="text/javascript" src="https://crunchydata.github.io/postgres-operator/js/auto-complete.js"></script>
55+
<script type="text/javascript">
56+
57+
var baseurl = "https:\/\/crunchydata.github.io\/postgres-operator\/";
58+
59+
</script>
60+
<script type="text/javascript" src="https://crunchydata.github.io/postgres-operator/js/search.js"></script>
61+
</div>
62+
63+
<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>
67+
<li data-nav-id="/installation/" class="dd-item haschildren
68+
">
69+
<div>
70+
<a href="https://crunchydata.github.io/postgres-operator/installation/">Installation</a><i class="fa fa-angle-right fa-lg category-icon"></i>
71+
72+
</div>
73+
<ul>
74+
<li data-nav-id="/installation/quick-installation/" class="dd-item">
75+
<div>
76+
<a href="https://crunchydata.github.io/postgres-operator/installation/quick-installation/">
77+
Quick Installation
78+
</a>
79+
</div>
80+
</li>
81+
<li data-nav-id="/installation/manual-installation/" class="dd-item">
82+
<div>
83+
<a href="https://crunchydata.github.io/postgres-operator/installation/manual-installation/">
84+
Manual Installation
85+
</a>
86+
</div>
87+
</li>
88+
<li data-nav-id="/installation/helm-chart/" class="dd-item">
89+
<div>
90+
<a href="https://crunchydata.github.io/postgres-operator/installation/helm-chart/">
91+
Helm Chart
92+
</a>
93+
</div>
94+
</li>
95+
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
96+
<div>
97+
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
98+
Upgrading the Operator
99+
</a>
100+
</div>
101+
</li>
102+
<li data-nav-id="/installation/deployment/" class="dd-item">
103+
<div>
104+
<a href="https://crunchydata.github.io/postgres-operator/installation/deployment/">
105+
Deployment
106+
</a>
107+
</div>
108+
</li>
109+
<li data-nav-id="/installation/configuration/" class="dd-item">
110+
<div>
111+
<a href="https://crunchydata.github.io/postgres-operator/installation/configuration/">
112+
Configuration
113+
</a>
114+
</div>
115+
</li>
116+
</ul>
117+
</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>
125+
<li data-nav-id="/how-it-works/" class="dd-item
126+
">
127+
<div>
128+
<a href="https://crunchydata.github.io/postgres-operator/how-it-works/">How it Works</a>
129+
130+
</div>
131+
</li>
132+
<li data-nav-id="/getting-started/" class="dd-item
133+
">
134+
<div>
135+
<a href="https://crunchydata.github.io/postgres-operator/getting-started/">Getting Started</a>
136+
137+
</div>
138+
</li>
139+
140+
141+
142+
<section id="shortcuts">
143+
<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>
144+
<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>
145+
<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>
147+
</section>
148+
149+
<hr />
150+
<li></li>
151+
152+
</ul>
153+
154+
<section id="footer">
155+
</section>
156+
</div>
157+
</nav>
158+
159+
160+
161+
<section id="body">
162+
<div id="overlay"></div>
163+
<div class="padding highlightable">
164+
165+
<div id="top-bar">
166+
<div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
167+
<span id="sidebar-toggle-span">
168+
<a href="#" id="sidebar-toggle" data-sidebar-toggle="">
169+
<i class="fa fa-bars"></i>
170+
</a>
171+
</span>
172+
<span id="toc-menu"><i class="fa fa-list-alt"></i></span>
173+
<span class="links">
174+
175+
176+
404 Page not found
177+
178+
179+
</span>
180+
</div>
181+
182+
183+
<div class="progress">
184+
<div class="wrapper">
185+
186+
</div>
187+
</div>
188+
189+
190+
</div>
191+
192+
193+
<div id="body-inner">
194+
195+
<h1>404 Page not found</h1>
196+
197+
198+
199+
200+
201+
202+
<h1>Error</h1>
203+
<p>
204+
</p>
205+
<p>Woops. Looks like this page doesn&#39;t exist.</p>
206+
<p></p>
207+
<p><a href="https://crunchydata.github.io/postgres-operator/">Go to homepage</a></p>
208+
<p><img src="https://crunchydata.github.io/postgres-operator/images/gopher-404.jpg" style="width:50%"></img></p>
209+
210+
211+
<footer class=" footline" >
212+
213+
</footer>
214+
</div>
215+
</div>
216+
217+
<div id="navigation">
218+
</div>
219+
220+
</section>
221+
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
222+
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
223+
</div>
224+
225+
<script src="https://crunchydata.github.io/postgres-operator/js/clipboard.min.js"></script>
226+
<script src="https://crunchydata.github.io/postgres-operator/js/featherlight.min.js"></script>
227+
<script src="https://crunchydata.github.io/postgres-operator/js/html5shiv-printshiv.min.js"></script>
228+
229+
<script src="https://crunchydata.github.io/postgres-operator/js/modernizr.custom.71422.js"></script>
230+
<script src="https://crunchydata.github.io/postgres-operator/js/docdock.js"></script>
231+
<script src="https://crunchydata.github.io/postgres-operator/theme-original/script.js"></script>
232+
233+
234+
235+
236+
237+
238+
239+
240+
</body>
241+
</html>
242+
243+

0 commit comments

Comments
 (0)