Re: [PATCH v6 2/4] Jobs based on custom runners: build environment docs and playbook

["Alex Bennée" <alex.bennee@linaro.org>]

Cleber Rosa Junior <crosa@redhat.com> writes:

> On Wed, Jun 9, 2021 at 11:26 AM Alex Bennée <alex.bennee@linaro.org> wrote:
>
>  Cleber Rosa Junior <crosa@redhat.com> writes:
>
>  > On Wed, Jun 9, 2021 at 9:36 AM Alex Bennée <alex.bennee@linaro.org> wrote:
>  >
>  >  Cleber Rosa <crosa@redhat.com> writes:
>  >
>  >  > To run basic jobs on custom runners, the environment needs to be
>  >  > properly set up.  The most common requirement is having the right
>  >  > packages installed.
>  >  >
>  >  > The playbook introduced here covers the QEMU's project s390x and
>  >  > aarch64 machines.  At the time this is being proposed, those machines
>  >  > have already had this playbook applied to them.
>  >  >
>  >  > Signed-off-by: Cleber Rosa <crosa@redhat.com>
>  >  > ---
>  >  >  docs/devel/ci.rst                      | 30 ++++++++
>  >  >  scripts/ci/setup/build-environment.yml | 98 ++++++++++++++++++++++++++
>  >  >  scripts/ci/setup/inventory.template    |  1 +
>  >  >  3 files changed, 129 insertions(+)
>  >  >  create mode 100644 scripts/ci/setup/build-environment.yml
>  >  >  create mode 100644 scripts/ci/setup/inventory.template
>  >  >
>  >  > diff --git a/docs/devel/ci.rst b/docs/devel/ci.rst
>  >  > index 585b7bf4b8..35c6b5e269 100644
>  >  > --- a/docs/devel/ci.rst
>  >  > +++ b/docs/devel/ci.rst
>  >  > @@ -26,3 +26,33 @@ gitlab-runner, is called a "custom runner".
>  >  >  The GitLab CI jobs definition for the custom runners are located under::
>  >  >  
>  >  >    .gitlab-ci.d/custom-runners.yml
>  >  > +
>  >  > +Machine Setup Howto
>  >  > +-------------------
>  >  > +
>  >  > +For all Linux based systems, the setup can be mostly automated by the
>  >  > +execution of two Ansible playbooks.  Create an ``inventory`` file
>  >  > +under ``scripts/ci/setup``, such as this::
>  >  > +
>  >  > +  fully.qualified.domain
>  >  > +  other.machine.hostname
>  >  > +
>  >  > +You may need to set some variables in the inventory file itself.  One
>  >  > +very common need is to tell Ansible to use a Python 3 interpreter on
>  >  > +those hosts.  This would look like::
>  >  > +
>  >  > +  fully.qualified.domain ansible_python_interpreter=/usr/bin/python3
>  >  > +  other.machine.hostname ansible_python_interpreter=/usr/bin/python3
>  >  > +
>  >  > +Build environment
>  >  > +~~~~~~~~~~~~~~~~~
>  >  > +
>  >  > +The ``scripts/ci/setup/build-environment.yml`` Ansible playbook will
>  >  > +set up machines with the environment needed to perform builds and run
>  >  > +QEMU tests.  It covers a number of different Linux distributions and
>  >  > +FreeBSD.
>  >  > +
>  >  > +To run the playbook, execute::
>  >  > +
>  >  > +  cd scripts/ci/setup
>  >  > +  ansible-playbook -i inventory build-environment.yml
>  >
>  >  I tried this to re-update aarch64.ci.qemu.org and another ubuntu box I
>  >  have up and running as a VM and I got a failure when checking facts:
>  >
>  >    14:26:26 [alex@zen:~/l/q/s/c/setup] review/custom-runners-v6|✚1…(+1/-1) + ansible-playbook -i inventory
>  build-environment.yml
>  >
>  >    PLAY [Installation of basic packages to build QEMU]
>  >  *************************************************************************************************************************
>  >
>  >    TASK [Gathering Facts]
>  > 
>  ******************************************************************************************************************************************************
>  
>  >  
>  >    ok: [aarch64.ci.qemu.org]
>  >    ok: [hackbox-ubuntu-2004]
>  >
>  >    TASK [Update apt cache]
>  > 
>  *****************************************************************************************************************************************************
>  
>  >  
>  >    fatal: [aarch64.ci.qemu.org]: FAILED! => {"msg": "The conditional check 'ansible_facts['distribution'] == 'Ubuntu'' failed. The
>  error
>  >  was: error while evaluating conditional (ansible_facts['distribution'] == 'Ubuntu'): 'dict object' has no attribute 'distribution'\n\nThe
>  >  error appears to have been in '/home/alex/lsrc/qemu.git/scripts/ci/setup/build-environment.yml': line 5, column 7, but may\nbe
>  >  elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n    - name: Update
>  apt
>  >  cache\n      ^ here\n"}
>  >    fatal: [hackbox-ubuntu-2004]: FAILED! => {"msg": "The conditional check 'ansible_facts['distribution'] == 'Ubuntu'' failed. The
>  error
>  >  was: error while evaluating conditional (ansible_facts['distribution'] == 'Ubuntu'): 'dict object' has no attribute 'distribution'\n\nThe
>  >  error appears to have been in '/home/alex/lsrc/qemu.git/scripts/ci/setup/build-environment.yml': line 5, column 7, but may\nbe
>  >  elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n  tasks:\n    - name: Update
>  apt
>  >  cache\n      ^ here\n"}
>  >            to retry, use: --limit @/home/alex/lsrc/qemu.git/scripts/ci/setup/build-environment.retry
>  >
>  >    PLAY RECAP
>  > 
>  ******************************************************************************************************************************************************************
>  
>  >  
>  >    aarch64.ci.qemu.org        : ok=1    changed=0    unreachable=0    failed=1
>  >    hackbox-ubuntu-2004        : ok=1    changed=0    unreachable=0    failed=1
>  >
>  > Hi Alex,
>  >
>  > Thanks for checking this version out.  It looks like this is similar to what happened to you during v5 and hackmox-ubuntu-2004. 
>  Because I
>  > had no issues running the playbook against aarch64.ci.qemu.org, I am now betting that this is an issue with the ansible installation
>  on the
>  > "controller" machine, that is, the one that drives the playbook execution (the "zen" host, according to your output).
>  >
>  > About the error, the syntax itself is correct[1], but I bet there may be differences between ansible versions.  Could you please share
>  the
>  > output of "ansible --version" on that machine?
>
>  15:41:21 [alex@zen:~/l/q/s/c/setup] review/custom-runners-v6|✚1…(+1/-1) 4 + ansible --version
>  ansible 2.7.7
>    config file = /etc/ansible/ansible.cfg
>    configured module search path = ['/home/alex/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
>    ansible python module location = /usr/lib/python3/dist-packages/ansible
>    executable location = /usr/bin/ansible
>    python version = 3.7.3 (default, Jan 22 2021, 20:04:44) [GCC 8.3.0]
>
>  My machine is Debian stable (aka Buster)
>
> Hi Alex,
>
> I found out, the hard way, that one will need ansible 2.8.x.  I'll
> make a note about that in the documentation. Long version:

OK - yes please and I'll test with a local installed version. Is it
possible for the playbook to error out with a useful warning if the
version of ansible isn't new enough?

>
> I was able to replicate this on Debian stable, using the exact same versions as you did.  Then I tried the latest ansible 2.7.18 (the latest in
> the 2.7.x series), installed with "pip install ansible==2.7.18 --user".  Still, the exact same issue.
>
> Then, still on Debian stable, I tried 2.8.20 (installed with "pip install ansible==2.8.20 --user"), and the playbook execution completed
> successfully.
>
> I went through the 2.7x. and 2.8.x changelogs, and I could not spot one clear entry about the change in behavior though.
>
> Thanks,
> - Cleber.
>  
>  >
>  > Thanks again,
>  > - Cleber.
>  >
>  > [1] - https://docs.ansible.com/ansible/latest/user_guide/playbooks_conditionals.html#ansible-facts-distribution
>  >  
>  >  -- 
>  >  Alex Bennée
>
>  -- 
>  Alex Bennée


-- 
Alex Bennée