Publishing documentation

Author: xenophenes

docs/contributing/index.html

@@ -220,7 +220,7 @@ <h1>Contributing</h1>
 
 
 <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="sect1">
 <h2 id="_getting_started">Getting Started</h2>

docs/getting-started/index.html

@@ -225,6 +225,7 @@ <h1>Getting Started</h1>
 <li><a href="#_pgo_commands">pgo Commands</a>
 <ul class="sectlevel2">
 <li><a href="#_pgo_version">pgo version</a></li>
+<li><a href="#_pgo_show_config">pgo show config</a></li>
 <li><a href="#_pgo_create_cluster">pgo create cluster</a></li>
 <li><a href="#_pgo_backup">pgo backup</a></li>
 <li><a href="#_pgo_delete_backup">pgo delete backup</a></li>
@@ -244,12 +245,13 @@ <h1>Getting Started</h1>
 <li><a href="#_pgo_failover">pgo failover</a></li>
 <li><a href="#_pgo_df">pgo df</a></li>
 <li><a href="#_pgo_status">pgo status</a></li>
+<li><a href="#_pgo_show_config_2">pgo show config</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="sect1">
 <h2 id="_pgo_commands">pgo Commands</h2>
@@ -280,6 +282,17 @@ <h3 id="_pgo_version">pgo version</h3>
 </div>
 </div>
 <div class="sect2">
+<h3 id="_pgo_show_config">pgo show config</h3>
+<div class="paragraph">
+<p>To see what configuration you are running against within the Operator, use the following -</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>pgo show config</pre>
+</div>
+</div>
+</div>
+<div class="sect2">
 <h3 id="_pgo_create_cluster">pgo create cluster</h3>
 <div class="paragraph">
 <p>To create a database, use the following -</p>
@@ -926,6 +939,18 @@ <h3 id="_pgo_user">pgo user</h3>
 </div>
 </div>
 <div class="paragraph">
+<p>To create a new Postgres user to the <strong>mycluster</strong> cluster that has credentials created with Kubernetes Secrets, use the <strong>--managed</strong> flag:</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>pgo create user sally --managed --selector=name=mycluster</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>A <strong>managed</strong> account is one that the Operator can manipulate as well; this means that when you run <code>pgo show cluster mycluster --show-secrets</code>
+their credentials are visible, when you run <code>pgo test mycluster</code> the account is tested with the other default accounts, etc.</p>
+</div>
+<div class="paragraph">
 <p>To change the password for a user in the <strong>mycluster</strong> cluster:</p>
 </div>
 <div class="literalblock">
@@ -950,7 +975,7 @@ <h3 id="_pgo_user">pgo user</h3>
 </div>
 <div class="literalblock">
 <div class="content">
-<pre>pgo create user user1 --valid-days=30 --managed --db=userdb --selector=name=xraydb1</pre>
+<pre>pgo create user user1 --valid-days=30 --db=userdb --selector=name=xraydb1</pre>
 </div>
 </div>
 <div class="paragraph">
@@ -1218,6 +1243,20 @@ <h3 id="_pgo_status">pgo status</h3>
 </div>
 </div>
 </div>
+<div class="sect2">
+<h3 id="_pgo_show_config_2">pgo show config</h3>
+<div class="paragraph">
+<p>The <code>pgo show config</code> command displays the running operator configuration
+parameters that dictate the setup and user defined configuration of the
+operator.  This command can be useful for sharing your configuration or
+verifying the setup is as expected.</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>pgo show config</pre>
+</div>
+</div>
+</div>
 </div>
 </div>
 

docs/how-it-works/index.html

@@ -250,7 +250,7 @@ <h1>How it Works</h1>
 </ul>
 </div>
 <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="sect1">
 <h2 id="_reference_architecture">Reference Architecture</h2>
@@ -810,14 +810,7 @@ <h3 id="_metrics_collection">Metrics Collection</h3>
 as defined within the <strong>crunchy-containers</strong> project.</p>
 </div>
 <div class="paragraph">
