Ansible: code cleanup and documentation update

Clean Up (code logic is kept unmodified):
* Remove repetition around `ansible.limit` option (merge conflict issue)
* Re-add missing comments from GH-1697 (merge conflict issue)
* Reorder instructions

Documentation for following changes:
* [GH-1697] add more options
* [GH-1979] extra verbosity option
This commit is contained in:
Gilles Cornu 2013-09-07 14:32:36 +02:00
parent 6512eb5cbb
commit 8a925e3461
2 changed files with 17 additions and 25 deletions

View File

@ -4,15 +4,13 @@ module VagrantPlugins
def provision def provision
ssh = @machine.ssh_info ssh = @machine.ssh_info
inventory_file_path = self.setup_inventory_file # Connect with Vagrant user (unless --user or --private-key are overidden by 'raw_arguments')
options = %W[--private-key=#{ssh[:private_key_path]} --user=#{ssh[:username]}] options = %W[--private-key=#{ssh[:private_key_path]} --user=#{ssh[:username]}]
# Joker! Not (yet) supported arguments can be passed this way. # Joker! Not (yet) supported arguments can be passed this way.
options << "#{config.raw_arguments}" if config.raw_arguments options << "#{config.raw_arguments}" if config.raw_arguments
options << "--inventory-file=#{inventory_file_path}" # Append Provisioner options (higher precedence):
options << "--ask-sudo-pass" if config.ask_sudo_pass
if config.extra_vars if config.extra_vars
extra_vars = config.extra_vars.map do |k,v| extra_vars = config.extra_vars.map do |k,v|
v = v.gsub('"', '\\"') v = v.gsub('"', '\\"')
@ -23,25 +21,13 @@ module VagrantPlugins
"#{k}=#{v}" "#{k}=#{v}"
end end
options << "--extra-vars=\"#{extra_vars.join(" ")}\"" options << "--extra-vars=\"#{extra_vars.join(" ")}\""
end end
options << "--inventory-file=#{self.setup_inventory_file}"
if config.limit
if not config.limit.kind_of?(Array)
config.limit = [config.limit]
end
config.limit = config.limit.join(",")
options << "--limit=#{config.limit}"
end
options << "--sudo" if config.sudo options << "--sudo" if config.sudo
options << "--sudo-user=#{config.sudo_user}" if config.sudo_user options << "--sudo-user=#{config.sudo_user}" if config.sudo_user
if config.verbose options << (config.verbose.to_s == "extra" ? "-vvv" : "--verbose") if config.verbose
options << (config.verbose.to_s == "extra" ? "-vvv" : "--verbose") options << "--ask-sudo-pass" if config.ask_sudo_pass
end
# Append Provisioner options (higher precedence):
options << "--tags=#{as_list_argument(config.tags)}" if config.tags options << "--tags=#{as_list_argument(config.tags)}" if config.tags
options << "--skip-tags=#{as_list_argument(config.skip_tags)}" if config.skip_tags options << "--skip-tags=#{as_list_argument(config.skip_tags)}" if config.skip_tags
options << "--limit=#{as_list_argument(config.limit)}" if config.limit options << "--limit=#{as_list_argument(config.limit)}" if config.limit
@ -70,6 +56,10 @@ module VagrantPlugins
end end
end end
protected
# Auto-generate "safe" inventory file based on Vagrantfile,
# unless inventory_path is explicitly provided
def setup_inventory_file def setup_inventory_file
return config.inventory_path if config.inventory_path return config.inventory_path if config.inventory_path
@ -86,8 +76,6 @@ module VagrantPlugins
return generated_inventory_file.to_s return generated_inventory_file.to_s
end end
protected
def as_list_argument(v) def as_list_argument(v)
v.kind_of?(Array) ? v.join(',') : v v.kind_of?(Array) ? v.join(',') : v
end end

View File

@ -121,7 +121,11 @@ These variables take the highest precedence over any other variables.
* `ansible.sudo_user` can be set to a string containing a username on the guest who should be used * `ansible.sudo_user` can be set to a string containing a username on the guest who should be used
by the sudo command. by the sudo command.
* `ansible.ask_sudo_pass` can be set to `true` to require Ansible to prompt for a sudo password. * `ansible.ask_sudo_pass` can be set to `true` to require Ansible to prompt for a sudo password.
* `ansible.limit` can be set to a string or an array of machines or groups from the inventory file * `ansible.limit` can be set to a string or an array of machines or groups from the inventory file to further narrow down which hosts are affected.
to further narrow down which hosts are affected. * `ansible.verbose` can be set to `:extra` or `'extra'` to increase Ansible's verbosity to obtain full detailed logging (`-vvv`). Otherwise default verbosity level (`--verbose`) is applied.
* `ansible.verbose` can be set to `true` to increase Ansible's verbosity to obtain more detailed logging * `ansible.tags` can be set to a string or an array of tags. Only plays, roles and tasks tagged with these values will be executed.
during playbook execution. * `ansible.skip_tags` can be set to a string or an array of tags. Only plays, roles and tasks that *do not match* these values will be executed.
* `ansible.start_at_task` can be set to a string corresponding to the task name where the playbook provision will start.
* `ansible.raw_arguments` is an *unsafe wildcard* string that can be used to take advantage of `ansible-playbook` arguments that are not (yet) supported by this Vagrant provisioner plugin. This can be very useful when integrating with bleeding edge Ansible versions. Following precedence rules apply:
* Any supported options (described above) will override conflicting `raw_arguments` value (e.g. `--tags` or `--start-at-task`)
* Vagrant default user authentication can be overridden via `raw_arguments` (with custom values for `--user` and `--private-key`)