kitchen-ansible 0.48.7 → 0.48.8

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,267 +1,267 @@
1
- # Ansible Install Options
2
-
3
- Kitchen-ansible is very flexible in how it installs ansible:
4
-
5
- It installs it in the following order:
6
-
7
- * if require_ansible_omnibus is set to true
8
-
9
- Installs using the omnibus_ansible script specified in the ansible_omnibus_url parameter and passes the ansible_version if specied as -v option.
10
-
11
- * If require_ansible_source is set to true
12
-
13
- Install require packages and download the ansible source from github from master or from a branch specified in the parameter install_source_rev.
14
-
15
- * if require_pip is set to true
16
-
17
- Install require packages and then installs ansible using the python pip command and ansible version must be specified. This allows a specific version of ansible to be installed.
18
-
19
- * if require_ansible_repo is set to true (the default)
20
-
21
- Installs from the operation system repository only with the ansible version that is in the particular repository and will use the ansible_version in the package name where appropriate.
22
-
23
- NOTE: Set to ansible_package_name to 'ansible' when installing from the CentOS/Redhat extras repo, instead of the EPEL.
24
-
25
- # Provisioner Options
26
-
27
- kitchen-ansible runs the ansible playbook command http://linux.die.net/man/1/ansible-playbook with options from parameters in the kitchen.yml file:
28
-
29
- key | default value | Notes
30
- ----|---------------|--------
31
- additional_copy_path | | Arbitrary array of files and directories to copy into test environment e.g. vars or included playbooks. See below section Copying Additional Files
32
- additional_copy_role_path | | Arbitrary array of files and directories to copy into test environment and are appended to the ANSIBLE_ROLES_PATH env var when running ansible. See below section Copying Additional Files
33
- additional_ssh_private_keys | | List of additional ssh private key files to be added to ~/.ssh
34
- ansible_apt_repo | ppa:ansible/ansible | `apt` repo; see `https://launchpad.net` `/~ansible/+archive/ubuntu/ansible` or `rquillo/ansible`
35
- ansible_binary_path | NULL | If specified this will override the location where `kitchen` tries to run `ansible-playbook` from, i.e. `ansible_binary_path: /usr/local/bin`
36
- ansible_check | false | Sets the `--check` flag when running Ansible
37
- ansible_connection | local | use `ssh` if the host is not `localhost` (Linux) or `winrm` (Windows) or `none` if defined in inventory
38
- ansible_cfg_path | ansible.cfg | location of custom ansible.cfg to get copied into test environment
39
- ansible_diff | false | Sets the `--diff` flag when running Ansible
40
- ansible_extra_flags | | Additional options to pass to ansible-playbook, e.g. `'--skip-tags=redis'`
41
- ansible_host_key_checking | true | Strict host key checking in ssh
42
- ansible_inventory | | Static or dynamic inventory file or directory or 'none' if defined in `ansible.cfg`
43
- ansible_limit | | Further limits the selected host/group patterns
44
- ansible_omnibus_remote_path | /opt/ansible | Server installation location of an Omnibus Ansible install
45
- ansible_omnibus_url | `https://raw.githubusercontent.com` `/neillturner/omnibus-ansible` `/master/ansible_install.sh` | Omnibus Ansible install location
46
- ansible_package_name | | Set to ansible when installing from the CentOS/Redhat extras repo, instead of the EPEL.
47
- ansible_platform | Naively tries to determine | OS platform of server
48
- ansible_playbook_command | | Override the Ansible playbook command
49
- ansible_sles_repo | `http://download.opensuse.org/repositories` `/systemsmanagement/SLE_12` `/systemsmanagement.repo` | Zypper SuSE Ansible repo
50
- ansible_source_url | `git://github.com/ansible/ansible.git` | Git URL of Ansible source
51
- ansible_source_rev | | Branch or tag to install Ansible source
52
- ansible_sudo | true | Determines whether `ansible-playbook` is executed as root or as the current authenticated user
53
- ansible_vault_password_file | | Path to Ansible Vault password file. Can also be an array of files.
54
- ansible_verbose | false | Extra information logging
55
- ansible_verbosity | 1 | Sets the verbosity flag appropriately, e.g.: `1 => '-v', 2 => '-vv', 3 => '-vvv' ...`. Valid values are: `1, 2, 3, 4` or `:info, :warn, :debug, :trace`
56
- ansible_version | latest | Desired version, only affects `apt-get` installs
57
- ansible_yum_repo | nil | `yum` repo for EL platforms
58
- ansiblefile_path | | Path to Ansiblefile
59
- callback_plugins_path | callback_plugins | Ansible repo `callback_plugins` directory
60
- chef_bootstrap_url | `https://www.chef.io/chef/install.sh` | The Chef install
61
- custom_pre_install_command | nil | Custom shell command to be used at beginning of install stage. Can be multiline.
62
- custom_pre_play_command | nil | Custom shell command to be used before the ansible play stage. Can be multiline. See examples below.
63
- custom_post_install_command | nil | Custom shell command to be used at after the install stage. Can be multiline.
64
- custom_post_play_command | nil | Custom shell command to be used after the ansible play stage. Can be multiline. See examples below.
65
- enable_yum_epel | false | Enable the `yum` EPEL repo
66
- env_vars | Hash.new | Hash to set environment variable to use with `ansible-playbook` command
67
- extra_vars | Hash.new | Hash to set the `extra_vars` passed to `ansible-playbook` command
68
- extra_vars_file | nil | file containing environment variables e.g. `private_vars/production.yml site.yml` Don't prefix with a @ sign.
69
- filter_plugins_path | filter_plugins | Ansible repo `filter_plugins` directory
70
- galaxy_ignore_certs | false | Ignore certificate errors when installing roles with ansible-galaxy.
71
- group_vars_path | group_vars | Ansible repo group_vars directory
72
- host_vars_path | host_vars | Ansible repo hosts directory
73
- hosts | | Create Ansible hosts file for localhost with this server group or list of groups
74
- http_proxy | nil | Use HTTP proxy when installing Ansible, packages and running Ansible
75
- https_proxy | nil | Use HTTPS proxy when installing Ansible, packages and running Ansible
76
- idempotency_test | false | Enable to test Ansible playbook idempotency
77
- idempotency_tags | [] | Adds a `--tags` parameter with the specified tags to the second invocation of `ansible-playbook` when `idempotency_test` is set to `true`
78
- idempotency_skip_tags | [] | Adds a `--skip-tags` parameter with the specified tags to the second invocation of `ansible-playbook` when `idempotency_test` is set to `true`
79
- ignore_extensions_from_root | ['.pyc'] | allow extensions to be ignored when copying from roles using additional_copy_role_path or doing recursive_additional_copy_path
80
- ignore_paths_from_root | [] | allow extra paths to be ignored when copying from roles using additional_copy_role_path or using recursive_additional_copy_path
81
- kerberos_conf_file | | Path of krb5.conf file using in Windows support
82
- library_plugins_path | library | Ansible repo library plugins directory
83
- lookup_plugins_path | lookup_plugins | Ansible repo `lookup_plugins` directory
84
- max_retries | 1 | maximum number of retry attempts of converge command
85
- modules_path | | Ansible repo manifests directory
86
- no_proxy | nil | List of URLs or IPs that should be excluded from proxying
87
- playbook | default.yml | Playbook for `ansible-playbook` to run
88
- private_key | | ssh private key file for ssh connection
89
- python_sles_repo | `http://download.opensuse.org/repositories` `/devel:/languages:/python/SLE_12` `/devel:languages:python.repo` | Zypper SuSE python repo
90
- recursive_additional_copy_path | | Arbitrary array of files and directories to copy into test environment. See below section Copying Additional Files
91
- require_ansible_omnibus | false | Set to `true` if using Omnibus Ansible `pip` install
92
- require_ansible_repo | true | Set if installing Ansible from a `yum` or `apt` repo
93
- require_ansible_source | false | Install Ansible from source using method described [here](http://docs.ansible.com/intro_installation.html#running-from-source). Only works on Debian/Ubuntu at present
94
- require_chef_for_busser | true | Install Chef to run Busser for tests. NOTE: kitchen 1.4 only requires Ruby to run Busser so this is not required.
95
- require_pip | false | Set to `true` if Ansible is to be installed through `pip`).
96
- require_ruby_for_busser | false | Install Ruby to run Busser for tests
97
- require_windows_support | false | Install [Windows support](http://docs.ansible.com/ansible/intro_windows.html)
98
- requirements_path | | Path to Ansible Galaxy requirements
99
- retry_on_exit_code | [] | Array of exit codes to retry converge command against
100
- role_name | | use when the repo name does not match the name the role is published as.
101
- roles_path | roles | Ansible repo roles directory
102
- shell_command | 'sh' | Shell command to use, usually an alias for bash. may need to set to bash.
103
- show_command_output | false | Show output of commands that are run to provision system.
104
- ssh_known_hosts | | List of hosts that should be added to ~/.ssh/known_hosts
105
- sudo_command | sudo -E | `sudo` command; change to `sudo -E -H` to be consistent with Ansible
106
- update_package_repos | true | Update OS repository metadata
107
- wait_for_retry | 30 | number of seconds to wait before retrying converge command
108
- ignore_ansible_cfg | false | If true, values from ansible.cfg file will not be loaded.
109
-
110
- ## Ansible Inventory
111
-
112
- Ansible has the concept of an [inventory](http://docs.ansible.com/ansible/latest/intro_inventory.html).
113
-
114
- Ansible then connects to these servers and processes the playbook against the server.
115
-
116
- See also [Host inventories](https://ansible-tips-and-tricks.readthedocs.io/en/latest/ansible/inventory/).
117
-
118
-
119
- ### ansible Inventory parameter
120
-
121
- if you have an ansible inventory file you can specify it in the ansible_inventory parameter in the .kitchen.yml file.
122
- ```yaml
123
- ansible_inventory: myinventoryfile.txt
124
- ```
125
- or if you have an ansible.cfg file specify
126
- ```yaml
127
- ansible_inventory: none
128
- ```
129
- it will look for the file in the root of your repository.
130
-
131
- or it can be a directory from the root of your repository and contain scripts to implement [dynamic inventory](http://docs.ansible.com/ansible/latest/intro_dynamic_inventory.html)
132
-
133
- ### hosts parameter
134
-
135
- if you don't specify an inventory file then you must specify the hosts parameter in the .kitchen.yml file.
136
-
137
- kitchen ansible uses this information to create a hosts file that is used by ansible with the ansible command is run.
138
-
139
- it can either be a name of a single server
140
-
141
- ```yaml
142
- hosts: myhost
143
- ```
144
-
145
- or any array of hosts:
146
-
147
- ```yaml
148
- hosts:
149
- - myhost1
150
- - myhost2
151
- ```
152
-
153
- the hosts file that is generated always contains in the first line
154
-
155
- ```yaml
156
- localhost ansible_connection=local
157
- ```
158
- so that it will process against the locahost.
159
-
160
- and it will create a hosts file that includes the hosts you specify
161
-
162
- ```yaml
163
- localhost ansible_connection=local
164
- myhost1
165
- myhost2
166
- localhost
167
- ```
168
-
169
-
170
- ## Copying Additional Files
171
-
172
- Several parameters have been developed rather organically to support the requirement to copy additional files beyond the ones in the standard ansible locations.
173
- * These could be used for the verification phase later
174
- * additional files required by the application
175
- * or these could be ansible roles
176
-
177
- ### additional_copy_path - Arbitrary array of files and directories to copy into test environment
178
- * If you specify a directory it will copy all the files to /tmp/kitchen with the directory structure
179
- * if you specify the full file name they are copied to the top of the /tmp/kitchen folder in the server and the path is ignored.
180
- i.e. if we have a directory data/ containing file xyz.txt
181
- ```
182
- additional_copy_path:
183
- - data/xyz.txt
184
- ```
185
- it will copy data/xyz.txt to /tmp/kitchen/xyz.txt
186
- * if you specify the directory without the filename it will preserve the path when copying to /tmp/kitchen.
187
- ```
188
- additional_copy_path:
189
- - data
190
- ```
191
- it will copy data/xyz.txt to /tmp/kitchen/data/xyz.txt
192
- NOTE: additional_copy_path does copy files that are links but if you specify the full file path only the file name is copied to /tmp/kitchen
193
-
194
- ### recursive_additional_copy_path
195
- This copies the directories in a resursive fashion which can work better for some directory structures
196
- * It does not support specifying files with paths. i.e. you can only specify files at the top level of the repository
197
- ```
198
- recursive_additional_copy_path:
199
- - xyz.txt
200
- ```
201
- * It does support copying directories in a similar fashion to additional_copy_path but uses recursion to discover the files in the directory structure which can be
202
- problematic with files with links.
203
- ```
204
- recursive_additional_copy_path:
205
- - data
206
- ```
207
- ### additional_copy_role_path
208
- This is the same as additional_copy_path but adds the extra paths to the ANSIBLE_ROLES_PATH ansible command parameter.
209
-
210
- ### ignore_paths_from_root and ignore_extensions_from_root
211
- During recursive_additional_copy_path or additional_copy_role_path there are 2 additional parameters.
212
- (NOTE: These don't apply with additional_copy_path)
213
- * ignore_paths_from_root defaults to empty array []. This causes these paths to be ignored.
214
- * ignore_extensions_from_root defaults to an array containg ['.pyc']. This causes files with these extensions to be ignored.
215
- as these are implemented with the 'Find.prune' command they can be problematic with file links.
216
-
217
-
218
- ## Configuring Provisioner Options
219
-
220
- The provisioner can be configured globally or per suite, global settings act as defaults for all suites, you can then customise per suite, for example:
221
-
222
- ```yaml
223
- ---
224
- driver:
225
- name: vagrant
226
-
227
- provisioner:
228
- name: ansible_playbook
229
- roles_path: roles
230
- hosts: tomcat-servers
231
- require_ansible_repo: true
232
- ansible_verbose: true
233
- ansible_verbosity: 2
234
- ansible_diff: true
235
-
236
- platforms:
237
- - name: nocm_ubuntu-12.04
238
- driver_plugin: vagrant
239
- driver_config:
240
- box: nocm_ubuntu-12.04
241
- box_url: http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210-nocm.box
242
-
243
- suites:
244
- - name: default
245
- ```
246
-
247
- ### Per-suite Structure
248
-
249
- It can be beneficial to keep different Ansible layouts for different suites. Rather than having to specify the roles, modules, etc for each suite, you can create the following directory structure and they will automatically be found:
250
-
251
- ```
252
- $kitchen_root/ansible/$suite_name/roles
253
- $kitchen_root/ansible/$suite_name/modules
254
- $kitchen_root/ansible/$suite_name/Ansiblefile
255
- ```
256
-
257
- Multiple Line Structure
258
- ```yaml
259
- provisioner::
260
- command: |
261
- sudo -s <<SERVERSPEC
262
- cd /opt/gdc/serverspec-core
263
- export SERVERSPEC_ENV=$EC2DATA_ENVIRONMENT
264
- export SERVERSPEC_BACKEND=exec
265
- serverspec junit=true tag=~skip_in_kitchen check:role:$EC2DATA_TYPE
266
- SERVERSPEC
267
- ```
1
+ # Ansible Install Options
2
+
3
+ Kitchen-ansible is very flexible in how it installs ansible:
4
+
5
+ It installs it in the following order:
6
+
7
+ * if require_ansible_omnibus is set to true
8
+
9
+ Installs using the omnibus_ansible script specified in the ansible_omnibus_url parameter and passes the ansible_version if specied as -v option.
10
+
11
+ * If require_ansible_source is set to true
12
+
13
+ Install require packages and download the ansible source from github from master or from a branch specified in the parameter install_source_rev.
14
+
15
+ * if require_pip is set to true
16
+
17
+ Install require packages and then installs ansible using the python pip command and ansible version must be specified. This allows a specific version of ansible to be installed.
18
+
19
+ * if require_ansible_repo is set to true (the default)
20
+
21
+ Installs from the operation system repository only with the ansible version that is in the particular repository and will use the ansible_version in the package name where appropriate.
22
+
23
+ NOTE: Set to ansible_package_name to 'ansible' when installing from the CentOS/Redhat extras repo, instead of the EPEL.
24
+
25
+ # Provisioner Options
26
+
27
+ kitchen-ansible runs the ansible playbook command http://linux.die.net/man/1/ansible-playbook with options from parameters in the kitchen.yml file:
28
+
29
+ key | default value | Notes
30
+ ----|---------------|--------
31
+ additional_copy_path | | Arbitrary array of files and directories to copy into test environment e.g. vars or included playbooks. See below section Copying Additional Files
32
+ additional_copy_role_path | | Arbitrary array of files and directories to copy into test environment and are appended to the ANSIBLE_ROLES_PATH env var when running ansible. See below section Copying Additional Files
33
+ additional_ssh_private_keys | | List of additional ssh private key files to be added to ~/.ssh
34
+ ansible_apt_repo | ppa:ansible/ansible | `apt` repo; see `https://launchpad.net` `/~ansible/+archive/ubuntu/ansible` or `rquillo/ansible`
35
+ ansible_binary_path | NULL | If specified this will override the location where `kitchen` tries to run `ansible-playbook` from, i.e. `ansible_binary_path: /usr/local/bin`
36
+ ansible_check | false | Sets the `--check` flag when running Ansible
37
+ ansible_connection | local | use `ssh` if the host is not `localhost` (Linux) or `winrm` (Windows) or `none` if defined in inventory
38
+ ansible_cfg_path | ansible.cfg | location of custom ansible.cfg to get copied into test environment
39
+ ansible_diff | false | Sets the `--diff` flag when running Ansible
40
+ ansible_extra_flags | | Additional options to pass to ansible-playbook, e.g. `'--skip-tags=redis'`
41
+ ansible_host_key_checking | true | Strict host key checking in ssh
42
+ ansible_inventory | | Static or dynamic inventory file or directory or 'none' if defined in `ansible.cfg`
43
+ ansible_limit | | Further limits the selected host/group patterns
44
+ ansible_omnibus_remote_path | /opt/ansible | Server installation location of an Omnibus Ansible install
45
+ ansible_omnibus_url | `https://raw.githubusercontent.com` `/neillturner/omnibus-ansible` `/master/ansible_install.sh` | Omnibus Ansible install location
46
+ ansible_package_name | | Set to ansible when installing from the CentOS/Redhat extras repo, instead of the EPEL.
47
+ ansible_platform | Naively tries to determine | OS platform of server
48
+ ansible_playbook_command | | Override the Ansible playbook command
49
+ ansible_sles_repo | `http://download.opensuse.org/repositories` `/systemsmanagement/SLE_12` `/systemsmanagement.repo` | Zypper SuSE Ansible repo
50
+ ansible_source_url | `git://github.com/ansible/ansible.git` | Git URL of Ansible source
51
+ ansible_source_rev | | Branch or tag to install Ansible source
52
+ ansible_sudo | true | Determines whether `ansible-playbook` is executed as root or as the current authenticated user
53
+ ansible_vault_password_file | | Path to Ansible Vault password file. Can also be an array of files.
54
+ ansible_verbose | false | Extra information logging
55
+ ansible_verbosity | 1 | Sets the verbosity flag appropriately, e.g.: `1 => '-v', 2 => '-vv', 3 => '-vvv' ...`. Valid values are: `1, 2, 3, 4` or `:info, :warn, :debug, :trace`
56
+ ansible_version | latest | Desired version, only affects `apt-get` installs
57
+ ansible_yum_repo | nil | `yum` repo for EL platforms
58
+ ansiblefile_path | | Path to Ansiblefile
59
+ callback_plugins_path | callback_plugins | Ansible repo `callback_plugins` directory
60
+ chef_bootstrap_url | `https://www.chef.io/chef/install.sh` | The Chef install
61
+ custom_pre_install_command | nil | Custom shell command to be used at beginning of install stage. Can be multiline.
62
+ custom_pre_play_command | nil | Custom shell command to be used before the ansible play stage. Can be multiline. See examples below.
63
+ custom_post_install_command | nil | Custom shell command to be used at after the install stage. Can be multiline.
64
+ custom_post_play_command | nil | Custom shell command to be used after the ansible play stage. Can be multiline. See examples below.
65
+ enable_yum_epel | false | Enable the `yum` EPEL repo
66
+ env_vars | Hash.new | Hash to set environment variable to use with `ansible-playbook` command
67
+ extra_vars | Hash.new | Hash to set the `extra_vars` passed to `ansible-playbook` command
68
+ extra_vars_file | nil | file containing environment variables e.g. `private_vars/production.yml site.yml` Don't prefix with a @ sign.
69
+ filter_plugins_path | filter_plugins | Ansible repo `filter_plugins` directory
70
+ galaxy_ignore_certs | false | Ignore certificate errors when installing roles with ansible-galaxy.
71
+ group_vars_path | group_vars | Ansible repo group_vars directory
72
+ host_vars_path | host_vars | Ansible repo hosts directory
73
+ hosts | | Create Ansible hosts file for localhost with this server group or list of groups
74
+ http_proxy | nil | Use HTTP proxy when installing Ansible, packages and running Ansible
75
+ https_proxy | nil | Use HTTPS proxy when installing Ansible, packages and running Ansible
76
+ idempotency_test | false | Enable to test Ansible playbook idempotency
77
+ idempotency_tags | [] | Adds a `--tags` parameter with the specified tags to the second invocation of `ansible-playbook` when `idempotency_test` is set to `true`
78
+ idempotency_skip_tags | [] | Adds a `--skip-tags` parameter with the specified tags to the second invocation of `ansible-playbook` when `idempotency_test` is set to `true`
79
+ ignore_extensions_from_root | ['.pyc'] | allow extensions to be ignored when copying from roles using additional_copy_role_path or doing recursive_additional_copy_path
80
+ ignore_paths_from_root | [] | allow extra paths to be ignored when copying from roles using additional_copy_role_path or using recursive_additional_copy_path
81
+ kerberos_conf_file | | Path of krb5.conf file using in Windows support
82
+ library_plugins_path | library | Ansible repo library plugins directory
83
+ lookup_plugins_path | lookup_plugins | Ansible repo `lookup_plugins` directory
84
+ max_retries | 1 | maximum number of retry attempts of converge command
85
+ modules_path | | Ansible repo manifests directory
86
+ no_proxy | nil | List of URLs or IPs that should be excluded from proxying
87
+ playbook | default.yml | Playbook for `ansible-playbook` to run
88
+ private_key | | ssh private key file for ssh connection
89
+ python_sles_repo | `http://download.opensuse.org/repositories` `/devel:/languages:/python/SLE_12` `/devel:languages:python.repo` | Zypper SuSE python repo
90
+ recursive_additional_copy_path | | Arbitrary array of files and directories to copy into test environment. See below section Copying Additional Files
91
+ require_ansible_omnibus | false | Set to `true` if using Omnibus Ansible `pip` install
92
+ require_ansible_repo | true | Set if installing Ansible from a `yum` or `apt` repo
93
+ require_ansible_source | false | Install Ansible from source using method described [here](http://docs.ansible.com/intro_installation.html#running-from-source). Only works on Debian/Ubuntu at present
94
+ require_chef_for_busser | true | Install Chef to run Busser for tests. NOTE: kitchen 1.4 only requires Ruby to run Busser so this is not required.
95
+ require_pip | false | Set to `true` if Ansible is to be installed through `pip`).
96
+ require_ruby_for_busser | false | Install Ruby to run Busser for tests
97
+ require_windows_support | false | Install [Windows support](http://docs.ansible.com/ansible/intro_windows.html)
98
+ requirements_path | | Path to Ansible Galaxy requirements
99
+ retry_on_exit_code | [] | Array of exit codes to retry converge command against
100
+ role_name | | use when the repo name does not match the name the role is published as.
101
+ roles_path | roles | Ansible repo roles directory
102
+ shell_command | 'sh' | Shell command to use, usually an alias for bash. may need to set to bash.
103
+ show_command_output | false | Show output of commands that are run to provision system.
104
+ ssh_known_hosts | | List of hosts that should be added to ~/.ssh/known_hosts
105
+ sudo_command | sudo -E | `sudo` command; change to `sudo -E -H` to be consistent with Ansible
106
+ update_package_repos | true | Update OS repository metadata
107
+ wait_for_retry | 30 | number of seconds to wait before retrying converge command
108
+ ignore_ansible_cfg | false | If true, values from ansible.cfg file will not be loaded.
109
+
110
+ ## Ansible Inventory
111
+
112
+ Ansible has the concept of an [inventory](http://docs.ansible.com/ansible/latest/intro_inventory.html).
113
+
114
+ Ansible then connects to these servers and processes the playbook against the server.
115
+
116
+ See also [Host inventories](https://ansible-tips-and-tricks.readthedocs.io/en/latest/ansible/inventory/).
117
+
118
+
119
+ ### ansible Inventory parameter
120
+
121
+ if you have an ansible inventory file you can specify it in the ansible_inventory parameter in the .kitchen.yml file.
122
+ ```yaml
123
+ ansible_inventory: myinventoryfile.txt
124
+ ```
125
+ or if you have an ansible.cfg file specify
126
+ ```yaml
127
+ ansible_inventory: none
128
+ ```
129
+ it will look for the file in the root of your repository.
130
+
131
+ or it can be a directory from the root of your repository and contain scripts to implement [dynamic inventory](http://docs.ansible.com/ansible/latest/intro_dynamic_inventory.html)
132
+
133
+ ### hosts parameter
134
+
135
+ if you don't specify an inventory file then you must specify the hosts parameter in the .kitchen.yml file.
136
+
137
+ kitchen ansible uses this information to create a hosts file that is used by ansible with the ansible command is run.
138
+
139
+ it can either be a name of a single server
140
+
141
+ ```yaml
142
+ hosts: myhost
143
+ ```
144
+
145
+ or any array of hosts:
146
+
147
+ ```yaml
148
+ hosts:
149
+ - myhost1
150
+ - myhost2
151
+ ```
152
+
153
+ the hosts file that is generated always contains in the first line
154
+
155
+ ```yaml
156
+ localhost ansible_connection=local
157
+ ```
158
+ so that it will process against the locahost.
159
+
160
+ and it will create a hosts file that includes the hosts you specify
161
+
162
+ ```yaml
163
+ localhost ansible_connection=local
164
+ myhost1
165
+ myhost2
166
+ localhost
167
+ ```
168
+
169
+
170
+ ## Copying Additional Files
171
+
172
+ Several parameters have been developed rather organically to support the requirement to copy additional files beyond the ones in the standard ansible locations.
173
+ * These could be used for the verification phase later
174
+ * additional files required by the application
175
+ * or these could be ansible roles
176
+
177
+ ### additional_copy_path - Arbitrary array of files and directories to copy into test environment
178
+ * If you specify a directory it will copy all the files to /tmp/kitchen with the directory structure
179
+ * if you specify the full file name they are copied to the top of the /tmp/kitchen folder in the server and the path is ignored.
180
+ i.e. if we have a directory data/ containing file xyz.txt
181
+ ```
182
+ additional_copy_path:
183
+ - data/xyz.txt
184
+ ```
185
+ it will copy data/xyz.txt to /tmp/kitchen/xyz.txt
186
+ * if you specify the directory without the filename it will preserve the path when copying to /tmp/kitchen.
187
+ ```
188
+ additional_copy_path:
189
+ - data
190
+ ```
191
+ it will copy data/xyz.txt to /tmp/kitchen/data/xyz.txt
192
+ NOTE: additional_copy_path does copy files that are links but if you specify the full file path only the file name is copied to /tmp/kitchen
193
+
194
+ ### recursive_additional_copy_path
195
+ This copies the directories in a resursive fashion which can work better for some directory structures
196
+ * It does not support specifying files with paths. i.e. you can only specify files at the top level of the repository
197
+ ```
198
+ recursive_additional_copy_path:
199
+ - xyz.txt
200
+ ```
201
+ * It does support copying directories in a similar fashion to additional_copy_path but uses recursion to discover the files in the directory structure which can be
202
+ problematic with files with links.
203
+ ```
204
+ recursive_additional_copy_path:
205
+ - data
206
+ ```
207
+ ### additional_copy_role_path
208
+ This is the same as additional_copy_path but adds the extra paths to the ANSIBLE_ROLES_PATH ansible command parameter.
209
+
210
+ ### ignore_paths_from_root and ignore_extensions_from_root
211
+ During recursive_additional_copy_path or additional_copy_role_path there are 2 additional parameters.
212
+ (NOTE: These don't apply with additional_copy_path)
213
+ * ignore_paths_from_root defaults to empty array []. This causes these paths to be ignored.
214
+ * ignore_extensions_from_root defaults to an array containg ['.pyc']. This causes files with these extensions to be ignored.
215
+ as these are implemented with the 'Find.prune' command they can be problematic with file links.
216
+
217
+
218
+ ## Configuring Provisioner Options
219
+
220
+ The provisioner can be configured globally or per suite, global settings act as defaults for all suites, you can then customise per suite, for example:
221
+
222
+ ```yaml
223
+ ---
224
+ driver:
225
+ name: vagrant
226
+
227
+ provisioner:
228
+ name: ansible_playbook
229
+ roles_path: roles
230
+ hosts: tomcat-servers
231
+ require_ansible_repo: true
232
+ ansible_verbose: true
233
+ ansible_verbosity: 2
234
+ ansible_diff: true
235
+
236
+ platforms:
237
+ - name: nocm_ubuntu-12.04
238
+ driver_plugin: vagrant
239
+ driver_config:
240
+ box: nocm_ubuntu-12.04
241
+ box_url: http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210-nocm.box
242
+
243
+ suites:
244
+ - name: default
245
+ ```
246
+
247
+ ### Per-suite Structure
248
+
249
+ It can be beneficial to keep different Ansible layouts for different suites. Rather than having to specify the roles, modules, etc for each suite, you can create the following directory structure and they will automatically be found:
250
+
251
+ ```
252
+ $kitchen_root/ansible/$suite_name/roles
253
+ $kitchen_root/ansible/$suite_name/modules
254
+ $kitchen_root/ansible/$suite_name/Ansiblefile
255
+ ```
256
+
257
+ Multiple Line Structure
258
+ ```yaml
259
+ provisioner::
260
+ command: |
261
+ sudo -s <<SERVERSPEC
262
+ cd /opt/gdc/serverspec-core
263
+ export SERVERSPEC_ENV=$EC2DATA_ENVIRONMENT
264
+ export SERVERSPEC_BACKEND=exec
265
+ serverspec junit=true tag=~skip_in_kitchen check:role:$EC2DATA_TYPE
266
+ SERVERSPEC
267
+ ```