bookkeeper-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From iv...@apache.org
Subject svn commit: r1697189 - in /bookkeeper/site/trunk/content/docs/master: bookkeeperConfig.textile bookkeeperConfigParams.textile bookkeeperOverview.textile bookkeeperStarted.textile bookkeeperTutorial.textile hedwigDocs.textile index.textile
Date Sun, 23 Aug 2015 15:20:12 GMT
Author: ivank
Date: Sun Aug 23 15:20:12 2015
New Revision: 1697189

URL: http://svn.apache.org/r1697189
Log:
Syncing website with master documentation

Added:
    bookkeeper/site/trunk/content/docs/master/hedwigDocs.textile
Modified:
    bookkeeper/site/trunk/content/docs/master/bookkeeperConfig.textile
    bookkeeper/site/trunk/content/docs/master/bookkeeperConfigParams.textile
    bookkeeper/site/trunk/content/docs/master/bookkeeperOverview.textile
    bookkeeper/site/trunk/content/docs/master/bookkeeperStarted.textile
    bookkeeper/site/trunk/content/docs/master/bookkeeperTutorial.textile
    bookkeeper/site/trunk/content/docs/master/index.textile

Modified: bookkeeper/site/trunk/content/docs/master/bookkeeperConfig.textile
URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/master/bookkeeperConfig.textile?rev=1697189&r1=1697188&r2=1697189&view=diff
==============================================================================
--- bookkeeper/site/trunk/content/docs/master/bookkeeperConfig.textile (original)
+++ bookkeeper/site/trunk/content/docs/master/bookkeeperConfig.textile Sun Aug 23 15:20:12
2015
@@ -142,7 +142,7 @@ Important parameters are:
 
 * @auditorPeriodicCheckInterval@, interval at which the auditor will do a check of all ledgers
in the cluster. By default this runs once a week. The interval is set in seconds. To disable
the periodic check completely, set this to 0. Note that periodic checking will put extra load
on the cluster, so it should not be run more frequently than once a day.
 
-* @rereplicationEntryBatchSize@ specifies the number of entries which a replication will
rereplicate in parallel. The default value is 10. A larger value for this parameter will increase
the speed at which autorecovery occurs but will increate the memory requirement of the autorecovery
process, and create more load on the cluster.
+* @rereplicationEntryBatchSize@ specifies the number of entries which a replication will
rereplicate in parallel. The default value is 10. A larger value for this parameter will increase
the speed at which autorecovery occurs but will increase the memory requirement of the autorecovery
process, and create more load on the cluster.
 
 * @openLedgerRereplicationGracePeriod@, is the amount of time, in milliseconds, which a recovery
worker will wait before recovering a ledger segment which has no defined ended, i.e. the client
is still writing to that segment. If the client is still active, it should detect the bookie
failure, and start writing to a new ledger segment, and a new ensemble, which doesn't include
the failed bookie. Creating new ledger segment will define the end of the previous segment.
If, after the grace period, the ledger segment's end has not been defined, we assume the writing
client has crashed. The ledger is fenced and the client is blocked from writing any more entries
to the ledger. The default value is 30000ms.
 

Modified: bookkeeper/site/trunk/content/docs/master/bookkeeperConfigParams.textile
URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/master/bookkeeperConfigParams.textile?rev=1697189&r1=1697188&r2=1697189&view=diff
==============================================================================
--- bookkeeper/site/trunk/content/docs/master/bookkeeperConfigParams.textile (original)
+++ bookkeeper/site/trunk/content/docs/master/bookkeeperConfigParams.textile Sun Aug 23 15:20:12
2015
@@ -35,5 +35,5 @@ h3. Bookie recovery settings
 
 Currently bookie recovery tool needs a digest type and passwd to open ledgers to do recovery.
Currently, bookkeeper assumes that all ledgers were created with the same DigestType and Password.
In the future, it needs to know for each ledger, what was the DigestType and Password used
to create it before opening it.
 
-| @digestType@ | Digest type used to open ledgers from bookkie recovery tool. |
+| @digestType@ | Digest type used to open ledgers from bookie recovery tool. |
 | @passwd@ | Password used to open ledgers from bookie recovery tool. |

