update README and meta

emmetog · Mar 12, 2017 · b94be5b · b94be5b
1 parent 794ec17
commit b94be5b
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -38,19 +38,34 @@ Role Variables
 --------------
 
 ```yml
-jenkins_version: "2.19.2" # The exact version of jenkins to deploy
+jenkins_version: "2.32.3" # The exact version of jenkins to deploy
 jenkins_url: "http://127.0.0.1" # The url that Jenkins will be accessible on
 jenkins_port: "8080" # The port that Jenkins will listen on
 jenkins_home: /data/jenkins # The directory on the server where the Jenkins configs will live
 
 # If you need to override any java options then do that here.
 jenkins_java_opts: "-Djenkins.install.runSetupWizard=false"
 
+# Configuration files owner and group
+jenkins_config_owner: "ubuntu"
+jenkins_config_group: "ubuntu"
+
 # The locations of the configuration files for jenkins
 jenkins_source_dir_configs: "{{ playbook_dir }}/jenkins-configs"
 jenkins_source_dir_jobs: "{{ jenkins_source_dir_configs }}/jobs"
 
-# The names of the jobs (an xml must exist in jenkins_source_dir_jobs with these names)
+# config.xml template source
+jenkins_source_config_xml: "{{ jenkins_source_dir_configs }}/config.xml"
+
+# Include custom files for jenkins installation
+jenkins_include_custom_files: false
+jenkins_custom_files: {}
+
+# Include secrets directory during installation
+jenkins_include_secrets: false
+jenkins_source_secrets: "{{ jenkins_source_dir_configs }}/secrets/"
+
+# The names of the jobs (config.xml must exist under jenkins_source_dir_jobs/job_name/)
 jenkins_jobs: []
 
 # These plugins will be installed in the jenkins instance
@@ -64,6 +79,9 @@ jenkins_plugins:
   - template-project
   - ec2
 
+# List of sources of custom jenkins plugins to install
+jenkins_custom_plugins: []
+
 # Configs specific to the "docker" method of running jenkins
 jenkins_docker_container_name: jenkins
 ```
@@ -79,10 +97,16 @@ Example Playbook
     jenkins_url: http://jenkins.example.com
     jenkins_port: 80
     jenkins_install_via: "docker"
-    jenkins_jobs: [
-        "my-cool-job",
-        "another-awesome-job"
-      ]
+    jenkins_jobs:
+        - "my-cool-job"
+        - "another-awesome-job"
+    jenkins_include_secrets: true
+    jenkins_include_custom_files: true
+    jenkins_custom_files:
+      - src: "jenkins.plugins.openstack.compute.UserDataConfig.xml"
+        dest: "jenkins.plugins.openstack.compute.UserDataConfig.xml"
+    jenkins_custom_plugins:
+        - "openstack-cloud-plugin/openstack-cloud.jpi"
 
   roles:
     - emmetog.jenkins
@@ -92,24 +116,24 @@ Jenkins Configs
 ---------------
 
 The example above will look for the job configs in 
-`{{ playbook_dir }}/jenkins-configs/jobs/my-cool-job.xml` and 
-`{{ playbook_dir }}/jenkins-configs/jobs/another-awesome-job.xml`. 
-It will also look for `{{ playbook_dir }}/jenkins-configs/config.xml` and 
-`{{ playbook_dir }}/jenkins-configs/credentials.xml`.
-These configs will be templated over to the server to be used 
-as the job configuration.
+`{{ playbook_dir }}/jenkins-configs/jobs/my-cool-job/config.xml` and 
+`{{ playbook_dir }}/jenkins-configs/jobs/another-awesome-job/config.xml`. 
 
-***NOTE***: These directories are customizable, see the `jenkins_source_dir_configs`
-and `jenkins_source_dir_jobs` role variables.
+***NOTE***: These directories are customizable, see the `jenkins_source_dir_configs` and `jenkins_source_dir_jobs` role variables.
 
-All the configs are templated so you can put variables in them,
+The role will also look for `{{ playbook_dir }}/jenkins-configs/config.xml`
+These config.xml will be templated over to the server to be used as the job configuration.
+It will upload the whole secrets directory under `{{ playbook_dir }}/jenkins-configs/secrets` and configure custom files provided under `{{ jenkins_custom_files }}` variable. Note that `{{ jenkins_include_secrets }}` and `{{ jenkins_include_custom_files }}` varibales should be set to true for these to work.
+Additionaly the role can install custom plugins by providing the .jpi or .hpi files as a list under `{{ jenkins_custom_plugins }}` variable.
+
+config.xml and custom files are templated so you can put variables in them,
 for example it would be a good idea to encrypt sensitive variables 
 in ansible vault.
 
 Example Job Configs
 -------------------
 
-Here's an example of what you could put in `{{ playbook_dir }}/jenkins-configs/jobs/my-cool-job.xml`:
+Here's an example of what you could put in `{{ playbook_dir }}/jenkins-configs/jobs/my-cool-job/config.xml`:
 
 ```xml
 <?xml version='1.0' encoding='UTF-8'?>
@@ -233,35 +257,6 @@ Jenkins configuration, for example:
 </hudson>
 ```
 
