Merge lp:~maxiberta/ols-jenkaas/extend-job-builder-docs into lp:~ols-jenkaas-admins/ols-jenkaas/trunk

[Maximiliano Bertacchini]

Update docs, deps and ubuntu release of the job builder container

[Guillermo Gonzalez (verterok)]

looks good, thanks for the update

review: Approve

[Odysseus Kaziolas (odysseus-k)]

LGTM. Thank you!

review: Approve

=== modified file 'README.rst'
--- README.rst	2020-07-30 18:21:34 +0000
+++ README.rst	2023-10-12 15:35:12 +0000
@@ -65,6 +65,33 @@
 ``ols-job-builder`` in ``ols-vms.conf`` is the container to use to create,
 update and delete the jobs.
 
+At the time of writing, `ols-vms` runs on xenial and bionic only.
+In order to prevent issues with nested LXD containers, it is recommended that 
+an LXD **VM** is used instead of a regular LXD container.
+
+Pre-requisites::
+
+  $ lxc launch --vm images:ubuntu/bionic -p default -p $USER myjenkaas
+
+Note the `--vm` option. It is assumed that an lxd profile named `$USER` 
+already exists where your home directory is mounted on the new VM.
+
+Log into the VM and install `ols-vms`::
+
+  $ sudo add-apt-repository --update ppa:ubuntuone/ols-tests
+  $ sudo apt install python3-ols-vms
+
+If you've never used lxd before::
+
+  $ sudo apt install snapd
+  $ sudo snap install lxd
+  $ sudo adduser $USER lxd
+  $ newgrp lxd
+  $ sudo lxd init --auto
+
+and follow the instructions to setup a bridge, nat'ed for ipv4, ipv6 is not
+needed, zfs is optional but great.
+
 Setting up ``ols-job-builder`` requires the credentials for
 ``{{jenkaas}.bot.user}``. They need to be retrieved from the jenkins master.
 
@@ -80,16 +107,22 @@
 
 You're now ready to create your job builder::
 
+  $ cd ols-jenkaas/
   $ ols-vms setup ols-job-builder
 
-You're good to go, edit job descriptions under 'jobs/' then do:
+You're good to go, edit job descriptions under 'jobs/', raise an MP and get it 
+merged. Then log into the new `ols-job-builder` container and do::
 
-ubuntu@ols-job-builder:~/jenkaas$ jenkins-jobs update --delete-old jobs/
+  $ ubuntu@ols-job-builder:~/jenkaas$ bzr pull
+  $ ubuntu@ols-job-builder:~/jenkaas$ jenkins-jobs update --delete-old jobs/
 
 Note: This a WIP and only applies to members of
 https://launchpad.net/~ols-jenkaas-admins who have the needed credentials,
 see `Test setup`_ for how to setup a test environment.
 
+Note: It might be necessary to manually copy `secrets/mattermost.endpoint`
+from lp:ols-jenkaas-secrets.
+
 
 Test setup
 ==========
@@ -97,14 +130,14 @@
 Pre-requisites::
 
   $ sudo add-apt-repository --update ppa:ubuntuone/ols-tests
-  $ sudo apt-get install wget ssh lxd lxd-client python3-ols-vms bzr-olsvms
+  $ sudo apt install wget ssh lxd lxd-client python3-ols-vms bzr-olsvms
 
 If you've never used lxd before::
 
+  $ sudo snap install lxd
   $ sudo adduser $USER lxd
   $ newgrp lxd
   $ sudo lxd init --auto
-  $ sudo dpkg-reconfigure -p medium lxd
 
 and follow the instructions to setup a bridge, nat'ed for ipv4, ipv6 is not
 needed, zfs is optional but great.

=== modified file 'ols-vms.conf'
--- ols-vms.conf	2023-03-02 05:05:54 +0000
+++ ols-vms.conf	2023-10-12 15:35:12 +0000
@@ -60,7 +60,8 @@
 
 [ols-job-builder]
 jenkaas = production
-vm.release = xenial
+vm.release = bionic
+logging.level = DEBUG
 lxd.image = ubuntu-daily:{vm.release}/{vm.architecture}
 apt.sources = ppa:ubuntuone/ols-tests
 # python3-pip is needed to install a more recent version of

=== modified file 'setup/job-builder'
--- setup/job-builder	2020-07-30 18:45:58 +0000
+++ setup/job-builder	2023-10-12 15:35:12 +0000
@@ -4,7 +4,7 @@
 
 
 # We need to run jenkins_jobs from pip to get the bzr scm :-/
-LC_ALL=C pip3 install --user jenkins-job-builder
+LC_ALL=C pip3 install --user jenkins-job-builder==2.10.1
 LC_ALL=C pip3 install --user git+https://github.com/jovandeginste/jenkins-jobs-mattermost.git
 
 CONF_DIR=~/.config/jenkins_jobs