openstack/openstack-manuals
Code Issues Proposed changes

rough draft v2, structural changes

Browse Source 
removed sets, adding in remote include, editorial changes from diane

Change-Id: I557303b68c4ca5b5d9f9664e200db3ab6286794e
This commit is contained in:
Sean Roberts 2013-07-17 20:20:57 -07:00
parent 070e387f36
commit 4291371b04
18 changed files with 474 additions and 350 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/src/docbkx/openstack-training/bk001-preface.xml Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk001-preface">
<title>Preface</title>
<para>OpenStack™ Training Guides offers open source software training for cloud
administration and management for any organization. </para>
<section xml:id="Document_Change_History-d1e118">
<title>Document Change History</title>
<para>The following table describes the most recent changes:</para>
<?rax revhistory?>
</section>
<section xml:id="references_and_credits">
<title>References and Credits</title>
<para>The training materials include the following materials:</para>
</section>
<!-- <xi:include href="https://raw.github.com/openstack/operations-guide/master/doc/src/docbkx/openstack-ops/src/preface_ops.xml" parse="xml" xpointer="chapter_gk2_jpr_lj"/> -->
</preface>

8
doc/src/docbkx/openstack-training/bk002-associate-training-guide.xml Normal file
View File

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk002-associate-training-guide">
<title>Associate Training Guide</title>
<xi:include href="bk002-ch001-associate-getting-started.xml"/>
<xi:include href="bk002-ch050-associate-assessment.xml"/>
</book>

17
doc/src/docbkx/openstack-training/bk002-ch001-associate-getting-started.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk002-ch001-associate-getting-started">
<title>Associate Getting Started</title>
<section xml:id="associate-section-one">
<title>Associate section one</title>
<para>
<orderedlist>
<listitem>
<para/>
</listitem>
</orderedlist>
</para>
</section>
<xi:include href="https://raw.github.com/openstack/operations-guide/master/doc/src/docbkx/openstack-ops/src/ch_arch_provision.xml" parse="xml" xpointer="automated_deploy"/>
</chapter>

8
doc/src/docbkx/openstack-training/associate-assessment.xml → doc/src/docbkx/openstack-training/bk002-ch050-associate-assessment.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_associate-assessment">
xml:id="bk002-ch050-associate-assessment">
<title>Associate Assessment</title>
<section xml:id="associate-assessment">
<title>Associate Assessment</title>
<section xml:id="associate-sections">
<title>Associate Sections</title>
<para>
<orderedlist>
<listitem>
@ -13,4 +13,4 @@
</orderedlist>
</para>
</section>
</chapter>
</chapter>

16
doc/src/docbkx/openstack-training/bk003-ch001-operations-getting-started.xml Normal file
View File

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-ch002-operations-getting-started">
<title>Operations Getting Started</title>
<section xml:id="operations-getting-started">
<title>Operations Getting Started</title>
<para>
<orderedlist>
<listitem>
<para/>
</listitem>
</orderedlist>
</para>
</section>
</chapter>

280
doc/src/docbkx/openstack-training/operations-fix-bug.xml → doc/src/docbkx/openstack-training/bk003-ch002-operations-fix-bug.xml
View File