-<p>The <strong>prometheus push gateway</strong> that is deployed as part of the
-<strong>crunchy-metrics</strong> example is a current requirement for the
-metrics solution.  This will change in an upcoming
-release of the <strong>crunchy-containers</strong> project and there will
-no longer be a requirement for the push gateway to be deployed.</p>
-</div>
-<div class="paragraph">
-<p>See <a href="https://github.com/CrunchyData/crunchy-containers/blob/master/docs/examples.adoc#metrics-collection">the crunchy-containers Metrics example</a> for more details on setting up the <strong>crunchy-metrics</strong> solution.</p>
+<p>See <a href="https://crunchydata.github.io/crunchy-containers/getting-started/kubernetes-and-openshift/#_metrics_and_performance">the crunchy-containers Metrics example</a> for more details on setting up the <strong>crunchy-metrics</strong> solution.</p>
 </div>
 </div>
 <div class="sect2">

docs/index.html

@@ -181,7 +181,7 @@
 </div>
 </div>
 <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="sect1">
 <h2 id="_documentation">Documentation</h2>

docs/index.json

@@ -17,7 +17,7 @@
       <pubDate>Thu, 26 Apr 2018 15:22:14 -0700</pubDate>
 
       <guid>https://crunchydata.github.io/postgres-operator/installation/quick-installation/</guid>
-      <description>Table of Contents Overview Quickstart GKE/PKS Openshift Container Platform   Next Steps   v3.1, 2018-06-13
+      <description>Table of Contents Overview Quickstart GKE/PKS Openshift Container Platform   Next Steps   v3.1, 2018-06-22
  Overview There are currently quickstart scripts that seek to automate the deployment to popular Kubernetes environments -
    quickstart-for-gke.sh
   quickstart-for-ocp.sh
@@ -31,7 +31,7 @@
       <pubDate>Thu, 26 Apr 2018 15:22:21 -0700</pubDate>
 
       <guid>https://crunchydata.github.io/postgres-operator/installation/manual-installation/</guid>
-      <description>Table of Contents Project Structure Installation Prerequsites Basic Installation Create HostPath Directory   Build Images &amp;amp; Deploy Makefile Targets Next Steps   v3.1, 2018-06-13
+      <description>Table of Contents Project Structure Installation Prerequsites Basic Installation Create HostPath Directory   Build Images &amp;amp; Deploy Makefile Targets Next Steps   v3.1, 2018-06-22
  Project Structure First, define the following environment variables in .bashrc:
  export GOPATH=$HOME/odev export GOBIN=$GOPATH/bin export CO_NAMESPACE=demo export CO_CMD=kubectl export COROOT=$GOPATH/src/github.com/crunchydata/postgres-operator export CO_IMAGE_PREFIX=crunchydata export CO_IMAGE_TAG=centos7-3.1 export CO_BASEOS=centos7   When deploying on Openshift Container Platform, the CO_CMD environment variable should be:
  export CO_CMD=oc   To perform an installation of the operator, first create the project structure as follows on your host, here we assume a local directory called odev -</description>
@@ -43,7 +43,7 @@
       <pubDate>Thu, 26 Apr 2018 15:24:16 -0700</pubDate>
 
       <guid>https://crunchydata.github.io/postgres-operator/installation/helm-chart/</guid>
-      <description>v3.1, 2018-06-13
+      <description>v3.1, 2018-06-22
  Helm Chart First, pull prebuilt versions from Dockerhub of the postgres-operator containers, specify the image versions, and execute the following Makefile target -
  export CO_IMAGE_PREFIX=crunchydata export CO_IMAGE_TAG=centos7-3.1 make pull   Then, build and deploy the operator using the provided Helm chart -
  cd $COROOT/chart helm install ./postgres-operator helm ls     Next Steps Next, visit the Deployment page to deploy the Operator, verify the installation, and view various storage configurations.</description>
@@ -55,7 +55,7 @@
       <pubDate>Thu, 26 Apr 2018 15:26:40 -0700</pubDate>
 
       <guid>https://crunchydata.github.io/postgres-operator/installation/deployment/</guid>
