OpenStack Community Welcome Guide

Revision 7

release date: 25. Apr. 2013

Table of Contents
Getting Started with the OpenStack Community........................................................3 What is OpenStack? ................................................................................................... 3 OpenStack Principles.............................................................................................. 4 OpenStack Projects................................................................................................. 4 elease Process...................................................................................................... ! Planning.............................................................................................................. ! "esign Summits................................................................................................. ! #aunchpad $lueprints......................................................................................... ! %mplementation.................................................................................................. ! &'....................................................................................................................... ! elease............................................................................................................... ! Go(ernance............................................................................................................ ) *he OpenStack +oundation......................................................................................... ) OpenStack Community............................................................................................... ) OpenStack "e(elopers .......................................................................................... ) #aunchpad %" ,Open%" pro(ider-......................................................................... #icensing............................................................................................................ . Contri/utor0s wiki............................................................................................... . Core Principles.................................................................................................... . Get the Code...................................................................................................... . $ugs................................................................................................................... . Other good resources 1or de(elopers.................................................................2 "ocumentation....................................................................................................... 2 Contri/ute to "ocumentation............................................................................. 2 OpenStack 3cosystem............................................................................................ 2 Sponsor the OpenStack +oundation ..................................................................2 %ndi(idual 4em/er o1 the +oundation ................................................................5 OpenStack 6ser Groups.................................................................................... 78 Other use1ul tools................................................................................................. 78 Wiki.................................................................................................................. 78 $ug eporting................................................................................................... 78 9eeping in touch............................................................................................... 78 4ailing #ists...................................................................................................... 77 OpenStack 3(ents.................................................................................................... 77 OpenStack Wiki #ayout............................................................................................. 77 Starting Page http:;;wiki.openstack.org;StartingPage .........................................7< ecent Changes .................................................................................................. 7< +ind Page ............................................................................................................. 7< =elp Contents ...................................................................................................... 7<

Revision 7

release date: 25. Apr. 2013

Revision 7

release date: 25. Apr. 2013

Getting Started with the OpenStack Community