@ -1,276 +1,276 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_operations-fix-bug">
xml:id="bk003-ch002-operations-fix-bug">
<title>Fix a Bug</title>
<section xml:id="getting-tools-and-accounts">
<title>Getting Tools and Accounts</title>
<para>
<orderedlist>
<listitem>
<para>Create a GitHub account at github.com</para>
</listitem>
<listitem>
<procedure>
<step>
<para>Create a GitHub account at github.com.</para>
</step>
<step>
<para>Create your local repository directory
<programlisting>$ mkdir /Users/yourusername/code/</programlisting>
</para>
</listitem>
<listitem>
</step>
<step>
<para>Install SourceTree</para>
<itemizedlist>
<listitem>
<procedure>
<step>
<para>through OSX AppManager</para>
</listitem>
<listitem>
</step>
<step>
<para>Ignore the Atlassian Bitbucket and Stack setup</para>
</listitem>
<listitem>
</step>
<step>
<para>Add your GitHub username and password</para>
</listitem>
<listitem>
</step>
<step>
<para>Set your local </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
</step>
</procedure>
</step>
<step>
<para>Install Oxygen</para>
<itemizedlist>
<listitem>
<procedure>
<step>
<para><link xlink:href="http://www.oxygenxml.com/download_oxygenxml_editor.html"
>http://www.oxygenxml.com/download_oxygenxml_editor.html</link></para>
</listitem>
<listitem>
</step>
<step>
<para>Request the openstack registration code from anne@openstack.org</para>
</listitem>
<listitem>
</step>
<step>
<para>Start Oxygen, use registration code from anne obtain the oxygen license</para>
</listitem>
<listitem>
</step>
<step>
<para>You will receive an email with the license data in it. Copy and paste everything
between and including ------START-LICENSE-KEY------ and
-------END-LICENSE-KEY------- </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
</step>
</procedure>
</step>
<step>
<para>Install Maven</para>
<itemizedlist>
<listitem>
<procedure>
<step>
<para><programlisting>$ mkdir /usr/local/apache-maven</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>The latest stable binary from <link
xlink:href="http://maven.apache.org/download.cgi"
>http://maven.apache.org/download.cgi</link> into /usr/local/apache-maven</para>
</listitem>
<listitem>
</step>
<step>
<para>create variables</para>
</listitem>
<listitem>
</step>
<step>
<para>
<orderedlist>
<listitem>
<procedure>
<step>
<para><programlisting>export M2_HOME=/usr/local/apache-maven/apache-maven-3.0.5
export M2=$M2_HOME/bin
export PATH=$M2:$PATH
export MAVEN_OPTS='-Xms256m -XX:MaxPermSize=1024m -Xmx1024m'</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>verify maven is setup with
<programlisting>$ mvn --install</programlisting></para>
</listitem>
</orderedlist>
</step>
</procedure>
</para>
</listitem>
</itemizedlist>
</listitem>
</step>
</procedure>
</step>
<!-- the next five paragraphs were lifted from https://wiki.openstack.org/wiki/Documentation/HowTo#First-time_Contributors, we should figure out how to embed instead -->
<listitem>
<step>
<para>Create a Launchpad account: Visit https://login.launchpad.net/+new_account After you
create this account, the followup page is slightly confusing. It doesn't tell you that
you are done. (It gives you the opportunity to change your -password, but you do not
have to.) </para>
</listitem>
<listitem>
</step>
<step>
<para>Add at least one SSH key to your account profile. To do this, follow the
instructions onhttps://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair. </para>
</listitem>
<listitem>
</step>
<step>
<para>Sign the CLA: Every developer and contributor needs to sign the Individual
Contributor License agreement and join the OpenStack Foundation. Visit
https://review.openstack.org/ and click the Sign In link at the top-right corner of the
page. Log in with your Launchpad ID. You can preview the text of the Individual
CLA.</para>
</listitem>
<listitem>
</step>
<step>
<para>Create a Github account and add SSH keys to your account profile (same one as used
in Launchpad, they must match). When you copy and paste the SSH key, include the ssh-rsa
algorithm and computer identifier. If this is your first time setting up git and Github,
be sure to run these steps in a Terminal window:
<programlisting>$ git config --global user.name "Firstname Lastname"
$ git config --global user.email "your_email@youremail.com" </programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Install git-review. If pip is not already installed, use "sudo easy_install pip" to
install it on a Mac or Ubuntu
<programlisting>$ sudo pip install git-review</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Create the location for your repository
<programlisting>$ mkdir /Users/yourusername/code</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Change to the directory
<programlisting>$ cd /Users/yourusername/code</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Clone the openstack-manuals repository with
<programlisting>$ git clone http://github.com/openstack/openstack-manuals.git </programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Change directory to the pulled repository
<programlisting>$ cd openstack-manuals</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Enter your Launchpad account information after testing for ssh key setup with
<programlisting>$ git review -s</programlisting></para>
</listitem>
</orderedlist>
</step>
</procedure>
</para>
</section>
<section xml:id="fix-doc-bug">
<title>Fix a Documentation Bug</title>
<para>
<orderedlist>
<listitem>
<procedure>
<step>
<para>Note: For this example, we are going to assume bug 1188522 and change 33713</para>
</listitem>
<listitem>
</step>
<step>
<para>Bring up <link xlink:href="https://launchpad.net/openstack"
>https://launchpad.net/openstack</link></para>
</listitem>
<listitem>
</step>
<step>
<para>Select the openstack-manuals project </para>
</listitem>
<listitem>
</step>
<step>
<para>Select a bug that is unassigned and that you can fix. Syntax errors are the best
ones to start off with. </para>
</listitem>
<listitem>
</step>
<step>
<para>Using Oxygen, open the
/Users/&lt;username>/code/openstack-manuals/doc/src/docbkx/openstack-compute-admin/bk_compute_adminguide.xml
master page for this example. It links together the rest of the material. Find the page
with the bug. Open the page that is referenced in the bug description by selecting the
content in the author view. Verify you have the correct page by visually inspecting the
html page and the xml page. </para>
</listitem>
<listitem>
</step>
<step>
<para>In the shell,
<programlisting>$ cd /Users/&lt;username>/code/openstack-manuals/doc/src/docbkx/openstack-compute-admin/ </programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Verify that you are on master with
<programlisting>$ git checkout master</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Create your working branch off master with
<programlisting>$ git checkout -b bug/1188522 </programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Verify that you have the branch open through SourceTree </para>
</listitem>
<listitem>
</step>
<step>
<para>Correct the bug through Oxygen. Toggle back and forth through the different views at
the bottom of the editor. </para>
</listitem>
<listitem>
</step>
<step>
<para>Once the bug is fixed, verify that the documentation can be built without errors by
running <programlisting>$ mvn clean generate-sources</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Add the changes <programlisting>$ git add . </programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Commit the changes
<programlisting>$ git commit -a -m " Removed reference to volume scheduler in the computer scheduler
config and admin pages, bug 1188522, author sean roberts"</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Submit the bug fix to gerrit <programlisting>$ git review</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Track the Gerrit review process at<link
xlink:href="https://review.openstack.org/#/c/33713"
>https://review.openstack.org/#/c/33713</link> Follow and respond inline to the Code
Review requests and comments </para>
</listitem>
<listitem>
</step>
<step>
<para>Your change will be tested, track the Jenkins testing process at
https://jenkins.openstack.org </para>
</listitem>
<listitem>
<para>If your change is rejected.<orderedlist>
<listitem>
</step>
<step>
<para>If your change is rejected.<procedure>
<step>
<para>Respond to the inline comments if any </para>
</listitem>
<listitem>
</step>
<step>
<para>Update the status to work in progress </para>
</listitem>
<listitem>
</step>
<step>
<para>Follow the recommended tweaks to the files </para>
</listitem>
<listitem>
</step>
<step>
<para>Rerun <programlisting>$ mvn clean generate-sources</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Commit the patch to the Gerrit change review <programlisting>$ git review -d 33713</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>add your additonal changes to the change log <programlisting>$ git commit -a --amend</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Final commit <programlisting>$ git review -v</programlisting></para>
</listitem>
<listitem>
</step>
<step>
<para>Update the Jenkins status to change completed </para>
</listitem>
</orderedlist></para>
</listitem>
<listitem>
</step>
</procedure></para>
</step>
<step>
<para>Follow the jenkins build progress at
https://jenkins.openstack.org/view/Openstack-manuals/. Note if the build process
fails then the online documention will not reflect your bug fix. </para>
</listitem>
</orderedlist>
</step>
</procedure>
</para>
</section>
<section xml:id="submit-doc-bug">
<title>Submit a Documentation Bug Fix</title>
<para>
<orderedlist>
<listitem>
<procedure>
<step>
<para>Bring up <link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
>https://bugs.launchpad.net/openstack-manuals/+filebug</link></para>
</listitem>
<listitem>
</step>
<step>
<para>Give your bug a descriptive name</para>
</listitem>
<listitem>
</step>
<step>
<para>verify if asked that it is not a duplicate</para>
</listitem>
<listitem>
</step>
<step>
<para>Add some more detail into the description field</para>
</listitem>
<listitem>
</step>
<step>
<para>Once submitted, select the assigned to pane and select assign to me</para>
</listitem>
<listitem>
</step>
<step>
<para>Follow the instructions for fixing a bug in the Fix a Documentation Bug
section.</para>
</listitem>
</orderedlist>
</step>
</procedure>
</para>
</section>
</chapter>