-In `{{ jenkins_source_dir_configs }}/credentials.xml` you put any 
-credentials that you need, for example:
-```xml
-<?xml version='1.0' encoding='UTF-8'?>
-<com.cloudbees.plugins.credentials.SystemCredentialsProvider plugin="credentials@1.24">
-    <domainCredentialsMap class="hudson.util.CopyOnWriteMap$Hash">
-        <entry>
-            <com.cloudbees.plugins.credentials.domains.Domain>
-                <specifications/>
-            </com.cloudbees.plugins.credentials.domains.Domain>
-            <java.util.concurrent.CopyOnWriteArrayList>
-
-                <com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey plugin="ssh-credentials@1.12">
-                    <scope>GLOBAL</scope>
-                    <id>github-deploy-key-jenkins</id>
-                    <description>github-deploy-key-jenkins</description>
-                    <username>git</username>
-                    <passphrase></passphrase>
-                    <privateKeySource class="com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey$DirectEntryPrivateKeySource">
-                        <privateKey>{{ github_jenkins_deploy_key }}</privateKey>
-                    </privateKeySource>
-                </com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey>
-
-            </java.util.concurrent.CopyOnWriteArrayList>
-        </entry>
-    </domainCredentialsMap>
-</com.cloudbees.plugins.credentials.SystemCredentialsProvider>
-```
-
 Making Changes
 --------------
 

diff --git a/defaults/main.yml b/defaults/main.yml
@@ -1,6 +1,6 @@
 ---
 
-jenkins_version: "2.32.1" # The exact version of jenkins to deploy
+jenkins_version: "2.32.3" # The exact version of jenkins to deploy
 jenkins_url: "http://127.0.0.1" # The url that Jenkins will be accessible on
 jenkins_port: "8080" # The port that Jenkins will listen on
 jenkins_home: /data/jenkins # The directory on the server where the Jenkins configs will live
@@ -16,16 +16,18 @@ jenkins_config_group: "ubuntu"
 jenkins_source_dir_configs: "{{ playbook_dir }}/jenkins-configs"
 jenkins_source_dir_jobs: "{{ jenkins_source_dir_configs }}/jobs"
 
+# config.xml template source
 jenkins_source_config_xml: "{{ jenkins_source_dir_configs }}/config.xml"
 
-jenkins_include_userdata: false
-
-jenkins_userdata: {} # src and dest names
+# Include custom files for jenkins installation
+jenkins_include_custom_files: false
+jenkins_custom_files: {} # src and dest names
 
+# Include secrets directory during installation
 jenkins_include_secrets: false
 jenkins_source_secrets: "{{ jenkins_source_dir_configs }}/secrets/"
 
-# The names of the jobs (an xml must exist in jenkins_source_dir_jobs with these names)
+# The names of the jobs (config.xml must exist under jenkins_source_dir_jobs/job_name/)
 jenkins_jobs: []
 
 # These plugins will be installed in the jenkins instance
@@ -39,6 +41,7 @@ jenkins_plugins:
   - template-project
   - ec2
 
+# List of sources of custom jenkins plugins to install
 jenkins_custom_plugins: []
 
 # Configs specific to the "docker" method of running jenkins

diff --git a/meta/main.yml b/meta/main.yml
@@ -4,7 +4,8 @@ galaxy_info:
   description: Installs and completely configures Jenkins using Ansible
   # If the issue tracker for your role is not on github, uncomment the
   # next line and provide a value
-  # issue_tracker_url: http://example.com/issue/tracker
+  issue_tracker_url: https://github.com/emmetog/ansible-jenkins/issues
+
   # Some suggested licenses:
   # - BSD (default)
   # - MIT
@@ -13,7 +14,8 @@ galaxy_info:
   # - Apache
   # - CC-BY
   license: MIT
-  min_ansible_version: 1.2
+
+  min_ansible_version: 2.1
   #
   # Below are all platforms currently available. Just uncomment
   # the ones that apply to your role. If you don't see your 

diff --git a/tasks/configure-jenkins.yml b/tasks/configure-jenkins.yml
@@ -8,15 +8,15 @@
     owner: "{{ jenkins_config_owner }}"
     group: "{{ jenkins_config_group }}"
 
-- name: Configure userdata
+- name: Configure custom files
   template:
     src: "{{ jenkins_source_dir_configs }}/{{ item.src }}"
     dest: "{{ jenkins_home }}/{{ item.dest }}"
     mode: 0644
     owner: "{{ jenkins_config_owner }}"
     group: "{{ jenkins_config_group }}"
-  when: jenkins_include_userdata
-  with_items: "{{ jenkins_userdata }}"
+  when: jenkins_include_custom_files
+  with_items: "{{ jenkins_custom_files }}"
 
 - name: secrets dir is up to date
   copy: