commit	fa52201e05f081c272cbf23c631612c5ceb6c2bd	[log] [tgz]
author	Benjamin Copeland <ben.copeland@linaro.org>	Tue Mar 07 13:38:01 2023 +0000
committer	Benjamin Copeland <ben.copeland@linaro.org>	Tue Mar 07 13:38:36 2023 +0000
tree	2057b4f95272d0d18bc4b63745733b2440ce9612
parent	b29b8d908015db94527babfa59d66e38de669518 [diff]

tree: 2057b4f95272d0d18bc4b63745733b2440ce9612

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

Ability to !include inside YAML to lessen duplication
Ability to include multiple YAML files with !include [file1.yml, file2.yml]
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.

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'

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'

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.