Bigtop 0.7.0 release: updating documentation
[bigtop.git] / src / site / xdoc / index.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!--
3 Licensed to the Apache Software Foundation (ASF) under one or more
4 contributor license agreements. See the NOTICE file distributed with
5 this work for additional information regarding copyright ownership.
6 The ASF licenses this file to You under the Apache License, Version 2.0
7 (the "License"); you may not use this file except in compliance with
8 the License. You may obtain a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
17 -->
18 <document xmlns="http://maven.apache.org/XDOC/2.0"
19 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20 xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
21 <properties></properties>
22 <body>
23
24 <section name="Apache Bigtop"></section>
25 <p>Bigtop is a project for the development of packaging and tests of the Apache Hadoop ecosystem.
26 <br/><br/>
27 The primary goal of Bigtop is to build a community around the packaging and interoperability testing
28 of Hadoop-related projects. This includes testing at various levels (packaging, platform, runtime, upgrade, etc...)
29 developed by a community with a focus on the system as a whole, rather than individual projects.</p>
30 <br/><br/>
31 <subsection name="Building Bigtop"></subsection>
32 <p>Packages have been built on Ubuntu 10.10, CentOS 5/6, Fedora 18, Mageia 1 and openSUSE 12.2
33 They can probably be built on other platforms as well.<br/><br/>
34 Building Bigtop requires the following tools:</p>
35 <ul>
36 <li>Java JDK 1.6</li>
37 <li>Apache Ant</li>
38 <li>Apache Maven</li>
39 <li>wget</li>
40 <li>tar</li>
41 <li>git</li>
42 <li>subversion</li>
43 <li>gcc</li>
44 <li>gcc-c++</li>
45 <li>make</li>
46 <li>fuse</li>
47 <li>protobuf-compiler</li>
48 <li>autoconf</li>
49 <li>automake</li>
50 <li>libtool</li>
51 <li>sharutils</li>
52 <li>asciidoc</li>
53 <li>xmlto</li>
54 </ul>
55 <p>On RPM-based systems one also needs</p>
56 <ul>
57 <li>lzo-devel</li>
58 <li>zlib-devel</li>
59 <li>fuse-devel</li>
60 <li>openssl-devel</li>
61 <li>python-devel</li>
62 <li>libxml2-devel</li>
63 <li>libxslt-devel</li>
64 <li>cyrus-sasl-devel</li>
65 <li>sqlite-devel</li>
66 <li>mysql-devel</li>
67 <li>openldap-devel</li>
68 <li>rpm-build</li>
69 <li>createrepo</li>
70 <li>redhat-rpm-config (RedHat/CentOS only)</li>
71 </ul>
72 <p>On DEB-based systems one also needs</p>
73 <ul>
74 <li>libxslt1-dev</li>
75 <li>libkrb5-dev</li>
76 <li>libldap2-dev</li>
77 <li>libmysqlclient-dev</li>
78 <li>libsasl2-dev</li>
79 <li>libsqlite3-dev</li>
80 <li>libxml2-dev</li>
81 <li>python-dev</li>
82 <li>python-setuptools</li>
83 <li>liblzo2-dev</li>
84 <li>libzip-dev</li>
85 <li>libfuse-dev</li>
86 <li>libssl-dev</li>
87 <li>build-essential</li>
88 <li>dh-make</li>
89 <li>debhelper</li>
90 <li>devscripts</li>
91 <li>reprepro</li>
92 </ul>
93 <subsection name="Continuous Integration"></subsection>
94 <p>
95 Apache Bigtop uses Jenkins for continuous integration testing (you can learn more about Jenkins <a href="http://jenkins-ci.org/">here</a>).
96 There are 2 Jenkins servers currently running for the project:
97 </p>
98 <ul>
99 <li><a href="https://builds.apache.org/view/A-F/view/Bigtop/">https://builds.apache.org/view/A-F/view/Bigtop/</a></li>
100 <li><a href="http://bigtop01.cloudera.org:8080/">http://bigtop01.cloudera.org:8080/</a></li>
101 </ul>
102 <p>
103 The Apache Jenkins server runs the "Bigtop-trunk" job whenever code is committed to the trunk branch, which in turn runs several test jobs.
104 </p>
105 <p>
106 The Bigtop Jenkins server runs daily jobs for the 0.3 and trunk branches, and each job has a configuration for each supported operating system.
107 In each branch there is a job to build each component, a job to run package tests and a job to build package repositories.
108 There are also jobs for building virtual machine images as well as the 2 most recent releases and other miscellaneous tasks for various RCs and tests.
109 For example:
110 </p>
111 <ul>
112 <li><a href="http://bigtop01.cloudera.org:8080/view/Bigtop-trunk/job/Bigtop-trunk-All/">Bigtop-trunk-All</a>: Runs all of the jobs for the trunk branch.</li>
113 <li><a href="http://bigtop01.cloudera.org:8080/view/Bigtop-trunk/job/Bigtop-trunk-HBase/">Bigtop-trunk-HBase</a>: Builds the HBase packages only.</li>
114 <li><a href="http://bigtop01.cloudera.org:8080/view/Bigtop-trunk/job/Bigtop-trunk-packagetest/">Bigtop-trunk-packagetest</a>: Runs the package tests.</li>
115 <li><a href="http://bigtop01.cloudera.org:8080/view/Bigtop-trunk/job/Bigtop-trunk-repository/">Bigtop-trunk-repository</a>: Builds an APT or YUM package repository.</li>
116 <li><a href="http://bigtop01.cloudera.org:8080/view/Bigtop-trunk/job/Bigtop-0.5.0/">Bigtop-0.5.0</a>: Builds the 0.5.0 release.</li>
117 <li><a href="http://bigtop01.cloudera.org:8080/job/Bigtop-VM-matrix/">Bigtop-VM-matrix</a>: Builds virtual machines of branches trunk and 0.3 for KVM, VMWare and VirtualBox.</li>
118 </ul>
119 </body>
120 </document>