Skip to content

Move Upgrading section to bottom of Installation #254

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
jmccormick2001 merged 2 commits into from
Jun 13, 2018
Merged

Move Upgrading section to bottom of Installation #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21701f2
move Upgrading section to bottom
xenophenes Jun 13, 2018
bd1607a
Publishing documentation
xenophenes Jun 13, 2018
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
16 changes: 8 additions & 8 deletions docs/404.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<meta name="generator" content="Hugo 0.40.3" />
<meta name="generator" content="Hugo 0.40" />

<title>404 Page not found :: Crunchy Data PostgreSQL Operator Documentation</title>
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />
Expand Down Expand Up @@ -91,13 +91,6 @@
Helm Chart
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
<li data-nav-id="/installation/deployment/" class="dd-item">
<div>
Expand All @@ -112,6 +105,13 @@
Configuration
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
</ul>
</li>
Expand Down
16 changes: 8 additions & 8 deletions docs/categories/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<meta name="generator" content="Hugo 0.40.3" />
<meta name="generator" content="Hugo 0.40" />

<title>Categories :: Crunchy Data PostgreSQL Operator Documentation</title>
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />
Expand Down Expand Up @@ -91,13 +91,6 @@
Helm Chart
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
<li data-nav-id="/installation/deployment/" class="dd-item">
<div>
Expand All @@ -112,6 +105,13 @@
Configuration
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
</ul>
</li>
Expand Down
20 changes: 10 additions & 10 deletions docs/contributing/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<meta name="generator" content="Hugo 0.40.3" />
<meta name="generator" content="Hugo 0.40" />

<title>Contributing :: Crunchy Data PostgreSQL Operator Documentation</title>
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />
Expand Down Expand Up @@ -91,13 +91,6 @@
Helm Chart
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
<li data-nav-id="/installation/deployment/" class="dd-item">
<div>
Expand All @@ -112,6 +105,13 @@
Configuration
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
</ul>
</li>
Expand Down Expand Up @@ -220,7 +220,7 @@ <h1>Contributing</h1>


<div class="paragraph">
<p>v3.0, 2018-06-04</p>
<p>v3.1, 2018-06-13</p>
</div>
<div class="sect1">
<h2 id="_getting_started">Getting Started</h2>
Expand Down Expand Up @@ -272,7 +272,7 @@ <h2 id="_documentation">Documentation</h2>
</div>

<div id="navigation">
<a class="nav nav-prev" href="https://crunchydata.github.io/postgres-operator/installation/configuration/" title="Configuration"> <i class="fa fa-chevron-left"></i><label>Configuration</label></a>
<a class="nav nav-prev" href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/" title="Upgrading the Operator"> <i class="fa fa-chevron-left"></i><label>Upgrading the Operator</label></a>
<a class="nav nav-next" href="https://crunchydata.github.io/postgres-operator/how-it-works/" title="How it Works" style="margin-right: 0px;"><label>How it Works</label><i class="fa fa-chevron-right"></i></a></div>

</section>
Expand Down
94 changes: 59 additions & 35 deletions docs/getting-started/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<meta name="generator" content="Hugo 0.40.3" />
<meta name="generator" content="Hugo 0.40" />

