Class: Proxy::AnsibleDirector::Runners::AnsibleBuilderRunner

Inherits:
Dynflow::Runner::Base
  • Object
show all
Includes:
Dynflow::Runner::ProcessManagerCommand
Defined in:
lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ansible_builder_input, suspended_action: nil) ⇒ AnsibleBuilderRunner

ansible_builder_input { ee_id: ee_id, ee_base_image: ee_base_image, ee_ansible_core_version: ee_ansible_core_version, ee_formatted_content: ee_formatted_content }



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb', line 20

def initialize(ansible_builder_input, suspended_action: nil)
  # ID of the execution environment definition; supplied by Foreman
  @ee_id = ansible_builder_input[:ee_id]
  # TAGGED registry URL of the base image; supplied by Foreman
  @ee_base_image_url = ansible_builder_input[:ee_base_image_url]
  # Tag used at the end of building for this image
  @ee_built_image_tag = ansible_builder_input[:ee_built_image_tag]
  @ee_ansible_core_version = ansible_builder_input[:ee_ansible_core_version]
  @ee_formatted_content = ansible_builder_input[:ee_formatted_content]
  @is_base_image = ansible_builder_input[:is_base_image]

  workdir_base = Proxy::AnsibleDirector::Plugin.settings[:execution_env_build_dir]
  @runner_workdir = Dir.mktmpdir('execution_env', workdir_base)
  super suspended_action: suspended_action
end

Instance Attribute Details

#continuous_outputObject (readonly)

Returns the value of attribute continuous_output.



11
12
13
# File 'lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb', line 11

def continuous_output
  @continuous_output
end

#exit_statusObject (readonly)

Returns the value of attribute exit_status.



11
12
13
# File 'lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb', line 11

def exit_status
  @exit_status
end

Instance Method Details

#closeObject



129
130
131
132
# File 'lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb', line 129

def close
  remove_workdirs = Proxy::AnsibleDirector::Plugin.settings[:remove_workdirs]
  FileUtils.rm_rf @runner_workdir if remove_workdirs
end

#publish_data(message, type = 'debug') ⇒ Object



134
135
136
# File 'lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb', line 134

def publish_data(message, type = 'debug')
    @continuous_output.add_output(message.force_encoding('UTF-8'), type)
end

#refreshObject



123
124
125
126
127
# File 'lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb', line 123

def refresh
  @process_manager.process(timeout: 0.1) unless @process_manager.done?
  puts @continuous_output.raw_outputs
  publish_exit_status(@process_manager.status) if @process_manager.done?
end

#startObject



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/smart_proxy_ansible_director/runners/ansible_builder_runner.rb', line 36

def start
  ee_content = @ee_formatted_content.to_hash
  ee_content.transform_values! do |value|
      value.map do |cuv|
        {
          'name' => cuv['name'],
          'source' => cuv['source'],
          'version' => cuv['version']
        }.compact
      end
  end

  if @is_base_image
    ee_content.merge!(
      { 'collections' => [
        {
          'name' => 'theforeman.foreman',
          'version' => '5.6.0',
          'source' => 'https://galaxy.ansible.com'
        }
      ] }
    )
  end

  ee_definition = {
    'version' => 3,
    'images' => {
      'base_image' => {
        'name' => @ee_base_image_url
      }
    },
    'dependencies' => {
      'python_interpreter' => {
        'package_system' => 'python3'
      },
      'ansible_core' => {
        'package_pip' => "ansible-core==#{@ee_ansible_core_version}"
      },
      'ansible_runner' => {
        'package_pip' => 'ansible-runner'
      },
      'system' => ['openssh-clients'],
      'galaxy' => ee_content
    },
    'additional_build_steps' => (
        unless @is_base_image
          {
            'prepend_base' => [
              'ENV ANSIBLE_CALLBACK_WHITELIST=theforeman.foreman.foreman',
              'ENV ANSIBLE_CALLBACKS_ENABLED=theforeman.foreman.foreman',
              "ENV FOREMAN_URL=#{Proxy::SETTINGS.foreman_url}",
              'ENV FOREMAN_SSL_CERT=/run/secrets/foreman_ssl_cert',
              'ENV FOREMAN_SSL_KEY=/run/secrets/foreman_ssl_key',
              'ENV FOREMAN_SSL_VERIFY=/run/secrets/foreman_ssl_verify'

            ]
          }
        end
      )
  }.compact

  build_args = {
    ANSIBLE_GALAXY_CLI_COLLECTION_OPTS: '-c'
  }

  build_args_str = ''

  build_args.each do |k, v|
    build_args_str += "--build-arg #{k}=\"#{v}\" "
  end

  # COMPAT 3.16 - 2
  # --extra-build-cli-args is not supported in ansible-builder 3.0.0
  # Verbosity is chosen by passing -v {0, 1, 2, 3}

  cmd = <<~CMD
    echo "Running in #{@runner_workdir}"

    cat <<EOF > "#{@runner_workdir}/execution-environment.yml"
    #{YAML.dump(ee_definition, indentation: 2)}
    EOF
    ansible-builder build --tag ansible_director/#{@ee_id}:#{@ee_built_image_tag} -v 3 --file #{@runner_workdir}/execution-environment.yml #{build_args_str} --context #{@runner_workdir}
  CMD

  initialize_command('bash', '-c', cmd)
end