Modified: bookkeeper/site/trunk/content/docs/master/bookkeeperOverview.textile
URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/master/bookkeeperOverview.textile?rev=1697189&r1=1697188&r2=1697189&view=diff
==============================================================================
--- bookkeeper/site/trunk/content/docs/master/bookkeeperOverview.textile (original)
+++ bookkeeper/site/trunk/content/docs/master/bookkeeperOverview.textile Sun Aug 23 15:20:12
2015
@@ -47,7 +47,7 @@ p. BookKeeper uses four basic elements:
 
 h1. Bookkeeper initial design
 
-p. A set of bookies implements BookKeeper, and we use a quorum-based protocol to replicate
data across the bookies. There are basically two operations to an existing ledger: read and
append. Here is the complete API list (mode detail "here":bookkeeperProgrammer.html): 
+p. A set of bookies implements BookKeeper, and we use a quorum-based protocol to replicate
data across the bookies. There are basically two operations to an existing ledger: read and
append. Here is the complete API list (more detail "here":./bookkeeperProgrammer.html):
 
 * Create ledger: creates a new empty ledger; 
 * Open ledger: opens an existing ledger for reading; 
@@ -58,7 +58,7 @@ p. A set of bookies implements BookKeepe
 p. There is only a single client that can write to a ledger. Once that ledger is closed or
the client fails, no more entries can be added. (We take advantage of this behavior to provide
our strong guarantees.) There will not be gaps in the ledger. Fingers get broken, people get
roughed up or end up in prison when books are manipulated, so there is no deleting or changing
of entries. 
 
 !images/bk-overview.jpg!
-p. A simple use of BooKeeper is to implement a write-ahead transaction log. A server maintains
an in-memory data structure (with periodic snapshots for example) and logs changes to that
structure before it applies the change. The application server creates a ledger at startup
and store the ledger id and password in a well known place (ZooKeeper maybe). When it needs
to make a change, the server adds an entry with the change information to a ledger and apply
the change when BookKeeper adds the entry successfully. The server can even use asyncAddEntry
to queue up many changes for high change throughput. BooKeeper meticulously logs the changes
in order and call the completion functions in order. 
+p. A simple use of BookKeeper is to implement a write-ahead transaction log. A server maintains
an in-memory data structure (with periodic snapshots for example) and logs changes to that
structure before it applies the change. The application server creates a ledger at startup
and store the ledger id and password in a well known place (ZooKeeper maybe). When it needs
to make a change, the server adds an entry with the change information to a ledger and apply
the change when BookKeeper adds the entry successfully. The server can even use asyncAddEntry
to queue up many changes for high change throughput. BookKeeper meticulously logs the changes
in order and call the completion functions in order.
 
 p. When the application server dies, a backup server will come online, get the last snapshot
