Jump to: navigation, search

Difference between revisions of "Training-guides"

(Update Infra section)
m (Modified training-guide doc links and added upstream-training link)
 
(25 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
= What is the Training Guides Project =
 +
The Training Guides project creates open source OpenStack training materials for use by OpenStack User Groups, Universities, and the OpenStack Upstream Training teams.
 +
 
= Quick Links =
 
= Quick Links =
  openstack-training docs http://docs.openstack.org/training-guides
+
  OpenStack Trainers Team https://wiki.openstack.org/wiki/Meetings/trainers
  launchpad project page https://launchpad.net/openstack-training-guides
+
OpenStack Training Docs
  source code http://git.openstack.org/cgit/openstack/training-guides/
+
  * Draft http://docs.openstack.org/draft/training-guides/
  openstack training labs https://wiki.openstack.org/wiki/Training-guides/lab-scripts
+
  * Icehouse (EOL) http://docs.openstack.org/icehouse/training-guides/
 +
OpenStack Upstream Training http://docs.openstack.org/upstream-training
 +
  Training Guides Launchpad project page https://launchpad.net/openstack-training-guides
 +
  Training Guides source code https://git.openstack.org/cgit/openstack/training-guides/
 +
  OpenStack Training Labs https://wiki.openstack.org/wiki/Documentation/training-labs
  
= Overview =
+
= Meeting Information =
 
* [[Meetings/training-manuals|The team meets weekly, here are the details]]
 
* [[Meetings/training-manuals|The team meets weekly, here are the details]]
 +
** [https://wiki.openstack.org/wiki/Meetings/training-guides Meeting agenda]
 
* [http://eavesdrop.openstack.org/meetings/training_guides weekly meeting history] [http://eavesdrop.openstack.org/meetings/training_manuals (weekly meeting history up to 8/2014)]
 
* [http://eavesdrop.openstack.org/meetings/training_guides weekly meeting history] [http://eavesdrop.openstack.org/meetings/training_manuals (weekly meeting history up to 8/2014)]
* [http://stackalytics.com/report/contribution/training-guides/30 Training Guides Heartbeat]
 
* [http://lists.openstack.org/pipermail/openstack-docs/ OpenStack docs mailing list history]
 
* [https://wiki.openstack.org/wiki/Training-guides#Create_a_Blueprint New design ideas and major changes will be submitted for team review]
 
* [https://launchpad.net/openstack-training-guides Blueprints contain team approved design ideas and status]
 
* [https://launchpad.net/openstack-training-guides Bugs are problems with the published documentation]
 
* For reference find the [https://review.openstack.org/#/admin/groups/360,members '''''Core Reviewers List'''''] here. By default, the sub-project leads are core reviewers.
 
* Some discussion on this etherpad with the results being moved to this wiki https://etherpad.openstack.org/p/training-guides-developing-topics
 
  
 
= Project Goals =
 
= Project Goals =
* Provide a structured training program to enable '''skill development''' for maintaining, consuming, and contributing to OpenStack
+
* Aim/Goal (What does training guides provides):
* Align to the OpenStack Foundation certification program as it evolves
+
** Training Content mostly by HTML slides
* '''Increase accuracy and usability''' of documentation and training by engaging user groups and community members across the world
+
** Example scenarios and use cases
* Increase the amount of skilled engineers and developers in the hiring pool for OpenStack operators and developers
+
** Quizzes
* Enable underrepresented / economically disadvantaged users groups and communities (Africa, Vietnam, Etc) to develop valuable and marketable skills.
+
* Target Audience
* We will be '''targeting the user group and university audiences first''' while '''partnering with commercial interests''' like Aptira. Commercial interests are encouraged to use and contribute to the project.
+
** OpenStack User Groups
* We aim to have as many commercial training programs use this project for the 'core' of their training. It will only improve the quality of the content while limiting the quantity to just the very most important bits.
+
** Upstream Training/OpenStack Summit training
* Reuse the openstack foundation guides with some additional training specific pages
+
** Universities
* Target 80% OpenStack manuals reuse
+
** Self-paced training
* Same contribution process as existing guides
+
* Support the OpenStack Documentation Program projects by cross posting content
* Training material and lab work will be based on defcore/refstack (this work is ongoing so no project impact at this time)
 
  
= Project Status =
+
= Project Lead =
* Currently an incubated project under OpenStack Manuals
+
* Matjaz Pancur/matjazp
* Plans for OpenStack project incubation are here https://wiki.openstack.org/wiki/Training-guides#Incubation_Plan
 
  
= Project Sub-Groups =
+
= Core Reviewer Responsibilities =
* '''docs''': ('''''Pranav Salunke/dguitarbite leads''''') keep the existing training materials up to date and tracking with the current documentation and stable release code. Unless there needs to be a major change, majority of the Stable work will be done through bugs.
+
* attend weekly IRC meets,
* '''development''': ('''''Sean Roberts/sarob leads''''') work on creating the new materials. All the Development work will be done through blueprints.
+
* attend core sprints when called,
* '''testing''': ('''''Matjaz Pancur/matjazp leads''''') curators of the quiz and test questions. The Testing work will be blueprints (new features) and bugs (updating existing materials).
+
* work through gerrit reviews of bugs and patches ([[CodeReviewGuidelines|Code Review Guidelines]])
* '''infrastructure''': ('''''Roger Luethi/rluethi, Pranav Salunke/dguitarbite leads''''') maintain the trainer tools and testing system. The Infrastructure work will be blueprints (new features) and bugs (updating existing materials).
+
* Consistent reviews to training-guides project.
* '''audio visual (AV)''': (TBD lead) create images, video, and graphics that promote and assist the training project
+
* Preference given to quality of reviews over quantity of reviews.
 +
* Creating or maintaining a sub-project/section in the project (ex. Labs, Docs, Slides etc.)
 +
* If it is required to give the core reviewership to the candidate (blockers ex. no one else can do the job better)
 +
* [https://review.openstack.org/#/admin/groups/360,members Current Core Reviewers]
  
= Team Responsibilities =
+
= Project Status =
:* sub-team leads/core-reviewers:
+
* [http://stackalytics.com/report/contribution/training-guides/30 Training Guides Heartbeat]
::* attend weekly IRC meets,
+
* [http://lists.openstack.org/pipermail/openstack-docs/ OpenStack docs mailing list history]
::* attend core sprints when called,
+
* Some discussion on this etherpad with the results being moved to this wiki https://etherpad.openstack.org/p/training-guides-developing-topics
::* work through gerrit reviews of bugs and patches
 
::* setup ZNC/ IRC bouncer and support new contributors via. IRC. Follow the URL for in depth instructions to setup ZNC via. bouncerstation.com http://goo.gl/R089Rl
 
:* reviewers, contributors:
 
::* when you can, attend weekly IRC meets,
 
::* when you can, attend core sprints when called,
 
::* work through gerrit reviews of bugs and patches,
 
::* contribute patches
 
:* community:
 
::* work on submitting bugs, fixing bugs,
 
::* suggest new material.
 
::* All are welcome to participate.
 
 
 
= docs sub-project =
 
==== Team Leads ====
 
* Pranav Salunke (email: dguitarbite@gmail.com, IRC: dguitarbite)
 
 
 
==== Install Guides ====
 
* As of now the install guides re outdated (Havana Version).
 
* Aim to re-use 90% of OpenStack Install Guide located in openstack-manuals.
 
* Refer Etherpad https://etherpad.openstack.org/p/training-guides-install-guide
 
 
 
==== Books ====
 
* Need to maintain Associate Book and Operators Book.
 
 
 
======Associate Training Guide======
 
* Associate Training Guide - "Review of Concepts"
 
 
 
======Operator Training Guide======
 
* TODO: Add More points here.
 
 
 
==== Other ====
 
* Maintain and Update versions for various OpenStack releases starting from IceHouse release.
 
* Fix various bugs and participate in code review as required.
 
* Create, develop and maintain blueprints for docs sub team in OpenStack Training.
 
 
 
(X) specs to be created for the current docs sub-project focus, the associate and operators training guides
 
ACTION: sarob make sure translations continue (sarob, 17:11:55)
 
ACTION: sarob verify Javanese translation (sarob, 17:12:33)
 
ACTION: sarob verify Indonesia translation (sarob, 17:14:21)
 
ACTION: dguitarbite docs team plans for matching docs team release cycle (sarob, 17:38:03)
 
 
 
= development sub-project =
 
* (10) specs to be created for the current development sub-project focus, the developer training guide
 
# COMPLETED developer training guide prerequisites
 
# INPROGRESS developer training guide how to participate classroom
 
# INPROGRESS developer training guide how to participate quizzes
 
# INPROGRESS developer training guide how to participate labs
 
# INPROGRESS developer training guide APIs deep dive classroom
 
# INPROGRESS developer training guide APIs deep dive quizzes
 
# INPROGRESS developer training guide APIs deep dive labs
 
# developer training guide assessment
 
# developer training guide 1 day bootcamp
 
# INPROGRESS developer training guide 2 day bootcamp
 
 
 
= testing  sub-project =
 
* current focus: Associate Guide, (Operator's guide next in pipeline)
 
* specs to be created for the testing sub-project
 
# Create platform for online test assessments (Moodle?)
 
* INPROGRESS revise/expand questions for Associate guide (file bugs - DONE)
 
# Associate Training Guide - revise Chapter 2. Getting Started Quiz, Chapter 4. Controller Node Quiz
 
# Associate Training Guide -  "Compute Node Quiz"
 
# Associate Training Guide - "Network Node Quiz"
 
# Associate Training Guide -  "Object Storage Node Quiz"
 
# Associate Training Guide - "Chapter 11. Assessment" - Task with a HowTo Style Solution
 
* write questions for Operators guide
 
* write questions for Developers Guide
 
* write questions for Architects Guide
 
ACTION: sparkycollier will look into reusing questions for Certification program for Training guides (matjazp, 17:47:15)
 
 
 
= infrastructure  sub-project =
 
* work in progress for tool suites, follow the discussion on etherpad https://etherpad.openstack.org/p/training-guides-tools
 
* training team core reviewers need to use irc bouncer
 
* trello discontinued in favor of blueprints
 
 
 
(X) specs to be created for the current infrastructure sub-project focus
 
=WIP=
 
dguitarbite adds automated test scripts for upstream training
 
=Action Items=
 
dguitarbite add osbash trigger to generate windows scripts on every change to the repository
 
dguitarbite add osbash testing trigger with jenkins
 
 
 
= audio visual  sub-project =
 
Current focus: Select videos from the OpenStack Summit sessions that can be re-used/sliced for Audio Visual content.
 
 
 
TODO:
 
:*Push an initial patch consisting of an edited summit video to be reviewed by the team for approval.
 
:*Draw out the content not covered in the summit videos as per the requirement to fill in the structure as discussed on [https://etherpad.openstack.org/p/openstck-training-guides%28Audio_Visual_Content%29 Etherpad] (keeping it similar to training-guides structure).
 
:*Discuss how to go about recording more material not covered in the summit videos.
 
  
 
= How To =
 
= How To =
Line 139: Line 53:
 
* By creating the bug directly in launchpad https://bugs.launchpad.net/openstack-training-guides/+filebug
 
* By creating the bug directly in launchpad https://bugs.launchpad.net/openstack-training-guides/+filebug
  
==== Create a Blueprint ====
+
= Training slides - Modules =
# The blueprint is created here https://blueprints.launchpad.net/openstack-training-guides/+addspec, only the name, title, and summary need to be filled out
+
* OpenStack getting started
# Submit a spec RST patch based on the template https://github.com/openstack/training-guides/blob/master/specs/template.rst
+
** what is, it's mission, other general info
# Gerrit reviews are the debate and refinement
+
** conceptual architecture, basic concepts
# Final RST patch either is rejected or approved
+
** logical architecture diagram with "core" projects
# If the RST patch is approved, then it gets merged, the blueprint is approved, and the RST details are manually updated into the blueprint
+
* Start a new VM with Horizon
# The blueprint can only be approved for current release
+
* Start a new VM with CLI
# Blueprints not approved or not implemented during a release cycle need the RST patch be resubmitted for the next cycle
+
* Dashboard (Horizon)
 
+
* What happens when you start a VM
==== Fix a Bug or Add code to Implement a Blueprint ====
+
* Compute service (Nova)
* Follow the Operator Training Guide Getting Started Lab http://docs.openstack.org/training-guides/content/operator-getting-started-lab.html
+
* Networking (Neutron)
 
+
* Image service (Glance)
= Book structure =
+
* Identity service (Keystone)
* each book needs goals that slightly overlap with the previous and next
+
* Block storage (Cinder)
:* 10 question quiz  and 1 scenario at the end of each chapter
+
* Object storage (Swift)
:* 40+ assessment broken down by each section/question representing a different chapter
 
* hierarchy: set -> book -> chapter -> section
 
* book topics
 
:* openstack associate engineer
 
:* openstack operator engineer
 
:* openstack developer engineer
 
:* openstack devOps architect
 
* publish to docs.openstack.org/training-guides
 
  
== Book openstack associate ==
+
= Old proposal: Structure of Materials =
 +
=== Book OpenStack Associate Guide ===
 
:* 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.
 
:* 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)
 
:* basic knowledge of core OpenStack components (Compute, Block, Network, Dashboard)
:* [http://docs.openstack.org/training-guides/content/bk001-associate-training-guide.html for the rest see the associate guide online]
 
  
== Book openstack operations engineer ==
+
=== Book openstack operations engineer ===
 
:* 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. May set aside some time for distro specific training.
 
:* 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. May set aside some time for distro specific training.
:* [http://docs.openstack.org/training-guides/content/bk003-operator-training-guide.html for the rest see the operator guide online]
 
  
== Book openstack development engineer ==
+
=== Book openstack development engineer ===
 
:* build on concepts from Operator training
 
:* build on concepts from Operator training
 
:* combine how to contribute and working with CI guides into a developers guide
 
:* 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. May set aside some time for distro specific training.
 
:* 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. May set aside some time for distro specific training.
:* [https://docs.google.com/document/d/17949LwkTd2a8fkQwHxtifZqxp309BdHxKD9sSYG4OD8/edit?usp=sharing outline is here]
 
  
== Book openstack devOps architect ==
+
=== Book openstack devOps architect ===
 
:* training would take 6 months or (12) 2 week periods with a user group meeting. 240 hours of self paced lab time.
 
:* 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.
 
:* Meant to be very hard to complete. Public contribution must be a considerable part of the work completed.
Line 184: Line 88:
 
:* speaking at user groups
 
:* speaking at user groups
 
:* summit session submissions should all count towards karma/contribution
 
:* summit session submissions should all count towards karma/contribution
:* Passing DevOps training would make the person desirable as an employee.
+
:* Passing DevOps training would make the person desirable as an employee and a core contributor to any project
:* Passing DevOps training would make the person desirable as a core contributor to any project
 
 
 
= Incubation Plan =
 
OpenStack projects generally start as stackforge projects in the GitHub organization Stackforge here https://github.com/stackforge. There are some simple rules, but not much team structure or contribution is required. The Training Guides project is a bit unusual as the project started and has been located within the openstack/openstack-manuals repository since mid 2013 already. Due to this project already being in the Openstack github organization, it will move from openstack/openstack-manuals to openstack/training-guides. The patch to do that is here https://review.openstack.org/#/c/96334/. The Training Guides project will continue to publish html to http://docs.openstack.org/training-guides.
 
 
 
'''''The Training Guides project desires to be an incubated OpenStack project. This desire will be discussed with the Technology Committee for Juno Milestone-2. In the meantime, sarob and annegentle will work on the Incubation Plan below.'''''
 
 
 
The official TC governance is here https://wiki.openstack.org/wiki/Governance/Approved/Incubation
 
Below are the incubation requirements from the TC from https://github.com/openstack/governance/blob/master/reference/incubation-integration-requirements.rst as of 03jun2014. This RST is still under development. Likely our incubation proposal will be debated within the TC in an etherpad.
 
 
 
The TC will evaluate the project scope and its complementarity with existing integrated projects and other official programs, look into the project technical choices, and check a number of requirements, including (but not limited to):
 
 
 
'''Scope'''
 
 
 
Project must have a clear and defined scope.
 
 
 
''We do. https://wiki.openstack.org/wiki/Training-guides#Project_Goals''
 
 
 
 
 
Project's scope should represent a measured progression for OpenStack as a whole.
 
 
 
''As the training-guides will be following the documentation project, we believe this is the case.''
 
 
 
 
 
Project should not inadvertently duplicate functionality present in other OpenStack projects. If they do, they should have a clear plan and timeframe to prevent long-term scope duplication.
 
 
 
''We are including existing documentation at build, so there is reuse rather than duplication.''
 
 
 
 
 
Project should leverage existing functionality in other OpenStack projects as much as possible
 
 
 
''See above.''
 
 
 
 
 
'''Maturity'''
 
 
 
Project should have an active team of contributors
 
 
 
''We are working on that. Right much of the work is being done outside of github. We will be fixing that over June.''
 
 
 
 
 
Project should not have a major architectural rewrite planned
 
 
 
''No major changes are planned.''
 
 
 
 
 
'''Process'''
 
 
 
Project must be hosted under stackforge (and therefore use git as its VCS)
 
 
 
''We are working this out with the documentation, infra, and TC. Right now the data is under the openstack-manuals repo.''
 
 
 
 
 
Project must obey OpenStack coordinated project interface (such as tox, pbr, global-requirements...)
 
 
 
''Not applicable''
 
 
 
 
 
Project should use oslo libraries or oslo-incubator where appropriate
 
 
 
''Not applicable''
 
 
 
 
 
If project is not part of an existing program, it needs to file for a new program concurrently with the Incubation request, and fill the corresponding requirements.
 
 
 
''Training-guides will be part of the Documentation program''
 
 
 
 
 
Project must have a well-defined core review team, with reviews distributed amongst the team (and not being primarily done by one person)
 
 
 
''Right now it is two people. We have spun out into five sub-projects. Each sub-project lead will be a core-reviewer at least. We should end up with 7-8 core reviewers over the entire project.''
 
 
 
 
 
Reviews should follow the same criteria as OpenStack projects (2 +2s before +A)
 
 
 
''Training-guides will follow the standard practice''
 
 
 
 
 
Project should use the official openstack lists for discussion
 
 
 
''We will push our ML discussions to docs ML. We already use IRC meetings.''
 
 
 
 
 
'''API'''
 
 
 
Project APIs should be reasonably stable
 
 
 
''Not applicable''
 
 
 
 
 
Project must have a REST API with at least a JSON entity representation
 
 
 
''Not applicable''
 
 
 
 
 
Project must have a Python client library API for its REST API
 
 
 
''Not applicable''
 
 
 
 
 
'''QA'''
 
 
 
Project must have a basic devstack-gate job set up
 
 
 
''TBD''
 
 
 
 
 
'''Documentation / User support'''
 
 
 
Project must have docs for developers who want to contribute to the project
 
 
 
''http://docs.openstack.org/training-guides/content/under-construction.html''
 
 
 
 
 
Project should have API documentation for devs who want to add to the API, updated when the code is updated
 
 
 
''Not applicable''
 
 
 
 
 
'''Legal requirements'''
 
 
 
Project must be licensed under the Apache License v2
 
 
 
''Licensed under Apache License v2 and Creative Commons Attribution ShareAlike 3.0 License as per the OpenStack documentation program projects lead.''
 
 
 
 
 
Project must have no library dependencies which effectively restrict how the project may be distributed or deployed [1]
 
 
 
''Content has no known dependencies''
 
 
 
 
 
All contributors to the project must have signed the CLA
 
 
 
''This is the case''
 
 
 
 
 
Project must have no known trademark issues [2]
 
  
''This is the case''
 
  
= Last edit {{REVISIONID}} by {{REVISIONUSER}} on {{REVISIONTIMESTAMP}} (year+month+day+UTC hour+seconds) =
+
=== Last edit {{REVISIONID}} by {{REVISIONUSER}} on {{REVISIONTIMESTAMP}} (year+month+day+UTC hour+seconds) ===

Latest revision as of 10:53, 9 July 2016

What is the Training Guides Project

The Training Guides project creates open source OpenStack training materials for use by OpenStack User Groups, Universities, and the OpenStack Upstream Training teams.

Quick Links

OpenStack Trainers Team https://wiki.openstack.org/wiki/Meetings/trainers
OpenStack Training Docs
  * Draft http://docs.openstack.org/draft/training-guides/
  * Icehouse (EOL) http://docs.openstack.org/icehouse/training-guides/
OpenStack Upstream Training http://docs.openstack.org/upstream-training
Training Guides Launchpad project page https://launchpad.net/openstack-training-guides
Training Guides source code https://git.openstack.org/cgit/openstack/training-guides/
OpenStack Training Labs https://wiki.openstack.org/wiki/Documentation/training-labs

Meeting Information

Project Goals

  • Aim/Goal (What does training guides provides):
    • Training Content mostly by HTML slides
    • Example scenarios and use cases
    • Quizzes
  • Target Audience
    • OpenStack User Groups
    • Upstream Training/OpenStack Summit training
    • Universities
    • Self-paced training
  • Support the OpenStack Documentation Program projects by cross posting content

Project Lead

  • Matjaz Pancur/matjazp

Core Reviewer Responsibilities

  • attend weekly IRC meets,
  • attend core sprints when called,
  • work through gerrit reviews of bugs and patches (Code Review Guidelines)
  • Consistent reviews to training-guides project.
  • Preference given to quality of reviews over quantity of reviews.
  • Creating or maintaining a sub-project/section in the project (ex. Labs, Docs, Slides etc.)
  • If it is required to give the core reviewership to the candidate (blockers ex. no one else can do the job better)
  • Current Core Reviewers

Project Status

How To

Create a Bug

Training slides - Modules

  • OpenStack getting started
    • what is, it's mission, other general info
    • conceptual architecture, basic concepts
    • logical architecture diagram with "core" projects
  • Start a new VM with Horizon
  • Start a new VM with CLI
  • Dashboard (Horizon)
  • What happens when you start a VM
  • Compute service (Nova)
  • Networking (Neutron)
  • Image service (Glance)
  • Identity service (Keystone)
  • Block storage (Cinder)
  • Object storage (Swift)

Old proposal: Structure of Materials

Book OpenStack Associate Guide

  • 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)

Book openstack operations engineer

  • 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. May set aside some time for distro specific training.

Book openstack development engineer

  • 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. May set aside some time for distro specific training.

Book openstack devOps architect

  • 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.
  • The Architect focuses on a specific OpenStack project as a specialization and becomes a working member of that project. The Architect training will be all about becoming a functioning member of the OpenStack open source community.
  • speaking at user groups
  • summit session submissions should all count towards karma/contribution
  • Passing DevOps training would make the person desirable as an employee and a core contributor to any project


Last edit 127859 by Ian Y. Choi on 20160709105307 (year+month+day+UTC hour+seconds)