An example project-config repo that can be used as a starting point.

Go to file

Clark Boylan 28fff67469 Update deprecated zuul syntax merge-failure has become merge-conflict in pipeline reporting configurations. The old syntax has been deprecated and will be removed soon. Update our examples to match current expectations. Change-Id: I7b3f07d071d52e4e6fe906e9037b489ae2455b43		2022-09-02 09:19:09 -07:00
jenkins/jobs	Replace openstack.org git:// URLs with https://	2019-03-24 20:35:36 +00:00
nodepool	Remove reference to node-devstack	2016-11-29 17:52:14 +02:00
tools	Replace openstack.org git:// URLs with https://	2019-03-24 20:35:36 +00:00
zuul	Update deprecated zuul syntax	2022-09-02 09:19:09 -07:00
.gitignore	Add tox checks	2015-09-28 15:08:11 -07:00
.gitreview	OpenDev Migration Patch	2019-04-19 19:26:04 +00:00
LICENSE	Initial commit	2015-09-25 10:37:08 -07:00
README.md	Update deprecated zuul syntax	2022-09-02 09:19:09 -07:00
test-requirements.txt	Add tox checks	2015-09-28 15:08:11 -07:00
tox.ini	Remove pep8 target	2015-12-23 10:09:35 +01:00

README.md

Example project-config repository

This is an example project-config repository for use as a starting point to setup a 3rd party CI account. It is expected that you fork this repository or otherwise copy it to your own repository. Any changes to this version are expected to remain within the scope of an 'example' to help others get started. Refer to openstack-infra/project-config for a more complete production configuration.

Steps to begin customization

The project-config repository is intended to contain custom configurations needed by each CI system.

Customize Zuul

The zuul layout configuration is located in zuul/layout.yaml. You can find the full configuration details in the Zuul manual.

Change 'myvendor' in the 'recheck' command to your CI's name.
Configure the e-mail addresses for merge-conflicts and job notification.
By default, the project zuul triggers on is openstack-dev/ci-sandbox. After testing your CI system update this section to include other projects. You are encouraged to use the 'silent' pipeline until your jobs are stable.

Customize Nodepool

The nodepool configuration is located in nodepool/nodepool.yaml. You can find the full configuration instructions in the Nodepool manual. There are a few configuration that need to be updated.

There are some user names and passwords that need to be configured.
Select a 'random time' for your nodepool images to be built in the image-update property. By having 3rd party systems use different times will help reduce the spike load on OpenStack's Git servers.
Setup an intial set of nodepool scripts and elements. Start by cloning OpenStack's project-config and copying the entire contents of that repo's nodepool/elements to your repo's nodepool/elements. Optionally do the same for the nodepool/scripts folder. You may have to change these elements to work in your environment. If so, see this README for help.
Update the nodepool/nodepool.yaml diskimages configuration to match the elements you included in the previous step. If you included everything, the defaults provide a good starting point. Otherwise, adjust them as needed as explained in the nodepool manual.

Customize Jenkins Jobs

Adjust the jenkins jobs in jenkins/jobs/ to your needs. You can find the full configuration details in the Jenkins Job Builder manual

Change the value of the <your-log-server> in project-config-example/jenkins/jobs/macros-common.yaml to the host you will publish job artifacts to. This is also known as the Log server. You can set one up using openstackci::logserver puppet class

Basic checks

Prerequisites: The following packages need to be installed for the zuul tox environment tests to pass: sudo apt-get install libxml2-dev libxslt1-dev python-dev build-essential

Run tox to run some basic syntax checks to validate the syntax of your configuration files.

Credits

This repository is based on work created from the following sources: