Colin McNamara - Surviving your first check-in: An engineers guide to contributing to OpenStack

Surviving your first check-in: An engineers guide
to contributing to OpenStack

Colin McNamara – Chief Geek, Nexus IS
CCIE #18233
@COLINMCNAMARA
1/9/2013
1 www.Nexusis.com 877.286.3987

Agenda

§  How this all started – “a simple experiment”
§  The importance of community - Leveraging the power of the meetup
§  Talking your employer into supporting OpenStack and the CLA
§  Setting up your Dev environments - getting beyond Devstack
§  “Getting” git, using the git repository for those that don't code for a
living
§  Testing your code - what do you mean it doesn't build?
§  How to give back, and get other people involved in the community

My Background


My Perspective

§  Network Engineer first
§  CCIE #18233

§  Systems/Storage Second
§  IEEE, IETF, T11
§  Linux user since 98
§  Creator of “Sausage Code”
§  NOT A PROGRAMMER


How this craziness started


“A simple experiment”

§  Ewan Mellor – Citrix Xen
§  Simple feature, Deploy
Storage QOS
§  Turned into a 4 month saga
§  Lots of lessons to be learned


Leveraging the power of the Meetup


Meetup.com – Community is your friend
§  Join a Meetup.com group
§  http://www.meetup.com/
openstack/
§  If there is none in your area–
Start One
§  Many eyes help in
overcoming challenges


Background


Talking to your employer about contributing


Talking to your employer about contributing

§  Notify your manager. If you don’t have a
policy you have a chance to set one.
§  In Ca, you are only protected if your
company isn’t in the line of biz your project
is.
§  If you are contributing on behalf of a
company, an authorized representative of
your company should also sign a
Corporate Contributor License Agreement.

Next steps – Executing your CLA
§  Join the OpenStack foundation
§  Create your launchpad account
§  *** don’t change your username after ***

§  Join the OpenStack team on launchpad
§  Sign the CLA electronically
§  Update the Contributors Wiki
§  Request openstack-cla membership on
launchpad
§  Wait (or ping an op on #openstack-dev)

Setting up your Dev environment


10 minutes to Devstack

§  Best run on Ubuntu 12.04
§  Log in as a USER (not root)
§  Sudo apt-get install git
§  git clone
https://github.com/openstack-dev/
devstack.git
§  cd devstack && ./stack.sh


Getting beyond Default Devstack

§  I like to run in a VMware environment
§  (in home lab + instance on laptop)
§  Working on cloning Rackspace’s nested setup
that cody_bunch is using

§  Spin up new instances easily
§  Quickly compare versions
§  Default install pushes QEMU
§  Puppet / Cobbler / Koan in your home lab
will save you time / headaches

Getting beyond Default Devstack - Stackrc
§  /devstack/
stackrc

§  Adjust API’s /
Services

§  Change git
repos


Getting beyond Default Devstack - Stackrc

§  ~/devstack/stackrc updated to point to working development
branch
§  Refs/changes/50/5050/1 is the review ID


You’ve made a change, Now What?

§  ./rejoin_stack.sh will attach you the screen with all the
terminals for the various apps. There could be as many as 14
screens depending on how many services are enabled
§  “ctrl-c” and “ctrl-d” on each window to kill the process. “ctrl-a
n” takes you to next terminal. Restart the process by using up-
arrow key and entering return
§  Another easier way to kill all and restart is to do “screen -ls”
and kill the process. Restart by ./rejoin_stack.sh


“Getting Git” OpenStack Workflows


What is Git ?

§  Repository created for Linux Kernel Dev
§  Solves centralization problems – you can
code at the lake, or in your isolated lab
§  Can be complex (multiple ways of doing
things)


Setting things up – Installing Git

Install Git

Install DevStack

Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Installing DevStack

Install Git

Install DevStack

Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Configuring Git

Install Git

Install DevStack

Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Configuring git-review

Install Git

Install DevStack Git review redirects a commit into a review and test
process
Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Cloning a project

Install Git

Install DevStack

Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Testing Gerrit

Install Git

Install DevStack
This error held us up for 2 weeks…
Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Generate your public key

Install Git

Install DevStack

Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Add your key to review.openstack.org

Install Git

Install DevStack

Configure git

Install git-review

Clone a project

Verify gerrit works

Setting things up – Add your key to review.openstack.org

Install Git
Doesn’t Work -
Install DevStack

Configure git

Install git-review

Clone a project Works -

Verify gerrit works

Making, Testing and submitting changes


Pro Git – Well worth the price

§  I didn’t write it, but this
book is great
§  It is on Safari Books
Online


Setting things up

Create a topic branch

Change code

Test Code

Commit Changes

Submit them for review

Monitor the review process


Edited v1_1 api to describe phys as well as virt CPU


Change code

Test Code

Commit Changes




./Run_tests.sh in each project


Change code

Test Code

Commit Changes




Commit your code


Change code

Test Code
Be verbose, and be sure to call out whether a feature is
Commit Changes blueprinted or a bugfix



Submit it for review!!


Change code

Test Code

Commit Changes




Track the reviews progress


Change code

Test Code

Commit Changes




Giving back Engaging the community


Giving back

§  Start a meetup.com group in your area
§  Connect with other meetup organizers
§  Present to your peers
§  Share your experience with the world


Open Blueprints Stuff to work on


Vish – Nova PTL Open Blueprints
§  edit-default-quota - nova grizzly
§  nova-api-samples - nova
grizzlylive-migration-scheduling
§  DHCPv6 Support – SFBay OpenStack
§  openstack-operations-manual - grizzly


@colinmcnamara
colin.mcnamara@nexusis.com
www.colinmcnamara.com


Colin McNamara - Surviving your first check-in: An engineers guide to contributing to OpenStack

More Related Content

Viewers also liked

Similar to Colin McNamara - Surviving your first check-in: An engineers guide to contributing to OpenStack

Colin McNamara - Surviving your first check-in: An engineers guide to contributing to OpenStack