174
doc/src/docbkx/openstack-training/bk003-ch050-operations-assessment.xml Normal file
View File

@ -0,0 +1,174 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-ch050-operations-assessment">
<title>Operations Assessment</title>
<section xml:id="operations-assessment">
<title>Operations Assessment</title>
<para>
<table rules="all"><caption>Trainee tasks</caption>
<thead>
<tr>
<th>Task</th>
<th>Completed?</th>
</tr>
</thead>
<tbody>
<tr>
<td><para>Configure a ....</para></td>
<td><para> </para></td>
</tr>
</tbody>
</table>
<orderedlist>
<listitem>
<para>As a trainee I must configure a virtual environment to accomplish the
configuration tasks </para>
</listitem>
<listitem>
<para>As a trainee I must understand the basic overview of OpenStack core projects </para>
</listitem>
<listitem>
<para>As a trainee I must understand the architecture the RefStack architecture described
in the Basic Install Guide </para>
</listitem>
<listitem>
<para>As a trainee I must understand how to install Ubuntu 12.04 (or 13.04 in later
versions) </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of the Controller Node in The RefStack
architecture described in the basic install guide </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of MySql server in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must install MySql server in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of RabbitMQ Messaging Service in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure RabbitMQ Messaging Service in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of OpenStack Identity Service in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must Install and Configure OpenStack Identity Service in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of OpenStack Image Service in the Controller
Node </para>
</listitem>
<listitem>
<para>As a trainee I must Install and configure OpenStack Identity Service in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of OpenStack Compute (Cloud Controller
Services) in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure OpenStack Compute (Cloud Controller
Services) in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of OpenStack Block Storage Service in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure OpenStack Block Storage Service in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of OpenStack Network Service (cloud
controller) in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure OpenStack Network Service (cloud
controller) in the Controller Node </para>
</listitem>
<listitem>
<para>As trainee I must verify the proper configuration and operation of the Controller
node within the RefStack architecture described in the Basic Install Guide </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of Network Node within the RefStack
architecture described in the Basic Install Guide </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of Open vSwitch in the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure Open vSwitch in the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of Neutron (formerly Quantum) in the Network
Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure Neutron (formerly Quantum) in the Network
Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand the how to create virtual networking in the Network
Node </para>
</listitem>
<listitem>
<para>As a trainee I must configure virtual networking in the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand L3 Configuration in the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I must configure L3 Configuration in the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I must verify the proper configuration and operation of the Network
Node within the Reference Architecture described in the basic install guide </para>
</listitem>
<listitem>
<para>As a trainee I must understand the role of Compute Node within the RefStack
architecture described in the Basic Install Guide </para>
</listitem>
<listitem>
<para>As a trainee I must understand Nova (compute node services) in the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure Nova (compute node services) in the
Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand OpenStack Networking using Open vSwitch in the
Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure OpenStack Networking using Open vSwitch in
the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand OpenStack Networking using Neutron (formerly Quantum)
in the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I must install and configure OpenStack Networking using Open Neutron
(formerly Quantum) n the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I must understand instantiation of a Virtual Machine (Instance) using
OpenStack Dashboard (Horizon) </para>
</listitem>
<listitem>
<para>As a trainee I must instantiate of a Virtual Machine (Instance) using OpenStack
Dashboard (Horizon)</para>
</listitem>
</orderedlist>
</para>
</section>
</chapter>

9
doc/src/docbkx/openstack-training/bk003-operations-training-guide.xml Normal file
View File

@ -0,0 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-operations-training-guide">
<title>Operations Training Guide</title>
<xi:include href="bk003-ch001-operations-getting-started.xml"/>
<xi:include href="bk003-ch002-operations-fix-bug.xml"/>
<xi:include href="bk003-ch050-operations-assessment.xml"/>
</book>

16
doc/src/docbkx/openstack-training/bk004-ch001-developer-getting-started.xml Normal file
View File

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch-developer-getting-started">
<title>Developer Getting Started</title>
<section xml:id="developer-getting-started">
<title>Developer Getting Started</title>
<para>
<orderedlist>
<listitem>
<para/>
</listitem>
</orderedlist>
</para>
</section>
</chapter>

2
doc/src/docbkx/openstack-training/developer-assessment.xml → doc/src/docbkx/openstack-training/bk004-ch050-developer-assessment.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_developer-assessment">
xml:id="ch-developer-assessment">
<title>Developer Assessment</title>
<section xml:id="developer-assessment">
<title>Developer Assessment</title>

8
doc/src/docbkx/openstack-training/bk004-developer-training-guide.xml Normal file
View File

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk004-developer-training-guide">
<title>Developer Training Guide</title>
<xi:include href="bk004-ch001-developer-getting-started.xml"/>
<xi:include href="bk004-ch050-developer-assessment.xml"/>
</book>

