Fuel Infrastructure¶

Install Jenkins Job Builder¶

To begin work with jenkins job builder we need to install it and configure.

1. Install packages required to work with JJB

   apt-get install -y git python-tox
   # or
   yum install git python-tox
   

2. Download git repository and install JJB

   git clone https://github.com/fuel-infra/jenkins-jobs.git
   cd jenkins-jobs
   tox
   

3. Enable python environment, please replace <server> with server name, for example fuel-ci

   source .tox/<server>/bin/activate
   

4. Create file jenkins_jobs.ini with JJB configuration. It could be created at any place, for this documentation we assume that it will be placed in conf/ directory, inside local copy of jenkins-jobs repository.

   [jenkins]
   user=<JENKINS USER>
   password=<JENKINS PASSWORD OR API-TOKEN>
   url=https://<JENKINS URL>/
   
   [job_builder]
   ignore_cache=True
   keep_descriptions=False
   recursive=True
   include_path=.:scripts
   

Note

<JENKINS_USER> is the user already defined in Jenkins with an appropriate permissions set:

• Read - under the Global group of permissions
• Create, Delete, Configure and Read - under the Job group of permissions

Upload jobs to Jenkins¶

When JJB is installed and configured you can upload jobs to jenkins master.

Upload all jobs configured for one specified server, for example upload of fule-ci can be done in this way:

jenkins-jobs --conf conf/jenkins_jobs.ini update servers/fuel-ci:common

Upload only one job

jenkins-jobs --conf conf/jenkins_jobs.ini update servers/fuel-ci:common 8.0-community.all

Requirements¶

For minimal environment we need 3 systems:

• Jenkins master

• Jenkins slave with enabled slave function for ISO building and deployment testing. This can be done in different ways. For instance, you can create hiera role for such server with the values provided below. Please keep in mind that you have to explicitely set run_test and build_fuel_iso variables to true, as ones are not enabled by default.

  ---
  classes:
    - '::fuel_project::jenkins::slave'
  
  fuel_project::jenkins::slave::run_test: true
  fuel_project::jenkins::slave::build_fuel_iso: true
  

  Note

  Every slave which will be used for ISO deployment testing, like BVT, requires additional preparation.

  Once puppet is applied, and slave is configured in Jenkins master, you need to run the prepare_env job on it. Job will setup the python virtual environment with fuel-devops installed (DevOps Guide).

  If you build ISO newer than 6.1 there is no need to change default job parameters. For older versions you need to run build with update_devops_2_5_x option checked.

• Seed server - it is the server where you plan to store built ISO

Create Jenkins jobs¶

To build your own ISO you need to create job configurations for it, it requires a few steps:

1. Create your own jobs repository, for start we will use fuel-ci jobs

   cd jenkins-jobs/servers
   cp -pr fuel-ci test-ci
   

2. To build and test ISO we will use files:

   • servers/test-ci/8.0/community.all.yaml
   • servers/test-ci/8.0/fuel_community_publish_iso.yaml
   • servers/test-ci/8.0/fuel_community.centos.bvt_2.yaml
   • servers/test-ci/8.0/fuel_community.ubuntu.bvt_2.yaml

3. In all files you need to make changes:

   • Change email alert@example.com to your own
   • If you don’t need reporting jobs you should delete triggering of fuel_community_build_reports in all jobs or disable reporting job

   - job:
      ...
      publishers:
         ...
         - trigger-parameterized-builds:
           ...
           - project: fuel_community_build_reports
   

   • Update seed name server in file servers/test-ci/8.0/fuel_community_publish_iso.yaml

   - job:
      ...
      publishers:
         ...
         - trigger-parameterized-builds:
           ...
           - project:  8.0.fuel_community.centos.bvt_2, 8.0.fuel_community.ubuntu.bvt_2
              ...
              predefined-parameters: |
                 ISO_TORRENT=http://seed.fuel-infra.org/fuelweb-iso/fuel-community-$ISO_ID.iso.torrent
   

   • Update seed name server in file servers/test-ci/8.0/builders/publish_fuel_community_iso.sh

   sed -i 's/seed-us1.fuel-infra.org/seed.test.local/g' servers/test-ci/8.0/builders/publish_fuel_community_iso.sh
   sed -i 's/seed-cz1.fuel-infra.org/seed.test.local/g' servers/test-ci/8.0/builders/publish_fuel_community_iso.sh
   

4. Create jobs on jenkins master

   Note

   Please remember to:

   • change current directory to the root directory of cloned jenkins-jobs repository
   • enable python environment
   • use correct jenkins_jobs.ini file (with correct jenkins master server)

   jenkins-jobs --conf conf/jenkins_jobs.ini update servers/test-ci:common 8.0-community.all
   jenkins-jobs --conf conf/jenkins_jobs.ini update servers/test-ci:common 8.0.publish_fuel_community_iso
   jenkins-jobs --conf conf/jenkins_jobs.ini update servers/test-ci:common 8.0.fuel_community.centos.bvt_2
   jenkins-jobs --conf conf/jenkins_jobs.ini update servers/test-ci:common 8.0.fuel_community.ubuntu.bvt_2
   

Start ISO building¶

When you finish setting jobs up on jenkins master you will see project with name 8.0-community.all there, to start ISO build and test procedure you need to run mentioned project.

Build and test procedure have 3 steps:

• ISO building (8.0-community.all)
• when ISO is successfully created it will be uploaded to the seed server (by triggering 8.0.publish_fuel_community_iso)
• successful upload will start BVT test (8.0.fuel_community.centos.bvt_2 and 8.0.fuel_community.ubuntu.bvt_2)

Contributing¶

Feedback¶