Welcome to the glo/al OpenStack community> home o1 the leading open source cloud in1rastructure solution. *his document is meant 1or anyone interested in learning more a/out OpenStack> how the community operates> and where to go 1or the in1ormation you need. %t is intended 1or new community mem/ers looking to get started> and as a way to ?uickly understand the de(elopment process and /asic community @rules.A %1 you need more in1ormation or ha(e additional ?uestions> please contact the community manager> Ste1ano 4a11ulli> at communitymngrBopenstack.org.

What is OpenStack?
OpenStack is a cloud operating system that controls large pools o1 compute> storage> and networking resources throughout a datacenter> all managed through a dash/oard that gi(es administrators control while empowering their users to pro(ision resources through a we/ inter1ace. *he OpenStack project is a glo/al colla/oration o1 de(elopers and cloud computing technologists producing the open standard cloud computing plat1orm 1or /oth pu/lic and pri(ate clouds. *he project aims to deli(er solutions 1or all types o1 clouds /y /eing simple to implement> massi(ely scala/le> and 1eature rich. *he technology consists o1 a series o1 interrelated projects deli(ering (arious components 1or a cloud in1rastructure solution.

OpenStack Principles
Open development model: 'll o1 the code 1or OpenStack is 1reely a(aila/le under the 'pache <.8 license.

Revision 7

release date: 25. Apr. 2013

Open design process: 3(ery siC months the de(elopment community holds a design summit to gather re?uirements and write speci1ications 1or the upcoming release. *he summits are open to the pu/lic and attendees include users> de(elopers> and upstream projects. Open community: OpenStack is dedicated to producing a healthy> (i/rant> and acti(e de(eloper and user community. 4ost decisions will /e made using a laDy consensus model. 'll processes are documented> open and transparent.

OpenStack Projects
*he OpenStack project is organised around three major concepts ,compute> storage> networking- and shared ser(ices. OpenStack Compute: Pro(ision and manage large networks o1 (irtual machines. Codename Eo(a> more details on http:;;www.openstack.org;so1tware;openstackFcompute; OpenStack Storage: O/ject storage ,codename Swi1t- and $lock storage ,codename Cinder- 1or use with ser(ers and applications. 4ore details on http:;;www.openstack.org;so1tware;openstackFstorage; OpenStack Networking: Plugga/le> scala/le> 'P%Fdri(en network and %P management. 4ore details on http:;;www.openstack.org;so1tware;openstackFnetworking; OpenStack has se(eral shared ser(ices that span the three pillars o1 compute> storage and networking> making it easier to implement and operate your cloud. *hese ser(icesincluding identity> image management and a we/ inter1ace integrate the OpenStack components with each other as well as eCternal systems to pro(ide a uni1ied eCperience 1or users as they interact with di11erent cloud resources. *he OpenStack dashboard pro(ides administrators and users a graphical inter1ace to access> pro(ision and automate cloudF/ased resources. Watch a demo on http:;;www.openstack.org;so1tware;openstackFdash/oard;

elease Process
OpenStack is currently on a )Fmonth release cycle> which consists o1 1our stages. "etails on http:;;wiki.openstack.org; eleaseCycle Planning *he Planning stage usually lasts 3 weeks and consists o1 discussion and 1eed/ack on what the neCt release will 1ocus on. '1ter deciding on the 1eatures> we write the corresponding specs on how to make them happen. *he "esign Summit usually takes place during the second week o1 the planning stage. !esign Summits "uring the summit de(elopers su/mit session ideas to discuss upcoming 1eatures 1or the neCt release cycle. *hese 1eatures get re(iewed and scheduled /y the

Revision 7

release date: 25. Apr. 2013

summit dri(ers. *he sessions are not 1ormal presentations /ut rather open discussions on a gi(en su/ject or 1eature. Summits happen e(ery ) months> in the spring and 1all> so check the e(ents listing 1or the neCt one. "etails on http:;;wiki.openstack.org;Summit "aunchpad #lueprints OpenStack uses #aunchpad $lueprints to track the design and implementation o1 signi1icant 1eatures during the planning and implementation stages. "etails on http:;;wiki.openstack.org;$lueprints#i1ecycle $mplementation *he %mplementation stage is split into a num/er o1 milestone iterations. *he work in progress is pu/lished in a /ranch> which should then /e proposed 1or merging when ready. Code is proposed se(eral weeks /e1ore each milestone release date so that it can /e re(iewed in a timely manner. %& *his is the testing phase. *esting> prioritiDing /ugs> and documentation are key parts o1 the &' phase. Only /ranches that 1iC /ugs and do not introduce new 1eatures are allowed to enter the release /ranch. elease elease Candidate +reeDe , C+- happens two days /e1ore the actual elease "ay. OpenStack releases are num/ered using a GGGG.E timeF/ased scheme. +or eCample> the 1irst release o1 <87< will ha(e the <87<.7 (ersion num/er. "uring the de(elopment cycle> the release is identi1ied using a codename. *hose codenames are ordered alpha/etically: 'ustin was the 1irst release> $eCar is the second> Cactus the third> etc. *hese codenames are chosen /y popular (ote using the /asic #aunchpad poll 1eature o(er the Hopenstack group. Codenames are cities or counties near where the corresponding OpenStack design summit took place. 'n eCception ,called the Waldon exception- is granted to elements o1 the state 1lag that sound especially cool. 4ore details on http:;;wiki.openstack.org; eleaseEaming

Governance
's o1 Septem/er <87<> the OpenStack project is go(erned /y a num/er o1 /odies> de1ined /y the OpenStack +oundation /ylaws on http:;;wiki.openstack.org;Go(ernance;+oundation;$ylaws +oundation /oard o1 directors *echnical Committee 6ser Committee

Revision 7

release date: 25. Apr. 2013

'he OpenStack (oundation

*he OpenStack +oundation promotes the de(elopment> distri/ution and adoption o1 the OpenStack cloud operating system. 's the independent home 1or OpenStack> the +oundation has already attracted more than !>)88 indi(idual mem/ers 1rom 2. countries and 2!8 di11erent organiDations> secured more than I78 million in 1unding and is ready to 1ul1ill the OpenStack mission o1 /ecoming the u/i?uitous cloud computing plat1orm. *he goal o1 the OpenStack +oundation is to ser(e de(elopers> users> and the entire ecosystem /y pro(iding a set o1 shared resources to grow the 1ootprint o1 pu/lic and pri(ate OpenStack clouds> ena/le technology (endors targeting the plat1orm and assist de(elopers in producing the /est cloud so1tware in the industry. #ike the so1tware> mem/ership within the OpenStack +oundation is 1ree and accessi/le to anyone. 4em/ers are eCpected to participate in the OpenStack community through technical contri/utions or community /uilding e11orts. Join the 1oundation on https:;;www.openstack.org;join; *he +oundation wouldnKt /e possi/le without the support o1 so many inno(ati(e companies that ha(e contri/uted in many di11erent ways. *o learn more a/out our Platinum> Gold> Corporate Sponsors and other supporters> check out the supporter recognition page. 4ore details on http:;;www.openstack.org;1oundation;

OpenStack Community
OpenStack is a glo/al community consisting o1 de(elopers> corporations> ser(ice pro(iders> researchers> and users.

OpenStack !evelopers
"aunchpad $! )Open$! provider* #aunchpad is the LhomeL 1or the project management and its de(elopers: create a #aunchpad %" on http:;;launchpad.net i1 you don0t ha(e one already. Gou0ll need it to commit code> edit the wiki and other acti(ities. "icensing %1 you are a de(eloper that would like to contri/ute to one o1 the a/o(e core projects you will need to sign an Individual Contri utor !icense A"ree#ent. %1 you are contri/uting on /ehal1 o1 a company> an authoriDed representati(e o1 your company should also sign a Corporate Contri utor !icense A"ree#ent. GouKll 1ind the most up to date instructions on how to sign the agreements on http:;;wiki.openstack.org;=ow*oContri/ute ,donKt 1ollow /ookmarks 1rom older instructions as they may re1erence to in(alid processes-.

Revision 7

release date: 25. Apr. 2013

Core Principles +amiliariDe yoursel1 with core OpenStack principles: 7. What @OpenA means http:;;wiki.openstack.org;Open <. "esign tenets http:;;wiki.openstack.org;$asic"esign*enets 3. Coding standards http:;;wiki.openstack.org;CodingStandards 4. *he release cycle http:;;wiki.openstack.org; eleaseCycle !. *he OpenStack /ranch model http:;;wiki.openstack.org;$ranch4odel Get the Code OpenStack manages source code in git using a code re(iew tool called Gerrit. *he work1low 1or working with Gerrit is descri/ed at http:;;wiki.openstack.org;GerritWork1low . Git repositories are mirrored to Githu/ 1or ease o1 1etching. *o get a copy o1 any o1 the other OpenStack projects> you can look at the Githu/ OpenStack organiDation and /rowse> or you can clone a repo. 4ore details on http:;;wiki.openstack.org;Getting*heCode '1ter your 1irst commit+ add your name and email address to the Aut$ors 1ile. #ugs $ugs can /e a good place to get your coding 1eet wet. *he /ugs con1irmed and triaged that should /e simple to tackle are tagged Mlow hanging 1ruit0

https:;;/ugs.launchpad.net;openstack;N/ugs?1ield.tagOlowFhangingF1ruit
Other good resources ,or developers "e(elopment 4ailing #ist: http:;;lists.openstack.org;cgiF/in;mailman;listin1o;openstackFde( % C Popenstack on +reenode Pop %n ,(ia /rowser client4eetings http:;;wiki.openstack.org;4eetings Project meetings are held pu/licly on % C.

!ocumentation
Getting Started Get up and running ?uickly with "e(Stack or *ryStack http:;;www.openstack.org;so1tware;start; %nstalling OpenStack %nstallation and deployment guides 1or productionFsiDed systems http:;;docs.openstack.org;install; unning OpenStack Operational and administration documentation 1or OpenStack cloud ser(ice pro(iders http:;;docs.openstack.org;run;

Revision 7

release date: 25. Apr. 2013

"e(eloping OpenStack Python de(eloper documentation> continuous integration documentation> and language /indings documentation 1or OpenStack projects http:;;docs.openstack.org;de(eloper; Command #ine %nter1aces ,C#%-*he C#% documentation 1or OpenStack clients http:;;docs.openstack.org;cli;?uickFstart;content;indeC.html 'P% "ocumentation on the 3S*1ul 'P%s pro(ided /y OpenStack ser(ices http:;;docs.openstack.org;api; Glossary ' list o1 terms and their de1initions http:;;docs.openstack.org;glossary;content;glossary.html

Contribute to !ocumentation 't the core o1 OpenStack is the community and colla/oration that we do F the same rules 1or the code apply to documentation too. %deally any code contri/ution that is merged into the /ase has documentation to go with it. 'nne Gentle is the coordinator 1or all documentation e11orts> /oth communityF/ased and Lo11icialL docs. *he page http:;;wiki.openstack.org;"ocumentation;=ow*o descri/es the methods we use to create the /asis 1or worldFclass documentation 1or OpenStack de(elopers and users.

OpenStack -cosystem
' ro/ust ecosystem is essential to OpenStack0s success. *here are se(eral ways your company can join this growing and (i/rant ecosystem. Sponsor the OpenStack (oundation OrganiDations can apply to /ecome new Gold .embers> and will /ecome 4em/ers su &ect to oard approval. Contact secretaryBopenstack.org to recei(e the application and Gold 4em/er 'greement. Companies can also choose to /ecome Corporate Sponsor o1 the +oundation with two sponsorship le(els Corporate Sponsor (Start Up) ' @Start 6pA is de1ined as @in /usiness less than < years and less than ! million re(enueA. *he ?uota 1or is set to I78k;year and grants: 'ccess to OpenStack restricted use logos 1or commercial use i1 and as long as product meets technical re?uirements ,your support helps the 1oundation promote and protect the OpenStack /rand"esignation as Startup sponsor with corporate logo placement in supporters section o1 openstack.org Pro1ile on openstack.org detailing your organiDationKs support 1or OpenStack> with a link to your site 3arly access to sponsorship opportunities> like OpenStack "esign Summit Q Con1erence

Revision 7

release date: 25. Apr. 2013

'

OpenStack Startup Sponsor /adge a(aila/le 1or corporate we/site or marketing material Opportunity to /e included in OpenStack newsletter *he Corporate Sponsor legal agreement is a(aila/le to re(iew https:;;www.openstack.org;legal;openstackF1oundationFsponsorFagreement;. Please email secretaryBopenstack.org to 1aciliate eCecuting the agreement. Corporate Sponsor (Established Company) +or companies that are not @Start 6pA the ?uota is set to I<!k;year and grants: 'ccess to OpenStack restricted use logos 1or commercial use i1 and as long as product meets technical re?uirements ,your support helps the 1oundation promote and protect the OpenStack /rand "esignation as Corporate sponsor with corporate logo placement in supporters section o1openstack.org Pro1ile on openstack.org detailing your organiDationKs support 1or OpenStack> with link to your site 3arly access to sponsorship opportunities> like OpenStack "esign Summit Q Con1erence> /e1ore nonFsponsors OpenStack Corporate Sponsor /adge a(aila/le 1or corporate we/site or marketing materials Opportunity to /e included in OpenStack newsletter *he Corporate Sponsor legal agreement is a(aila/le to re(iew https:;;www.openstack.org;legal;openstackF1oundationFsponsorFagreement;. Please email secretaryBopenstack.org to 1acilitate eCecuting the agreement. $ndividual .ember o, the (oundation 'ny person can join the OpenStack +oundation 1or 1ree. %ndi(idual 4em/ers: 7. Get acti(e in the OpenStack community as a user> de(eloper> /usiness person> art maker> or howe(er you want to contri/ute <. un 1or an elected position such as Project *echnical #ead 1or projects you contri/ute to> *echnical Committee 4em/er> or +oundation $oard o1 "irectors 4em/er 3. Rote in elections such as 1or the $oard o1 "irectors 4. Stay in1ormed o1 the latest OpenStack news through mem/er updates OpenStack /ser Groups OpenStack users 1rom around the world are creating local OpenStack 6ser Groups to promote the open source project and their associated technologies. %1 you are interested in esta/lishing a user group in your area> please join the %nternational Community mailing list on http:;;lists.openstack.org;cgiF/in;mailman;listin1o;community *he list o1 OpenStack 6ser Groups around the world is maintained on the wiki on http:;;wiki.openstack.org;OpenStack6sersGroup

Revision 7

release date: 25. Apr. 2013

10

Other use,ul tools

%uestions and &nswers )ask0OpenStack0org* *he place where people can ask ?uestions and gi(e answers a/out OpenStack deployments> operations and de(elopment https:;;ask.openstack.org. Wiki ' lot o1 good in1ormation on getting started with OpenStack core projects can /e 1ound in the wiki. *he search 1unction in the upper right hand corner o1 the wiki is (ery power1ul and is searcha/le /y /oth title and /y content. http:;;wiki.openstack.org;StartingPage #ug eporting *he OpenStack community appreciates testers and their 1eed/ack. *o report a /ug you must 1irst sign up 1or a #aunchpad account. Check that the /ug you 1ound has not already /een reported /y searching the #aunchpad /ugs list: https:;;/ugs.launchpad.net;openstack;N/ugs? order/yOFimportanceQ1ield.status:listOCOE+% 43"Q1ield.status:listO* %'G3" %1 you 1ound a new /ug> 1ill out a /ug report: Gi(e a clear> concise summary Pro(ide as much detail as possi/le in the description. Paste in your command output or stack traces> link to screenshots> etc. $e sure to include what (ersion o1 the so1tware you are using. *his is especially critical i1 you are using a de(elopment /ranch. 3Cample: (Austin release( vs lp:nova rev.3'6. 'ny deployment speci1ic in1o is help1ul as well. 3Cample: ) untu 10.04* #ulti+node install.

1eeping in touch *witter: Bopenstack *he OpenStack $log: http:;;www.openstack.org;/log; ' /log aggregated 1rom de(elopers and other key players o1 OpenStack projects: http:;;planet.openstack.org; %nternet elay Chat ,% C- is where de(elopers hold realFtime discussions on (arious projects. Pu/lic meetings are also held on % C. Channel Popenstack on +reenode ,http:;;we/chat.1reenode.net (ia /rowser client O11icial Gou*u/e Channel with (ideos 1rom con1erences and other interesting material: http:;;www.youtu/e.com;openstack1oundation Slides and presentations are a(aila/le on the OpenStack SlideShare http:;;www.slideshare.net;openstack; +lickr Group http:;;www.1lickr.com;groups;7!.4)5!BE<<;

Revision 7

release date: 25. Apr. 2013

11

%1 you ha(e any ?uestions a/out OpenStack> and ha(en0t /een a/le to 1ind answers elsewhere> try one o1 these knowledgea/le people: http:;;wiki.openstack.org;Contact

.ailing "ists *he project runs many mailing lists. *he most important ones are: General list Gou should join this list when you start to know OpenStack. e?uest 1or help and community announcements are allowed on this list. %ts rate can /e up to 788 messages per day. http:;;wiki.openstack.org;4ailing#istsPGeneralS#ist !evelopment list *his list 1or the developers o1 OpenStack to discuss de(elopment issues and roadmap. %t is 1ocused on the neCt release o1 OpenStack: you should post on this list i1 you are a contri/utor to OpenStack or are (ery 1amiliar with OpenStack de(elopment and want to discuss (ery precise topics> contri/ution ideas and similar. "o not ask support re?uests on this list. http:;;wiki.openstack.org;4ailing#istsP"e(elopmentS#ist Operators *his is a speci1ic list 1or eCisting OpenStack cloud operators. %t is a 1orum to eCchange /est practices around operating an OpenStack installation at scale. Gou can ask 1or support on this list. http:;;wiki.openstack.org;4ailing#istsPOperators

OpenStack -vents
OpenStack Summits take place e(ery ) months. OpenStack also participates in many cloud and open source con1erences throughout the year. %1 you are planning an OpenStack e(ent or meet up and you would like it added to the e(ents page http:;;openstack.org;community;e(ents; please email your e(ent in1ormation to the OpenStack Community 4anager communitymngrBopenstack.org.

OpenStack Wiki "ayout

Starting Page
http:;;wiki.openstack.org;StartingPage Getting Started: #inks to the page with instructions a/out installing OpenStack> searching the wiki> how to use #aunchpad and #aunchpad /ug 2ow to Contribute: #inks to instructions on joining the OpenStack teams in #aunchpad and how to contri/ute a1ter joining ,most o1 this in1ormation is also contained in this document!ocumentation: #inks to the wiki page 1or all so1tware documentation including OpenStack manuals and project documentation

Revision 7

release date: 25. Apr. 2013

12

Contact3 #inks to contact in1ormation 1or the Chie1 'rchitect> the *echnical Writer> the We/master> and the Community 4anager Contributor4s corner: #inks to /asic in1ormation a/out contri/uting to OpenStack code> the release cycle> the jo/ listing page> and de(elopment release status Resources and Community3 #inks to the core community (alues o1 OpenStack> mailing lists> and % C in1ormation> 6ser groups> /logs> the weekly newsletter and more.

Revision 7

release date: 25. Apr. 2013

13