Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

So you think you're ready to start touching some code? We'll see about that...

Sign Up for Slack Account(s)

Most of the day-to-day communication happens via Slack.

Sign up for an account on https://nationaldataservice.slack.com/messages .

You can ask Sara Lambert for an invite if necessary.

Important Channels

  • #general - please do not talk in general, to avoid bothering all users on the server
  • #random - non work-related talk or potentially distracting content
  • #development - general discussion towards NDS development
  • #nebula - read-only forwarding from NCSA RocketChat about OpenStack Nebula
  • #notifications - Update spam from GitHub / DockerHub / JIRA
  • #alerts - NAGIOS alerts from production instances
  • #standup - automated daily standup reports

Access OpenStack (aka Nebula)

The next few steps will involve familiarizing yourself with Nebula, our on-site OpenStack implementation.

Retrieve Your Nebula Password

Specify your AD username, then execute the following command to retrieve your Nebula password:

export AD_USERNAME=
sudo ssh ${AD_USERNAME}@public-linux.ncsa.illinois.edu cat /afs/ncsa/projects/openstack/etc/users/${AD_USERNAME}/password

Create an SSH Keypair

Log into Nebula and expand the Compute dropdown.

Select Access & Security, navigate to the Key Pairs tab, and click the Create Key Pair button.

Walk through the wizard to generate an SSH key pair.

Your browser should automatically download a private key (for example, key.pem).

Allocate a development VM

Choose a project at the top-middle of the page (we tend to use NDS-hackathon, but your choice will depend on which project you can access).

Choose Instances from the left side navbar.

Create a new Instance using the image entitled CoreOSAlpha.

Be sure to select a flavor (aka "machine size").

If you are unsure which to use, you likely should be using "large" or "medium".

Networking Gotchas

  • DO NOT FORGET to associate an SSH key for this machine, or else you will never be able to get into it
  • Remember to associate a Floating IP with this VM, so you can access it from outside of Nebula via 141.142.xxx.xxx
  • Be sure to add Permissions to this VM:
    • remote SSH
    • remote HTTP
    • default

Create Necessary Accounts

Create an NCSA OpenSource Account

...

These projects build up the Docker images deployed by NDSLabs. Our backend

The NDS Labs spec for each service mimics that of the "Kubernetes Spec" and references the images built by the repos above:

These specs are then fed by the NDSLabs NDS Labs API Server into the etcd instance that is run by Kubernetes.

...

The code for the API / GUI can be found here: https://github.com/nds-org/ndslabs

Further documentation for the NDS Labs initiative can be found here:

Congratulations!

If you have made it through all of the tutorials without hurting yourself or others, then you're doing great! (big grin)

You should now have all of the information that you need to get started working on NDS Labs!

Check out the documentation for that project here: NDS Labs

Extra Credit

Useful Tutorials / Discussions:

...