TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / ci / ci-yadp-builder / 2e9439b72f6bd292b14de0603f1f5cff0e92bb49
commit2e9439b72f6bd292b14de0603f1f5cff0e92bb49[log] [tgz]
authorBenjamin Copeland <ben.copeland@linaro.org>Fri Oct 30 19:52:35 2020 +0000
committerBenjamin Copeland <ben.copeland@linaro.org>Mon Nov 02 11:11:03 2020 +0000
treed408be4962b297648260b38c58cad2bc3d0d4202
parentda6b7e7568e1b4b372114a67d4e19f74a11fd9a0 [diff]
Update YADP to include per project style docker images. TF-M and TF-A.
Before this is pushed through we need to update TF-M and TF-A to use the
new image.

Signed-off-by: Benjamin Copeland <ben.copeland@linaro.org>
Change-Id: Ic255aacb4c02ccb95608579d2694bb4337caaee3
1 file changed
tree: d408be4962b297648260b38c58cad2bc3d0d4202
  1. templates/
  2. docker_ssh_buildslave.yml
  3. docker_templates_amd64.yml
  4. hosts
  5. README.md
  6. yadp_builder.py
  7. yadp_builder_v2.py
README.md

Yet Another Docker Plugin config builder

Yet Another Docker Plugin (YADP) is extremely hard to manage, when running multiple slaves with multiple images. Due to the way Jenkins displays the configuration page. YADP provides a groovy script which builds a JSON array to populate the configuration in Jenkins.

This script uses YAML and Jinja2 to generate a java JSONARRAY to build the configuration, using a !include constructor in the YAML file, allowing the ability to template up docker_images, since many of our slaves run the same image, it lessens repetition.

Features

  1. Ability to !include inside YAML to lessen duplication
  2. Ability to include multiple YAML files with !include [file1.yml, file2.yml]
  3. Ability to include SSH settings via using launch_method:" along with ssh: or jnlp:

Usage

####hosts

- host1:
  cloud_name: host1.example.org
  docker-url: tcp://0.0.0.0:2375
  docker_templates: !include external_template_file.yml

- host2:
  cloud_name: host2.example.org
  docker-url: tcp://0.0.0.1:2375
  docker_templates:
    - xenial-amd64:
      docker_image_name: 'ubuntu:latest'
      max_instances: '1'
      labels: 'docker-ubuntu'
      launch_method: ssh
      ssh:
        launch_ssh_credentials_id: 'random-id'
        launch_ssh_port: '22'

- host3
  cloud_name: host3.example.org
  docker-url: tcp://0.0.0.0:2375
  docker_templates:
    !include [external_template_file.yml, external_template_file_2.yml]

Limitations

Due to the nature of YAML and populating the Java JSONARRAY, its important that YAML is phased correctly.

Most of the limitations surround docker_templates.

A list of limitations and pending improvements.

  1. Do not mix !include and templates under docker_templates.

Example of broken approach:

  • host1: cloud_name: host1.example.org docker-url: tcp://0.0.0.0:2375 docker_templates: !include external_template_file.yml
    • xenial-amd64: docker_image_name: 'ubuntu:latest' max_instances: '1' labels: 'docker-ubuntu'
  1. Do not add spaces under the image cloud_name, the must fall inline with the image name

Example of broken approach:

  • xenial-amd64: docker_image_name: 'ubuntu:latest' max_instances: '1' labels: 'docker-ubuntu'
  1. Docker labels could be "host" specific. If you are including a template file, the template has no link to the host, so its not possible to do "host based labels". Instead just create another template file with custom settings and include that file.