Jump to: navigation, search

Difference between revisions of "Training-guides"

(→‎Project Goals)
m (Modified training-guide doc links and added upstream-training link)
 
(10 intermediate revisions by 4 users not shown)
Line 4: Line 4:
 
= Quick Links =
 
= Quick Links =
 
  OpenStack Trainers Team https://wiki.openstack.org/wiki/Meetings/trainers
 
  OpenStack Trainers Team https://wiki.openstack.org/wiki/Meetings/trainers
−
  OpenStack Training Docs http://docs.openstack.org/training-guides
+
  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 Launchpad project page https://launchpad.net/openstack-training-guides
 
  Training Guides source code https://git.openstack.org/cgit/openstack/training-guides/
 
  Training Guides source code https://git.openstack.org/cgit/openstack/training-guides/
−
  OpenStack Training Labs https://wiki.openstack.org/wiki/Training-guides/lab-scripts
+
  OpenStack Training Labs https://wiki.openstack.org/wiki/Documentation/training-labs
  
 
= Meeting Information =
 
= Meeting Information =
Line 16: Line 19:
 
= Project Goals =
 
= Project Goals =
 
* Aim/Goal (What does training guides provides):
 
* Aim/Goal (What does training guides provides):
−
** OpenStack training cluster
 
−
*** automated local installation on VirtualBox (via osbash scripts)
 
−
*** follows the official OpenStack install-guide
 
−
*** one node cluster installation (all-in-one) in the public cloud
 
 
** Training Content mostly by HTML slides
 
** Training Content mostly by HTML slides
 
** Example scenarios and use cases
 
** Example scenarios and use cases
Line 30: Line 29:
 
* Support the OpenStack Documentation Program projects by cross posting content
 
* Support the OpenStack Documentation Program projects by cross posting content
  
−
= Project Lead Sean Roberts, with Sub-Groups =
+
= Project Lead =
−
* '''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.
+
* Matjaz Pancur/matjazp
−
* '''development''': ('''''Sean Roberts/sarob leads''''') work on creating the new materials. All the Development work will be done through blueprints.
 
−
* '''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).
 
−
* '''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).
 
−
* '''audio visual (AV)''': (""Sayali/sayali lead"") create images, video, and graphics that promote and assist the training project
 
  
 
= Core Reviewer Responsibilities =
 
= Core Reviewer Responsibilities =
Line 46: Line 41:
 
* If it is required to give the core reviewership to the candidate (blockers ex. no one else can do the job better)
 
* 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]
 
* [https://review.openstack.org/#/admin/groups/360,members Current Core Reviewers]
−
 
−
= Sub-Projects =
 
−
== Docs ==
 
−
'''Team Leads'''
 
−
* Pranav Salunke (email: dguitarbite@gmail.com, IRC: dguitarbite)
 
−
 
−
'''blueprints here'''
 
−
 
−
Install Guides[edit]
 
−
 
−
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[edit]
 
−
 
−
Need to maintain Associate Book and Operators Book.
 
−
Associate Training Guide[edit]
 
−
 
−
Associate Training Guide - "Review of Concepts"
 
−
Operator Training Guide[edit]
 
−
 
−
TODO: Add More points here.
 
−
Other[edit]
 
−
 
−
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.
 
−
 
−
== Development ==
 
−
'''Blueprints here'''
 
−
 
−
== Testing ==
 
−
* 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
 
−
 
−
== Infrastructure ==
 
−
 
−
add blueprints here
 
−
 
−
* 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
 
−
 
−
'''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 ==
 
−
'''blueprints here'''
 
−
 
−
Current focus: Select videos from the OpenStack Summit sessions that can be re-used/sliced for Audio Visual content.
 
−
 
−
:*Audio Visual youtube channel:  https://www.youtube.com/user/trainingguides
 
−
This channel will be used to maintain the videos created and added to the project.
 
−
 
−
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.
 
  
 
= Project Status =
 
= Project Status =
Line 128: 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)
 +
* Identity service (Keystone)
 +
* Block storage (Cinder)
 +
* Object storage (Swift)
  
−
= Structure of Materials =
+
= Old proposal: Structure of Materials =
−
== Book openstack associate ==
+
=== 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)
  
−
== 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.
  
−
== 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.
  
−
== 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 161: Line 90:
 
:* 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 an employee and 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.  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.
 
−
 
−
''The training-guides follows the documentation program and the OpenStack release cycle.''
 
−
 
−
 
−
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 building unique materials.''
 
−
 
−
 
−
Project should leverage existing functionality in other OpenStack projects as much as possible
 
−
 
−
''We are working with the existing OpenStack Documentation projects to blend in each others materials.''
 
−
 
−
 
−
'''Maturity'''
 
−
 
−
Project should have an active team of contributors
 
−
 
−
''We have diverse active contributors. See http://stackalytics.com/report/contribution/training-guides/90''
 
−
 
−
 
−
Project should not have a major architectural rewrite planned
 
−
 
−
''We are in the process of converting over to match the Upstream Training materials by simplifying our content. The lab scripts are very stable. ''
 
−
 
−
 
−
'''Process'''
 
−
 
−
Project must be hosted under stackforge (and therefore use git as its VCS)
 
−
 
−
''We are in OpenStack/training-guides, so changes will be required.''
 
−
 
−
 
−
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 in a project within 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)
 
−
 
−
''We have four established core-reviewers with two more soon.''
 
−
 
−
 
−
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 have a long history of using the docs ML and 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
 
−
 
−
''We reuse the Docs gate jobs.''
 
−
 
−
 
−
'''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)

Retrieved from "https://wiki.openstack.org/w/index.php?title=Training-guides&oldid=127859"