| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta content="Apache Forrest" name="Generator"> |
| <meta name="Forrest-version" content="0.9"> |
| <meta name="Forrest-skin-name" content="pelt"> |
| <title>BookKeeper Getting Started Guide</title> |
| <link type="text/css" href="skin/basic.css" rel="stylesheet"> |
| <link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet"> |
| <link media="print" type="text/css" href="skin/print.css" rel="stylesheet"> |
| <link type="text/css" href="skin/profile.css" rel="stylesheet"> |
| <script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script> |
| <link rel="shortcut icon" href="images/favicon.ico"> |
| </head> |
| <body onload="init()"> |
| <script type="text/javascript">ndeSetTextSize();</script> |
| <div id="top"> |
| <!--+ |
| |breadtrail |
| +--> |
| <div class="breadtrail"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://hadoop.apache.org/">Hadoop</a> > <a href="http://hadoop.apache.org/zookeeper/">ZooKeeper</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script> |
| </div> |
| <!--+ |
| |header |
| +--> |
| <div class="header"> |
| <!--+ |
| |start group logo |
| +--> |
| <div class="grouplogo"> |
| <a href="http://hadoop.apache.org/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Apache Hadoop"></a> |
| </div> |
| <!--+ |
| |end group logo |
| +--> |
| <!--+ |
| |start Project Logo |
| +--> |
| <div class="projectlogo"> |
| <a href="http://hadoop.apache.org/zookeeper/"><img class="logoImage" alt="ZooKeeper" src="images/zookeeper_small.gif" title="ZooKeeper: distributed coordination"></a> |
| </div> |
| <!--+ |
| |end Project Logo |
| +--> |
| <!--+ |
| |start Search |
| +--> |
| <div class="searchbox"> |
| <form action="http://www.google.com/search" method="get" class="roundtopsmall"> |
| <input value="hadoop.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google"> |
| <input name="Search" value="Search" type="submit"> |
| </form> |
| </div> |
| <!--+ |
| |end search |
| +--> |
| <!--+ |
| |start Tabs |
| +--> |
| <ul id="tabs"> |
| <li> |
| <a class="unselected" href="http://hadoop.apache.org/zookeeper/">Project</a> |
| </li> |
| <li> |
| <a class="unselected" href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a> |
| </li> |
| <li class="current"> |
| <a class="selected" href="index.html">ZooKeeper 3.3 Documentation</a> |
| </li> |
| </ul> |
| <!--+ |
| |end Tabs |
| +--> |
| </div> |
| </div> |
| <div id="main"> |
| <div id="publishedStrip"> |
| <!--+ |
| |start Subtabs |
| +--> |
| <div id="level2tabs"></div> |
| <!--+ |
| |end Endtabs |
| +--> |
| <script type="text/javascript"><!-- |
| document.write("Last Published: " + document.lastModified); |
| // --></script> |
| </div> |
| <!--+ |
| |breadtrail |
| +--> |
| <div class="breadtrail"> |
| |
| |
| </div> |
| <!--+ |
| |start Menu, mainarea |
| +--> |
| <!--+ |
| |start Menu |
| +--> |
| <div id="menu"> |
| <div onclick="SwitchMenu('menu_1.1', 'skin/')" id="menu_1.1Title" class="menutitle">Overview</div> |
| <div id="menu_1.1" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="index.html">Welcome</a> |
| </div> |
| <div class="menuitem"> |
| <a href="zookeeperOver.html">Overview</a> |
| </div> |
| <div class="menuitem"> |
| <a href="zookeeperStarted.html">Getting Started</a> |
| </div> |
| <div class="menuitem"> |
| <a href="releasenotes.html">Release Notes</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div> |
| <div id="menu_1.2" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="api/index.html">API Docs</a> |
| </div> |
| <div class="menuitem"> |
| <a href="zookeeperProgrammers.html">Programmer's Guide</a> |
| </div> |
| <div class="menuitem"> |
| <a href="javaExample.html">Java Example</a> |
| </div> |
| <div class="menuitem"> |
| <a href="zookeeperTutorial.html">Barrier and Queue Tutorial</a> |
| </div> |
| <div class="menuitem"> |
| <a href="recipes.html">Recipes</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_selected_1.3', 'skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">BookKeeper</div> |
| <div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;"> |
| <div class="menupage"> |
| <div class="menupagetitle">Getting started</div> |
| </div> |
| <div class="menuitem"> |
| <a href="bookkeeperOverview.html">Overview</a> |
| </div> |
| <div class="menuitem"> |
| <a href="bookkeeperConfig.html">Setup guide</a> |
| </div> |
| <div class="menuitem"> |
| <a href="bookkeeperProgrammer.html">Programmer's guide</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.4', 'skin/')" id="menu_1.4Title" class="menutitle">Admin & Ops</div> |
| <div id="menu_1.4" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="zookeeperAdmin.html">Administrator's Guide</a> |
| </div> |
| <div class="menuitem"> |
| <a href="zookeeperQuotas.html">Quota Guide</a> |
| </div> |
| <div class="menuitem"> |
| <a href="zookeeperJMX.html">JMX</a> |
| </div> |
| <div class="menuitem"> |
| <a href="zookeeperObservers.html">Observers Guide</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title" class="menutitle">Contributor</div> |
| <div id="menu_1.5" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="zookeeperInternals.html">ZooKeeper Internals</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.6', 'skin/')" id="menu_1.6Title" class="menutitle">Miscellaneous</div> |
| <div id="menu_1.6" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://wiki.apache.org/hadoop/ZooKeeper/FAQ">FAQ</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://hadoop.apache.org/zookeeper/mailing_lists.html">Mailing Lists</a> |
| </div> |
| </div> |
| <div id="credit"></div> |
| <div id="roundbottom"> |
| <img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div> |
| <!--+ |
| |alternative credits |
| +--> |
| <div id="credit2"></div> |
| </div> |
| <!--+ |
| |end Menu |
| +--> |
| <!--+ |
| |start content |
| +--> |
| <div id="content"> |
| <div title="Portable Document Format" class="pdflink"> |
| <a class="dida" href="bookkeeperStarted.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br> |
| PDF</a> |
| </div> |
| <h1>BookKeeper Getting Started Guide</h1> |
| <div id="front-matter"> |
| <div id="minitoc-area"> |
| <ul class="minitoc"> |
| <li> |
| <a href="#bk_GettingStarted">Getting Started: Setting up BookKeeper to write logs.</a> |
| <ul class="minitoc"> |
| <li> |
| <a href="#bk_Prerequisites">Pre-requisites</a> |
| </li> |
| <li> |
| <a href="#bk_Download">Download</a> |
| </li> |
| <li> |
| <a href="#bk_localBK">LocalBookKeeper</a> |
| </li> |
| <li> |
| <a href="#bk_setupBookies">Setting up bookies</a> |
| </li> |
| <li> |
| <a href="#bk_setupZK">Setting up ZooKeeper</a> |
| </li> |
| <li> |
| <a href="#bk_example">Example</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| <a name="bk_GettingStarted"></a> |
| <h2 class="h3">Getting Started: Setting up BookKeeper to write logs.</h2> |
| <div class="section"> |
| <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 |
| <a href="bookkeeperProgrammer.html">BookKeeper Programmer's Guide</a>. |
| </p> |
| <a name="bk_Prerequisites"></a> |
| <h3 class="h4">Pre-requisites</h3> |
| <p>See <a href="bookkeeperConfig.html#bk_sysReq"> |
| System Requirements</a> in the Admin guide.</p> |
| <a name="bk_Download"></a> |
| <h3 class="h4">Download</h3> |
| <p> BookKeeper is distributed along with ZooKeeper. To get a ZooKeeper distribution, |
| download a recent |
| <a href="http://hadoop.apache.org/zookeeper/releases.html"> |
| stable</a> release from one of the Apache Download |
| Mirrors.</p> |
| <a name="bk_localBK"></a> |
| <h3 class="h4">LocalBookKeeper</h3> |
| <p> Under org.apache.bookkeeper.util, you'll find a java program |
| called LocalBookKeeper.java that sets you up to run BookKeeper on a |
| single machine. This is far from ideal from a performance perspective, |
| but the program is useful for both test and educational purposes. |
| </p> |
| <a name="bk_setupBookies"></a> |
| <h3 class="h4">Setting up bookies</h3> |
| <p> If you're bold and you want more than just running things locally, then |
| you'll need to run bookies in different servers. You'll need at least three bookies |
| to start with. |
| </p> |
| <p> |
| For each bookie, we need to execute a command like the following: |
| </p> |
| <p> |
| <span class="codefrag computeroutput"> |
| java -cp .:./zookeeper-<version>-bookkeeper.jar:./zookeeper-<version>.jar:../log4j/apache-log4j-1.2.15/log4j-1.2.15.jar\ |
| -Dlog4j.configuration=log4j.properties org.apache.bookkeeper.proto.BookieServer 3181 /path_to_log_device/\ |
| /path_to_ledger_device/ |
| </span> |
| </p> |
| <p> "/path_to_log_device/" and "/path_to_ledger_device/" are different paths. Also, port 3181 |
| is the port that a bookie listens on for connection requests from clients. |
| </p> |
| <a name="bk_setupZK"></a> |
| <h3 class="h4">Setting up ZooKeeper</h3> |
| <p> ZooKeeper stores metadata on behalf of BookKeeper clients and bookies. To get a minimal |
| ZooKeeper installation to work with BookKeeper, we can set up one server running in |
| standalone mode. Once we have the server running, we need to create a few znodes: |
| </p> |
| <ol> |
| |
| <li> |
| |
| <p> |
| <span class="codefrag computeroutput"> |
| /ledgers |
| </span> |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| |
| <p> |
| <span class="codefrag computeroutput"> |
| /ledgers/available |
| </span> |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| |
| <p> For each bookie, we add one znode such that the name of the znode is the |
| concatenation of the machine name and the port number that the bookie is |
| listening on. For example, if a bookie is running on bookie.foo.com an is listening |
| on port 3181, we add a znode |
| <span class="codefrag computeroutput">/ledgers/available/bookie.foo.com:3181</span>. |
| </p> |
| |
| </li> |
| |
| </ol> |
| <a name="bk_example"></a> |
| <h3 class="h4">Example</h3> |
| <p> |
| In the following excerpt of code, we: |
| </p> |
| <ol> |
| |
| <li> |
| |
| <p> |
| Create a ledger; |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| |
| <p> |
| Write to the ledger; |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| |
| <p> |
| Close the ledger; |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| |
| <p> |
| Open the same ledger for reading; |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| |
| <p> |
| Read from the ledger; |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| |
| <p> |
| Close the ledger again; |
| </p> |
| |
| </li> |
| |
| </ol> |
| <pre class="code"> |
| LedgerHandle lh = bkc.createLedger(ledgerPassword); |
| ledgerId = lh.getId(); |
| ByteBuffer entry = ByteBuffer.allocate(4); |
| |
| for(int i = 0; i < 10; i++){ |
| entry.putInt(i); |
| entry.position(0); |
| entries.add(entry.array()); |
| lh.addEntry(entry.array()); |
| } |
| lh.close(); |
| lh = bkc.openLedger(ledgerId, ledgerPassword); |
| |
| LedgerSequence ls = lh.readEntries(0, 9); |
| int i = 0; |
| while(ls.hasMoreElements()){ |
| ByteBuffer origbb = ByteBuffer.wrap( |
| entries.get(i++)); |
| Integer origEntry = origbb.getInt(); |
| ByteBuffer result = ByteBuffer.wrap( |
| ls.nextElement().getEntry()); |
| |
| Integer retrEntry = result.getInt(); |
| } |
| lh.close(); |
| </pre> |
| </div> |
| |
| <p align="right"> |
| <font size="-2"></font> |
| </p> |
| </div> |
| <!--+ |
| |end content |
| +--> |
| <div class="clearboth"> </div> |
| </div> |
| <div id="footer"> |
| <!--+ |
| |start bottomstrip |
| +--> |
| <div class="lastmodified"> |
| <script type="text/javascript"><!-- |
| document.write("Last Published: " + document.lastModified); |
| // --></script> |
| </div> |
| <div class="copyright"> |
| Copyright © |
| 2008-2013 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a> |
| </div> |
| <!--+ |
| |end bottomstrip |
| +--> |
| </div> |
| </body> |
| </html> |
