Skip to content

Update README.asciidoc #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 22, 2017
Merged

Update README.asciidoc #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 25 additions & 6 deletions README.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
== Crunchy Postgres Operator
== PostgreSQL Operator
v1.0.0, {docdate}

image::docs/crunchy_logo.png?raw=true[]
# Overview

Crunchy's Postgres Operator provides a Kubernetes operator capability
for managing PostgreSQL containers deployed within a Kubernetes cluster.
The PostgreSQL Operator provides a Kubernetes operator capability for managing PostgreSQL Databases and Clusters deployed within a Kubernetes.

# Usage
The PostgreSQL Operator leverages a Kubernetes Third Party Resources in order to define custom Kubernetes objects such as 'Database Name' and 'Cluster Name'.

Once those custom objects are defined, Kubernetes provides the ability to create and manage those objects similar to any other native Kubernetes object.

The PostgreSQL Operator runs within Kubernetes enabling Kubernetes to detect these new custom object types being created or removed.

Once the objects are detected, the PostgreSQL Operator enables useres to perform operations across the Kubernetes environment, including

* Create Database or Cluster
* Destroy Database or Cluster
* Backup Database or Cluster
* Restore Database or Cluster
* View PVC

# Requirements

* Kubernetes 1.5.3+
* [TO CONFIRM]


# Example Commands Usage

Some examples of using the command line interface:

Expand Down Expand Up @@ -124,7 +143,7 @@ docker images | grep operator
....


==== Deploy the postgres Operator
==== Deploy the PostgreSQL Operator
note that this will create and use */data* on your
local system as the persistent store for the operator to use
for its persistent volume:
Expand Down