Since we're converting plugins repo to collection, we make plugins
usable from collection. For that we change repo structure.
Symlinks to old destinations are created for backwards compatability
Change-Id: I15b4a9f50910794c11b57457f9f4fbb34f321654
Since we're leveraging native SSH connection plugin, we should
provide all supported parameters, otherwise plugin will fail with KeyError
Change-Id: I40d15cabf640d84d455d23286a25887c00aae52c
Since ansible-core we need to define all option defaults since they
will be passed to the original module we execute, otherwise connection
will fail with [1]
[1] https://paste.opendev.org/show/808609/
Change-Id: I68bc5f022ec67ec3bece5f2588b33bb8d2d98ee2
When the play context contains 'become' for ansible privilege
escalation, apply the configured become method (sudo) to the command
used to attach to a container. This allows for non-root users to use the
connection plugin to connect to containers.
Closes-Bug: 1645732
Change-Id: I485bd0aa850f39201654c808f0c61d26113f6390
The imp module is deprecated since version 3.4, so we should
use importlib wich is recommended replacement.
Change-Id: Ic725bf6e99af11bee6a4c4a5c8f409f0675ce8bf
This can fail as follows with ansible 2.8:
fatal: [infra1]: FAILED! => {"msg": "failed to transfer file to
/home/zuul/.ansible/tmp/ansible-local-5893pv8hvtki/tmp5likarkj
/proc/548/root/~zuul/.ansible/tmp/ansible-tmp-1582391749.9168267-281064036689686/AnsiballZ_file.py:
mesg: ttyname failed: Inappropriate ioctl for device\ndd: failed to open
'/proc/548/root/~zuul/.ansible/tmp/ansible-tmp-1582391749.9168267-281064036689686/AnsiballZ_file.py':
No such file or directory\n"}
'~zuul' being in the path cuses the failure
Depends-On: https://review.opendev.org/709320/
Change-Id: Id1de8fb49965caede8c7b95d94a1d3b013aca655
shlex_quote has been part of the connection plugin since the
Ansible 2.3 release. We don't need to do this anymore.
Change-Id: I6be4e5fdce16154ea664ccb5cb26add268b8c9b2
We had our own re-implemented close function from when this was
first introduced which has since then drifted a lot from Ansible.
This drops all that code so that we can use the superclass when
closing the connection.
Change-Id: Id62e510af035988084453883278c3db85c8b7519
We made a change not long ago in order to run chown if the
container user did not match the remote user. This is running
all the time even if we're on metal.
This code optimizes it to avoid that extra call.
Change-Id: Ia97ee15b452f3d9496a0f575b8c482e9d6bf9018
inventory_hostname is not reliable to be used as container_name. When
delegating in 2.6+, the inventory_hostname of the delegating host is
passed to the connection plugin, additionally when a host doesn't have
its own container_name variable a cached inventory_hostname is used in
its place.
To get the connection plugin working with Ansible 2.6 this change
essentially allows the container_check to fall through when delegating
to physical hosts or hosts not in the inventory by:
- removing inventory_hostname as a fallback for container_name
- unsetting container_name when delegating to a known physical host
- unsetting container_name when delegating to a host not mentioned in
the inventory
container_name can no longer be used as a group variable based on
inventory_hostname, it will need to be an inventory/host variable for
each individual host.
Also, when container_user is used the remote_tmp path needs to be set to
a system writable directory instead of the root user's home.
Change-Id: If2eb4c16273e19599f6ec3f0cba6b3573912c6a0
There are quite a few instances where the "exec_command" function fails
due unrelated issues. This change adds a retry with a backoff. The exec
function will now retry 3 times in the event of an exception with a cool
down of 2 seconds. The play context for retries will also be set if
undefined making it possible to recover from transient UNREACHABLE
errors.
Change-Id: Ic7c7af49e1c5eba21216b33814b92e276e3fba3e
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
The connection plugin needs to follow the upstream connection/ssh
plugin's docstring, otherwise this causes failures for undefined options
sftp_executable and scp_executable. This PR adds those docstrings to
mirror upstream.
This follows on from a patch in upstream ansible:
https://github.com/ansible/ansible/pull/36648/files
Change-Id: Ia2a2f2238bb60710c7efe76e2cd9f86493833a2d
For 'physical_host_addrs' to be able to be looked up by the connection
plugin it will need to be included in the 'task_vars' dictionary which
is eventually passed to the task executor. Moreover, we remove the now
obsoleted[1] 'set_host_overrides' function.
If the 'container_name' variable is available, it should take precedence
over 'inventory_hostname' for determining a container's name.
The 'container_user' variable is now set through 'set_options' instead
of a host variable and, when it is available, the connection plugin's
shell is initialized with a system writable temp directory to avoid
requiring additional privileges for the user.
The container check has been updated to also check 'container_name'
against 'ansible_host'. If these match, the container is only known by
an IP address and will require a direct SSH connection.
[1]: 23b1dbacaf
Co-Authored-By: Markos Chandras <mchandras@suse.de>
Change-Id: I16bc76f17ae5d2da4803fd7cdcdcfe72e77f9df1
When using Ansible 2.5, delegation of a task from a container to a host
that is not mentioned in the inventory is currently broken.
The connection plugin works by comparing the host vars 'container_name'
and 'physical_host' to determine if a target host is a container. Both
of these variables are specific to hosts within an OSA generated
inventory. When delegating to a host outside of the inventory however,
the variables will remain cached from the originating host, so a task
wouldn't actually delegate at all.
This is fixed by checking that the 'inventory_hostname' is the same as
the 'container_name'.
Change-Id: I69f2eed35859bdc149e5ed21441eab7c8a8352cf
Instead of always su - container_user -c /bin/sh.....
Now it will only pass su if container_user is set, otherwise the
execution will begin at /bin/sh inside the container.
Change-Id: I50ff0f0788855115c8bae3cb5fe5eabb4e2d74b1
When using SFTP to put files onto the remote node, we place those
files into the container as the remote_user (eg: root), however when
the container_user tries to use said file, it will have the incorrect
permission.
Update put_file function to chmod files after they are copied into the
container.
Change-Id: I09d341923f43c7bc3b18252f7791880eba5469f2
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
This exposes the container_user setting to an operator and allows them
to override it. This is helpful when you want to use 2 different
username for your physical_host user and container user. Today if the
physical_host user is root, the container user will always be root
too.
Change-Id: Ie8e32b0441a5d72fcbc3cbf9769d8a7dc7548f08
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
Clean up some duplicate code that is already setup in the init()
function.
Change-Id: I8e1b448a1eba483f90cbf1c43cb45d18bf0db91b
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
with the consolidation of container attachment methods we've seen issues
where attaching to a container a container can result in the following
error.
> __libc_fork: Assertion `THREAD_GETMEM (self, tid) != ppid'
This error is being caused by a bug in glibc which has been resolved in
2.25+.
* https://sourceware.org/bugzilla/show_bug.cgi?id=15392
To resolve this issue the lxc-attach method has been put back when
interacting with lxc type containers. While this issue has been fixed it
is not something we can rely on being fixed in all supported distros at
this time. To resolve this across the board the old lxc-attach command
has been restored to the connection plugin which has worked around the
libc issues internally.
Change-Id: I97cb3f92ae67b2c5c098c8792a0793972ec0105a
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
The container interactions require a couple interactions to address the
container namespace as well as pad the pathing when transmitting a file.
This change reduces those interactions by nearly half for a single task
by storing information about a target container instead of looking it up
for every interaction.
Example file transfer:
> Before this PR: http://paste.openstack.org/show/691341/
> After this PR: http://paste.openstack.org/show/691338/
In the example we can see the "Before" runnins 20 commands to transfer
a file to a target while the "After" is running only 11.
Example command:
> Before: http://paste.openstack.org/show/691343/
> After: http://paste.openstack.org/show/691344/
In the command example we can see the "Before" is running 10 commands
to run a single command task while the "After" is running only 6.
This change will improve general ansible performance by cutting down the
number of operations needed to be completed to execute any one task.
Change-Id: Ia8405ec5c3b55ed3f7f134c4882d337c5e0b625f
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
The ssh plugin will now use the `nsenter` command to attach to the
container instead of splitting the command functionality between nspawn
and lxc. With the use of `nsenter` we can now selectively use different
namespaces when remotely executing against a container. A new option was
added to the plugin for "container_namespaces" which is a user provided
interface for passing in the namespaces used to attach to the container.
If this option is undefined the default namespaces will be used for full
container isolation.
Change-Id: I904ee68bbc59a0ee4458401a243246bb3f4c3523
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
Previously, the MAGIC_VARIABLE_MAPPING constant was updated to make
additional OSA required hostvars available to the play_context. In 2.5,
MAGIC_VARIABLE_MAPPING has a different location but updating it is no
longer necessary. Connection plugins are now able to access any hostvars
and options defined within their docstrings. The upstream connection/ssh
plugin's docstring has been copied here with the addition of OSA's
required options.
Change-Id: I6b1bcd4ec5e9d2701bd26e24e0f7645629ae4f3d
The follow-context switch is not valid on early releases of systemd. This
change removes the optional switch so that nsenter can work on all of
our platforms.
Change-Id: I13d05ba8bcfe785257a9cf98dbdb6024ec937816
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
It appears that since Ansible 2.4 the 'hostvars' variable does not
contain the host variables set by the linear plugin. However, the
physical_host_addrs variable set by that plugin is already present on
the host we are interested in. As such we can obtain that variable by
simply using the get_vars() method on the Host object.
Change-Id: Ibe2cff5fabf23e5ba6d5d165fb5406bca690a1e2
This change modifies our connection plugins to allow us to use nspawn
type containers. The change will pull in the container_type variable and
set the padding for commands accordingly.
While the module has been setup to default to LXC which ensures we've no
conflicts with existing deployments, the container_check function has been
set to ignore "nspawn" type containers until we have a suitable/reliable
method to connect to them without envoking ssh.
Change-Id: I8877c244af6458ca9840ea0519ab457a726feefd
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
In a recent Ansible change[0], when the set_host_overrides function is
overridden it will need to include an additional argument.
[0]
1665178626
Change-Id: I1bbfddcda49b8c8a6ae21ee77d51c6db19cb212e
Both the 'container_user' used within the 'cmd' variable and the
container path padding added to the 'out_file' variable in the
connection plugin should be strings since they're later encoded
to bytes by the inherited class.
Change-Id: I8874c439fc9c006125bb39ff6a2cd386bfc8f561
The import `to_bytes` was broken with recent ansible changes. This change
ensures that we're using the method from the embeded Ansible ssh plugin
instead of trying to import it. I've also moved the `shlex_quote`
method back to the embeded module so that we ensure we're not facing
similar import issues in the future.
Change-Id: I24b0e1c71650598f8ff5e7b4e1823411787266d2
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
Tasks which delegate from a container to a container on a separate host
currently fail because the 'physical_host_addr' variable, which those
tasks use to connect to a physical host, is exclusively set as the
address of the originating container's physical host.
Assign a new host variable, 'physical_host_addrs', which contains a
mapping of each physical host and its address, so the tasks can now
lookup of the correct address to use depending on the target container.
Change-Id: If594914df53efacc6d5bba148f4f46280f5a117d
Instead of having a conditional, we should directly use python .get()
internals, that allow to have a default.
Change-Id: I9908e83e3faa2fcc22c891c0fd6caa1fd8e92cc4
Related-Bug: 1695944
We should clear the environment before connecting to an LXC container to
avoid inheriting host variables that may break container services like
the following failure in rabbitmqctl:
TASK [Get status of rabbitmq] *************************************************************************************************************************************************************************************
fatal: [container1]: FAILED! => {"changed": true, "cmd": ["rabbitmqctl", "status"], "delta": "0:00:00.705116", "end": "2017-06-06 20:03:13.771796", "failed": true, "rc": 69, "start": "2017-06-06 20:03:13.066680", "stderr": "Error: unable to connect to node 'rabbit@vagrant-openSUSE-Leap': nodedown\n\nDIAGNOSTICS\n===========\n\nattempted to contact: ['rabbit@vagrant-openSUSE-Leap']\n\nrabbit@vagrant-openSUSE-Leap:\n * unable to connect to epmd (port 4369) on vagrant-openSUSE-Leap: address (cannot connect to host/port)\n\n\ncurrent node details:\n- node name: 'rabbitmq-cli-82@localhost'\n- home dir: /var/lib/rabbitmq\n- cookie hash: NqWRA5RzO5daz4Jb5LJsXg==", "stderr_lines": ["Error: unable to connect to node 'rabbit@vagrant-openSUSE-Leap': nodedown", "", "DIAGNOSTICS", "===========", "", "attempted to contact: ['rabbit@vagrant-openSUSE-Leap']", "", "rabbit@vagrant-openSUSE-Leap:", " * unable to connect to epmd (port 4369) on vagrant-openSUSE-Leap: address (cannot connect to host/port)", "", "", "current node details:", "- node name: 'rabbitmq-cli-82@localhost'", "- home dir: /var/lib/rabbitmq", "- cookie hash: NqWRA5RzO5daz4Jb5LJsXg=="], "stdout": "Status of node 'rabbit@vagrant-openSUSE-Leap' ...", "stdout_lines": ["Status of node 'rabbit@vagrant-openSUSE-Leap' ..."]}
to retry, use: --limit @/vagrant/tests/test-rabbitmq-server-functional.retry
The reason for this failure is that the HOSTNAME variable is being
inherited by the host (vagrant-openSUSE-Leap) and the rabbitmqctl
command uses this variable to guess the host it should try to
connect to.
This is similar to what the upstream lxc connection module is doing.
This is an attempt to fix problems introduced in
https://review.openstack.org/#/c/471472/ and subsequently
reverted in https://review.openstack.org/#/c/471713/
The reason for these failures was that 'lxc-attach' executed commands
which assumed that basic variables like HOME are set properly. However,
--clear-env didn't preserve these variables so various operations started
to fail. In order to fix that, it's best if we start a real login shell
using 'su' in order to mimic an expected user environment when executing
commands within the container.
Change-Id: I684a11f4380f91b1cb0585f38817859dfaa68f80
If ansible_host is defined on the physical_host inventory item,
physical_host_addr will be set and used as the ssh destination.
However if ansible_host is not defined, we will fall back to the
physical_host inventory hostname.
Related-Bug: 1695944
Change-Id: I90ccc12fd044f08a60c84f0b8ae5d7fd783760dd
I75f9d0f55ecd875caa1bf608a77c92f950b679a1 introduced a problem when
ansible_host is not defined on a host.
Related-Bug: 1695944
Change-Id: I9863757eef363cb05f581ab1449eb2f4aa3a0dda
Within the strategy plugin set a host var, 'physical_host_addr', which
corresponds to the 'ansible_host' var of the host's 'physical_host'.
Use this within the connection plugin rather than the hostname of the
physical host, which may not exist in DNS or the deployment host's
hosts file.
Closes-Bug: 1695944
Change-Id: I75f9d0f55ecd875caa1bf608a77c92f950b679a1
Unfortunately this breaks other roles/deployments as there are now
no environment variables set for the user. This is being reverted to
unblock the gate. We'll need to more carefully cross-repo test this
when it comes in again.
This reverts commit c2c71bc2b0.
Change-Id: I5981e72d8153e6ea490446ac9e2e8e31959d9f72
We should clear the environment before connecting to an LXC container to
avoid inheriting host variables that may break container services like
the following failure in rabbitmqctl:
TASK [Get status of rabbitmq] *************************************************************************************************************************************************************************************
fatal: [container1]: FAILED! => {"changed": true, "cmd": ["rabbitmqctl", "status"], "delta": "0:00:00.705116", "end": "2017-06-06 20:03:13.771796", "failed": true, "rc": 69, "start": "2017-06-06 20:03:13.066680", "stderr": "Error: unable to connect to node 'rabbit@vagrant-openSUSE-Leap': nodedown\n\nDIAGNOSTICS\n===========\n\nattempted to contact: ['rabbit@vagrant-openSUSE-Leap']\n\nrabbit@vagrant-openSUSE-Leap:\n * unable to connect to epmd (port 4369) on vagrant-openSUSE-Leap: address (cannot connect to host/port)\n\n\ncurrent node details:\n- node name: 'rabbitmq-cli-82@localhost'\n- home dir: /var/lib/rabbitmq\n- cookie hash: NqWRA5RzO5daz4Jb5LJsXg==", "stderr_lines": ["Error: unable to connect to node 'rabbit@vagrant-openSUSE-Leap': nodedown", "", "DIAGNOSTICS", "===========", "", "attempted to contact: ['rabbit@vagrant-openSUSE-Leap']", "", "rabbit@vagrant-openSUSE-Leap:", " * unable to connect to epmd (port 4369) on vagrant-openSUSE-Leap: address (cannot connect to host/port)", "", "", "current node details:", "- node name: 'rabbitmq-cli-82@localhost'", "- home dir: /var/lib/rabbitmq", "- cookie hash: NqWRA5RzO5daz4Jb5LJsXg=="], "stdout": "Status of node 'rabbit@vagrant-openSUSE-Leap' ...", "stdout_lines": ["Status of node 'rabbit@vagrant-openSUSE-Leap' ..."]}
to retry, use: --limit @/vagrant/tests/test-rabbitmq-server-functional.retry
The reason for this failure is that the HOSTNAME variable is being
inherited by the host (vagrant-openSUSE-Leap) and the rabbitmqctl
command uses this variable to guess the host it should try to
connect to.
This is similar to what the upstream lxc connection module is doing.
Link: https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/connection/lxc.py#L121
Change-Id: Ic3b8bf9a9aaf8738c49490e22fec2fc0b5140ac0
The strategy plugin previously did not support container detection
when the delegate_to host was a container. This adds support for
delegating tasks to other containers, so the strategy will perform
the same container vars lookups so the SSH connection is toward the
physical host of the container, and the command is wrapped with
lxc-attach based on the container_name.
Co-Authored-By: Jimmy McCrory <jimmy.mccrory@gmail.com>
Change-Id: I56d8afddbccf01f2944d2fdd505b601a4b048374
This change allows the connection plugin to work with Ansible 2.3.
Upstream changes now require the use of the public method.
Change-Id: I044aa442f116cbbf5fbdb6e6ca0b691c04c56a2d
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
In some situations it may be useful to execute a role or
set of tasks against a remote chroot.
This patch aims to add that capability.
Change-Id: Icebec389807aa8782f97a95f63687eb5606f7b22
This change is creating an opportunistic Ansible execution strategy and
an update the ssh connection plugin so that it supports direct access to lxc
containers within ever having to ssh into them.
The intention of this change is to speed up execution time and reliability by
tuning the execution environment within Ansible to run faster while also attempting
to subvert transient ssh issues.
Change-Id: Ide34513bf82523257bdd2a8a68dff165f9927c56
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
Dmitriy Rabotyagov