TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / next / ci / ci-yadp-builder / 84d418ea7480919823a5eb6d47119fe304a01d1d
commit84d418ea7480919823a5eb6d47119fe304a01d1d[log] [tgz]
authorArthur She <arthur.she@linaro.org>Tue Dec 19 22:14:27 2023 -0800
committerArthur She <arthur.she@linaro.org>Tue Dec 19 22:15:16 2023 -0800
tree9f9e6647c4072a59c9e3f394d8416295f95426d2
parent2000a03af05ad40b54a7dd13f025de0a81b620b3 [diff]
docker_templates_amd64.yml: Rename image name to ci-amd64-tf-m-ubuntu:jammy-iar

The Jenkins job "CI docker cleanup and image update" will delete the
docker image which can not be pull from the docker hub.
Since the IAR docker image is still in development, not yet to push to
the docker heub. In order not to be deleted, change the tag name to
"ci-amd64-tf-m-ubuntu:jammy-iar" to prevent be deleted by the cleanup
job

Signed-off-by: Arthur She <arthur.she@linaro.org>
Change-Id: I0866a6461bb0504eb7b01a485928cb38c3791352
1 file changed
tree: 9f9e6647c4072a59c9e3f394d8416295f95426d2
  1. templates/
  2. .gitreview
  3. docker_ssh_buildslave.yml
  4. docker_templates_amd64.yml
  5. docker_vol.yml
  6. hosts
  7. README.md
  8. yadp_builder.py
  9. 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.