Introduction
Nordix provides various services to the community as listed below. Please see the corresponding section for accessing and using these services.
Service | Tool | URL | Access |
---|---|---|---|
Code Review/SCM | Gerrit | https://gerrit.nordix.org | |
Automation/CI | Jenkins | https://jenkins.nordix.org | |
Artifact Repository | Artifactory | https://artifactory.nordix.org | Local User |
Artifact Repository | Nexus | <TBD> | <TBD> |
Wiki/Collaborative Editing | Confluence | https://wiki.nordix.org | |
Issue/Bug Tracking | JIRA | https://jira.nordix.org | |
Maillist | Mailman | https://lists.nordix.org/ | Local User |
IRC | Freenode | https://webchat.freenode.net/ | Local User |
Accessing Services
All the services can be accessed using regular Google account unless otherwise noted in the table above and in corresponding sections.
If you do not have an account on Google, please ensure you create one before accessing the services.
You will then use your Gmail address as username and your Gmail password as password to login to Nordix services.
Services fetch fullnames from Google so please ensure you use your real name.
Usage
The usage of the tools does not differ from how the same tools are used elsewhere however it is strongly advised to have a look at the sections below to see you do not miss anything and experience difficulty while accessing and using these tools.
Gerrit
Nordix Gerrit can be accessed using Google account.
Login
- Click "Sign In" link from the upper left corner of https://gerrit.nordix.org
- Login with your Gmail username and password and press Enter.
- You should now be redirected to Nordix Gerrit.
- Once you login, send an email to discuss@lists.nordix.org and announce your intention to contribute to a(ny) project you are member of so you are given developer rights on Gerrit.
Initial Configuration
- After logging in, click your name on the upper left corner and click "Settings".
- Set your username. This is important in order to be able to clone Git repos using SSH.
- Upload/paste your Public SSH Key(s) by clicking "SSH Public Keys" link on "Settings" screen. This is important in order to be able to clone Git repos using SSH.
- Open the project you would like to work and clone the repo using SSH URI provided on the opening page.
Jenkins
Nordix Jenkins can be accessed using Google account.
Using Nordix Jenkins is not different from any other Jenkins instance with one important difference. Jobs on Nordix Jenkins are created, configured, updated, and deleted using OpenStack utility named Jenkins Job Builder (JJB).
Developers are not supposed to create, (re)configure, and delete jobs using Jenkins UI.
With JJB, Jenkins jobs are treated like source code; a patch modifying JJB yaml file(s) for the jobs in question is sent to corresponding Nordix Gerrit project, verified by automated jobs, reviewed by reviewers and then submitted.
Once the patch is sent to Nordix Gerrit, they get tested automatically, resulting in the usual Verified +1 or Verified -1. If verification fails, the person who proposed the change needs to amend it and then it gets reverified.
If the patch passes the verification and gets +2 from the reviewers, it gets submitted. When the change gets merged, another job gets triggered, deploying job changes to Jenkins.
Nordix has and will have several Gerrit projects to host JJB.
- infra/ci: Jobs related to the projects hosted on Nordix or related to general Nordix operations.
- ci-management: Jobs related to the upstream ONAP project so the development work carried on in Nordix can be tested using same jobs. An important aspect of this is to use nordix-dev branch to make modifications to the jobs that will be run on Nordix Jenkins. That change can then be contributed to upstream ONAP on master branch.
Artifactory
Nordix Artifactory can be accessed using local account. Please send an email to discuss@lists.nordix.org for the requests such as creation of a repository to store the artifacts, get additional access right, and so on.
Nexus
Nordix Nexus is currently being installed.
Wiki
Nordix Wiki can be accessed using Google account. Please ensure to login by clicking "Login with Google" button.
When users login, they become users group by default. You should be able to create spaces and pages.
JIRA
Nordix JIRA can be accessed using Google account. Please ensure to login by clicking "Login with Google" button.
When users login, they become users group by default. You should be able to create and work on issues for existing projects. If you would like to have a new project to be created, please send an email to discuss@lists.nordix.org.
Maillist
Nordix Maillists can be access by local accounts.
In order to sign up for the mailing lists, open Nordix Maillists on your browser, click the maillist you are interested signing up and fill in the details.
It is strongly adviced to sign up to both TC and discuss mailing lists as main communication mechanism for questions, infra support, technical committee is maillists.
Infra, tooling and account related questions and requests should be sent to discuss@lists.nordix.org.
IRC
IRC is used by many open source communities to have realtime communication with the fellow community members.
Nordix has a channel on Freenode IRC Network named #nordix. It is adviced for developers to join to this channel to reach out to other members of the community.
You can either use desktop clients for your operating system such as Pidgin or Adium or free services like IRCCloud.
If you do not have time to do this, you can use Freenode Webchat to join to #nordix channel.
Basic Developer Workflow
TBD