openstack/sahara
Code Issues Proposed changes

Update the docs for CDH plugin userdoc and image-builder doc

Browse Source 
We update the contents to update some obsolete info.

Closes-Bug: #1431103
Change-Id: I8bc6a8d1966481190a9e0809bd3c1072acf41045
This commit is contained in:
Ken Chen 2015-03-12 09:39:13 +08:00
parent 3814c2796e
commit 6b170370e0
2 changed files with 14 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/userdoc/cdh_imagebuilder.rst
View File

@ -4,7 +4,7 @@ Building Images for Cloudera Plugin
===================================
In this document you will find instructions on how to build Ubuntu and CentOS
images with Cloudera Express versions 5.2.0.
images with Cloudera Express (now only 5.0.0 and 5.3.0 versions are supported).
Apache Hadoop. To simplify the task of building such images we use
`Disk Image Builder <https://github.com/openstack/diskimage-builder>`_.
@ -35,13 +35,16 @@ To create cloudera images follow these steps:
(subset of Ubuntu, Fedora, and CentOS depending on plugin). To only create
Cloudera images, you should use the "-p cloudera" parameter in the command
line. If you want to create the image only for a specific operating system,
you should use the "-i ubuntu|fedora|centos" parameter to assign the operating
system. This script must be run with root privileges. Below is an example to
create Cloudera images for both Ubuntu and CentOS.
you should use the "-i ubuntu|centos" parameter to assign the operating
system (the cloudera plugin only supports Ubuntu and Centos). If you want
to create the image only for a specific Cloudera version, you should use the
"-v 5.0|5.3" parameter to assign the version. This script must be run with
root privileges. Below is an example to create Cloudera images for both
Ubuntu and CentOS with Cloudera Express 5.3.0 version.
.. sourcecode:: console
sudo bash diskimage-create.sh -p cloudera
sudo bash diskimage-create.sh -p cloudera -v 5.3
NOTE: If you don't want to use default values, you should explicitly set the
values of your required parameters.

22
doc/source/userdoc/cdh_plugin.rst
View File

@ -4,26 +4,16 @@ Cloudera Plugin
The cloudera plugin is a Sahara plugin which allows the user to deploy and
operate a cluster with Cloudera Manager.
The cloudera plugin is not enabled in Sahara by default. To enable it you should
manually modify the Sahara configuration file (default /etc/sahara/sahara.conf)
to add "cdh" in "plugins" value.
.. sourcecode:: cfg
plugins=cdh,vanilla,hdp,fake
To use the cloudera plugin, you should have cm_api (version >=8.0.0) installed
on the server where Sahara is running. To install cm_api, simply use pip:
.. sourcecode:: console
sudo pip install cm_api
The cloudera plugin is enabled in Sahara by default. You can manually
modify the Sahara configuration file (default /etc/sahara/sahara.conf) to
explicitly enable or disable it in "plugins" line.
You need to build images using :doc:`cdh_imagebuilder` to produce images used
to provision cluster. They already have Cloudera Express 5.2.0 installed.
to provision cluster. They already have Cloudera Express installed (5.0.0 or
5.3.0 version).
The cloudera plugin requires an image to be tagged in Sahara Image Registry with
two tags: 'cdh' and '<cloudera version>' (e.g. '5').
two tags: 'cdh' and '<cloudera version>' (e.g. '5' or '5.3.0').
The default username specified for these images is different for each
distribution: