Jump to: navigation, search

Training-manuals

Revision as of 22:59, 9 September 2013 by Colinmcnamara (talk | contribs) (Project Goals)
openstack-training docs http://docs.openstack.org/trunk/openstack-training
Blueprint https://blueprints.launchpad.net/openstack-manuals/+spec/training-manuals
weekly meeting agenda https://wiki.openstack.org/wiki/Meetings/training-manuals
trello storyboard https://trello.com/board/openstack-training/51d6e5fee37248fd5b003de9
sfbay-openstack hackathon https://etherpad.openstack.org/sfbay-openstack

Project Goals

  • Provide a structured training program to enable skill development for maintaining, consuming, and contributing to OpenStack
  • Increase accuracy and usability of documentation and training by engaging user groups and community members across the world
  • Increase the amount of skilled engineers and developers in the hiring pool for OpenStack operators and developers
  • Enable underrepresented / economically disadvantaged users groups and communities (Africa, Vietnam, Etc) to develop valuable and marketable skills.

Project Status

  • Currently an incubated project under OpenStack Manuals (PTL = Anne Gentle)
  • Currently focused - OpenStack Associates Course Launch

Project requirements

  • Reuse the openstack foundation manuals with some additional training specific pages
  • Target 80% doc reuse
  • Same process as existing manuals
  • Leave in space and time for distro specific training
  • Training material and lab work would all be based on refstack https://etherpad.openstack.org/RefStackBlueprint, but this work is still evolving

Project dependancies / issues

  • majority of the material will be stitched together from remote github repositories and the local openstack-manuals repository through xi:include statements through the gerrit build process
  • openstack-docs refactoring https://wiki.openstack.org/wiki/Blueprint-restructure-documentation: as of 15jul2013, the impact will be minimal. colin and sean will continue monitor
  • publishing location
  • gerrit/jenkins files
  • modules/openstack_project/files/jenkins_job_builder/config/manuals.yaml
  • modules/openstack_project/files/zuul/layout.yaml
  • web index file ...
  • breakdown of task management
  • in launchpad, the blueprint will hold status and links back to bugs,
  • in launchpad bugs on the published documentation will be posted,
  • on this wiki page the project status and overview will be posted
  • in trello the story boards and sprints will be published and developed
  • breakdown of responsibilities of the three teams:
  • core: attend weekly IRC meets, attend core sprints when called, through gerrit review bugs and patches
  • sarob, colinmcnamara, plus up to eight others
  • community: work through sub-core sprints by checking out book chapters, fix bugs
  • sfbay hackathon team, and other user groups we can get to sign up
  • extended/education: walk through and use training-manuals, create bugs, provide content reviews
  • user groups, university, others?

Book structure

  • each book needs an outline published inline below
  • each book needs goals that slightly overlap with the previous and next
  • 10 question quiz and 1 scenario at the end of each chapter
  • 40+ assessment broken down by each section/question representing a different chapter
  • hierarchy: set -> book -> chapter -> section
  • book topics
  • openstack associate engineer
  • openstack operations engineer
  • openstack development engineer
  • openstack devOps architect
  • publish to
  • docs.openstack.org/training as annegentle suggests OR
  • by each release like docs.openstack.org/trunk/training, docs.openstack.org/grizzly/training
  • book structure xml details
  • bk000-preface
  • bk001-ch000-associate-preface
  • bk001-ch001-associate-what-does-this-book-intend-to-teach
  • bk001-ch002-associate-getting-started
  • bk001-ch003-associate-general (three main core sections: general, nova, glance)
  • bk001-ch004-associate-assessment
  • bk002-ch000-operations-preface
  • bk002-ch001-operations-what-does-this-book-intend-to-teach
  • bk002-ch002-operations-getting-started
  • bk002-ch003-operations-general (three main core sections: general, nova, glance)
  • bk002-ch004-operations-swift (specialization)
  • bk002-ch005-operations-glance (specialization)
  • bk002-ch006-operations-cinder (specialization)
  • bk002-ch007-operations-oslo (specialization)
  • bk002-ch008-operations-assessment
  • bk003-ch000-developer-preface
  • bk003-ch001-developer-what-does-this-book-intend-to-teach
  • bk003-ch002-developer-getting-started
  • bk003-ch003-developer-general (three main core sections: general, nova, glance)
  • bk003-ch004-developer-nova (specialization)
  • bk003-ch005-developer-neutron (specialization)
  • bk003-ch006-developer-swift (specialization)
  • bk003-ch007-developer-glance (specialization)
  • bk003-ch008-developer-cinder (specialization)
  • bk003-ch009-developer-oslo (specialization)
  • bk003-ch010-developer-assessment
  • bk004-ch000-devops-preface
  • bk004-ch001-devops-what-does-this-book-intend-to-teach
  • bk004-ch002-devops-getting-started
  • bk004-ch003-devops-general (three main core sections: general, nova, glance)
  • bk004-ch004-devops-nova (specialization)
  • bk004-ch005-devops-neutron (specialization)
  • bk004-ch006-devops-swift (specialization)
  • bk004-ch007-devops-glance (specialization)
  • bk004-ch008-devops-cinder (specialization)
  • bk004-ch009-devops-oslo (specialization)
  • bk004-ch010-devops-assessment

Overview of training structure (Self Paced and user group paced)

time - name - topics covered

  • 1 month - associate - general
  • 2.5 months - ops general - general, nova, glance
  •                         - ops specialization - swift, quantum, oslo, or cinder
  • 2.5 months - dev general - general, nova, glance
  •                        - dev specialization - nova, glance, swift, quantum, oslo, cinder
  • 6 months - devOps general - general, nova, glance
  •                        - devOps specializaton - nova, glance, swift, quantum, oslo, cinder
OpenStack Training Outline

Book openstack associate

  • source content: basic install-guide repo openstack-manual/doc/src/docbkx/basic-install/src/
  • What Does This Book Intend To Teach chapter
  • training would take 1 month self paced, (2) 2 week periods with a user group meeting, or 16 hours instructor led. Some time set aside for distro specific training.
  • basic knowledge of core OpenStack components (Compute, Block, Network, Dashboard)
  • create an instance
  • understand conf and log files
  • understand basics of APIs and framework architecture
  • understand shared components
  • work off a single node openstack implementation
  • get on IRC, mailing lists
  • able to deploy applications to OpenStack clouds
  • able to leverage basic functions including pools IPs and multiple disks
  • able to deploy multi-tier applications to OpenStack clouds
  • advanced knowledge of OpenStack components including new and incubated projects
  • able to create complicated network topologies
  • able to leverage advanced application topologies
  • able to operate and manage projects and elements via Horizon, and some CLI

Book openstack operations engineer

  • source content
  • What Does This Book Intend To Teach chapter

Book openstack development engineer

  • source content
  • What Does This Book Intend To Teach chapter
  • build on concepts from Operator training
  • combine how to contribute and working with CI guides into a developers guide
  • training would take 2.5 months self paced, (5) 2 week periods with a user group meeting, or 40 hours instructor led with 40 hours of self paced lab time. Some time set aside for distro specific training.
  • include ideas from
  • deep understanding of APIs
  • commit python patches
  • karma greater than X

Book openstack devOps architect

  • source content
  • repo openstack-manuals/doc/src/docbkx/training-manuals
  • What Does This Book Intend To Teach chapter
  • Combination of Operator and Developer training
  • training would take 6 months or (12) 2 week periods with a user group meeting. 240 hours of self paced lab time.
  • Meant to be very hard to complete. Public contribution must be a considerable part of the work completed.
  • code contribution
  • CI infrastructure time in
  • implementation builds
  • contributions to answer
  • speaking at user groups
  • summit session submissions should all count towards karma/contribution
  • use TripleO for build/ops environment. include https://github.com/tripleo/incubator/blob/master/devtest.md
  • karma greater than Y
  • Passing DevOps training would make the person desirable as an employee.
  • Passing DevOps training would make the person desirable as a core contributor to any project

XML template file syntax

<?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="bookstub-general-templatestub">
 <title>Associate General Sub-Section</title>
 
 <section xml:id="basic-install_requirements"><title>Basic Install Requirements</title>
   <section xml:id="basic-install_requirements-lead-in">
     <title>lead in</title>
     <para>Lead in
     Including a whole file</para>
   </section>
   <xi:include href="../basic-install/src/basic-install_requirements.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'basic-install_requirements'])">
     <xi:fallback/></xi:include>
   <section xml:id="submit-bug-basic-install_requirements"><title>submit a bug</title><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
     the section above. Short description for the bug summary. Paragraph for the description and
     then tag with training-manuals. </link></para>
   </section>
 </section>
 <section xml:id="basic-install_controller-common-controller-os"><title>Basic Install Controller controller-os</title>
   <section xml:id="basic-install_controller-common-controller-os-lead-in">
     <title>lead in</title>
     <para>Lead in
       Including a section of a file</para>
   </section>
   <xi:include href="../basic-install/src/basic-install_controller-common.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'controller-os'])">
   <xi:fallback/></xi:include>
   <section xml:id="submit-bug-controller-os"><title>submit a bug</title><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
     the section above. Short description for the bug summary. Paragraph for the description and
     then tag with training-manuals. </link></para>
   </section>
</section>
</chapter>

Last edit 29786 by Colinmcnamara on 20130909225943 (year+month+day+UTC hour+seconds)

training manuals core leaders sarob and colinmcnamara