and then it will open the ledger of the old server and read all the entries from the time
the snapshot was taken. (Since it doesn't know the last entry number it will use MAX_INTEGER).
Once all the entries have been processed, it will close the ledger and start a new one for
its use. 
 

Modified: bookkeeper/site/trunk/content/docs/master/bookkeeperStarted.textile
URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/master/bookkeeperStarted.textile?rev=1697189&r1=1697188&r2=1697189&view=diff
==============================================================================
--- bookkeeper/site/trunk/content/docs/master/bookkeeperStarted.textile (original)
+++ bookkeeper/site/trunk/content/docs/master/bookkeeperStarted.textile Sun Aug 23 15:20:12
2015
@@ -16,7 +16,7 @@ This guide contains detailed information
 
 h1. Getting Started: Setting up BookKeeper to write logs.
 
-p. This document contains information to get you started quickly with BookKeeper. It is aimed
primarily at developers willing to try it out, and contains simple installation instructions
for a simple BookKeeper installation and a simple programming example. For further programming
detail, please refer to  "BookKeeper Programmer's Guide":bookkeeperProgrammer.html. 
+p. This document contains information to get you started quickly with BookKeeper. It is aimed
primarily at developers willing to try it out, and contains simple installation instructions
for a simple BookKeeper installation and a simple programming example. For further programming
detail, please refer to the "BookKeeper Tutorial":./bookkeeperTutorial.html.
 
 h1. Pre-requisites
 
@@ -24,7 +24,7 @@ p. See "System Requirements":./bookkeepe
 
 h1. Download
 
-p. BookKeeper trunk can be downloaded from subversion. See "Version Control:http://zookeeper.apache.org/bookkeeper/svn.html.

+p. BookKeeper trunk can be downloaded from subversion. See "Version Control":http://bookkeeper.apache.org/svn.html.
 
 h1. LocalBookKeeper
 
@@ -99,4 +99,4 @@ while(ls.hasMoreElements()){
 }
 lh.close();
 bkc.close();
-</code></pre>
\ No newline at end of file
+</code></pre>

Modified: bookkeeper/site/trunk/content/docs/master/bookkeeperTutorial.textile
URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/master/bookkeeperTutorial.textile?rev=1697189&r1=1697188&r2=1697189&view=diff
==============================================================================
--- bookkeeper/site/trunk/content/docs/master/bookkeeperTutorial.textile (original)
+++ bookkeeper/site/trunk/content/docs/master/bookkeeperTutorial.textile Sun Aug 23 15:20:12
2015
@@ -16,7 +16,7 @@ Notice:    Licensed to the Apache Softwa
            specific language governing permissions and limitations
            under the License.
 
-This tutorial aims to show you how to build a replicated distributed system using Bookkeeper
as the replicated log. Before we start, you will need to have a bookkeeper cluster up and
running. You can download the bookkeeper distribution at "https://zookeeper.apache.org/bookkeeper/releases.html":https://zookeeper.apache.org/bookkeeper/releases.html.
The binary distribution, bookkeeper-server-4.x.x-bin.tar.gz, will be sufficient for the tutorial.
+This tutorial aims to show you how to build a replicated distributed system using Bookkeeper
as the replicated log. Before we start, you will need to have a bookkeeper cluster up and
running. You can download the bookkeeper distribution at "http://bookkeeper.apache.org/releases.html":http://bookkeeper.apache.org/releases.html.
The binary distribution, bookkeeper-server-4.x.x-bin.tar.gz, will be sufficient for the tutorial.
 This tutorial does not cover the setup of a distributed cluster, but you can run a local
cluster on your machine by running:
 
 <pre>

Added: bookkeeper/site/trunk/content/docs/master/hedwigDocs.textile
URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/master/hedwigDocs.textile?rev=1697189&view=auto
==============================================================================
--- bookkeeper/site/trunk/content/docs/master/hedwigDocs.textile (added)
+++ bookkeeper/site/trunk/content/docs/master/hedwigDocs.textile Sun Aug 23 15:20:12 2015
@@ -0,0 +1,31 @@
+Title:     Hedwig Documentation
+Notice:    Licensed to the Apache Software Foundation (ASF) under one
+           or more contributor license agreements.  See the NOTICE file
+           distributed with this work for additional information
+           regarding copyright ownership.  The ASF licenses this file
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this file except in compliance
+           with the License.  You may obtain a copy of the License at
+           .
+             http://www.apache.org/licenses/LICENSE-2.0
+           .
+           Unless required by applicable law or agreed to in writing,
+           software distributed under the License is distributed on an
+           "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+           KIND, either express or implied.  See the License for the
+           specific language governing permissions and limitations
+           under the License.
+
+h1. Apache Hedwig documentation
+
+* "Building Hedwig, or how to set up Hedwig":./hedwigBuild.html
+* "User's Guide, or how to program against the Hedwig API and how to run it":./hedwigUser.html
+* "Developer's Guide, or Hedwig internals and hacking details":./hedwigDesign.html
+* "Configuration parameters":./hedwigParams.html
+* "Message Filtering":./hedwigMessageFilter.html
+* "Hedwig Metadata Management":./hedwigMetadata.html
+
+h2. Hedwig Admin & Ops
+
+* "Hedwig Console":./hedwigConsole.html
+* "Hedwig JMX":./hedwigJMX.html

Modified: bookkeeper/site/trunk/content/docs/master/index.textile
URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/master/index.textile?rev=1697189&r1=1697188&r2=1697189&view=diff
==============================================================================
--- bookkeeper/site/trunk/content/docs/master/index.textile (original)
+++ bookkeeper/site/trunk/content/docs/master/index.textile Sun Aug 23 15:20:12 2015
@@ -16,37 +16,39 @@ Notice:    Licensed to the Apache Softwa
            specific language governing permissions and limitations
            under the License.
 
-h1. Apache BookKeeper documentation
+How to start with BookKeeper depends on who you are...
 
-* "Overview":./bookkeeperOverview.html
-* "Getting started":./bookkeeperStarted.html
-* "Programmer's Guide":./bookkeeperProgrammer.html
-* "Bookie Server Configuration Parameters":./bookieConfigParams.html
-* "BookKeeper Configuration Parameters":./bookkeeperConfigParams.html
-* "BookKeeper Internals":./bookkeeperInternals.html
-* "Bookie Recovery":./bookieRecovery.html
-* "Using BookKeeper stream library":./bookkeeperStream.html
-* "BookKeeper Metadata Management":./bookkeeperMetadata.html
+*Developers* who are new to BookKeeper should start with the "BookKeeper Tutorial":./bookkeeperTutorial.html.
The tutorial shows you how to build a basic distributed system using BookKeeper. "Turning
ledgers into logs":./bookkeeperLedgers2Logs.html gives a briefer description of the principles
behind the logs used in the tutorial.
 
-h2. BookKeeper Admin & Ops
+Once familiar with the basic concepts, developers can consult the "BookKeeper Java API documentation":./apidocs.
 
-* "Admin Guide":./bookkeeperConfig.html
-* "BookKeeper JMX":./bookkeeperJMX.html
+*Administrators* will be more interested in the "BookKeeper Admin guide":./bookkeeperConfig.html.
It describes the steps involved in setting up and maintaining a cluster. The available configuration
parameters can be found "here":./bookieConfigParams.html. An important aspect of BookKeeper
is how it deals with the failure of storage nodes. This is covered in "Bookie Recovery":./bookieRecovery.html.
 
-h1. Apache Hedwig documentation
+*Contributor* documentation is less organized, "BookKeeper Internals":./bookkeeperInternals.html
is a good place to start. From there you can check out our "wiki":https://cwiki.apache.org/confluence/display/BOOKKEEPER/Index
and ask questions on our "mailing lists":/lists.html or "IRC":/irc.html.
 
-* "Building Hedwig, or how to set up Hedwig":./hedwigBuild.html
-* "User's Guide, or how to program against the Hedwig API and how to run it":./hedwigUser.html
-* "Developer's Guide, or Hedwig internals and hacking details":./hedwigDesign.html
-* "Configuration parameters":./hedwigParams.html
-* "Message Filtering":./hedwigMessageFilter.html
-* "Hedwig Metadata Management":./hedwigMetadata.html
+Hedwig documentation can be found "here":./hedwigDocs.html.
 
-h2. Hedwig Admin & Ops
+h3. All documents
 
-* "Hedwig Console":./hedwigConsole.html
-* "Hedwig JMX":./hedwigJMX.html
+* Overview
+** "Getting started":./bookkeeperStarted.html
+** "Overview":./bookkeeperOverview.html
 
-h1. Metastore documentation
+* Developers
+** "BookKeeper Tutorial":./bookkeeperTutorial.html
+** "Turning ledgers into logs":./bookkeeperLedgers2Logs.html
+** "BookKeeper Java API documentation":./apidocs
+** "Programmer's Guide (old)":./bookkeeperProgrammer.html
+** "BookKeeper Configuration Parameters (old)":./bookkeeperConfigParams.html
 
-* "Metastore Interface":./metastore.textile
+
+* Administrators
+** "Admin Guide":./bookkeeperConfig.html
+** "BookKeeper JMX":./bookkeeperJMX.html
+** "Bookie Server Configuration Parameters (old)":./bookieConfigParams.html
+** "Bookie Recovery":./bookieRecovery.html
+
+* Contributors
+** "BookKeeper Internals":./bookkeeperInternals.html
+** "BookKeeper Metadata Management":./bookkeeperMetadata.html
+** "Metastore Interface":./metastore.textile



Mime
View raw message