16
doc/src/docbkx/openstack-training/bk005-ch001-devops-getting-started.xml Normal file
View File

@ -0,0 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch-devops-getting-started">
<title>DevOps Getting Started</title>
<section xml:id="devops-getting-started">
<title>DevOps Getting Started</title>
<para>
<orderedlist>
<listitem>
<para/>
</listitem>
</orderedlist>
</para>
</section>
</chapter>

2
doc/src/docbkx/openstack-training/devops-assessment.xml → doc/src/docbkx/openstack-training/bk005-ch050-devops-assessment.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_devops-assessment">
xml:id="ch-devops-assessment">
<title>DevOps Assessment</title>
<section xml:id="devops-assessment">
<title>DevOps Assessment</title>

8
doc/src/docbkx/openstack-training/bk005-devops-training-guide.xml Normal file
View File

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk005-devops-training-guide">
<title>DevOps Training Guide</title>
<xi:include href="bk005-ch001-devops-getting-started.xml"/>
<xi:include href="bk005-ch050-devops-assessment.xml"/>
</book>

171
doc/src/docbkx/openstack-training/operations-assessment.xml
View File

@ -1,171 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_operations-assessment">
<title>Operations Assessment</title>
<section xml:id="operations-assessment">
<title>Operations Assessment</title>
<para>
<orderedlist>
<listitem>
<para>As a trainee I need to be able to configure a virtual environment enable to
accomplish the configuration tasks </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the basic overview of OpenStack core
projects </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the architecture the RefStack
architecture described in the Basic Install Guide </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand how to install Ubuntu 12.04 (or 13.04
in later versions) </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of the Controller Node in The
RefStack architecture described in the basic install guide </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of MySql server in the
Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install MySql server in the Controller Node
</para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of RabbitMQ Messaging Service
in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure RabbitMQ Messaging Service
in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of OpenStack Identity Service
in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to Install and Configure OpenStack Identity Service
in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of OpenStack Image Service in
the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to Install and configure OpenStack Identity Service
in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of OpenStack Compute (Cloud
Controller Services) in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure OpenStack Compute (Cloud
Controller Services) in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of OpenStack Block Storage
Service in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure OpenStack Block Storage
Service in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of OpenStack Network Service
(cloud controller) in the Controller Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure OpenStack Network Service
(cloud controller) in the Controller Node </para>
</listitem>
<listitem>
<para>As trainee I need to be able to verify the proper configuration and operation of the
Controller node within the RefStack architecture described in the Basic Install Guide
</para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of Network Node within the
RefStack architecture described in the Basic Install Guide </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of Open vSwitch in the Network
Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure Open vSwitch in the Network
Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of Neutron (formerly Quantum)
in the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure Neutron (formerly Quantum)
in the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the how to create virtual networking in
the Network Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to configure virtual networking in the Network Node
</para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand L3 Configuration in the Network Node
</para>
</listitem>
<listitem>
<para>As a trainee I need to be able to configure L3 Configuration in the Network Node
</para>
</listitem>
<listitem>
<para>As a trainee I need to be able to verify the proper configuration and operation of
the Network Node within the Reference Architecture described in the basic install guide
</para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand the role of Compute Node within the
RefStack architecture described in the Basic Install Guide </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand Nova (compute node services) in the
Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure Nova (compute node services)
in the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand OpenStack Networking using Open vSwitch
in the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure OpenStack Networking using
Open vSwitch in the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand OpenStack Networking using Neutron
(formerly Quantum) in the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to install and configure OpenStack Networking using
Open Neutron (formerly Quantum) n the Compute Node </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to understand instantiation of a Virtual Machine
(Instance) using OpenStack Dashboard (Horizon) </para>
</listitem>
<listitem>
<para>As a trainee I need to be able to instantiate of a Virtual Machine (Instance) using
OpenStack Dashboard (Horizon)</para>
</listitem>
</orderedlist>
</para>
</section>
</chapter>

