OpenStack Documentation Projects and Processes
Upcoming SlideShare
Loading in...5

OpenStack Documentation Projects and Processes



Describes the OpenStack projects and how documentation is done for all the projects.

Describes the OpenStack projects and how documentation is done for all the projects.



Total Views
Views on SlideShare
Embed Views



0 Embeds 0

No embeds



Upload Details

Uploaded via as Microsoft PowerPoint

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.


12 of 2

  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
Post Comment
Edit your comment
  • These all support the other core projects
  • The Planning stage usually lasts 3 weeks and consists of discussion and feedback on what the next release will focus on. After deciding on the features, we write the corresponding specs on how to make them happen. The Design Summit usually takes place during the second week of the planning stage.Blueprints are used for significant featuresImplementationThe Implementation stage is split into a number of milestone iterations. The work in progress is published in a branch, which should then be proposed for merging when ready. Code is proposed several weeks before each milestone release date so that it can be reviewed in a timely manner. QAThis is the testing phase. Testing, prioritizing bugs, and documentation are key parts of the QA phase. Only branches that fix bugs and do not introduce new features are allowed to enter the release branch. ReleaseRelease Candidate Freeze (RCF) happens two days before the actual Release Day.Codenames are cities or counties near where the corresponding OpenStack design summit took place: Austin: The first design summit took place in Austin, TX Bexar: The second design summit took place in San Antonio, Bexar county. Cactus: Cactus is a city in Texas Diablo: Diablo is a city in the bay area near Santa Clara, CA Essex: Essex is a city near Boston, MA Folsom: Folsom is a city near San Francisco, CA

OpenStack Documentation Projects and Processes OpenStack Documentation Projects and Processes Presentation Transcript

  • OpenStack DocumentationProjects and ProcessDocumentation in the Open
  • What is OpenStack?• OpenStack is a global collaboration of developers and cloud computing technologists producing the open standard cloud computing platform for both public and private clouds.• The project aims to deliver solutions for all types of clouds by being simple to implement, massively scalable, and feature rich.• The technology consists of a series of interrelated projectsdelivering various components for a cloud infrastructure solution. ®
  • OpenStack Principles• Open development model – Apache 2.0 license, Contributors agreement.• Open design process – Design Summit every six months.• Open community – Resources dedicated to active developer and user community. Open processes required. ®
  • OpenStack Projects - Core• Compute – Nova• Storage - Swift• It’s OSSM (awesome) – On-demand: the server is already setup and ready to be deployed – Self-service: customer chooses what they want, when they want it – Scalable: customer can choose how much they want and ramp up if necessary – Measureable: theres metering/reporting so you know you are getting what you pay for ®
  • OpenStack Projects - Core• Identity service - Keystone• Image service - Glance• OpenStack Dashboard - Horizon• Network Connectivity service - Quantum ®
  • OpenStack Release Process• Planning – Design Summits – Blueprints• Implementation• QA• Release – Release milestones – Release Candidate Freeze – Feature Freeze Exception – Release naming – Release numbering ®
  • OpenStack Documentation Processes –Design Summit• Blueprints and discussion at Design Summit• Implementation of blueprints – example, ®
  • OpenStack Documentation Processes –Launchpad• Bug logging• Bug triaging• Bug assigning• Core documentation team – monthly meetings ®
  • OpenStack Documentation Processes –Github and GitGithub repositories store admin guides and API guidesopenstack/openstack-manualsContains: – Compute admin manual – Storage admin manual – API Quick Start – Compute API Programmer’s Guide – Install guide for Compute – Network connectivity (Quantum) admin manualOne dev guide each (plus WADLs):openstack/object-apiopenstack/compute-apiopenstack/netconn-apiopenstack/identity-apiopenstack/image-api ®
  • OpenStack Documentation Processes –Gerrit and Jenkins• Automated publishing process with Jenkins jobs and Gerrit reviews ®
  • Where Documentation Processes Divergefrom Development Processes• Does not track milestone releases yet• Translation not yet set up ®
  • OpenStack GovernanceProject Policy Board•• The Project Policy Board is a governance body for OpenStack projects. The Board consists of a mixture of elected and appointed members.Elections•• Under the OpenStack Governance Model biannual elections will be held for a variety of positions. Each project will elect a Project Technical Lead every six months.Summary: Meritocracy ®
  • Questions with AnswersHow can I get on the openstack-core-docs team? Do lots of reviews at for the openstack-manuals project. Triage bugs and log doc bugs at We’ll discuss on the openstack-docs-core mailing list and then invite you.How should I find doc work that needs to be done on a particular project? Refer to and look for Wishlist for tasks, or any doc bug can be picked up as a work item. We also track few blueprints which may need someone to work on, though doc bugs are probably the best first place to lookHow do I know who should do reviews of my document changes?Anne Gentle, the doc coordinator, or anyone on the openstack-doc-core team can help you identify reviewers, or you can also check the doc bug and ask the reporter to review the changes by adding their name to the reviewers list. ®