You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by gi...@apache.org on 2017/08/07 18:44:43 UTC
[bookkeeper] branch asf-site updated: Updated site at revision
f90fa78
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/asf-site by this push:
new c92117b Updated site at revision f90fa78
c92117b is described below
commit c92117b3e710844aa25c176d9009fd93ba01990c
Author: jenkins <bu...@apache.org>
AuthorDate: Mon Aug 7 18:44:41 2017 +0000
Updated site at revision f90fa78
---
content/docs/latest/admin/autorecovery/index.html | 7 +
content/docs/latest/admin/bookies/index.html | 7 +
.../docs/latest/admin/geo-replication/index.html | 7 +
content/docs/latest/admin/metrics/index.html | 7 +
content/docs/latest/admin/perf/index.html | 7 +
content/docs/latest/admin/placement/index.html | 7 +
.../manual => admin/upgrade}/index.html | 148 +++++++++++----------
.../docs/latest/api/distributedlog-api/index.html | 7 +
content/docs/latest/api/ledger-adv-api/index.html | 7 +
content/docs/latest/api/ledger-api/index.html | 7 +
content/docs/latest/api/overview/index.html | 7 +
content/docs/latest/deployment/dcos/index.html | 7 +
.../docs/latest/deployment/kubernetes/index.html | 7 +
content/docs/latest/deployment/manual/index.html | 7 +
.../docs/latest/development/codebase/index.html | 7 +
.../docs/latest/development/protocol/index.html | 7 +
content/docs/latest/example/index.html | 7 +
.../latest/getting-started/concepts/index.html | 7 +
.../latest/getting-started/installation/index.html | 7 +
.../latest/getting-started/run-locally/index.html | 7 +
content/docs/latest/reference/cli/index.html | 7 +
content/docs/latest/reference/config/index.html | 7 +
content/docs/latest/reference/metrics/index.html | 7 +
23 files changed, 233 insertions(+), 69 deletions(-)
diff --git a/content/docs/latest/admin/autorecovery/index.html b/content/docs/latest/admin/autorecovery/index.html
index 870288e..778b901 100644
--- a/content/docs/latest/admin/autorecovery/index.html
+++ b/content/docs/latest/admin/autorecovery/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/admin/bookies/index.html b/content/docs/latest/admin/bookies/index.html
index abecfc0..f86024d 100644
--- a/content/docs/latest/admin/bookies/index.html
+++ b/content/docs/latest/admin/bookies/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/admin/geo-replication/index.html b/content/docs/latest/admin/geo-replication/index.html
index 4794d30..c58550f 100644
--- a/content/docs/latest/admin/geo-replication/index.html
+++ b/content/docs/latest/admin/geo-replication/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/admin/metrics/index.html b/content/docs/latest/admin/metrics/index.html
index 399bd1e..f2175a2 100644
--- a/content/docs/latest/admin/metrics/index.html
+++ b/content/docs/latest/admin/metrics/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/admin/perf/index.html b/content/docs/latest/admin/perf/index.html
index 2d4bf8f..cda6794 100644
--- a/content/docs/latest/admin/perf/index.html
+++ b/content/docs/latest/admin/perf/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/admin/placement/index.html b/content/docs/latest/admin/placement/index.html
index 5527c88..5807b43 100644
--- a/content/docs/latest/admin/placement/index.html
+++ b/content/docs/latest/admin/placement/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/deployment/manual/index.html b/content/docs/latest/admin/upgrade/index.html
similarity index 68%
copy from content/docs/latest/deployment/manual/index.html
copy to content/docs/latest/admin/upgrade/index.html
index 2386a7c..4e9bb90 100644
--- a/content/docs/latest/deployment/manual/index.html
+++ b/content/docs/latest/admin/upgrade/index.html
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
- <title>Apache BookKeeper - Manual deployment</title>
+ <title>Apache BookKeeper - Upgrade</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
@@ -364,7 +371,7 @@
<nav class="level bk-level">
<div class="level-left">
<div class="level-item">
- <h1 class="title">Manual deployment</h1>
+ <h1 class="title">Upgrade</h1>
</div>
</div>
@@ -377,87 +384,87 @@
<div class="content">
<section class="bk-main-content">
- <p>The easiest way to deploy BookKeeper is using schedulers like <a href="../dcos">DC/OS</a>, but you can also deploy BookKeeper clusters manually. A BookKeeper cluster consists of two main components:</p>
+ <blockquote>
+ <p>If you have questions about upgrades (or need help), please feel free to reach out to us by <a href="/community/mailing-lists">mailing list</a> or <a href="/community/slack">Slack Channel</a>.</p>
+</blockquote>
+
+<h2 id="overview">Overview</h2>
+
+<p>Consider the below guidelines in preparation for upgrading.</p>
<ul>
- <li>A <a href="#zookeeper-setup">ZooKeeper</a> cluster that is used for configuration- and coordination-related tasks</li>
- <li>An <a href="#starting-up-bookies">ensemble</a> of <span class="pop" id="bookie-popover">bookies</span></li>
+ <li>Always back up all your configuration files before upgrading.</li>
+ <li>Read through the documentation and draft an upgrade plan that matches your specific requirements and environment before starting the upgrade process.
+ Put differently, don’t start working through the guide on a live cluster. Read guide entirely, make a plan, then execute the plan.</li>
+ <li>Pay careful consideration to the order in which components are upgraded. In general, you need to upgrade bookies first and then upgrade your clients.</li>
+ <li>If autorecovery is running along with bookies, you need to pay attention to the upgrade sequence.</li>
+ <li>Read the release notes carefully for each release. They contain not only information about noteworthy features, but also changes to configurations
+ that may impact your upgrade.</li>
+ <li>Always upgrade one or a small set of bookies to canary new version before upgraing all bookies in your cluster.</li>
</ul>
-<h2 id="zookeeper-setup">ZooKeeper setup</h2>
+<h2 id="canary">Canary</h2>
-<p>We won’t provide a full guide to setting up a ZooKeeper cluster here. We recommend that you consult <a href="https://zookeeper.apache.org/doc/current/zookeeperAdmin.html">this guide</a> in the official ZooKeeper documentation.</p>
+<p>It is wise to canary an upgraded version in one or small set of bookies before upgrading all bookies in your live cluster.</p>
-<h2 id="starting-up-bookies">Starting up bookies</h2>
+<p>You can follow below steps on how to canary a upgraded version:</p>
-<p>Once your ZooKeeper cluster is up and running, you can start up as many <span class="pop" id="bookie-popover">bookies</span> as you’d like to form a cluster. Before starting up each bookie, you need to modify the bookie’s configuration to make sure that it points to the right ZooKeeper cluster.</p>
+<ol>
+ <li>Stop a Bookie.</li>
+ <li>Upgrade the binary and configuration.</li>
+ <li>Start the Bookie in <code class="highlighter-rouge">ReadOnly</code> mode. This can be used to verify if the Bookie of this new version can run well for read workload.</li>
+ <li>Once the Bookie is running at <code class="highlighter-rouge">ReadOnly</code> mode successfully for a while, restart the Bookie in <code class="highlighter-rouge">Write/Read</code> mode.</li>
+ <li>After step 4, the Bookie will serve both write and read traffic.</li>
+</ol>
-<p>On each bookie host, you need to <a href="../../getting-started/installation#download">download</a> the BookKeeper package as a tarball. Once you’ve done that, you need to configure the bookie by setting values in the <code class="highlighter-rouge">bookkeeper-server/conf/bk_server.conf</code> config file. The one parameter that you will absolutely need to change is the <a href="../../config#zkServers"><code class="highlighter-rouge">zkServers</code></a> parameter, which you will need [...]
+<h3 id="rollback-canaries">Rollback Canaries</h3>
-<div class="language-properties highlighter-rouge"><pre class="highlight"><code><span class="py">zkServers</span><span class="p">=</span><span class="s">100.0.0.1:2181,100.0.0.2:2181,100.0.0.3:2181</span>
-</code></pre>
-</div>
+<p>If problems occur during canarying an upgraded version, you can simply take down the problematic Bookie node. The remain bookies in the old cluster
+will repair this problematic bookie node by autorecovery. Nothing needs to be worried about.</p>
-<blockquote>
- <p>A full listing of configurable parameters available in <code class="highlighter-rouge">bookkeeper-server/conf/bk_server.conf</code> can be found in the <a href="../../reference/config">Configuration</a> reference manual.</p>
-</blockquote>
+<h2 id="upgrade-steps">Upgrade Steps</h2>
-<p>Once the bookie’s configuration is set, you can start it up using the <a href="../../reference/cli#bookkeeper-bookie"><code class="highlighter-rouge">bookie</code></a> command of the <a href="../../reference/cli#bookkeeper"><code class="highlighter-rouge">bookkeeper</code></a> CLI tool:</p>
+<p>Once you determined a version is safe to upgrade in a few nodes in your cluster, you can perform following steps to upgrade all bookies in your cluster.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>bookkeeper-server/bin/bookkeeper bookie
-</code></pre>
-</div>
+<ol>
+ <li>Determine if autorecovery is running along with bookies. If yes, check if the clients (either new clients with new binary or old clients with new configurations)
+are allowed to talk to old bookies; if clients are not allowed to talk to old bookies, please <a href="../../reference/cli/#autorecovery-1">disable autorecovery</a> during upgrade.</li>
+ <li>Decide on performing a rolling upgrade or a downtime upgrade.</li>
+ <li>Upgrade all Bookies (more below)</li>
+ <li>If autorecovery was disabled during upgrade, <a href="../../reference/cli/#autorecovery-1">enable autorecovery</a>.</li>
+ <li>After all bookies are upgraded, build applications that use <code class="highlighter-rouge">BookKeeper client</code> against the new bookkeeper libraries and deploy the new versions.</li>
+</ol>
-<blockquote>
- <p>You can also build BookKeeper <a href="../../getting-started/installation#clone">by cloning it from source</a> or <a href="../../getting-started/installation#build-using-maven">using Maven</a>.</p>
-</blockquote>
+<h3 id="upgrade-bookies">Upgrade Bookies</h3>
-<h3 id="system-requirements">System requirements</h3>
-
-<p>The number of bookies you should run in a BookKeeper cluster depends on the quorum mode that you’ve chosen, the desired throughput, and the number of clients using the cluster simultaneously.</p>
-
-<table>
- <thead>
- <tr>
- <th style="text-align: left">Quorum type</th>
- <th style="text-align: left">Number of bookies</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td style="text-align: left">Self-verifying quorum</td>
- <td style="text-align: left">3</td>
- </tr>
- <tr>
- <td style="text-align: left">Generic</td>
- <td style="text-align: left">4</td>
- </tr>
- </tbody>
-</table>
-
-<p>Increasing the number of bookies will enable higher throughput, and there is <strong>no upper limit</strong> on the number of bookies.</p>
-
-<h2 id="cluster-metadata-setup">Cluster metadata setup</h2>
-
-<p>Once you’ve started up a cluster of bookies, you need to set up cluster metadata for the cluster by running the following command from any bookie in the cluster:</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>bookkeeper-server/bin/bookkeeper shell metaformat
-</code></pre>
-</div>
+<p>In a rolling upgrade scenario, upgrade one Bookie at a time. In a downtime upgrade scenario, take the entire cluster down, upgrade each Bookie, then start the cluster.</p>
-<p>You can run in the formatting</p>
+<p>For each Bookie:</p>
-<blockquote>
- <p>The <code class="highlighter-rouge">metaformat</code> command performs all the necessary ZooKeeper cluster metadata tasks and thus only needs to be run <em>once</em> and from <em>any</em> bookie in the BookKeeper cluster.</p>
-</blockquote>
+<ol>
+ <li>Stop the bookie.</li>
+ <li>Upgrade the software (either new binary or new configuration)</li>
+ <li>Start the bookie.</li>
+</ol>
+
+<h2 id="upgrade-guides">Upgrade Guides</h2>
+
+<p>We describes the general upgrade method in Apache BookKeeper as above. We will cover the details for individual versions.</p>
+
+<h3 id="44x-to-45x-upgrade">4.4.x to 4.5.x upgrade</h3>
+
+<p>There isn’t any protocol related backward compabilities changes in 4.5.0. So you can follow the general upgrade sequence to upgrade from 4.4.x to 4.5.x.
+However, we list a list of things that you might want to know.</p>
-<p>Once cluster metadata formatting has been completed, your BookKeeper cluster is ready to go!</p>
+<ol>
+ <li>4.5.x upgrades netty from 3.x to 4.x. The memory usage pattern might be changed a bit. Netty 4 uses more direct memory. Please pay attention to your memory usage
+ and adjust the JVM settings accordingly.</li>
+ <li><code class="highlighter-rouge">multi journals</code> is a non-rollbackable feature. If you configure a bookie to use multiple journals on 4.5.x you can not roll the bookie back to use 4.4.x. You have
+ to take a bookie out and recover it if you want to rollback to 4.4.x.</li>
+</ol>
-<!--
-## AutoRecovery
+<p>If you are planning to upgrade a non-secured cluster to a secured cluster enabling security features in 4.5.0, please read <a href="../../security">BookKeeper Security</a> for more details.</p>
-[this guide](../../admin/autorecovery)
--->
</section>
@@ -469,12 +476,15 @@
<div class="toc">
- <h2 class="title">Manual deployment</h2>
+ <h2 class="title">Upgrade</h2>
<ul class="section-nav">
-<li class="toc-entry toc-h2"><a href="#zookeeper-setup">ZooKeeper setup</a></li>
-<li class="toc-entry toc-h2"><a href="#starting-up-bookies">Starting up bookies</a></li>
-<li class="toc-entry toc-h3"><a href="#system-requirements">System requirements</a></li>
-<li class="toc-entry toc-h2"><a href="#cluster-metadata-setup">Cluster metadata setup</a></li>
+<li class="toc-entry toc-h2"><a href="#overview">Overview</a></li>
+<li class="toc-entry toc-h2"><a href="#canary">Canary</a></li>
+<li class="toc-entry toc-h3"><a href="#rollback-canaries">Rollback Canaries</a></li>
+<li class="toc-entry toc-h2"><a href="#upgrade-steps">Upgrade Steps</a></li>
+<li class="toc-entry toc-h3"><a href="#upgrade-bookies">Upgrade Bookies</a></li>
+<li class="toc-entry toc-h2"><a href="#upgrade-guides">Upgrade Guides</a></li>
+<li class="toc-entry toc-h3"><a href="#44x-to-45x-upgrade">4.4.x to 4.5.x upgrade</a></li>
</ul>
</div>
diff --git a/content/docs/latest/api/distributedlog-api/index.html b/content/docs/latest/api/distributedlog-api/index.html
index 6e6d12d..17b2da9 100644
--- a/content/docs/latest/api/distributedlog-api/index.html
+++ b/content/docs/latest/api/distributedlog-api/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/api/ledger-adv-api/index.html b/content/docs/latest/api/ledger-adv-api/index.html
index aa67f70..b37c3d9 100644
--- a/content/docs/latest/api/ledger-adv-api/index.html
+++ b/content/docs/latest/api/ledger-adv-api/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/api/ledger-api/index.html b/content/docs/latest/api/ledger-api/index.html
index dcc55cf..d4a6f88 100644
--- a/content/docs/latest/api/ledger-api/index.html
+++ b/content/docs/latest/api/ledger-api/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/api/overview/index.html b/content/docs/latest/api/overview/index.html
index 928a3fa..9473c79 100644
--- a/content/docs/latest/api/overview/index.html
+++ b/content/docs/latest/api/overview/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/deployment/dcos/index.html b/content/docs/latest/deployment/dcos/index.html
index 1732879..6c78e1e 100644
--- a/content/docs/latest/deployment/dcos/index.html
+++ b/content/docs/latest/deployment/dcos/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/deployment/kubernetes/index.html b/content/docs/latest/deployment/kubernetes/index.html
index 3a6b9ed..39a640a 100644
--- a/content/docs/latest/deployment/kubernetes/index.html
+++ b/content/docs/latest/deployment/kubernetes/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/deployment/manual/index.html b/content/docs/latest/deployment/manual/index.html
index 2386a7c..3cf40b6 100644
--- a/content/docs/latest/deployment/manual/index.html
+++ b/content/docs/latest/deployment/manual/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/development/codebase/index.html b/content/docs/latest/development/codebase/index.html
index 9bf4bda..56bf41d 100644
--- a/content/docs/latest/development/codebase/index.html
+++ b/content/docs/latest/development/codebase/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/development/protocol/index.html b/content/docs/latest/development/protocol/index.html
index 35e020d..1807fd2 100644
--- a/content/docs/latest/development/protocol/index.html
+++ b/content/docs/latest/development/protocol/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/example/index.html b/content/docs/latest/example/index.html
index d4a32ad..74310bd 100644
--- a/content/docs/latest/example/index.html
+++ b/content/docs/latest/example/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/getting-started/concepts/index.html b/content/docs/latest/getting-started/concepts/index.html
index 77e01f7..ddea8ed 100644
--- a/content/docs/latest/getting-started/concepts/index.html
+++ b/content/docs/latest/getting-started/concepts/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/getting-started/installation/index.html b/content/docs/latest/getting-started/installation/index.html
index 180bb35..6cc8f36 100644
--- a/content/docs/latest/getting-started/installation/index.html
+++ b/content/docs/latest/getting-started/installation/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/getting-started/run-locally/index.html b/content/docs/latest/getting-started/run-locally/index.html
index 25b1fdd..6b62c45 100644
--- a/content/docs/latest/getting-started/run-locally/index.html
+++ b/content/docs/latest/getting-started/run-locally/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/reference/cli/index.html b/content/docs/latest/reference/cli/index.html
index 5dd000e..6cf7418 100644
--- a/content/docs/latest/reference/cli/index.html
+++ b/content/docs/latest/reference/cli/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/reference/config/index.html b/content/docs/latest/reference/config/index.html
index 5d3c42a..94e71b2 100644
--- a/content/docs/latest/reference/config/index.html
+++ b/content/docs/latest/reference/config/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
diff --git a/content/docs/latest/reference/metrics/index.html b/content/docs/latest/reference/metrics/index.html
index f8e246e..9eedf3c 100644
--- a/content/docs/latest/reference/metrics/index.html
+++ b/content/docs/latest/reference/metrics/index.html
@@ -274,6 +274,13 @@
</a>
</li>
+
+ <li>
+ <a href="/test/content/docs/latest/admin/upgrade">
+ Upgrade
+ </a>
+ </li>
+
</ul>
<p>
--
To stop receiving notification emails like this one, please contact
['"commits@bookkeeper.apache.org" <co...@bookkeeper.apache.org>'].