20
doc/src/docbkx/openstack-training/pom.xml
View File

@ -1,4 +1,3 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
@ -21,8 +20,15 @@
<!-- ################################################ -->
<build>
<resources>
<resource>
<directory>target/docbkx/pdf</directory>
<excludes>
<exclude>**/*.fo</exclude>
</excludes>
</resource>
</resources>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
@ -58,9 +64,9 @@
<sectionAutolabel>0</sectionAutolabel>
<tocSectionDepth>1</tocSectionDepth>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
<targetDirectory>target/docbkx/webhelp/${release.path.name}/openstack-training</targetDirectory>
<webhelpDirname>admin</webhelpDirname>
<pdfFilenameBase>bk-training-manuals${release.path.name}</pdfFilenameBase>
<targetDirectory>target/docbkx/webhelp/${release.path.name}/</targetDirectory>
<webhelpDirname>openstack-training</webhelpDirname>
<pdfFilenameBase>training-manuals-${release.path.name}</pdfFilenameBase>
</configuration>
</execution>
<execution>
@ -87,9 +93,9 @@
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>.</sourceDirectory>
<includes>
bk-training-manuals.xml
st-training-manuals.xml
</includes>
<canonicalUrlBase>http://docs.openstack.org/${release.path.name}/openstack-training/admin/content/</canonicalUrlBase>
<canonicalUrlBase>http://docs.openstack.org/${release.path.name}/openstack-training/content/</canonicalUrlBase>
<profileSecurity>reviewer</profileSecurity>
<branding>openstack</branding>

15
doc/src/docbkx/openstack-training/preface.xml
View File

@ -1,15 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch_preface">
<title>Preface</title>
<para>OpenStack™ Training Manuals offers open source software training for cloud
administration and management for any organization. </para>
<section xml:id="Document_Change_History-d1e118">
<title>Document Change History</title>
<para>The most recent changes are described in the table
below:</para>
<?rax revhistory?>
</section>
</preface>

35
doc/src/docbkx/openstack-training/bk-training-manuals.xml → doc/src/docbkx/openstack-training/st-training-guide.xml
View File

@ -5,10 +5,10 @@
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:html="http://www.w3.org/1999/xhtml"
version="5.0"
xml:id="ch_openstack-training-manuals-havana">
<title>OpenStack Training Manuals</title>
xml:id="st-training-guides">
<title>OpenStack Training Guides</title>
<?rax title.font.size="28px" subtitle.font.size="28px"?>
<titleabbrev>OpenStack Training Manuals</titleabbrev>
<titleabbrev>OpenStack Training Guides</titleabbrev>
<info>
<author>
<personname>
@ -56,14 +56,27 @@
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2013-07-17</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>rough draft v2
structural updates</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</info>
<!-- Chapters are referred from the book file through these include statements. You can add additional chapters using these types of statements. -->
<!-- Each groups of material (assoc, ops, ..) needs to be broken down into books and connected by a set http://www.docbook.org/tdg/en/html/set.html -->
<xi:include href="preface.xml"/>
<xi:include href="associate-assessment.xml"/>
<xi:include href="operations-fix-bug.xml"/>
<xi:include href="operations-assessment.xml"/>
<xi:include href="developer-assessment.xml"/>
<xi:include href="devops-assessment.xml"/>
<xi:include href="bk001-preface.xml"/>
<xi:include href="bk002-ch001-associate-getting-started.xml"/>
<xi:include href="bk002-ch050-associate-assessment.xml"/>
<xi:include href="bk003-ch001-operations-getting-started.xml"/>
<xi:include href="bk003-ch002-operations-fix-bug.xml"/>
<xi:include href="bk003-ch050-operations-assessment.xml"/>
<xi:include href="bk004-ch001-developer-getting-started.xml"/>
<xi:include href="bk004-ch050-developer-assessment.xml"/>
<xi:include href="bk005-ch001-devops-getting-started.xml"/>
<xi:include href="bk005-ch050-devops-assessment.xml"/>
</book>