Baremetal and Cloud Resources
Nordix uses few tenants OpenStack public clouds for most of the development activities.
Apart from the cloud resources, work is ongoing to bring up a baremetal lab to ensure we can provide baremetal resources to community as well when needed.
Access to Project Instances
The projects that are developed on Nordix OpenStack Tenants have instances for the development work. (ONAP and Acumos are the 2 examples) SSH access to project instances are provided on a need basis and this access must be under the control of the Infra Core Team.
All the project instances have jumphost between them and the internet. The access to jumphost must be requested on discuss maillist and is given by the Infra Core Team. The only access mechanism that is accepted is key-based authentication so requestors must provide their ssh public keys.
Once the access is given to the jumphost instance, the developer then needs to contact to the project team to get access to the rest of the project instances. Infra Core Team does not have any responsibility over how the project utilizes the project instances or who gets access to them.
Accounts on jumphost can be created using regular Linux commands. Here are the steps.
- Login to jumphost.<project> as a user with sudo rights
- Create user using regular linux commands
- sudo useradd -G <project group> -m -s /bin/bash <username> # usernames are generally constructed using the first letter of the first name and the last name
- Copy user's ssh public key into /home/<username>/.ssh/authorized_keys
- Update /etc/ssh/sshd_config and append username into AllowUsers
- Restart sshd service
Setting Up a New Gerrit Based Upstream Project
Setting up a new Gerrit based upstream project requires following certain steps and reaching out to communities for getting additional rights for Nordix CI/CD.
Most of the steps are same no matter what upstream project is setup within Nordix except the differences highlighted in corresponding step.
Some of the steps can be performed in advance and some others must be done after the others are completed.
Here are the steps to follow.
- Create an account on SSOs of upstream projects
- Common for all upstream SSOs:
- A user must be created or an existing user must be used if a project from a certain community has already been mirrored in Nordix Gerrit.
- User name for Nordix Infra is nordix and this user name must be used while creating a new account if it is available. If it is not available, it must be discussed first so everyone knows the username.
- The mail address for nordix user is firstname.lastname@example.org and the people who work with Nordix Infra is subscribed to this mailbox.
- LF hosted projects use LFID and once an account is setup for Nordix Infra user there, same account can and should be used for accessing all the systems of all the LF hosted projects including but not limited to Gerrit, Jenkins and so on.
- Please note that an account for Nordix Infra named nordix has already been created on LFID so you should not create a new account.
- OpenDev uses Ubuntu One and an account for Nordix Infra named nordix must be created.
- Common for all upstream SSOs:
- Set username on Upstream Project's Gerrits
- Username to use is nordix.
- This is done in Profile tab on Gerrit Settings page after the initial login to upstream Gerrit. Please note that this is a one time operation and username can not be changed afterwards.
- Upload ssh public key for the user on Upstream Project's Gerrits
- This is done on SSH Public Keys tab on Gerrit Settings page after the initial login to upstream Gerrit.
The key to use must be nordix user's key and not random as it is used for cloning repos and so on and configured on Nordix Jenkins.
Attempt cloning a repo using SSH from Upstream Gerrit with the username nordix and its ssh private key to ensure username, ssh keys and other stuff is correctly setup.
Create Gerrit Server Configuration on Nordix Jenkins
This is done on Nordix Jenkins Gerrit Trigger Configuration page by clicking Add New Server link.
Fill in the name of the new Gerrit Server to Add New Server field. Format of the server names is <Upstream Project> Gerrit such as ONAP Gerrit, OpenDev Gerrit.
Clicking Copy Existing Server Configurations will make configuration easier and reduce the chance to make mistakes as fields will be prepopulated with the values. Update the fields specific to the project you are setting up.
- After you save the configuration for the new Gerrit Server, you should click the red ball and see it turning blue. If it stays red, something might be wrong either with the configuration in Nordix or in upstream Gerrit. Troubleshooting is needed.
- Ask for Gerrit Stream Event Rights from upstream community
- OpenDev generally allows stream rights for all the users by default so nothing extra needs to be done for it in upstream. Just verification is needed in Nordix Jenkins by creating trigger macros and setting a job for a mirrored project and watching it getting triggered by different Gerrit Events such as change-merged. See the next step.
- If it doesn't work, upstream community needs to be reached in #openstack-infra channel. Ask others who know who to talk in OpenStack community for help to reduce the time it takes to get this fixed.
- LF does not allow stream rights for all the users by default and this must be requested using corresponding project's helpdesk.
- To make things faster, ask the people who know who to talk to in LF for help to reduce the time it takes to get stream rights for nordix granted.
- Add Trigger Macros for new Gerrit Server into JJB Macros in nordix infra/cicd repo
- See existing macros and copy/paste/adjust them.
- Setup build server(s) for the project
- If the developers need special build servers, they need to be setup.
- Otherwise, existing build servers should be ok to use.
- Ensure Gerrit Host Keys are added to build servers
- This can perhaps be automated but the easiest way to do this is to login to build servers and clone one of the repos from upstream project via ssh and accept the key.
- Not doing this will cause job build failures with ssh key complaints.
- See the next chapter
Mirroring a Project from Upstream Gerrit
Mirroring a project from upstream Gerrit can be done by following the steps listed below.
- SSH to Nordix Gerrit server as infra user
- clone the repo of the project that is about to be mirrored
- ensure all the remote branches are pulled
- create the project on Nordix Gerrit
- copy .git folder from the clone into the newly created projects root folder
- assign the appropriate access control permissions to the mirrored project
- flush Gerrit cache
Once the above steps are done without issues, the mirrored project should be visible on Nordix Gerrit Web Interface and its parent should reflect to what you set.
If the project is visible there, further work is needed to be done to ensure the project repo is kept up to date with the upstream and push upstream jobs are created on Nordix Jenkins in order to support development workflow.
- create rebase and push-upstream jobs using jjb
- run rebase job manually to ensure any new change that might have been merged in upstream is synched to Nordix
Following example demonstrates these steps by mirroring a project from ONAP Gerrit into Nordix Gerrit.
See this change for creating rebase and push-upstream jobs on Jenkins.
Adding branch from upstream to existing project in Gerrit
Currently only the branches defined in the Jenkins rebase job will be synchronized with Nordix Gerrit. Please follow steps below to add a branch from upstream to existing project in Nordix Gerrit:
- Update the rebase, push-upstream and verify (if exist) Jenkins job with the new branch. Please see this change for an example.
- Execute the rebase Jenkins job for given project to pull down the branch to Nordix Gerrit.
Managing Gerrit Access
If a project inherits rights from a certain project, the ACL for the project can be managed by modifying corresponding files in the project such as groups and project.config which the rights are inherited from.
As an example, default All-Projects project will be used to list the steps so it is important to adjust the project name depending on what you are doing.
Nordix Gerrit has few parent projects created in order to control access to various projects on Nordix Gerrit.
Below table lists the projects and their purposes so if a project you are creating or mirroring fits into one of these, choose that one.
If you don't see an appropriate parent project there, you can create it but please take a discussion with the rest of the Infra Team before doing this.
|All-Projects||Default project which the access permissions are inherited by all the other projects. Use with care.|
|infra/acl/infra-global||Parent project for all Nordix Infra projects to inherit access rights from.|
|infra/acl/onap-global||Parent project for all mirrored ONAP projects to inherit access rights from.|
On top of having parent projects to inherit access rights from, Gerrit has User Groups as well.
Below table lists the groups and their purposes so if a user you are granting rights for fits into one of these, choose that one.
If you don't see an appropriate group there, you can create it but please take a discussion with the rest of the Infra Team before doing this.
Do not modify without taking a discussion with the rest of the Infra Team.
|Developers||Obsoleted by the new groups. Do not use!!!|
Noone should be in this group once all the ACL work is completed.
|Non-Interactive Users||Do not modify without taking a discussion with the rest of the Infra Team.|
Users who perform batch actions on Gerrit. (Jenkins, etc.)
|infra-core||Core reviewers for Nordix Infra Projects. |
All Nordix contributors are member of this group. All rights on infra/acl/infra-global project.
Not in use yet. Do not use!!!
|onap-core||Not in use yet. Do not use!!!|
Core reviewers for mirrored ONAP Projects. All rights including +2/submit on infra/acl/onap-global project.
|onap-developers||Contributors for mirrored ONAP Projects. No +2/submit rights on infra/acl/onap-global project.|
All Nordix ONAP developers are currently member of this group to prevent accidental merges on master.
Nordix provides various artifact repository services depending on the type of artifacts.
- Artifactory: General purpose artifact repository manager which can be used for storing ISOs, RPMs, QCOW2 images and so on.
- Harbor: Private container image registry to store images built within Nordix or mirror images that are consumed from upstream communities.
Primary mechanism Nordix employed to control access is as below.
- Anonymous pulls are enabled.
- Self-registration is enabled and anyone who registers will end up in readers group which has the same access rights as Anonymous users.
- Users that are member of the group builders can pull and push images.
- Users that are member of the group owners own specific repositories and have pull, push rights and rights to alter the repo structure. (TODO: find out if project specific owner groups can be done or if we should have owner groups per repo)
- Users that are member of the group admin have full admin rights over all repos and harbor itself.
Admin Contacts for the Services and Tools
|EST OpenStack Tenants||TBD|
|Nordix OpenStack Tenant||TBD|