Workflow for updating images.

documenation on:
"Update Packer Base Image"
and
"Update Packer Images to reflect changes
in LF ansible galaxy roles"

ISSUE: RELENG-2363
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: Ia2bac9c336772742bf58058114b1668498cfcbd3

diff --git a/docs/conf.py b/docs/conf.py
index 5b3b5a2..0205002 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -22,6 +22,12 @@ import subprocess
 
 from docs_conf.conf import *
 
+linkcheck_ignore = [
+              'http://localhost',
+              'https://jenkins.umbrella-name.org',
+]
+
+
 def format_version(version):
     fmt = '{tag}.dev{commitcount}+{gitsha}'
     parts = version.split('-')

diff --git a/docs/index.rst b/docs/index.rst
index 5978e92..9803bb1 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,6 +12,7 @@ projects as a central way to maintain and manage common VM configuration.
    install
    usage
    lf-network
+   update-images
 
 Indices and tables
 ==================

diff --git a/docs/update-images.rst b/docs/update-images.rst
new file mode 100644 (file)
index 0000000..5719507
--- /dev/null
+++ b/docs/update-images.rst
@@ -0,0 +1,121 @@
+########################################
+Upload Linux cloud image for packer jobs
+########################################
+
+The following instructions provide details on how to update a base image in
+OpenStack cloud.
+
+1. Ask an administrator for the required ~/.config/openstack/ files
+1. Install prerequisites
+
+   .. code-block:: bash
+
+      pip install lftools[openstack]
+      yum/apt install qemu-img
+
+
+2. Fetch the image file in .img format
+3. Vexxhost requires images to be uploaded in RAW format so QCOW2 images need to be converted to RAW:
+
+
+   .. code-block:: bash
+
+       qemu-img convert -f qcow2 -O raw bionic-server-cloudimg-amd64.img bionic-server-cloudimg-amd64-raw.img
+
+3. upload it to the cloud in question
+
+   .. code-block:: bash
+
+       lftools openstack --os-cloud "cloudname" image upload --disk-format raw local-server-cloudimg-arm64-raw.img "Ubuntu 18.04 LTS [2020-08-04]"
+
+4. Update common-packer to use this new image.
+
+eg edit: vars/ubuntu-18.04.json
+once that is merged tag common packer with the new version
+
+   .. code-block:: bash
+
+       git tag -s v0.6.2 -m  "common-packer v0.6.2 release"
+       git push origin v0.6.2
+
+5. pull common packer changes into global-jjb of your project
+
+   .. code-block:: bash
+
+       cd packer/common-packer/
+       git checkout git checkout v0.6.2
+
+6. once your change is merged re-run one of the packer merge jobs it will use
+the new base image.
+
+##################################################################
+Update Packer Images to reflect changes in LF ansible galaxy roles
+##################################################################
+
+Workflow:
+
+Change is merged to an ansible role:
+https://gerrit.linuxfoundation.org/infra/c/ansible/roles/lf-recommended-tools/+/16671
+
+Now we want the images in our "umbrella-project's" openstack cloud to have these changes:
+
+Find the packer merge jobs in our umbrella project's jenkins.
+Trigger this job for each builder you want to be able to update.
+
+https://jenkins.umbrella-name.org/search/?q=packer-merge
+
+    ci-management-packer-merge-centos-7-docker
+    ci-management-packer-merge-centos-7-builder
+    ci-management-packer-merge-ubuntu-18.04-docker
+    ci-management-packer-merge-ubuntu-18.04-builder
+
+
+Trigger a merge job for each builder that we want to update.
+https://jenkins.acumos.org/job/ci-management-packer-merge-centos-7-builder/
+
+Or if you dont have trigger:
+
+you can run a remerge via comment on a change (anyone can do this) to for example:
+umbrella-project/ci-management/packer/vars/centos-7.json
+
+example:
+https://gerrit.acumos.org/r/c/ci-management/+/5041/1/packer/vars/centos-7.json
+
+and that will trigger both builds:
+ci-management-packer-merge-centos-7-docker
+ci-management-packer-merge-centos-7-builder
+
+
+When the job is complete, you will see some info in the Build history
+
+Which will look like this:
+
+   .. code-block:: bash
+
+       Image: ZZCI - CentOS 7 - builder - x86_64 - 20190910-180457.538
+
+Or there is an openstack command for admins.
+
+   .. code-block:: bash
+
+       openstack --os-cloud="odlci" image list
+
+Take this information and update a file in your ci-managment repo
+umbrella-project/ci-management/jenkins-config/clouds/openstack/UMBRELLA-PROJECT-VEX/
+for example:
+centos7-builder-2c-1g.cfg
+
+   .. code-block:: bash
+
+       IMAGE_NAME=ZZCI - CentOS 7 - builder - 20181115-0246
+       LABELS=centos7-basebuild-4c-4g
+       HARDWARE_ID=v1-standard-4
+
+In this case you would also want to update
+centos7-builder-4c-4g.cfg
+
+Replace the IMAGE_NAME with the string retreived from the ci-management-packer-merge-centos-7-builder job.
+Once that is merged the new image will be used when that builder is spawned.
+
+Some info on the jenkins side of this about the  ci-management-packer-merge jobs:
+https://docs.releng.linuxfoundation.org/projects/global-jjb/en/latest/jjb/lf-ci-jobs.html?highlight=jenkins-config#jenkins-configuration-verify