Merge branch 'develop' of github.com:crunchydata/postgres-operator into develop

Author: jmccormick2001

README.md

@@ -25,20 +25,20 @@ The Operator deploys on Kubernetes and Openshift clusters.  Some form of storage
 
 The Operator includes various components that get deployed to your
 Kubernetes cluster as shown in the following diagram and detailed
-in the [Design](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/design/).
+in the [Design](https://crunchydata.github.io/postgres-operator/stable/design/).
 
-![Reference](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/Operator-Architecture.png)
+![Reference](https://crunchydata.github.io/postgres-operator/stable/Operator-Architecture.png)
 
 The Operator is developed and tested on CentOS and RHEL linux platforms but is known to run on other Linux variants.
 
 ## Documentation
 The following documentation is provided:
 
- - [pgo CLI Syntax and Examples](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/operator-cli/)
- - [Installation](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/installation/)
- - [Configuration](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/configuration/configuration/)
- - [pgo.yaml Description](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/configuration/pgo-yaml-configuration/)
- - [Security](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/security/)
- - [Design Overview](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/design/)
- - [Developing](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/developer-setup/)
- - [Upgrading the Operator](https://access.crunchydata.com/documentation/postgres-operator/3.5.0/upgrade/)
+ - [pgo CLI Syntax and Examples](https://crunchydata.github.io/postgres-operator/stable/operator-cli/)
+ - [Installation](https://crunchydata.github.io/postgres-operator/stable/installation/)
+ - [Configuration](https://crunchydata.github.io/postgres-operator/stable/configuration/configuration/)
+ - [pgo.yaml Description](https://crunchydata.github.io/postgres-operator/stable/configuration/pgo-yaml-configuration/)
+ - [Security](https://crunchydata.github.io/postgres-operator/stable/security/)
+ - [Design Overview](https://crunchydata.github.io/postgres-operator/stable/design/)
+ - [Developing](https://crunchydata.github.io/postgres-operator/stable/developer-setup/)
+ - [Upgrading the Operator](https://crunchydata.github.io/postgres-operator/stable/upgrade/)

hugo/content/Installation/_index.md

@@ -41,6 +41,10 @@ Environment variables control aspects of the Operator installation.  You can cop
 
 For various scripts used by the Operator, the *expenv* utility is required, download
 this utility from the Github Releases page, and place it into your PATH (e.g. $HOME/odev/bin).
+{{% notice tip %}}There is also a Makefile target that includes is *expenv* and several other dependencies that are only needed if you plan on building from source: 
+
+    make setup
+{{% /notice %}}
 
 In this example set of environment variables, the CO_NAMESPACE environment variable is set to *demo* as an example namespace in which the Operator will be deployed.  See the Design section of documentation on the Operator namespace requirements.  
 

hugo/content/cli/pgo.md

@@ -0,0 +1,46 @@
+---
+title: "pgo"
+---
+## pgo
+
+The pgo command line interface.
+
+### Synopsis
+
+The pgo command line interface lets you create and manage PostgreSQL clusters.
+
+### Options
+
+```
+      --apiserver-url string     The URL for the PostgreSQL Operator apiserver.
+      --debug                    Enable debugging when true.
+  -h, --help                     help for pgo
+      --namespace string         The namespace to use for pgo requests.
+      --pgo-ca-cert string       The CA Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-cert string   The Client Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-key string    The Client Key file path for authenticating to the PostgreSQL Operator apiserver.
+```
+
+### SEE ALSO
+
+* [pgo apply](/commands/pgo_apply/)	 - Apply a policy
+* [pgo backup](/commands/pgo_backup/)	 - Perform a Backup
+* [pgo create](/commands/pgo_create/)	 - Create a Cluster, PGBouncer, PGPool, Policy, Schedule, or User
+* [pgo delete](/commands/pgo_delete/)	 - Delete a backup, cluster, pgbouncer, pgpool, label, policy, upgrade, or user
+* [pgo df](/commands/pgo_df/)	 - Display disk space for clusters
+* [pgo failover](/commands/pgo_failover/)	 - Performs a manual failover
+* [pgo label](/commands/pgo_label/)	 - Label a set of clusters
+* [pgo load](/commands/pgo_load/)	 - Perform a data load
+* [pgo reload](/commands/pgo_reload/)	 - Perform a cluster reload
+* [pgo restore](/commands/pgo_restore/)	 - Perform a restore from previous backup
+* [pgo scale](/commands/pgo_scale/)	 - Scale a PostgreSQL cluster
+* [pgo scaledown](/commands/pgo_scaledown/)	 - Scale down a PostgreSQL cluster
+* [pgo show](/commands/pgo_show/)	 - Show the description of a cluster
+* [pgo status](/commands/pgo_status/)	 - Display PostgreSQL cluster status
+* [pgo test](/commands/pgo_test/)	 - Test cluster connectivity
+* [pgo update](/commands/pgo_update/)	 - Update a cluster
+* [pgo upgrade](/commands/pgo_upgrade/)	 - Perform an upgrade
+* [pgo user](/commands/pgo_user/)	 - Manage PostgreSQL users
+* [pgo version](/commands/pgo_version/)	 - Print version information for the PostgreSQL Operator
+
+###### Auto generated by spf13/cobra on 21-Feb-2019

hugo/content/cli/pgo_apply.md

@@ -0,0 +1,43 @@
+---
+title: "pgo_apply"
+---
+## pgo apply
+
+Apply a policy
+
+### Synopsis
+
+APPLY allows you to apply a Policy to a set of clusters. For example:
+
+	pgo apply mypolicy1 --selector=name=mycluster
+	pgo apply mypolicy1 --selector=someotherpolicy
+	pgo apply mypolicy1 --selector=someotherpolicy --dry-run
+
+```
+pgo apply [flags]
+```
+
+### Options
+
+```
+      --dry-run           Shows the clusters that the label would be applied to, without labelling them.
+  -h, --help              help for apply
+  -s, --selector string   The selector to use for cluster filtering.
+```
+
+### Options inherited from parent commands
+
+```
+      --apiserver-url string     The URL for the PostgreSQL Operator apiserver.
+      --debug                    Enable debugging when true.
+      --namespace string         The namespace to use for pgo requests.
+      --pgo-ca-cert string       The CA Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-cert string   The Client Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-key string    The Client Key file path for authenticating to the PostgreSQL Operator apiserver.
+```
+
+### SEE ALSO
+
+* [pgo](/commands/pgo/)	 - The pgo command line interface.
+
+###### Auto generated by spf13/cobra on 21-Feb-2019

hugo/content/cli/pgo_backup.md

@@ -0,0 +1,44 @@
+---
+title: "pgo_backup"
+---
+## pgo backup
+
+Perform a Backup
+
+### Synopsis
+
+BACKUP performs a Backup, for example:
+
+  pgo backup mycluster
+
+```
+pgo backup [flags]
+```
+
+### Options
+
+```
+      --backup-opts string      The pgbackup options to pass into pgbasebackup or pgbackrest.
+      --backup-type string      The backup type to perform. Default is pgbasebackup. Valid backup types are pgbasebackup, pgbackrest and pgdump.
+  -h, --help                    help for backup
+      --pvc-name string         The PVC name to use for the backup instead of the default.
+  -s, --selector string         The selector to use for cluster filtering.
+      --storage-config string   The name of a Storage config in pgo.yaml to use for the cluster storage.  Only applies to pgbasebackup backups.
+```
+
+### Options inherited from parent commands
+
+```
+      --apiserver-url string     The URL for the PostgreSQL Operator apiserver.
+      --debug                    Enable debugging when true.
+      --namespace string         The namespace to use for pgo requests.
+      --pgo-ca-cert string       The CA Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-cert string   The Client Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-key string    The Client Key file path for authenticating to the PostgreSQL Operator apiserver.
+```
+
+### SEE ALSO
+
+* [pgo](/commands/pgo/)	 - The pgo command line interface.
+
+###### Auto generated by spf13/cobra on 21-Feb-2019

hugo/content/cli/pgo_clidoc.md

@@ -0,0 +1,39 @@
+---
+title: "pgo_clidoc"
+---
+## pgo clidoc
+
+Generate Markdown of CLI commandes
+
+### Synopsis
+
+The clidoc command allows you to generate markdown files for all CLI commands:
+
+	pgo clidoc
+
+```
+pgo clidoc [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for clidoc
+```
+
+### Options inherited from parent commands
+
+```
+      --apiserver-url string     The URL for the PostgreSQL Operator apiserver.
+      --debug                    Enable debugging when true.
+      --namespace string         The namespace to use for pgo requests.
+      --pgo-ca-cert string       The CA Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-cert string   The Client Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-key string    The Client Key file path for authenticating to the PostgreSQL Operator apiserver.
+```
+
+### SEE ALSO
+
+* [pgo](/commands/pgo/)	 - The pgo command line interface.
+
+###### Auto generated by spf13/cobra on 21-Feb-2019

hugo/content/cli/pgo_create.md

@@ -0,0 +1,49 @@
+---
+title: "pgo_create"
+---
+## pgo create
+
+Create a Cluster, PGBouncer, PGPool, Policy, Schedule, or User
+
+### Synopsis
+
+CREATE allows you to create a new Cluster, PGBouncer, PGPool, Policy, Schedule or User. For example: 
+
+    pgo create cluster
+    pgo create pgbouncer
+    pgo create pgpool
+    pgo create policy
+    pgo create user
+
+```
+pgo create [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for create
+```
+
+### Options inherited from parent commands
+
+```
+      --apiserver-url string     The URL for the PostgreSQL Operator apiserver.
+      --debug                    Enable debugging when true.
+      --namespace string         The namespace to use for pgo requests.
+      --pgo-ca-cert string       The CA Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-cert string   The Client Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-key string    The Client Key file path for authenticating to the PostgreSQL Operator apiserver.
+```
+
+### SEE ALSO
+
+* [pgo](/commands/pgo/)	 - The pgo command line interface.
+* [pgo create cluster](/commands/pgo_create_cluster/)	 - Create a PostgreSQL cluster
+* [pgo create pgbouncer](/commands/pgo_create_pgbouncer/)	 - Create a pgbouncer 
+* [pgo create pgpool](/commands/pgo_create_pgpool/)	 - Create a pgpool 
+* [pgo create policy](/commands/pgo_create_policy/)	 - Create a SQL policy
+* [pgo create schedule](/commands/pgo_create_schedule/)	 - Create a cron-like scheduled task
+* [pgo create user](/commands/pgo_create_user/)	 - Create a PostgreSQL user
+
+###### Auto generated by spf13/cobra on 21-Feb-2019

hugo/content/cli/pgo_create_cluster.md

@@ -0,0 +1,63 @@
+---
+title: "pgo_create_cluster"
+---
+## pgo create cluster
+
+Create a PostgreSQL cluster
+
+### Synopsis
+
+Create a PostgreSQL cluster consisting of a primary and a number of replica backends. For example:
+
+    pgo create cluster mycluster
+
+```
+pgo create cluster [flags]
+```
+
+### Options
+
+```
+      --archive                         Enables archive logging for the database cluster.
+      --autofail                        If set, will cause autofailover to be enabled on this cluster.
+  -x, --backup-path string              The backup archive path to restore from.
+  -p, --backup-pvc string               The backup archive PVC to restore from.
+      --ccp-image string                The CCPImage name to use for cluster creation. If specified, overrides the value crunchy-postgres.
+  -c, --ccp-image-tag string            The CCPImageTag to use for cluster creation. If specified, overrides the pgo.yaml setting.
+      --custom-config string            The name of a configMap that holds custom PostgreSQL configuration files used to override defaults.
+  -h, --help                            help for cluster
+  -l, --labels string                   The labels to apply to this cluster.
+      --metrics                         Adds the crunchy-collect container to the database pod.
+      --node-label string               The node label (key=value) to use in placing the primary database. If not set, any node is used.
+  -w, --password string                 The password to use for initial database users.
+      --pgbackrest                      Enables a pgBackRest volume for the database pod.
+      --pgbadger                        Adds the crunchy-pgbadger container to the database pod.
+      --pgbouncer                       Adds a crunchy-pgbouncer deployment to the cluster.
+      --pgpool                          Adds the crunchy-pgpool container to the database pod.
+      --pgpool-secret string            The name of a pgpool secret to use for the pgpool configuration.
+  -z, --policies string                 The policies to apply when creating a cluster, comma separated.
+      --replica-count int               The number of replicas to create as part of the cluster.
+      --replica-storage-config string   The name of a Storage config in pgo.yaml to use for the cluster replica storage.
+  -r, --resources-config string         The name of a container resource configuration in pgo.yaml that holds CPU and memory requests and limits.
+  -s, --secret-from string              The cluster name to use when restoring secrets.
+  -e, --series int                      The number of clusters to create in a series. (default 1)
+      --service-type string             The Service type to use for the PostgreSQL cluster. If not set, the pgo.yaml default will be used.
+      --storage-config string           The name of a Storage config in pgo.yaml to use for the cluster storage.
+```
+
+### Options inherited from parent commands
+
+```
+      --apiserver-url string     The URL for the PostgreSQL Operator apiserver.
+      --debug                    Enable debugging when true.
+      --namespace string         The namespace to use for pgo requests.
+      --pgo-ca-cert string       The CA Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-cert string   The Client Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-key string    The Client Key file path for authenticating to the PostgreSQL Operator apiserver.
+```
+
+### SEE ALSO
+
+* [pgo create](/commands/pgo_create/)	 - Create a Cluster, PGBouncer, PGPool, Policy, Schedule, or User
+
+###### Auto generated by spf13/cobra on 21-Feb-2019

hugo/content/cli/pgo_create_pgbouncer.md

@@ -0,0 +1,39 @@
+---
+title: "pgo_create_pgbouncer"
+---
+## pgo create pgbouncer
+
+Create a pgbouncer 
+
+### Synopsis
+
+Create a pgbouncer. For example:
+
+	pgo create pgbouncer mycluster
+
+```
+pgo create pgbouncer [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for pgbouncer
+```
+
+### Options inherited from parent commands
+
+```
+      --apiserver-url string     The URL for the PostgreSQL Operator apiserver.
+      --debug                    Enable debugging when true.
+      --namespace string         The namespace to use for pgo requests.
+      --pgo-ca-cert string       The CA Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-cert string   The Client Certificate file path for authenticating to the PostgreSQL Operator apiserver.
+      --pgo-client-key string    The Client Key file path for authenticating to the PostgreSQL Operator apiserver.
+```
+
+### SEE ALSO
+
+* [pgo create](/commands/pgo_create/)	 - Create a Cluster, PGBouncer, PGPool, Policy, Schedule, or User
+
+###### Auto generated by spf13/cobra on 21-Feb-2019