Getting Started as a Developer¶

This brief note would serve as a reference for a developer looking to start-up on the Tungsten Fabric development environment.

PLEASE NOTE: Until 2018, Tungsten Fabric was named “OpenContrail”. There are still several references to the old name in the code and other utilities.

A new developer can refer to the Tungsten Fabric Architecture document at https://tungstenfabric.github.io/website/Tungsten-Fabric-Architecture.html.

To get information about latest releases and schedule, please refer to: https://jira.tungsten.io

1. Registration and User Creation¶

A new developer should register on Tungsten Fabric development/user mailing lists and Slack on this link: https://tungsten.io/community/
In order to submit blueprints for a new feature or to raise bugs on existing features, create a Linux Foundation ID: http://identity.linuxfoundation.org
Have a look at the blueprints and bugs in our Jira: https://jira.tungsten.io
Create a GitHub account by signing up on https://github.com/ (if you’re not already registered)
Confirm you can log into the Gerrit with your Linux Foundation ID: https://gerrit.tungsten.io

2. Ubuntu installation and configuration¶

Install Ubuntu version 16.04 trusty for the Tungsten Fabric stable installation.

2.1 Relevant packages for the Tungsten Fabric installation.¶

sudo apt-get update
sudo apt-get install git
sudo apt-get install git-core
sudo apt-get install ant
sudo apt-get install aptitude
sudo aptitude install build-essential
sudo apt-get install libev4 libev-dev

2.2 Generate SSH key and add it to local SSH-agent¶

Ref: https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account

ssh-keygen -t rsa -b 4096 -C "<username@someone.com>"
eval $(ssh-agent -s)
ssh-add ~/.ssh/id_rsa
sudo apt-get install xclip
xclip -sel clip < ~/.ssh/id_rsa.pub

2.3 Add SSH key to GitHub account¶

Go to profile and select settings
Choose SSH and GPG keys -> New SSH key
Give a title for the key
Paste the key generated above ( xclip command will copy the key from .pub file to your clipboard)
Add SSH key.

3. Tungsten Fabric + Devstack setup¶

Ref: https://github.com/Juniper/contrail-installer/blob/master/README.md

3.1 Clone Contrail-installer and devstack Repositories¶

git clone https://github.com/juniper/contrail-installer.git
git clone https://github.com/openstack-dev/devstack -b stable/newton

3.2 Set up Tungsten Fabric (formerly known as OpenContrail)¶

Copy the localrc file from samples to the current directory and edit it as required.
```
cd contrail-installer cp samples/localrc-all localrc
```
change eth interface: default is eth0 #CONTRAIL_BRANCH=R3.2 //Commented means code will be checked out from Trunk. //Else specify the branch and uncomment it.
Execute contrail.sh
```
./contrail.sh
```

3.3 Set up DevStack¶

Copy the opencontrail plugin to devstack neutron_plugins directory

cp ../contrail-installer/devstack/lib/neutron_plugins/opencontrail
lib/neutron_plugins/

Prepare localrc for devstack:

cp ../contrail-installer/devstack/samples/localrc-all localrc

Update “PHYSICAL_INTERFACE” as applicable.

Add following to localrc file:

NOVNC_BRANCH=v0.6.0

Run stack.sh
```
./stack.sh
```
The installation shall fail once. Once it fails, do the following change

Edit the file “/usr/local/lib/python2.7/dist-packages/openstack/session.py” at line 29 and replace “openstack.version” with “openstack”

Line 29: DEFAULT_USER_AGENT = “openstacksdk/%s” % openstack

Now do a restack. For this Tungsten Fabric needs to be restarted as well, i.e.

./unstack.sh cd ../contrail_installer ./contrail.sh restart cd -
./stack.sh

3.4. Accessing Openstack and Tungsten Fabric GUIs¶

Openstack and contrail GUIs can be accessed as follows:-

Openstack GUI: http://localhost/dashboard/
Tungsten Fabric GUI: http://localhost:8080/

4. Setting up Gerrit for committing code-changes for review¶

Ref: https://gerrit.tungsten.io/r/Documentation/index.html

4.1 Setup SSH access¶

Log into your account at gerrit.tungsten.io
Go to top-right corner -> settings
Left panel -> SSH public keys -> Add key
Follow the instruction under heading “How to generate an SSH key”

Test the SSH access

$ ssh -p 29418 sshusername@gerrit.tungsten.io

\***\* Welcome to Gerrit Code Review \***\*

Hi John Doe, you have successfully connected over SSH.

Unfortunately, interactive shells are disabled. To clone a hosted Git repository, use:

git clone
ssh://sshusername@gerrit.tungsten.io:29418/REPOSITORY_NAME.git

Connection to hostname closed.

4.2 Pushing code-changes for review¶

Install git-review
```
sudo apt-get install git-review
```

Configure Gerrit

git config –global user.email username@someone.com gitdir=$(git
rev-parse –git-dir); scp -p -P 29418
username@gerrit.tungsten.io:hooks/commit-msg ${gitdir}/hooks/

Clone the repo where changes need to be committed

git clone
ssh://sshusername@gerrit.tungsten.io:29418/REPOSITORY_NAME.git

Commit the changes
```
git commit -m "<commit-note>"
```
Note: please ensure that any change being committed should have a corresponding launch-pad bug-id mentioned in the commit message, i.e. “Bug #1679466”

Push the locally committed changes up for review

git push ssh://username@gerrit.tungsten.io:29418/REPOSITORY_NAME \
HEAD:refs/for/<branch>%topic=<few-words-describing-the-change>, \
r=reviewername@someone.com, cc=otherreviewer@someone.com