module VagrantPlugins module Ansible class Provisioner < Vagrant.plugin("2", :provisioner) def initialize(machine, config) super @logger = Log4r::Logger.new("vagrant::provisioners::ansible") end def provision @ssh_info = @machine.ssh_info # # 1) Default Settings (lowest precedence) # # Connect with Vagrant SSH identity options = %W[--private-key=#{@ssh_info[:private_key_path][0]} --user=#{@ssh_info[:username]}] # Multiple SSH keys and/or SSH forwarding can be passed via # ANSIBLE_SSH_ARGS environment variable, which requires 'ssh' mode. # Note that multiple keys and ssh-forwarding settings are not supported # by deprecated 'paramiko' mode. options << "--connection=ssh" unless ansible_ssh_args.empty? # By default we limit by the current machine. # This can be overridden by the limit config option. options << "--limit=#{@machine.name}" unless config.limit # # 2) Configuration Joker # options.concat(self.as_array(config.raw_arguments)) if config.raw_arguments # # 3) Append Provisioner options (highest precedence): # options << "--inventory-file=#{self.setup_inventory_file}" options << "--extra-vars=#{self.get_extra_vars_argument}" if config.extra_vars options << "--sudo" if config.sudo options << "--sudo-user=#{config.sudo_user}" if config.sudo_user options << "#{self.get_verbosity_argument}" if config.verbose options << "--ask-sudo-pass" if config.ask_sudo_pass options << "--ask-vault-pass" if config.ask_vault_pass options << "--vault-password-file=#{config.vault_password_file}" if config.vault_password_file options << "--tags=#{as_list_argument(config.tags)}" if config.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 << "--start-at-task=#{config.start_at_task}" if config.start_at_task # Assemble the full ansible-playbook command command = (%w(ansible-playbook) << options << config.playbook).flatten # Some Ansible options must be passed as environment variables env = { "ANSIBLE_FORCE_COLOR" => "true", "ANSIBLE_HOST_KEY_CHECKING" => "#{config.host_key_checking}", # Ensure Ansible output isn't buffered so that we receive ouput # on a task-by-task basis. "PYTHONUNBUFFERED" => 1 } # Support Multiple SSH keys and SSH forwarding: env["ANSIBLE_SSH_ARGS"] = ansible_ssh_args unless ansible_ssh_args.empty? show_ansible_playbook_command(env, command) if config.verbose # Write stdout and stderr data, since it's the regular Ansible output command << { env: env, notify: [:stdout, :stderr], workdir: @machine.env.root_path.to_s } begin result = Vagrant::Util::Subprocess.execute(*command) do |type, data| if type == :stdout || type == :stderr @machine.env.ui.info(data, new_line: false, prefix: false) end end raise Vagrant::Errors::AnsibleFailed if result.exit_code != 0 rescue Vagrant::Util::Subprocess::LaunchError raise Vagrant::Errors::AnsiblePlaybookAppNotFound end end protected # Auto-generate "safe" inventory file based on Vagrantfile, # unless inventory_path is explicitly provided def setup_inventory_file return config.inventory_path if config.inventory_path # Managed machines inventory_machines = {} generated_inventory_dir = @machine.env.local_data_path.join(File.join(%w(provisioners ansible inventory))) FileUtils.mkdir_p(generated_inventory_dir) unless File.directory?(generated_inventory_dir) generated_inventory_file = generated_inventory_dir.join('vagrant_ansible_inventory') generated_inventory_file.open('w') do |file| file.write("# Generated by Vagrant\n\n") @machine.env.active_machines.each do |am| begin m = @machine.env.machine(*am) if !m.ssh_info.nil? file.write("#{m.name} ansible_ssh_host=#{m.ssh_info[:host]} ansible_ssh_port=#{m.ssh_info[:port]}\n") inventory_machines[m.name] = m else @logger.error("Auto-generated inventory: Impossible to get SSH information for machine '#{m.name} (#{m.provider_name})'. This machine should be recreated.") # Let a note about this missing machine file.write("# MISSING: '#{m.name}' machine was probably removed without using Vagrant. This machine should be recreated.\n") end rescue Vagrant::Errors::MachineNotFound => e @logger.info("Auto-generated inventory: Skip machine '#{am[0]} (#{am[1]})', which is not configured for this Vagrant environment.") end end # Write out groups information. # All defined groups will be included, but only supported # machines and defined child groups will be included. # Group variables are intentionally skipped. groups_of_groups = {} defined_groups = [] config.groups.each_pair do |gname, gmembers| # Require that gmembers be an array # (easier to be tolerant and avoid error management of few value) gmembers = [gmembers] if !gmembers.is_a?(Array) if gname.end_with?(":children") groups_of_groups[gname] = gmembers defined_groups << gname.sub(/:children$/, '') elsif !gname.include?(':vars') defined_groups << gname file.write("\n[#{gname}]\n") gmembers.each do |gm| file.write("#{gm}\n") if inventory_machines.include?(gm.to_sym) end end end defined_groups.uniq! groups_of_groups.each_pair do |gname, gmembers| file.write("\n[#{gname}]\n") gmembers.each do |gm| file.write("#{gm}\n") if defined_groups.include?(gm) end end end return generated_inventory_dir.to_s end def get_extra_vars_argument if config.extra_vars.kind_of?(String) and config.extra_vars =~ /^@.+$/ # A JSON or YAML file is referenced (requires Ansible 1.3+) return config.extra_vars else # Expected to be a Hash after config validation. (extra_vars as # JSON requires Ansible 1.2+, while YAML requires Ansible 1.3+) return config.extra_vars.to_json end end def get_verbosity_argument if config.verbose.to_s =~ /^v+$/ # ansible-playbook accepts "silly" arguments like '-vvvvv' as '-vvvv' for now return "-#{config.verbose}" else # safe default, in case input strays return '-v' end end def ansible_ssh_args @ansible_ssh_args ||= get_ansible_ssh_args end def get_ansible_ssh_args ssh_options = [] # Multiple Private Keys @ssh_info[:private_key_path].drop(1).each do |key| ssh_options << "-o IdentityFile=#{key}" end # SSH Forwarding ssh_options << "-o ForwardAgent=yes" if @ssh_info[:forward_agent] # Unchecked SSH Parameters ssh_options.concat(self.as_array(config.raw_ssh_args)) if config.raw_ssh_args # Re-enable ControlPersist Ansible defaults, # which are lost when ANSIBLE_SSH_ARGS is defined. unless ssh_options.empty? ssh_options << "-o ControlMaster=auto" ssh_options << "-o ControlPersist=60s" # Intentionally keep ControlPath undefined to let ansible-playbook # automatically sets this option to Ansible default value end ssh_options.join(' ') end def as_list_argument(v) v.kind_of?(Array) ? v.join(',') : v end def as_array(v) v.kind_of?(Array) ? v : [v] end def show_ansible_playbook_command(env, command) shell_command = '' env.each_pair do |k, v| if k == 'ANSIBLE_SSH_ARGS' shell_command += "#{k}='#{v}' " else shell_command += "#{k}=#{v} " end end shell_arg = [] command.each do |arg| if arg =~ /(--start-at-task|--limit)=(.+)/ shell_arg << "#{$1}='#{$2}'" else shell_arg << arg end end shell_command += shell_arg.join(' ') @machine.env.ui.detail(shell_command) end end end end