Add awx as an embedded ansible plugin #16205

carbonin · 2017-10-13T22:21:21Z

This fixes #15975

This PR builds on #16168 by adding a new EmbeddedAnsible plugin which handles running AWX.

AWX is the upstream of Ansible Tower and is distributed in a collection of containers rather than rpms.

The DockerEmbeddedAnsible class manages these containers using the docker-api gem.

When the role is enabled on an upstream appliance or on a development machine, we will pull the latest images, and run the containers using the same credential management system as we would in the appliance case.

The class also handles setting up the container environment required. This is mostly a ruby version of the playbook role that the AWX project uses to install the containers without all the image build and PG bits.

gtanzillo

Very nice! 👍

gtanzillo · 2017-11-03T16:05:56Z

lib/embedded_ansible/docker_embedded_ansible.rb

+    require 'docker'
+    Docker.validate_version!
+  rescue RuntimeError
+    false


Maybe we should log something here in case the error is not what we are expecting?

I wanted to avoid logging here because this could get called whenever we do EmbeddedAnsible.new which could be quite a lot in production.

I will look into if we can rescue a more specific error though.

miq-bot · 2017-11-06T22:52:38Z

This pull request is not mergeable. Please rebase and repush.

carbonin · 2017-11-17T20:52:07Z

lib/embedded_ansible/docker_embedded_ansible.rb

+  end
+
+  def awx_task_image_name
+    "ansible/awx_task:latest"


Looking for suggestions around how to make this configurable.

Should I go for creating a new key in Settings?

👍 for Settings

bdunne · 2017-11-20T15:12:33Z

lib/embedded_ansible.rb

@@ -43,9 +43,45 @@ def api_connection_raw(host, port)
    )
  end

+  def find_or_create_secret_key
+    miq_database.ansible_secret_key || miq_database.ansible_secret_key = SecureRandom.hex(16)


Will this be saved?

Yup https://github.com/ManageIQ/manageiq/blob/master/app/models/mixins/ansible_authentications.rb#L25

Can I persuade you to miq_database.ansible_secret_key ||= SecureRandom.hex(16)?

bdunne · 2017-11-20T15:24:34Z

lib/embedded_ansible.rb

+  end
+
+  def database_configuration
+    @db_config ||= Rails.configuration.database_configuration[Rails.env]


Prefer ActiveRecord::Base.configurations. See #15269 for more info

bdunne · 2017-11-20T15:26:06Z

lib/embedded_ansible/docker_embedded_ansible.rb

+  def start
+    run_rabbitmq_container
+    run_memcached_container
+    sleep(15)


Is there something better that we could do? I assume we're waiting for rabbitmq and memcached to start, right?

Do the other containers have any of their own checks for these services?

I actually yanked this directly from the playbook in ansible/awx

Because these are not "services" it seems harder to check their status.
Maybe we can pull the ncat checks into ManageIQ/manageiq in some way and reuse those here and in the pod in a follow up?

bdunne · 2017-11-20T15:30:45Z

spec/lib/embedded_ansible_spec.rb

+        expect(connection).to receive(:select_value).with("CREATE DATABASE awx OWNER \"awx\" ENCODING 'utf8'")
+
+        auth = subject.send(:find_or_create_database_authentication)
+        expect(auth.userid).to eq("awx")


You can use have_attributes to reduce the number of expectations.

Fryguy · 2017-11-27T16:30:30Z

app/models/embedded_ansible_worker/runner.rb

    end
-
-    URI::HTTPS.build(:host => host, :path => path).to_s


Minor, but you can also code this up such that each path in the conditional creates a hash, with :scheme as one of the keys, then you can DRY up the URI, build, to_s bits down here into a single line.

Fryguy · 2017-11-27T16:31:28Z

lib/embedded_ansible.rb

+    auth
+  end
+
+  def generate_password


I can't tell if they aren't already, but these should probably be private methods from here down.

Yup, they're private starting at line 34

Fryguy · 2017-11-27T16:32:24Z

Looks good! Sorry about the delayed review.

carbonin · 2017-11-29T16:39:34Z

Leaving this as WIP until ManageIQ/manageiq-appliance-build#250 is merged which adds docker to the appliance.

carbonin · 2017-12-04T19:34:02Z

Requires ManageIQ/manageiq-appliance#160

bdunne · 2017-12-06T21:14:41Z

lib/embedded_ansible.rb

+  end
+
+  def find_or_create_admin_authentication
+    miq_database.ansible_admin_authentication || miq_database.set_ansible_admin_authentication(:password => generate_password)