<title>Getting Started :: Crunchy Data PostgreSQL Operator Documentation</title>
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />
Expand Down Expand Up @@ -91,13 +91,6 @@
Helm Chart
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
<li data-nav-id="/installation/deployment/" class="dd-item">
<div>
Expand All @@ -112,6 +105,13 @@
Configuration
</a>
</div>
</li>
<li data-nav-id="/installation/upgrading-the-operator/" class="dd-item">
<div>
<a href="https://crunchydata.github.io/postgres-operator/installation/upgrading-the-operator/">
Upgrading the Operator
</a>
</div>
</li>
</ul>
</li>
Expand Down Expand Up @@ -249,7 +249,7 @@ <h1>Getting Started</h1>
</ul>
</div>
<div class="paragraph">
<p>v3.0, 2018-06-04</p>
<p>v3.1, 2018-06-13</p>
</div>
<div class="sect1">
<h2 id="_pgo_commands">pgo Commands</h2>
Expand Down Expand Up @@ -410,6 +410,22 @@ <h3 id="_pgo_create_cluster">pgo create cluster</h3>
<p>This will cause a new PVC to be created to hold archive logs. Space
is consumed by these logs but archives enable you to perform Point-In-Time-Recovery.</p>
</div>
<div class="paragraph">
<p>To enable <strong>auto failover</strong> on this cluster, use the following flag:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>pgo create cluster testcluster --autofail</pre>
</div>
</div>
<div class="paragraph">
<p><strong>auto failover</strong> when set on the cluster informs the operator to look
or watch for <strong>NotReady</strong> events on this cluster, and when those occur
to create a failover state machine which acts as a timer for the cluster.
If the timer expires, then a failover is triggered on the cluster turning
one of the cluster replica pods into the replacement primary pod. See
the How It Works documentation for more details on <strong>auto failover</strong>.</p>
</div>
</div>
<div class="sect2">
<h3 id="_pgo_backup">pgo backup</h3>
Expand Down Expand Up @@ -475,6 +491,18 @@ <h3 id="_pgo_backup">pgo backup</h3>
be left intact but the actual Kubernetes Job will be removed prior
to creating a new Job with the same name.</p>
</div>
<div class="paragraph">
<p>You can override the PVC used by the backup job with the following:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>pgo backup mycluster --pvc-name=myremotepvc</pre>
</div>
</div>
<div class="paragraph">
<p>This might be useful for special backup cases, perhaps to create
a backup on a disaster recovery PVC.</p>
</div>
</div>
<div class="sect2">
<h3 id="_pgo_delete_backup">pgo delete backup</h3>
Expand Down Expand Up @@ -894,15 +922,7 @@ <h3 id="_pgo_user">pgo user</h3>
</div>
<div class="literalblock">
<div class="content">
<pre>pgo user --delete-user=sally --selector=name=mycluster</pre>
</div>
</div>
<div class="paragraph">
<p>To delete that user in all clusters:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>pgo user --delete-user=sally</pre>
<pre>pgo user delete user sally --selector=name=mycluster</pre>
</div>
</div>
<div class="paragraph">
Expand Down Expand Up @@ -951,14 +971,6 @@ <h3 id="_pgo_user">pgo user</h3>
specify <strong>valid-days=-1</strong> it will mean the password will not expire (e.g. infinity).</p>
</div>
<div class="paragraph">
<p>To drop a user:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>pgo user --delete-user=user3   --selector=project=xray</pre>
</div>
</div>
<div class="paragraph">
<p>To see which passwords are set to expire in a given number of days:</p>
</div>
<div class="literalblock">
Expand Down Expand Up @@ -1101,15 +1113,27 @@ <h3 id="_pgo_failover">pgo failover</h3>
cluster.</p>
</div>
<div class="paragraph">
<p>This process includes the following actions:
* pick a target replica to become the new primary
* delete the current primary deployment to avoid user requests from
going to multiple primary databases (split brain)
* promote the targeted replica using <strong>pg_ctl promote</strong>, this will
cause PostgreSQL to go into read-write mode
* re-label the targeted replica to use the primary labels, this
will match the primary service selector and cause new requests
to the primary to be routed to the new primary (targeted replica)</p>
<p>This process includes the following actions:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>pick a target replica to become the new primary</p>
</li>
<li>
<p>delete the current primary deployment to avoid user requests from
going to multiple primary databases (split brain)</p>
</li>
<li>
<p>promote the targeted replica using <strong>pg_ctl promote</strong>, this will
cause PostgreSQL to go into read-write mode</p>
</li>
<li>
<p>re-label the targeted replica to use the primary labels, this
will match the primary service selector and cause new requests
to the primary to be routed to the new primary (targeted replica)</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>The command works like this:</p>
Expand Down
Loading