Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: "Crunchy Data PostgreSQL Operator"
date: 2018-04-23T14:52:09-07:00
draft: false
---

image::crunchy_logo.png[Crunchy Data Logo,width="25%",height="25%", align="center"]
= PostgreSQL Operator

v2.6, {docdate}

== Documentation

Please view the official Crunchy Data PostgreSQL Operator documentation link:https://crunchydata.github.io/postgres-operator/[here]. If you are
interested in contributing or making an update to the documentation, please view the link:https://crunchydata.github.io/postgres-operator/contributing/[Contributing Guidelines].

== What is the Operator?

The *postgres-operator* is a controller that runs within a Kubernetes cluster that provides a means to deploy and manage PostgreSQL clusters.

Use the postgres-operator to -

* deploy PostgreSQL containers including streaming replication clusters
* scale up PostgreSQL clusters with extra replicas
* add pgpool and metrics sidecars to PostgreSQL clusters
* apply SQL policies to PostgreSQL clusters
* assign metadata tags to PostgreSQL clusters
* maintain PostgreSQL users and passwords
* perform minor and major upgrades to PostgreSQL clusters
* load simple CSV and JSON files into PostgreSQL clusters
* perform database backups

== Design

The *postgres-operator* design incorporates the following concepts -

* adds Custom Resource Definitions for PostgreSQL to Kubernetes
* adds controller logic that watches events on PostgreSQL resources
* provides a command line client (*pgo*) and REST API for interfacing with the postgres-operator
* provides for very customized deployments including container resources, storage configurations, and PostgreSQL custom configurations

More design information is found on the link:https://crunchydata.github.io/postgres-operator/how-it-works/[How It Works] page.

== Requirements

The postgres-operator runs on any Kubernetes and Openshift platform that supports
Custom Resource Definitions.

The Operator project builds and operates with the following containers -

* link:https://hub.docker.com/r/crunchydata/pgo-lspvc/[PVC Listing Container]
* link:https://hub.docker.com/r/crunchydata/pgo-rmdata/[Remove Data Container]
* link:https://hub.docker.com/r/crunchydata/postgres-operator/[postgres-operator Container]
* link:https://hub.docker.com/r/crunchydata/pgo-apiserver/[apiserver Container]
* link:https://hub.docker.com/r/crunchydata/pgo-load/[file load Container]

This Operator is developed and tested on the following operating systems but is known to run on other operating systems -

* *CentOS 7*
* *RHEL 7*

== Installation

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.

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.

== Configuration

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.

== Getting Started

*postgres-operator* commands are documented on the link:https://crunchydata.github.io/postgres-operator/getting-started/[Getting Started] page.
55 changes: 0 additions & 55 deletions README.asciidoc

This file was deleted.

11 changes: 11 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@
</div>

<ul class="topics">
<li data-nav-id="/" class="dd-item">
<a href="https://crunchydata.github.io/postgres-operator/"><i class="fa fa-fw fa-home"></i></a>
</li>
<li data-nav-id="/installation/" class="dd-item haschildren
">
<div>
Expand Down Expand Up @@ -112,6 +115,13 @@
</li>
</ul>
</li>
<li data-nav-id="/contributing/" class="dd-item
">
<div>
<a href="https://crunchydata.github.io/postgres-operator/contributing/">Contributing</a>

</div>
</li>
<li data-nav-id="/how-it-works/" class="dd-item
">
<div>
Expand All @@ -133,6 +143,7 @@
<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>
<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>
<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>
<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>
</section>

<hr />
Expand Down
11 changes: 11 additions & 0 deletions docs/categories/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@
</div>

<ul class="topics">
<li data-nav-id="/" class="dd-item">
<a href="https://crunchydata.github.io/postgres-operator/"><i class="fa fa-fw fa-home"></i></a>
</li>
<li data-nav-id="/installation/" class="dd-item haschildren
">
<div>
Expand Down Expand Up @@ -112,6 +115,13 @@
</li>
</ul>
</li>
<li data-nav-id="/contributing/" class="dd-item
">
<div>
<a href="https://crunchydata.github.io/postgres-operator/contributing/">Contributing</a>

</div>
</li>
<li data-nav-id="/how-it-works/" class="dd-item
">
<div>
Expand All @@ -133,6 +143,7 @@
<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>
<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>
<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>
<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>
</section>

<hr />
Expand Down
Loading