Skip to content

Commit cff09b5

Browse files
committed
update README, clipboard/code styles
1 parent 7ea23f0 commit cff09b5

File tree

5 files changed

+16
-154
lines changed

5 files changed

+16
-154
lines changed

Diff for: README.adoc

+8-52
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,25 @@
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]
62

7-
image::crunchy_logo.png[Crunchy Data Logo,width="25%",height="25%", align="center"]
3+
Latest Release: v3.0, {docdate}
84

9-
v2.6, {docdate}
5+
== General
106

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.
128

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

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]
6014

6115
== Installation
6216

6317
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.
6418

6519
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.
6620

21+
More design information is found on the link:https://crunchydata.github.io/postgres-operator/how-it-works/[How It Works] page.
22+
6723
== Configuration
6824

6925
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.

Diff for: README.asciidoc

-55
This file was deleted.

Diff for: btn.png

5.04 KB
Loading

Diff for: generate-docs.sh

-5
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,6 @@ cd ${COROOT?}/hugo/
2727
echo "Generating Hugo webpages..."
2828
hugo
2929

30-
# Copy README into main GitHub directory for those accessing the repository
31-
echo "Copying README into main GitHub repository..."
32-
rm -f ${COROOT?}/README.adoc
33-
cp ${COROOT?}/hugo/content/_index.adoc ${COROOT?}/README.adoc
34-
3530
# Add all changes and commit, push to GitHub
3631
echo "Updating GitHub repository..."
3732
git add --all && git commit -m "Publishing documentation"

Diff for: hugo/themes/docdock/static/theme-original/style.css

+8-42
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)