Install and configure Jenkins and some plugins.
This role requires Ansible 2.2 or higher, and platform requirements are listed in the metadata file.
This role use Molecule to run tests.
Local and Travis tests run tests on Docker by default. See molecule documentation to use other backend.
Currently, tests are done on:
- Ubuntu Xenial
and use:
- Ansible 2.2.x
- Ansible 2.3.x
- Ansible 2.4.x
$ tox
Follow the possible variables with their default values
# Ubuntu repository vars
jenkins_repository_key_url: 'https://jenkins-ci.org/debian/jenkins-ci.org.key'
jenkins_repository_content: 'deb http://pkg.jenkins-ci.org/debian binary/'
jenkins_package_state: 'latest'
jenkins_system_dependencies: []
jenkins_system_dependencies_state: 'present'
# Configuration file settings
jenkins_default_cfg_file_owner: 'root'
jenkins_default_cfg_file_group: 'root'
jenkins_default_cfg_file_mode: '0640'
# Configuration file content variables
jenkins_etc_name: 'jenkins'
jenkins_etc_user: 'jenkins'
jenkins_etc_group: 'jenkins'
jenkins_etc_run_standalone: True
jenkins_etc_max_open_files: 8192
jenkins_etc_umask: '022'
jenkins_etc_listen_address: '127.0.0.1'
jenkins_etc_http_port: '8080'
jenkins_etc_ajp_port: -1
jenkins_etc_servlet_context_prefix: "/{{ jenkins_etc_name }}"
# Location and files configuration
jenkins_etc_java_location: '/usr/bin/java'
jenkins_etc_war_location: >
/usr/share/{{ jenkins_etc_name }}/{{ jenkins_etc_name }}.war
jenkins_etc_home_location: "/var/lib/{{ jenkins_etc_name }}"
jenkins_etc_log_location: >
/var/log/{{ jenkins_etc_name }}/{{ jenkins_etc_name }}.log
jenkins_etc_pid_file: >
/var/run/{{ jenkins_etc_name }}/{{ jenkins_etc_name }}.pid
# Java and jenkins arguments
jenkins_etc_java_args:
- '-Dhudson.diyChunking=false'
- '-Djava.awt.headless=true'
- -Dhudson.model.DirectoryBrowserSupport.CSP=\"sandbox; default-src 'none'; img-src 'self'; style-src 'self';\"
jenkins_etc_args:
- "--webroot=/var/cache/{{ jenkins_etc_name }}/war"
- "--httpListenAddress={{ jenkins_etc_listen_address }}"
- "--httpPort={{ jenkins_etc_http_port }}"
- "--ajp13Port={{ jenkins_etc_ajp_port }}"
# Jenkins cli
jenkins_base_url: "http://localhost:{{ jenkins_etc_http_port }}"
jenkins_cli_download_url: "{{ jenkins_base_url }}/jnlpJars/jenkins-cli.jar"
jenkins_cli: "{{ jenkins_etc_home_location }}/jenkins-cli.jar"
# Jenkins update center variables
jenkins_update_center_url_download: >
https://updates.jenkins-ci.org/update-center.json
jenkins_update_center_url_post: >
{{ jenkins_base_url }}/updateCenter/byId/default/postBack
jenkins_update_file: "{{ jenkins_etc_home_location }}/updates_jenkins.json"
# Jenkins waiting availability test
jenkins_waiting_available_retries: 10
jenkins_waiting_available_delay: 5
# Jenkins plugin management
jenkins_manage_plugin_install: True
jenkins_manage_plugin_upgrade: False
# Jenkins clouds
jenkins_main_cfg_clouds: []
# CONFIGURATION
#--------------
jenkins_configuration_files_owner: "{{ jenkins_etc_user }}"
jenkins_configuration_files_group: "{{ jenkins_etc_group }}"
jenkins_configuration_files_mode: '0644'
# Main configuration
jenkins_config_disable_remember_me: False
jenkins_config_label: ''
jenkins_config_mode: 'NORMAL'
jenkins_config_num_executors: 2
jenkins_config_project_naming_strategy:
pattern: '\w+'
description: 'Alphanumeric pattern'
force: True
jenkins_config_quiet_period: 5
jenkins_config_scm_checkout_retry_count: 0
jenkins_config_slave_agent_port: 0
# Jenkins users configuration
jenkins_manage_users_and_security: True
jenkins_deployment_user:
username: 'ansible'
full_name: 'Ansible deployment user'
email: '[email protected]'
password: 'ansible'
ssh:
private: ''
public: ''
jenkins_users:
- username: 'admin'
full_name: 'Jenkins administrator user'
email: '[email protected]'
password: 'admin'
roles:
- 'jenkins-administer'
public_keys: []
# Jenkins realm management
jenkins_security_realm:
class: 'HudsonPrivateSecurityRealm'
# Jenkins authorization strategy management
jenkins_authorization_strategy:
class: 'GlobalMatrixAuthorizationStrategy'
# Jenkins crumb issuer, set to disable because not work with CLI
jenkins_crumb:
issuer: ''
exclude_client_ip: False
# Jenkins location settings
jenkins_location_administrator_email: 'root@localhost'
jenkins_location_administrator_full_name: 'Jenkins administrator'
jenkins_location_url: 'http://jenkins.foo.bar/'
# Credentials configuration
#==========================
jenkins_credentials_domains_to_empty: []
jenkins_credentials: []
# Plugins configuration
#======================
# Plugins management
jenkins_plugins: []
jenkins_plugins_state: 'latest'
# Plugins: git
jenkins_plugin_git_manage_configuration: True
jenkins_plugin_git_global_full_name: 'Jenkins GitUser'
jenkins_plugin_git_global_email: '[email protected]'
jenkins_plugin_git_create_account_based_on_email: False
# Plugins: mailer
jenkins_plugin_mailer_manage_configuration: True
jenkins_plugin_mailer:
charset: 'UTF-8'
default_suffix: ''
reply_to: ''
smtp_host: ''
smtp_password: ''
smtp_port: 25
smtp_user: ''
use_ssl: False
# Plugins: github
jenkins_plugin_github_manage_configuration: True
jenkins_plugin_github_remove_servers: True
jenkins_plugin_github_servers: []
# Plugins: debian package builder
jenkins_plugin_debian_package_builder_manage_configuration: True
jenkins_plugin_debian_package_builder_remove_repositories: True
jenkins_plugin_debian_package_builder_gpg:
name: 'Foo Bar'
email: '[email protected]'
public_key: 'foo_public_key'
private_key: 'foo_private_key'
passphrase: 'foo_passphrase'
jenkins_plugin_debian_package_builder_repo: []
# Plugins: gitlab
jenkins_plugin_gitlab_manage_configuration: True
jenkins_plugin_gitlab: []
# Plugins: hipchat
jenkins_plugin_hipchat_manage_configuration: True
jenkins_plugin_hipchat:
server: 'api.hipchat.com'
v2_enabled: True
room: 'Continuous Integration'
send_as: 'Jenkins'
jenkins_plugin_hipchat_notifications: []
# Plugins: docker
jenkins_plugin_docker_manage_configuration: True
jenkins_plugin_docker_clouds: []
# Plugins: workflow global libs
jenkins_plugin_workflow_libs_manage_configuration: True
jenkins_plugin_workflow_libs: []
jenkins_repository_file_prefix: '/etc/apt/sources.list.d'
jenkins_repository_file: 'pkg_jenkins_ci_org_debian.list'
jenkins_default_cfg_prefix: '/etc/default'
jenkins_default_cfg_file: 'jenkins'
jenkins_package_name: 'jenkins'
jenkins_service_name: 'jenkins'
jenkins_system_dependencies:
- 'python-httplib2'
Update "jenkins_etc_java_args" variable values, to set new CSP setting on this line:
-Dhudson.model.DirectoryBrowserSupport.CSP=
Default settings create an administrator account, follows the structure to manage your Jenkins users
Example:
jenkins_users:
- username: 'admin'
full_name: 'Jenkins administrator user'
email: '[email protected]'
password: 'admin'
roles:
- 'jenkins-administer'
public_keys: []
- username: 'user'
full_name: 'Jenkins read only user'
email: '[email protected]'
password: 'user'
roles:
- 'jenkins-read'
public_keys: []
We manage three credentials types:
- SSH with passphrase
- User/Password
- String
This is an example of YAML structure to create these credentials for Jenkins.
jenkins_credentials:
- credentials_type: 'ssh_with_passphrase'
credentials_domain: 'global'
scope: 'global'
id: 'ssh-jenkins-master-user'
username: 'jenkins'
private_key_source_type: 'user'
private_key_source_data: 'foo'
private_key_passphrase: 'bar'
description: 'Jenkins user on local server'
state: 'present'
- credentials_type: 'password'
credentials_domain: 'global'
scope: 'global'
id: 'simple-jenkins-user'
username: 'jenkins'
password: 'jenkins'
description: 'Jenkins testing password credentials'
state: 'present'
- credentials_type: 'text'
credentials_domain: 'global'
scope: 'global'
id: 'simple-text-credentials'
text: 'loving_jenkins'
description: 'Jenkins testing text credentials'
state: 'present'
- credentials_type: 'gitlab_api_token'
credentials_domain: 'global'
scope: 'global'
id: 'simple-gitlab-api-token-credentials'
text: 'loving_jenkins'
description: 'Jenkins testing Gitlab API credentials'
state: 'present'
You can remove all credentials linked to a domain. Just set the domain list to "jenkins_credentials_domains_to_empty".
Example:
jenkins_credentials_domains_to_empty:
- 'global'
You can manage the plugin configuration with these settings, example with repositories for publisher step:
jenkins_plugins_debian_package_builder_gpg:
name: 'Foo Bar'
email: '[email protected]'
public_key: 'foo_public_key'
private_key: 'foo_private_key'
passphrase: 'foo_passphrase'
jenkins_plugins_debian_package_builder_repo:
- name: 'repo_1'
method: 'scpb'
fqdn: 'foo.bar.fr'
incoming: '/foo'
login: 'foo'
key_path: '/bar/foo.key'
options: 'foo_options'
state: 'present'
- name: 'repo_2'
method: 'scpb'
fqdn: 'foobar.bar.fr'
incoming: '/foobar'
login: 'foobar'
key_path: '/bar/foobar.key'
options: 'foobar_options'
state: 'absent'
You can remove all repositories before plugin configuration. Just set True to "jenkins_plugins_debian_package_builder_remove_repositories" variable.
You can manage Github plugin serveurs with this structure:
jenkins_plugins_github_servers:
- manage_hooks: False
credentials_id: 'simple-text-credentials'
custom_url: ''
client_cache_size: 20
You can remove all servers before plugin configuration. Just set True to "jenkins_plugins_github_remove_servers" variable.
You can manage GitLab plugin connections with this structure:
jenkins_plugin_gitlab:
- name: 'foo'
api_token: 'gitlab-api'
host_url: 'http://localhost:443/gitlab'
ignore_cert_error: True
connection_timeout: 10
read_timeout: 10
You can manage Hipchat plugin notifications with this structure:
jenkins_plugins_hipchat_notifications:
- notify_enable: True
text_format: True
notification_type: STARTED
color: YELLOW
message_template: null
You can manage Docker plugin clouds with this structure:
jenkins_plugins_docker_clouds:
- name: 'docker-cloud-test'
server_url: 'http://127.0.0.1:8081'
container_cap: 10
connect_timeout: 10
read_timeout: 10
credentials_id: 'simple-jenkins-user'
docker_hostname: 'Foo'
version: null
state: 'present'
templates:
- config_version: 2
label_string: ''
remote_fs_mapping: '/tmp'
remote_fs: '/home/jenkins'
instance_cap: 20
mode: 'NORMAL'
num_executors: 1
remove_volumes: False
pull_strategy: 'PULL_LATEST'
connector:
class: 'ssh'
ssh_key_strategy_name: 'manually_configured_ssh_key'
ssh_key_strategy_value: 'simple-jenkins-user'
jvm_options: []
java_path: ''
launch_timeout: 0
max_num_retries: 0
port: 22
prefix_start_slave_cmd: ''
suffix_start_slave_cmd: ''
retry_wait_time: 0
template_base:
image: 'evarga/jenkins-slave'
pull_credentials_id: ''
network: ''
docker_command: ''
lxc_conf_string: ''
hostname: ''
dns_hosts: []
volumes: []
volumes_from: []
environments: []
bind_ports: []
bind_all_ports: False
privileged: False
tty: False
extra_hosts: []
mac_address: ''
memory_limit: null
memory_swap: 0
cpu_shares: null
retention_strategy:
class: 'once'
idle_minutes: 10
None
- hosts: servers
roles:
- { role: infOpen.jenkins }MIT
Alexandre Chaussier (for Infopen company)
- http://www.infopen.pro
- a.chaussier [at] infopen.pro