Can these also be moved to miq_database.ansible_admin_authentication= then collapsed to ||= like 52bab34#r155362349 ?

This will make it easier to move this method into a shared location

This allows the "fetch from the database or generate and save" behavior to be shared across different embedded ansible platforms

This will run the containers which make up AWX (https://github.com/ansible/awx) and configure our app to use that for the embedded ansible feature. This class uses the docker-api gem to communicate with the locally running docker daemon to pull and launch the containers. We use port 54321 as the host port so that this can be used seamlessly in place of ApplianceEmbeddedAnsible when ansible tower is not installed locally

When we have "localhost" in our database configuration, we have to change that to the local machine's IP on the docker NIC

This also adds stubs for all of the subclass availability in each of the specs to avoid sporadic test failures depending on the order the subclasses are evaluated for availability.

This sorts the subclasses and instantiates the first available one

This error will be raised when the containers are just started. Every API end point during the initial migration will return an html page rather than a json payload. This accounts for that specific situation by assuming if we don't get a valid json response the service is not ready to serve requests

This really just assumes that a dev environment isn't multi-appliance and isn't fronted by our httpd configuration. This means that we always go to localhost, use http over https and hardcode the port and path.

miq-bot · 2017-12-06T22:38:25Z

Checked commits carbonin/manageiq@a754fa8~...b015723 with ruby 2.3.3, rubocop 0.47.1, haml-lint 0.20.0, and yamllint 1.10.0
10 files checked, 1 offense detected

app/models/embedded_ansible_worker/runner.rb

❗ - Line 76, Col 78 - Style/NumericLiterals - Separate every 3 digits in the integer portion of a number with underscores(_).

bdunne · 2017-12-06T22:45:03Z

lib/embedded_ansible/docker_embedded_ansible.rb

+    end
+  end
+
+  private_constant :DockerDaemon


bdunne · 2017-12-06T22:48:59Z

lib/embedded_ansible/docker_embedded_ansible.rb

+
+  def docker_bridge_gateway
+    br = Docker::Network.get("bridge")
+    br.info["IPAM"]["Config"].first["Gateway"]


fetch_path FTW

…ackend Add awx as an embedded ansible plugin (cherry picked from commit 5d27b97)

simaishi · 2017-12-11T17:15:23Z

Gaprindashvili backport details:

$ git log -1
commit 1c5c1589982d848788a55aad0105dfd9b73fb5e3
Author: Brandon Dunne <[email protected]>
Date:   Wed Dec 6 17:52:22 2017 -0500

    Merge pull request #16205 from carbonin/add_awx_as_embedded_ansible_backend
    
    Add awx as an embedded ansible plugin
    (cherry picked from commit 5d27b9731bd9bb10bdf72a7058cd2d8ec128ce15)

carbonin added core fine/no wip labels Oct 13, 2017

carbonin assigned gtanzillo Oct 13, 2017

carbonin requested review from Fryguy and bdunne October 13, 2017 22:21

miq-bot added the dependencies label Oct 13, 2017

carbonin mentioned this pull request Oct 17, 2017

Increase filesystem sizes ManageIQ/manageiq-appliance-build#232

Merged

carbonin force-pushed the add_awx_as_embedded_ansible_backend branch from ec9dab6 to e45b418 Compare October 18, 2017 15:49

gtanzillo approved these changes Nov 3, 2017

View reviewed changes

miq-bot added the unmergeable label Nov 6, 2017

carbonin force-pushed the add_awx_as_embedded_ansible_backend branch from e45b418 to 285ceda Compare November 7, 2017 14:52

miq-bot removed the unmergeable label Nov 7, 2017

carbonin commented Nov 17, 2017

View reviewed changes

carbonin force-pushed the add_awx_as_embedded_ansible_backend branch from 285ceda to f04352a Compare November 17, 2017 21:41

bdunne requested changes Nov 20, 2017

View reviewed changes

Fryguy reviewed Nov 27, 2017

View reviewed changes

carbonin force-pushed the add_awx_as_embedded_ansible_backend branch 2 times, most recently from e42f543 to 13891f9 Compare November 28, 2017 21:35

carbonin removed the wip label Nov 29, 2017

carbonin changed the title ~~[WIP] Add awx as an embedded ansible plugin~~ Add awx as an embedded ansible plugin Nov 29, 2017

carbonin added gaprindashvili/yes wip labels Nov 29, 2017

carbonin changed the title ~~Add awx as an embedded ansible plugin~~ [WIP] Add awx as an embedded ansible plugin Nov 29, 2017

carbonin mentioned this pull request Nov 29, 2017

Add the docker package to run awx locally on the appliance ManageIQ/manageiq-appliance-build#250

Merged

bdunne reviewed Dec 6, 2017

View reviewed changes

carbonin added 2 commits December 6, 2017 17:20

Don't use python to generate the ansible secret key

a754fa8

Refactor generating the ansible secret key into a method

fbc3d3d

This will make it easier to move this method into a shared location

carbonin force-pushed the add_awx_as_embedded_ansible_backend branch from 74396f2 to 574a6c4 Compare December 6, 2017 22:28

carbonin added 10 commits December 6, 2017 17:32

Refactor password generation methods into shared find_or_create methods

28b87db

This allows the "fetch from the database or generate and save" behavior to be shared across different embedded ansible platforms

Add the docker-api gem

3d740c4

Extract the database configuration into a method on EmbeddedAnsible

e194cca

Don't try to use "localhost" for the database host

6b22cb9

When we have "localhost" in our database configuration, we have to change that to the local machine's IP on the docker NIC

Add some specs for DockerEmbeddedAnsible

481bf42

This also adds stubs for all of the subclass availability in each of the specs to avoid sporadic test failures depending on the order the subclasses are evaluated for availability.

Add priority to the EmbeddedAnsible subclasses

e72b52e

This sorts the subclasses and instantiates the first available one

Start the docker daemon when we start DockerEmbeddedAnsible

1ed4128

Add hack to get EmbeddedAnsible provider working on dev machines

b015723

This really just assumes that a dev environment isn't multi-appliance and isn't fronted by our httpd configuration. This means that we always go to localhost, use http over https and hardcode the port and path.

carbonin force-pushed the add_awx_as_embedded_ansible_backend branch from 574a6c4 to b015723 Compare December 6, 2017 22:33

bdunne reviewed Dec 6, 2017

View reviewed changes

bdunne approved these changes Dec 6, 2017

View reviewed changes

bdunne merged commit 5d27b97 into ManageIQ:master Dec 6, 2017

bdunne added this to the Sprint 75 Ending Dec 11, 2017 milestone Dec 6, 2017

bdunne assigned bdunne and unassigned gtanzillo Dec 6, 2017

carbonin deleted the add_awx_as_embedded_ansible_backend branch December 6, 2017 23:26

simaishi pushed a commit that referenced this pull request Dec 11, 2017

Merge pull request #16205 from carbonin/add_awx_as_embedded_ansible_b…

1c5c158

…ackend Add awx as an embedded ansible plugin (cherry picked from commit 5d27b97)

simaishi added gaprindashvili/backported and removed gaprindashvili/yes labels Dec 11, 2017

carbonin mentioned this pull request Dec 15, 2017

Embedded Ansible cannot be activated in MiQ #15670

Closed

psachin mentioned this pull request Feb 16, 2018

EmbeddedAnsibleWorker existing with "No such image: rabbitmq:3" #17014

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add awx as an embedded ansible plugin #16205

Add awx as an embedded ansible plugin #16205

carbonin commented Oct 13, 2017

gtanzillo left a comment

gtanzillo Nov 3, 2017

carbonin Nov 17, 2017

miq-bot commented Nov 6, 2017

carbonin Nov 17, 2017

bdunne Nov 20, 2017

bdunne Nov 20, 2017

carbonin Nov 21, 2017

bdunne Dec 6, 2017

bdunne Nov 20, 2017

bdunne Nov 20, 2017

bdunne Nov 20, 2017

carbonin Nov 21, 2017

bdunne Nov 20, 2017

Fryguy Nov 27, 2017

Fryguy Nov 27, 2017

carbonin Nov 28, 2017

Fryguy commented Nov 27, 2017

carbonin commented Nov 29, 2017

carbonin commented Dec 4, 2017

bdunne Dec 6, 2017

miq-bot commented Dec 6, 2017

bdunne Dec 6, 2017 •

edited

Loading

bdunne Dec 6, 2017

simaishi commented Dec 11, 2017

Add awx as an embedded ansible plugin #16205

Add awx as an embedded ansible plugin #16205

Conversation

carbonin commented Oct 13, 2017

gtanzillo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miq-bot commented Nov 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fryguy commented Nov 27, 2017

carbonin commented Nov 29, 2017

carbonin commented Dec 4, 2017

Choose a reason for hiding this comment

miq-bot commented Dec 6, 2017

bdunne Dec 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

simaishi commented Dec 11, 2017

bdunne Dec 6, 2017 •

edited

Loading