diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 16 insertions, 4 deletions
@@ -3,13 +3,21 @@ 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](https://github.com/KostyaSha/yet-another-docker-plugin/blob/master/docs/script-console-scripts/configure-yadocker-cloud.groovy) 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. +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.yml -List your jenkin_slaves here + ``` - host1: cloud_name: host1.example.org @@ -17,13 +25,17 @@ List your jenkin_slaves here docker_templates: !include external_template_file.yml - host2: - cloud_name: 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 @@ -35,7 +47,7 @@ List your jenkin_slaves here Limitations ======= -Due to the nature of YAML and populating the Java JSONARRAY, its important that yaml is phased correctly. +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. |