-      <description>Table of Contents Verify Operator Status Configure pgo Client Verify pgo Client Storage Configuration Next Steps   v3.1, 2018-06-13
+      <description>Table of Contents Verify Operator Status Configure pgo Client Verify pgo Client Storage Configuration Next Steps   v3.1, 2018-06-22
  This document details verifying the installation of the PostgreSQL Operator is successful, in addition to detailing some different storage configurations that can be made.
  Verify Operator Status To verify that the operator is deployed and running, run the following:
  kubectl get pod --selector=name=postgres-operator   You should see output similar to this:</description>
@@ -67,7 +67,7 @@
       <pubDate>Tue, 24 Apr 2018 18:26:56 -0700</pubDate>
 
       <guid>https://crunchydata.github.io/postgres-operator/installation/configuration/</guid>
-      <description>Table of Contents Overview Openshift Container Platform Security Configuration Kube RBAC Basic Authentication Configure TLS pgo RBAC apiserver Configuration postgres-operator Container Configuration   bash Completion REST API Deploying pgpool   v3.1, 2018-06-13
+      <description>Table of Contents Overview Openshift Container Platform Security Configuration Kube RBAC Basic Authentication Configure TLS pgo RBAC apiserver Configuration postgres-operator Container Configuration   bash Completion REST API Deploying pgpool   v3.1, 2018-06-22
  Overview This document describes how to configure the operator beyond the default configurations in addition to detailing what the configuration settings mean.
    Openshift Container Platform To run the Operator on Openshift Container Platform note the following requirements -</description>
     </item>
@@ -78,7 +78,7 @@
       <pubDate>Tue, 24 Apr 2018 18:27:30 -0700</pubDate>
 
       <guid>https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/</guid>
-      <description>v3.1, 2018-06-13
+      <description>v3.1, 2018-06-22
    Upgrading from v2.4 to v2.5   For a full list of additions and revisions that occurred in the PostgreSQL Operator v2.5 release, please view the related release page here.
  Required Updates This section notes some required steps that will need to be taken in the process of upgrading from v2.4 to v2.5.
  Configuration File It will be necessary to update your existing pgo.</description>

docs/index.xml

@@ -245,7 +245,7 @@ <h1>Configuration</h1>
 </ul>
 </div>
 <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="sect1">
 <h2 id="_overview">Overview</h2>

docs/installation/configuration/index.html

@@ -235,7 +235,7 @@ <h1>Deployment</h1>
 </ul>
 </div>
 <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="paragraph">
 <p>This document details verifying the installation of the PostgreSQL Operator
@@ -336,6 +336,39 @@ <h2 id="_configure_strong_pgo_strong_client">Configure <strong>pgo</strong> Clie
 </div>
 </div>
 <div class="paragraph">
+<p>Roles are defined in a file called <strong>pgorole</strong>. This file defines each role and the
+permissions for that role. By default, two roles are defined as samples -</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>pgoadmin
+pgoreader</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>This file, moved to your $HOME folder, is optional. These default settings can be adjusted to meet local
+security requirements.</p>
+</div>
+<div class="paragraph">
+<p>The format of this file is as follows -</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>rolename: permissionA, permissionB</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>These are defined in the following file -</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>$COROOT/conf/apiserver/pgorole</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The complete set of permissions is documented in the <a href="https://crunchydata.github.io/postgres-operator/installation/configuration/">Configuration</a> document.</p>
+</div>
+<div class="paragraph">
 <p>The <strong>pgo</strong> client needs the URL to connect to the operator.</p>
 </div>
 <div class="paragraph">

docs/installation/deployment/index.html

@@ -225,7 +225,7 @@ <h1>Helm Chart</h1>
 
 
     <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="sect1">
 <h2 id="_helm_chart">Helm Chart</h2>

docs/installation/helm-chart/index.html

@@ -221,7 +221,7 @@ <h1>Installation</h1>
 
 
 <div class="paragraph">
-<p>v3.1, 2018-06-13</p>
+<p>v3.1, 2018-06-22</p>
 </div>
 <div class="sect1">
 <h2 id="_installation">Installation</h2>