Skip to contentSkip to conversation

Convert bringup_guestfs to a single Ansible role

PATCH In review Chuck Lever 2 participants 16 messages May 30, 2025 – Jun 4, 2025

lore
Share & tools
lore
#0 lore raw

v2 cover Convert bringup_guestfs to a single Ansible role

From: Chuck Lever <[email protected]>

This series demonstrates some ideas about how libvirt/guestfs bring- up might be expressed using only Ansible (ie. with a minimal use of shell scripting). Benefits include:

- Starting guests is now done in parallel
- "make bringup" is more idempotent
- Lets us create utilities that both guestfs and Terraform can use

The new parts that handle custom upstream images has not yet been tested.

Changes since RFC:
- All of bringup_guestfs.sh has now been converted to Ansible
- Remove the old code as the last step in the series
- Reorganize the series to reduce the size of each patch
- Modernize steps that Ansible can now do with builtin modules

Chuck Lever (12):
guestfs: Replace scripts/destroy_guestfs.sh with an Ansible playbook Move the guestfs install-deps to the guestfs playbook
guestfs: Do not use the config-check tag
guestfs: Add a "bringup" tag to the guestfs role
guestfs: Copy "network" tag steps to guestfs role
guestfs: Move the QEMU_GROUP check
Add a base-image role
guestfs: Convert scripts/bringup_guestfs.sh to Ansible
guestfs: Move console-related steps to guestfs role
bringup_guestfs: Remove the role
scripts: Remove the bringup_guestfs.sh script
scripts: Remove the destroy_guestfs.sh script

 .gitignore                                    |   1 +
 playbooks/base_image.yml                      |   7 +
 playbooks/bringup_guestfs.yml                 |   4 -
 playbooks/guestfs.yml                         |   7 +
 playbooks/roles/base_image/README.md          |  45 ++
 playbooks/roles/base_image/defaults/main.yml  |   7 +
 .../roles/base_image/tasks/base-image.yml     |  80 ++++
 .../roles/base_image/tasks/custom-image.yml   | 159 +++++++
 playbooks/roles/base_image/tasks/main.yml     |  19 +
 .../base_image/templates/custom-index.j2      |   2 +
 .../base_image/templates/custom-source.j2     |   3 +
 .../base_image/templates/virt-builder.j2      |  77 ++++
 .../roles/bringup_guestfs/defaults/main.yml   |  12 -
 .../tasks/install-deps/main.yml               |  17 -
 .../roles/bringup_guestfs/tasks/main.yml      | 243 -----------
 playbooks/roles/guestfs/defaults/main.yml     |   5 +
 .../tasks/bringup/console-permissions.yml     |  31 ++
 .../guestfs/tasks/bringup/extra-disks.yml     |  16 +
 .../roles/guestfs/tasks/bringup/largeio.yml   |  11 +
 .../roles/guestfs/tasks/bringup/main.yml      | 132 ++++++
 .../roles/guestfs/tasks/bringup/network.yml   |  83 ++++
 .../tasks/bringup/storage-pool-path.yml       |  92 ++++
 playbooks/roles/guestfs/tasks/destroy.yml     |  32 ++
 .../tasks/install-deps/debian/main.yml        |   3 +-
 .../roles/guestfs/tasks/install-deps/main.yml |  21 +
 .../tasks/install-deps/redhat/main.yml        |   5 +-
 .../tasks/install-deps/suse/main.yml          |   3 +-
 playbooks/roles/guestfs/tasks/main.yml        |  67 +++
 scripts/bringup_guestfs.sh                    | 399 ------------------
 scripts/destroy_guestfs.sh                    |  36 --
 scripts/guestfs.Makefile                      |  23 +-
 31 files changed, 911 insertions(+), 731 deletions(-)
 create mode 100644 playbooks/base_image.yml
 delete mode 100644 playbooks/bringup_guestfs.yml
 create mode 100644 playbooks/guestfs.yml
 create mode 100644 playbooks/roles/base_image/README.md
 create mode 100644 playbooks/roles/base_image/defaults/main.yml
 create mode 100644 playbooks/roles/base_image/tasks/base-image.yml
 create mode 100644 playbooks/roles/base_image/tasks/custom-image.yml
 create mode 100644 playbooks/roles/base_image/tasks/main.yml
 create mode 100644 playbooks/roles/base_image/templates/custom-index.j2
 create mode 100644 playbooks/roles/base_image/templates/custom-source.j2
 create mode 100644 playbooks/roles/base_image/templates/virt-builder.j2
 delete mode 100644 playbooks/roles/bringup_guestfs/defaults/main.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/tasks/install-deps/main.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/tasks/main.yml
 create mode 100644 playbooks/roles/guestfs/defaults/main.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/console-permissions.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/extra-disks.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/largeio.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/main.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/network.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/storage-pool-path.yml
 create mode 100644 playbooks/roles/guestfs/tasks/destroy.yml
 rename playbooks/roles/{bringup_guestfs => guestfs}/tasks/install-deps/debian/main.yml (78%)
 create mode 100644 playbooks/roles/guestfs/tasks/install-deps/main.yml
 rename playbooks/roles/{bringup_guestfs => guestfs}/tasks/install-deps/redhat/main.yml (62%)
 rename playbooks/roles/{bringup_guestfs => guestfs}/tasks/install-deps/suse/main.yml (71%)
 create mode 100644 playbooks/roles/guestfs/tasks/main.yml
 delete mode 100755 scripts/bringup_guestfs.sh
 delete mode 100755 scripts/destroy_guestfs.sh
Signature · 1 line
2.49.0
#1 lore raw

PATCH v2 1/12 guestfs: Replace scripts/destroy_guestfs.sh with an Ansible playbook

From: Chuck Lever <[email protected]>

Use Ansible for destroying libvirt-based target nodes. This replaces an open-coded loop over the target node hosts, and makes the destroy target more idempotent.

Also, this change is a prerequisite to making guestfs and terraform manage their ssh key material in the same way, eventually.

---
 .gitignore                                |  1 +
 playbooks/guestfs.yml                     |  7 +++++
 playbooks/roles/guestfs/tasks/destroy.yml | 32 +++++++++++++++++++++++
 playbooks/roles/guestfs/tasks/main.yml    |  6 +++++
 scripts/guestfs.Makefile                  |  6 +++--
 5 files changed, 50 insertions(+), 2 deletions(-)
 create mode 100644 playbooks/guestfs.yml
 create mode 100644 playbooks/roles/guestfs/tasks/destroy.yml
 create mode 100644 playbooks/roles/guestfs/tasks/main.yml
.gitignore +1 -0
index 45113a669390..706ef3fca950 100644
@@ -6,6 +6,7 @@
 .provisioned_once*
 
 guestfs/
+!playbooks/roles/guestfs/
 
 linux/
 !workflows/linux/
playbooks/guestfs.yml new file +7 -0
new file mode 100644
index 000000000000..8bb496e0f05a
@@ -0,0 +1,7 @@
+---
+- name: Provision target nodes with libvirt/guestfs
+  gather_facts: false
+  connection: local
+  hosts: all
+  roles:
+    - role: guestfs
playbooks/roles/guestfs/tasks/destroy.yml new file +32 -0
new file mode 100644
index 000000000000..e26aacde4cff
@@ -0,0 +1,32 @@
+---
+- name: Destroy each target node
+  community.libvirt.virt:
+    name: "{{ inventory_hostname }}"
+    command: "destroy"
+    uri: "{{ libvirt_uri }}"
+  failed_when: false # Do not fail if the target node is not currently running
+
+- name: Undefine each target node
+  community.libvirt.virt:
+    name: "{{ inventory_hostname }}"
+    command: "undefine"
+    uri: "{{ libvirt_uri }}"
+    force: true
+  failed_when: false # Do not fail if the target node is not currently defined
+
+- name: Remove per-node configuration files
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: absent
+  loop:
+    - "{{ guestfs_path }}/{{ inventory_hostname }}"
+    - "{{ kdevops_storage_pool_path }}/guestfs/{{ inventory_hostname }}"
+
+- name: Remove global configuration files
+  run_once: true
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: absent
+  loop:
+    - "{{ kdevops_ssh_config }}"
+    - "{{ topdir_path }}/{{ kdevops_nodes }}"
playbooks/roles/guestfs/tasks/main.yml new file +6 -0
new file mode 100644
index 000000000000..60d4ffd40a20
@@ -0,0 +1,6 @@
+---
+- name: Shut down and destroy each target node
+  tags:
+    - destroy
+  ansible.builtin.import_tasks:
+    file: "{{ role_path }}/tasks/destroy.yml"
scripts/guestfs.Makefile +4 -2
index 8d4aac3e3669..5d355ec70f8c 100644
@@ -93,9 +93,11 @@ status_guestfs:
 PHONY += status_guestfs
 
 destroy_guestfs:
-	$(Q)$(TOPDIR)/scripts/destroy_guestfs.sh
+	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) \
+		-i hosts playbooks/guestfs.yml \
+		--extra-vars=@./extra_vars.yaml \
+		--tags destroy
 	$(Q)rm -f $(KDEVOPS_PROVISIONED_SSH) $(KDEVOPS_PROVISIONED_DEVCONFIG)
-
 PHONY += destroy_guestfs
 
 cleancache:
Signature · 1 line
2.49.0
#2 lore raw

PATCH v2 2/12 Move the guestfs install-deps to the guestfs playbook

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

As a clean up, handle "install-deps" in the new guestfs role, just like is done for terraform.

In addition to copying the install-deps scripts, switch to using import_tasks, which has more dependable behavior and avoids the need to add a "tags:" keyword on each step.

---
 .../tasks/install-deps/debian/main.yml        | 10 +++++++++
 .../roles/guestfs/tasks/install-deps/main.yml | 21 +++++++++++++++++++
 .../tasks/install-deps/redhat/main.yml        | 12 +++++++++++
 .../guestfs/tasks/install-deps/suse/main.yml  |  9 ++++++++
 playbooks/roles/guestfs/tasks/main.yml        |  6 ++++++
 scripts/guestfs.Makefile                      |  4 ++--
 6 files changed, 60 insertions(+), 2 deletions(-)
 create mode 100644 playbooks/roles/guestfs/tasks/install-deps/debian/main.yml
 create mode 100644 playbooks/roles/guestfs/tasks/install-deps/main.yml
 create mode 100644 playbooks/roles/guestfs/tasks/install-deps/redhat/main.yml
 create mode 100644 playbooks/roles/guestfs/tasks/install-deps/suse/main.yml
playbooks/roles/guestfs/tasks/install-deps/debian/main.yml new file +10 -0
new file mode 100644
index 000000000000..5935f752a493
@@ -0,0 +1,10 @@
+---
+- name: Install guestfs dependencies for Debian
+  become: true
+  become_method: ansible.builtin.sudo
+  ansible.builtin.package:
+    update_cache: true
+    name:
+      - libguestfs-tools
+      - isc-dhcp-client
+    state: present
playbooks/roles/guestfs/tasks/install-deps/main.yml new file +21 -0
new file mode 100644
index 000000000000..5cbc55dcb188
@@ -0,0 +1,21 @@
+---
+- name: Gathering facts
+  ansible.builtin.gather_facts:
+
+- name: Debian-specific setup
+  ansible.builtin.import_tasks:
+    file: debian/main.yml
+  when:
+    - ansible_os_family == "Debian"
+
+- name: SuSE-specific setup
+  ansible.builtin.import_tasks:
+    file: suse/main.yml
+  when:
+    - ansible_os_family == "Suse"
+
+- name: Red Hat-specific setup
+  ansible.builtin.import_tasks:
+    file: redhat/main.yml
+  when:
+    - ansible_os_family == "Redhat"
playbooks/roles/guestfs/tasks/install-deps/redhat/main.yml new file +12 -0
new file mode 100644
index 000000000000..c28a16a07c7a
@@ -0,0 +1,12 @@
+---
+- name: Install guestfs dependencies for Red Hat Enterprise
+  become: true
+  become_method: ansible.builtin.sudo
+  ansible.builtin.package:
+    update_cache: true
+    name:
+      - libguestfs-tools
+      - dhcpcd
+    state: present
+  when:
+    - ansible_distribution != "Fedora"
playbooks/roles/guestfs/tasks/install-deps/suse/main.yml new file +9 -0
new file mode 100644
index 000000000000..c1bf24354612
@@ -0,0 +1,9 @@
+---
+- name: Install guestfs dependencies for Suse
+  become: true
+  become_method: ansible.builtin.sudo
+  ansible.builtin.package:
+    name:
+      - libguestfs-tools
+      - dhcpcd
+    state: present
playbooks/roles/guestfs/tasks/main.yml +6 -0
index 60d4ffd40a20..ba38a67c4baf 100644
@@ -1,4 +1,10 @@
 ---
+- name: Install guestfs dependencies on the Ansible controller
+  tags:
+    - install-deps
+  ansible.builtin.import_tasks:
+    file: "{{role_path }}/tasks/install-deps/main.yml"
+
 - name: Shut down and destroy each target node
   tags:
     - destroy
scripts/guestfs.Makefile +2 -2
index 5d355ec70f8c..4ad347544cf6 100644
@@ -68,9 +68,9 @@ $(KDEVOPS_PROVISIONED_SSH):
 	$(Q)touch $(KDEVOPS_PROVISIONED_SSH)
 
 install_libguestfs:
-	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
+	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) \
 		--inventory localhost, \
-		playbooks/bringup_guestfs.yml \
+		playbooks/guestfs.yml \
 		--extra-vars=@./extra_vars.yaml \
 		--tags install-deps
 
Signature · 1 line
2.49.0
#3 lore raw

PATCH v2 3/12 guestfs: Do not use the config-check tag

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

These days, "make bringup" fails immediately if "make" has not already been run, because ansible.cfg does not yet exist.

The guestfs config-check steps are no longer necessary.

---
 scripts/guestfs.Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/guestfs.Makefile +1 -1
index 4ad347544cf6..7f5fb6334846 100644
@@ -79,7 +79,7 @@ bringup_guestfs: $(GUESTFS_BRINGUP_DEPS)
 		--inventory localhost, \
 		playbooks/bringup_guestfs.yml \
 		--extra-vars=@./extra_vars.yaml \
-		--tags config-check,network,storage-pool-path
+		--tags network,storage-pool-path
 	$(Q)$(TOPDIR)/scripts/bringup_guestfs.sh
 	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
 		--inventory localhost, \
Signature · 1 line
2.49.0
#4 lore raw

PATCH v2 4/12 guestfs: Add a "bringup" tag to the guestfs role

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

Create a new "bringup" tag that bookends the existing "destroy" tag. All guestfs bringup steps will get this tag.

Start by populating this new tag with the steps that provision the kdevops storage pool for guestfs.

---
 playbooks/roles/guestfs/defaults/main.yml     |  2 +
 .../tasks/bringup/storage-pool-path.yml       | 78 +++++++++++++++++++
 playbooks/roles/guestfs/tasks/main.yml        |  8 ++
 scripts/guestfs.Makefile                      |  6 +-
 4 files changed, 93 insertions(+), 1 deletion(-)
 create mode 100644 playbooks/roles/guestfs/defaults/main.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/storage-pool-path.yml
playbooks/roles/guestfs/defaults/main.yml new file +2 -0
new file mode 100644
index 000000000000..6112b384bb57
@@ -0,0 +1,2 @@
+---
+libvirt_uri_system: false
playbooks/roles/guestfs/tasks/bringup/storage-pool-path.yml new file +78 -0

78 lines not on this page · raw message

playbooks/roles/guestfs/tasks/main.yml +8 -0
index ba38a67c4baf..12064cb91d73 100644
@@ -5,6 +5,14 @@
   ansible.builtin.import_tasks:
     file: "{{role_path }}/tasks/install-deps/main.yml"
 
+- name: Ensure a storage pool for guestfs exists
+  delegate_to: localhost
+  run_once: true
+  tags:
+    - bringup
+  ansible.builtin.import_tasks:
+    file: "{{role_path }}/tasks/bringup/storage-pool-path.yml"
+
 - name: Shut down and destroy each target node
   tags:
     - destroy
scripts/guestfs.Makefile +5 -1
index 7f5fb6334846..571662d187ae 100644
@@ -75,11 +75,15 @@ install_libguestfs:
 		--tags install-deps
 
 bringup_guestfs: $(GUESTFS_BRINGUP_DEPS)
+	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) \
+		-i hosts playbooks/guestfs.yml \
+		--extra-vars=@./extra_vars.yaml \
+		--tags bringup
 	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
 		--inventory localhost, \
 		playbooks/bringup_guestfs.yml \
 		--extra-vars=@./extra_vars.yaml \
-		--tags network,storage-pool-path
+		--tags network
 	$(Q)$(TOPDIR)/scripts/bringup_guestfs.sh
 	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
 		--inventory localhost, \
Signature · 1 line
2.49.0
#5 lore raw

PATCH v2 5/12 guestfs: Copy "network" tag steps to guestfs role

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

Copy the "network" tag steps into the guestfs role to remove a usage of the bringup_guestfs role.

---
 playbooks/roles/guestfs/defaults/main.yml     |  2 +
 .../roles/guestfs/tasks/bringup/network.yml   | 83 +++++++++++++++++++
 playbooks/roles/guestfs/tasks/main.yml        |  8 ++
 scripts/guestfs.Makefile                      |  5 --
 4 files changed, 93 insertions(+), 5 deletions(-)
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/network.yml
playbooks/roles/guestfs/defaults/main.yml +2 -0
index 6112b384bb57..e250a40fd27a 100644
@@ -1,2 +1,4 @@
 ---
+distro_debian_based: false
+
 libvirt_uri_system: false
playbooks/roles/guestfs/tasks/bringup/network.yml new file +83 -0

83 lines not on this page · raw message

playbooks/roles/guestfs/tasks/main.yml +8 -0
index 12064cb91d73..6981d3c1a70b 100644
@@ -13,6 +13,14 @@
   ansible.builtin.import_tasks:
     file: "{{role_path }}/tasks/bringup/storage-pool-path.yml"
 
+- name: Ensure libvirt networking has started
+  delegate_to: localhost
+  run_once: true
+  tags:
+    - bringup
+  ansible.builtin.import_tasks:
+    file: "{{role_path }}/tasks/bringup/network.yml"
+
 - name: Shut down and destroy each target node
   tags:
     - destroy
scripts/guestfs.Makefile +0 -5
index 571662d187ae..f2900a684960 100644
@@ -79,11 +79,6 @@ bringup_guestfs: $(GUESTFS_BRINGUP_DEPS)
 		-i hosts playbooks/guestfs.yml \
 		--extra-vars=@./extra_vars.yaml \
 		--tags bringup
-	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
-		--inventory localhost, \
-		playbooks/bringup_guestfs.yml \
-		--extra-vars=@./extra_vars.yaml \
-		--tags network
 	$(Q)$(TOPDIR)/scripts/bringup_guestfs.sh
 	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
 		--inventory localhost, \
Signature · 1 line
2.49.0
#6 lore raw

PATCH v2 6/12 guestfs: Move the QEMU_GROUP check

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

The qemu group check is needed by both the stoage-pool-path tag and the bringup_guestfs.sh, but is done only by the latter. The makefile runs the former first, however.

Move the check earlier during bring-up.

---
 .../guestfs/tasks/bringup/storage-pool-path.yml    | 14 ++++++++++++++
 scripts/bringup_guestfs.sh                         |  8 --------
 2 files changed, 14 insertions(+), 8 deletions(-)
playbooks/roles/guestfs/tasks/bringup/storage-pool-path.yml +14 -0
index 50f804cc304c..385b6cdfdbe7 100644
@@ -1,4 +1,18 @@
 ---
+- name: Get the user who invoked Ansible
+  ansible.builtin.command:
+    cmd: "id -Gn"
+  register: id_group
+  changed_when: false
+
+- name: Group membership check failed
+  vars:
+    user_groups: "{{ id_group.stdout | split }}"
+  ansible.builtin.fail:
+    msg: "Ansible user is not part of the {{ libvirt_qemu_group }} group."
+  when:
+    - libvirt_qemu_group not in user_groups
+
 - name: Create storage pool path directory (libvirt session uri)
   # noqa: risky-file-permissions
   ansible.builtin.file:
scripts/bringup_guestfs.sh +0 -8
index 67f85a5fdb0a..55b13a0cb2cc 100755
@@ -31,14 +31,6 @@ OS_VERSION=${CONFIG_VIRT_BUILDER_OS_VERSION}
 BASE_IMAGE_DIR="${STORAGEDIR}/base_images"
 BASE_IMAGE="${BASE_IMAGE_DIR}/${OS_VERSION}.raw"
 
-if id -nG "$(whoami)" | grep -qw "$QEMU_GROUP"; then
-    echo "User $USER is part of the $QEMU_GROUP group."
-else
-    echo "Error: User $USER is not part of the $QEMU_GROUP group. Exiting..."
-    echo "Fix this and come back and try again."
-    exit 1
-fi
-
 build_custom_source()
 {
 	SOURCE_TMP=$(mktemp)
Signature · 1 line
2.49.0
#7 lore raw

PATCH v2 7/12 Add a base-image role

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

Add a base-image role that ensures a base OS image exists for libvirt to use when provisioning guests. Copy the steps from scripts/bringup_guestfs.sh.

This procedure is maintained outside of the guestfs role in order to reduce the complexity of guestfs and base-image.

---
 playbooks/base_image.yml                      |   7 +
 playbooks/roles/base_image/README.md          |  45 +++++
 playbooks/roles/base_image/defaults/main.yml  |   7 +
 .../roles/base_image/tasks/base-image.yml     |  80 +++++++++
 .../roles/base_image/tasks/custom-image.yml   | 159 ++++++++++++++++++
 playbooks/roles/base_image/tasks/main.yml     |  19 +++
 .../base_image/templates/custom-index.j2      |   2 +
 .../base_image/templates/custom-source.j2     |   3 +
 .../base_image/templates/virt-builder.j2      |  77 +++++++++
 9 files changed, 399 insertions(+)
 create mode 100644 playbooks/base_image.yml
 create mode 100644 playbooks/roles/base_image/README.md
 create mode 100644 playbooks/roles/base_image/defaults/main.yml
 create mode 100644 playbooks/roles/base_image/tasks/base-image.yml
 create mode 100644 playbooks/roles/base_image/tasks/custom-image.yml
 create mode 100644 playbooks/roles/base_image/tasks/main.yml
 create mode 100644 playbooks/roles/base_image/templates/custom-index.j2
 create mode 100644 playbooks/roles/base_image/templates/custom-source.j2
 create mode 100644 playbooks/roles/base_image/templates/virt-builder.j2
playbooks/base_image.yml new file +7 -0
new file mode 100644
index 000000000000..41126844ab30
@@ -0,0 +1,7 @@
+---
+- name: Create a libvirt base OS image
+  gather_facts: false
+  connection: local
+  hosts: localhost
+  roles:
+    - role: base_image
playbooks/roles/base_image/README.md new file +45 -0

45 lines not on this page · raw message

playbooks/roles/base_image/defaults/main.yml new file +7 -0
new file mode 100644
index 000000000000..dc9e8f6617d3
@@ -0,0 +1,7 @@
+---
+libvirt_uri_system: false
+
+guestfs_copy_sources_from_host_to_guest: false
+guestfs_has_custom_raw_image: false
+kdevops_uid: ""
+update_grub_cmd: "/usr/sbin/update-grub2"
playbooks/roles/base_image/tasks/base-image.yml new file +80 -0

80 lines not on this page · raw message

playbooks/roles/base_image/tasks/custom-image.yml new file +159 -0

159 lines not on this page · raw message

playbooks/roles/base_image/tasks/main.yml new file +19 -0
new file mode 100644
index 000000000000..a708fd8dff29
@@ -0,0 +1,19 @@
+---
+- name: Stat {{ base_image_pathname }}
+  ansible.builtin.stat:
+    path: "{{ base_image_pathname }}"
+    get_checksum: false
+    get_mime: false
+  register: result
+
+- name: Create custom upstream OS image
+  ansible.builtin.include_tasks:
+    file: "{{ role_path }}/tasks/custom_image.yml"
+  when:
+    - guestfs_has_custom_raw_image|bool
+
+- name: Create the base OS image
+  ansible.builtin.include_tasks:
+    file: "{{ role_path }}/tasks/base-image.yml"
+  when:
+    - not result.stat.exists
playbooks/roles/base_image/templates/custom-index.j2 new file +2 -0
new file mode 100644
index 000000000000..32edd8f9e1e5
@@ -0,0 +1,2 @@
+[{{ base_image_os_version }}]
+file={{ base_image_os_version }}.raw
playbooks/roles/base_image/templates/custom-source.j2 new file +3 -0
new file mode 100644
index 000000000000..cb4af83fb5f3
@@ -0,0 +1,3 @@
+[local]
+uri=file:///{{ custom_index }}
+proxy=off
playbooks/roles/base_image/templates/virt-builder.j2 new file +77 -0

77 lines not on this page · raw message

Signature · 1 line
2.49.0
#8 lore raw

PATCH v2 8/12 guestfs: Convert scripts/bringup_guestfs.sh to Ansible

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

The bringup_guestfs.sh is converted to Ansible to enable the virt-builder part of bring to run in parallel. This also gives us a fighting chance to integrate terraform and guestfs ssh key management in the future.

In addition to those benefits, the new Ansible code takes a stab at being more idempotent than the shell script was. Idempotency is achieved by checking that each guest is defined, and then defining it if not; then using community.libvirt.virt to boot the guest, which does nothing if the guest is already running.

---
 playbooks/guestfs.yml                         |   2 +-
 playbooks/roles/guestfs/defaults/main.yml     |   1 +
 .../guestfs/tasks/bringup/extra-disks.yml     |  16 +++
 .../roles/guestfs/tasks/bringup/largeio.yml   |  11 ++
 .../roles/guestfs/tasks/bringup/main.yml      | 132 ++++++++++++++++++
 playbooks/roles/guestfs/tasks/main.yml        |  29 ++++
 scripts/guestfs.Makefile                      |   1 -
 7 files changed, 190 insertions(+), 2 deletions(-)
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/extra-disks.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/largeio.yml
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/main.yml
playbooks/guestfs.yml +1 -1
index 8bb496e0f05a..784775cdb818 100644
@@ -1,6 +1,6 @@
 ---
 - name: Provision target nodes with libvirt/guestfs
-  gather_facts: false
+  gather_facts: true
   connection: local
   hosts: all
   roles:
playbooks/roles/guestfs/defaults/main.yml +1 -0
index e250a40fd27a..eec137bd730a 100644
@@ -2,3 +2,4 @@
 distro_debian_based: false
 
 libvirt_uri_system: false
+libvirt_enable_largeio: false
playbooks/roles/guestfs/tasks/bringup/extra-disks.yml new file +16 -0
new file mode 100644
index 000000000000..438b65ed5d3d
@@ -0,0 +1,16 @@
+---
+- name: Create the new drive image
+  ansible.builtin.command:
+    argv:
+      - "qemu-img"
+      - "create"
+      - "-f"
+      - "{{ libvirt_extra_drive_format }}"
+      - "{{ path }}"
+      - "100G"
+
+- name: Update the permission settings of the drive image file
+  ansible.builtin.file:
+    path: "{{ path }}"
+    group: "{{ libvirt_qemu_group }}"
+    mode: "g+rw,o-rw"
playbooks/roles/guestfs/tasks/bringup/largeio.yml new file +11 -0
new file mode 100644
index 000000000000..4246677d18d8
@@ -0,0 +1,11 @@
+---
+- name: Compute the total number of devices to build
+  ansible.builtin.set_fact:
+    total_devices: "{{ libvirt_largeio_pow_limit * libvirt_largeio_drives_per_space }}"
+
+- name: Create largeio block devices
+  ansible.builtin.include_tasks:
+    file: "{{ role_path }}/tasks/extra_disks.yml"
+  vars:
+    path: "{{ storagedir }}/{{ inventory_hostname }}/extra{{ item }}.{{ libvirt_extra_drive_format }}"
+  loop: "{{ range(0, total_devices) | list }}"
playbooks/roles/guestfs/tasks/bringup/main.yml new file +132 -0

132 lines not on this page · raw message

playbooks/roles/guestfs/tasks/main.yml +29 -0
index 6981d3c1a70b..8201c8a4dcb2 100644
@@ -21,6 +21,35 @@
   ansible.builtin.import_tasks:
     file: "{{role_path }}/tasks/bringup/network.yml"
 
+- name: Set the pathname of storage pool directory
+  tags:
+    - bringup
+  ansible.builtin.set_fact:
+    storagedir: "{{ kdevops_storage_pool_path }}/guestfs"
+
+- name: Set the pathname of the OS base image
+  tags:
+    - bringup
+  ansible.builtin.set_fact:
+    base_image: "{{ storagedir }}/base_images/{{ virtbuilder_os_version }}.raw"
+
+- name: Ensure the base OS image exists
+  delegate_to: localhost
+  run_once: true
+  tags:
+    - bringup
+  ansible.builtin.import_role:
+    name: base_image
+  vars:
+    base_image_os_version: "{{ virtbuilder_os_version }}"
+    base_image_pathname: "{{ base_image }}"
+
+- name: Bring up each target node
+  tags:
+    - bringup
+  ansible.builtin.import_tasks:
+    file: "{{role_path }}/tasks/bringup/main.yml"
+
 - name: Shut down and destroy each target node
   tags:
     - destroy
scripts/guestfs.Makefile +0 -1
index f2900a684960..0f0a8b858dba 100644
@@ -79,7 +79,6 @@ bringup_guestfs: $(GUESTFS_BRINGUP_DEPS)
 		-i hosts playbooks/guestfs.yml \
 		--extra-vars=@./extra_vars.yaml \
 		--tags bringup
-	$(Q)$(TOPDIR)/scripts/bringup_guestfs.sh
 	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
 		--inventory localhost, \
 		playbooks/bringup_guestfs.yml \
Signature · 1 line
2.49.0
#9 lore raw

PATCH v2 9/12 guestfs: Move console-related steps to guestfs role

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

Copy these steps to the guestfs role because my plan is to remove the bringup_guestfs role eventually.

---
 .../tasks/bringup/console-permissions.yml     | 31 +++++++++++++++++++
 playbooks/roles/guestfs/tasks/main.yml        | 10 ++++++
 scripts/guestfs.Makefile                      |  5 ---
 3 files changed, 41 insertions(+), 5 deletions(-)
 create mode 100644 playbooks/roles/guestfs/tasks/bringup/console-permissions.yml
playbooks/roles/guestfs/tasks/bringup/console-permissions.yml new file +31 -0
new file mode 100644
index 000000000000..ad169a4eab31
@@ -0,0 +1,31 @@
+---
+- name: Get the user who invoked Ansible
+  ansible.builtin.command:
+    cmd: whoami
+  register: reg_user
+  changed_when: false
+
+- name: Look for console.log files in guestfs subdirectories to check for CI enablement
+  become: true
+  become_flags: 'su - -c'
+  become_method: ansible.builtin.sudo
+  ansible.builtin.find:
+    paths: "{{ topdir_path }}/guestfs"
+    patterns: "console.log"
+    file_type: file
+    recurse: true
+  register: console_log_files
+
+- name: Ensure console.log files are owned by the main user for CI monitoring
+  become: true
+  become_flags: 'su - -c'
+  become_method: ansible.builtin.sudo
+  ansible.builtin.file:
+    path: "{{ item.path }}"
+    owner: "{{ reg_user.stdout }}"
+    group: "{{ reg_user.stdout }}"
+  loop: "{{ console_log_files.files }}"
+  loop_control:
+    label: "{{ item.path | regex_replace('^.*guestfs/', 'guestfs/') }}"
+  when:
+    - console_log_files.matched > 0
playbooks/roles/guestfs/tasks/main.yml +10 -0
index 8201c8a4dcb2..0cc9dc43cbe8 100644
@@ -50,6 +50,16 @@
   ansible.builtin.import_tasks:
     file: "{{role_path }}/tasks/bringup/main.yml"
 
+- name: Set up target node console permissions
+  delegate_to: localhost
+  run_once: true
+  tags:
+    - bringup
+  ansible.builtin.import_tasks:
+    file: "{{ role_path }}/tasks/bringup/console-permissions.yml"
+  when:
+    - libvirt_uri_system|bool
+
 - name: Shut down and destroy each target node
   tags:
     - destroy
scripts/guestfs.Makefile +0 -5
index 0f0a8b858dba..ebd7f53d1bde 100644
@@ -79,11 +79,6 @@ bringup_guestfs: $(GUESTFS_BRINGUP_DEPS)
 		-i hosts playbooks/guestfs.yml \
 		--extra-vars=@./extra_vars.yaml \
 		--tags bringup
-	$(Q)ansible-playbook $(ANSIBLE_VERBOSE) --connection=local \
-		--inventory localhost, \
-		playbooks/bringup_guestfs.yml \
-		--extra-vars=@./extra_vars.yaml \
-		--tags console-permissions
 PHONY += bringup_guestfs
 
 status_guestfs:
Signature · 1 line
2.49.0
#10 lore raw

PATCH v2 10/12 bringup_guestfs: Remove the role

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

Clean up: The tasks performed by the bringup_guestfs role have been superceded by the new guestfs role.

---
 playbooks/bringup_guestfs.yml                 |   4 -
 .../roles/bringup_guestfs/defaults/main.yml   |  12 -
 .../tasks/install-deps/debian/main.yml        |  11 -
 .../tasks/install-deps/main.yml               |  17 --
 .../tasks/install-deps/redhat/main.yml        |  11 -
 .../tasks/install-deps/suse/main.yml          |  10 -
 .../roles/bringup_guestfs/tasks/main.yml      | 243 ------------------
 7 files changed, 308 deletions(-)
 delete mode 100644 playbooks/bringup_guestfs.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/defaults/main.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/tasks/install-deps/debian/main.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/tasks/install-deps/main.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/tasks/install-deps/redhat/main.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/tasks/install-deps/suse/main.yml
 delete mode 100644 playbooks/roles/bringup_guestfs/tasks/main.yml
playbooks/bringup_guestfs.yml deleted +0 -4
deleted file mode 100644
index 80a1afcd0a69..000000000000
@@ -1,4 +0,0 @@
----
-- hosts: localhost
-  roles:
-    - role: bringup_guestfs
playbooks/roles/bringup_guestfs/defaults/main.yml deleted +0 -12
deleted file mode 100644
index 65867cd1093a..000000000000
@@ -1,12 +0,0 @@
-# SPDX-License-Identifier GPL-2.0+
----
-libvirt_uri_system: False
-distro_debian: False
-distro_debian_based: False
-distro_redhat: False
-distro_redhat_based: False
-distro_fedora: False
-distro_suse: False
-distro_suse_based: False
-distro_ubuntu: False
-dnsmasq_files_exist: False
playbooks/roles/bringup_guestfs/tasks/install-deps/debian/main.yml deleted +0 -11
deleted file mode 100644
index 6b502f59f3e4..000000000000
@@ -1,11 +0,0 @@
----
-- name: Install libguestfs
-  become: true
-  become_method: ansible.builtin.sudo
-  ansible.builtin.package:
-    update_cache: true
-    name:
-      - libguestfs-tools
-      - isc-dhcp-client
-    state: present
-  tags: ['install-deps']
playbooks/roles/bringup_guestfs/tasks/install-deps/main.yml deleted +0 -17
deleted file mode 100644
index af3be6dea3c3..000000000000
@@ -1,17 +0,0 @@
----
-- name: Debian-specific setup
-  ansible.builtin.include_tasks: debian/main.yml
-  when: ansible_facts['os_family']|lower == 'debian'
-  tags: ['install-deps']
-
-- name: SuSE-specific setup
-  ansible.builtin.include_tasks: suse/main.yml
-  when: ansible_facts['os_family']|lower == 'suse'
-  tags: ['install-deps']
-
-- name: Fedora/Red Hat Enterprise-specific setup
-  ansible.builtin.include_tasks: redhat/main.yml
-  when:
-    - ansible_facts['os_family']|lower == 'redhat'
-    - ansible_facts['distribution']|lower != "fedora"
-  tags: ['install-deps']
playbooks/roles/bringup_guestfs/tasks/install-deps/redhat/main.yml deleted +0 -11
deleted file mode 100644
index 5e4bfa9c9aeb..000000000000
@@ -1,11 +0,0 @@
----
-- name: Install libguestfs on Fedora/RedHat
-  become: true
-  become_method: ansible.builtin.sudo
-  ansible.builtin.package:
-    update_cache: true
-    name:
-      - libguestfs-tools
-      - dhcpcd
-    state: present
-  tags: ['install-deps']
playbooks/roles/bringup_guestfs/tasks/install-deps/suse/main.yml deleted +0 -10
deleted file mode 100644
index 730bc20b5a7b..000000000000
@@ -1,10 +0,0 @@
----
-- name: Install libguestfs on SUSE
-  become: true
-  become_method: ansible.builtin.sudo
-  ansible.builtin.package:
-    name:
-      - libguestfs-tools
-      - dhcpcd
-    state: present
-  tags: ['install-deps']
playbooks/roles/bringup_guestfs/tasks/main.yml deleted +0 -243

243 lines not on this page · raw message

Signature · 1 line
2.49.0
#11 lore raw

PATCH v2 11/12 scripts: Remove the bringup_guestfs.sh script

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

Clean up: This script is no longer used.

---
 scripts/bringup_guestfs.sh | 391 -------------------------------------
 1 file changed, 391 deletions(-)
 delete mode 100755 scripts/bringup_guestfs.sh
scripts/bringup_guestfs.sh deleted +0 -391
deleted file mode 100755
index 55b13a0cb2cc..000000000000
@@ -1,391 +0,0 @@
-#!/bin/bash
-# SPDX-License-Identifier: copyleft-next-0.3.1
-
-[ -z "${TOPDIR}" ] && TOPDIR='.'
-source ${TOPDIR}/.config
-source ${TOPDIR}/scripts/lib.sh
-
-if [[ "${CONFIG_GUESTFS_BRINGUP_DEBUG_0+x}" && \
-	   "${CONFIG_GUESTFS_BRINGUP_DEBUG_0}" == "y" ]]; then
-	set -x
-fi
-
-if [[ "${CONFIG_GUESTFS_BRINGUP_DEBUG_1+x}" && \
-	  "${CONFIG_GUESTFS_BRINGUP_DEBUG_1}" == "y" ]]; then
-	set -euxo pipefail
-fi
-
-export LIBVIRT_DEFAULT_URI=$CONFIG_LIBVIRT_URI
-
-# We use the NVMe setting for virtio too (go figure), but IDE
-# requires qcow2
-#
-IMG_FMT="qcow2"
-if [ "${CONFIG_LIBVIRT_EXTRA_DRIVE_FORMAT_RAW}" = "y" ]; then
-	IMG_FMT="raw"
-fi
-STORAGEDIR="${CONFIG_LIBVIRT_STORAGE_POOL_PATH}/${CONFIG_KDEVOPS_STORAGE_POOL_USER}/guestfs"
-QEMU_GROUP=$CONFIG_LIBVIRT_QEMU_GROUP
-GUESTFSDIR="${TOPDIR}/guestfs"
-OS_VERSION=${CONFIG_VIRT_BUILDER_OS_VERSION}
-BASE_IMAGE_DIR="${STORAGEDIR}/base_images"
-BASE_IMAGE="${BASE_IMAGE_DIR}/${OS_VERSION}.raw"
-
-build_custom_source()
-{
-	SOURCE_TMP=$(mktemp)
-	cat <<_EOT >$SOURCE_TMP
-[local]
-uri=file:///${CUSTOM_INDEX}
-proxy=off
-_EOT
-	sudo mv $SOURCE_TMP $CUSTOM_SOURCE
-}
-
-build_custom_index()
-{
-	cat <<_EOT >$CUSTOM_INDEX
-[$OS_VERSION]
-file=${OS_VERSION}.raw
-_EOT
-}
-
-fetch_custom_image()
-{
-	wget --directory-prefix=$CUSTOM_IMAGE_DIR $CONFIG_GUESTFS_CUSTOM_RAW_IMAGE_URL
-	if [[ $? -ne 0 ]]; then
-		echo -e "Could not download:\n$CONFIG_GUESTFS_CUSTOM_RAW_IMAGE_URL"
-		exit 1
-	fi
-}
-
-check_custom_image()
-{
-	SHA512SUMS_FILE="$(basename $CONFIG_GUESTFS_CUSTOM_RAW_IMAGE_SHA512SUMS_URL)"
-	CUSTOM_IMAGE_SHA512SUM="$CUSTOM_IMAGE_DIR/$SHA512SUMS_FILE"
-	if [[ ! -f $CUSTOM_IMAGE_SHA512SUM ]]; then
-		wget --directory-prefix=$CUSTOM_IMAGE_DIR $CONFIG_GUESTFS_CUSTOM_RAW_IMAGE_SHA512SUMS_URL
-		if [[ $? -ne 0 ]]; then
-			echo "Could not get sha512sum file: $CONFIG_GUESTFS_CUSTOM_RAW_IMAGE_SHA512SUMS_URL"
-			exit 1
-		fi
-	fi
-	echo "Checking $CUSTOM_IMAGE_DIR/$SHA512SUMS_FILE"
-
-	# This subshell let's us keep below in the current directory.
-	# sha512sum files are relative to the local directory
-	(cd $CUSTOM_IMAGE_DIR && sha512sum --ignore-missing -c $SHA512SUMS_FILE)
-	if [[ $? -ne 0 ]]; then
-		echo "Invalid SHA512SUM checksum for $CUSTOM_IMAGE as per $SHA512SUMS_FILE"
-		exit 1
-	fi
-	touch $CUSTOM_IMAGE_OK
-}
-
-# Ensure folks are not surprised. If you're using rolling distros you know what
-# you are doing. This gives us the right later to change this at will.
-#
-# In the future we can make this smoother, as we used to have it with vagrant
-# update, but for now downloading *once* for a rolling distro seems ok to start.
-# We give enough information so you can update.
-build_warn_rolling_distro()
-{
-	echo "------------------------------------------------------------------"
-	echo "This is a rolling distribution release! To upgrade just do:"
-	echo
-	echo "rm -rf ${CUSTOM_IMAGE}/*"
-	echo "rm -f  ${CUSTOM_SOURCE}"
-	echo "rm -f  ${CUSTOM_INDEX}"
-	echo
-	echo "Running guests always use their own copy. To rebuild your custom"
-	echo "base image from the custom image, also remove the base image:"
-	echo
-	echo "rm -f  ${BASE_IMAGE}"
-	echo
-	echo "This can always be done safely without affecting running guests."
-	echo "------------------------------------------------------------------"
-}
-
-build_custom_image()
-{
-	CUSTOM_IMAGE_DIR="${STORAGEDIR}/custom_images/${OS_VERSION}"
-	CUSTOM_IMAGE="${CUSTOM_IMAGE_DIR}/${OS_VERSION}.raw"
-	CUSTOM_IMAGE_OK="${CUSTOM_IMAGE_DIR}.ok"
-	CUSTOM_SOURCE="/etc/virt-builder/repos.d/kdevops-custom-images-${OS_VERSION}.conf"
-	mkdir -p ${CUSTOM_IMAGE_DIR}
-	CUSTOM_INDEX="$(realpath ${CUSTOM_IMAGE_DIR}/index)"
-
-	if [[ ! -f $CUSTOM_IMAGE && "$CONFIG_GUESTFS_HAS_CUSTOM_RAW_IMAGE_URL" == "y" ]]; then
-		fetch_custom_image
-	fi
-
-	if [[ ! -f $CUSTOM_IMAGE_OK && "$CONFIG_GUESTFS_HAS_CUSTOM_RAW_IMAGE_SHA512SUMS" == "y" ]]; then
-		check_custom_image
-	fi
-
-	if [[ ! -f $CUSTOM_IMAGE ]]; then
-		echo "Custom image on path $CUSTOM_IMAGE not found"
-		exit 1
-	fi
-
-	if [[ ! -f $CUSTOM_SOURCE ]]; then
-		build_custom_source
-	fi
-
-	if [[ ! -f $CUSTOM_INDEX ]]; then
-		build_custom_index
-	fi
-
-	echo "Custom virt-builder source: $CUSTOM_SOURCE"
-	echo "Custom virt-builder index:  $CUSTOM_INDEX"
-	echo "Custom image source:        $CUSTOM_IMAGE"
-
-	if [[ "$CONFIG_GUESTFS_HAS_CUSTOM_RAW_IMAGE_ROLLING" == "y" ]]; then
-		build_warn_rolling_distro
-	fi
-
-	echo "Going to build index for $OS_VERSION ..."
-	virt-builder-repository --no-compression $CUSTOM_IMAGE_DIR
-	if [[ $? -ne 0 ]]; then
-		echo "Failed to build repository ..."
-		exit 1
-	fi
-
-	# Note, we don't build $BASE_IMAGE, virt-builder does that later. We
-	# just build $virt-builder, which is the pristine upstream image.
-}
-
-handle_rhel_activation()
-{
-	if [ -n "$CONFIG_RHEL_ORG_ID" -a -n "$CONFIG_RHEL_ACTIVATION_KEY" ]; then
-		DO_UNREG=1
-		cat <<_EOT >>$cmdfile
-run-command subscription-manager register --org=${CONFIG_RHEL_ORG_ID} --activationkey=${CONFIG_RHEL_ACTIVATION_KEY}
-_EOT
-	fi
-}
-
-handle_rhel_unreg()
-{
-	cat <<_EOT >>$cmdfile
-sm-unregister
-_EOT
-}
-
-copy_yum_repo()
-{
-	cat <<_EOT >>$cmdfile
-copy-in $CONFIG_KDEVOPS_CUSTOM_YUM_REPOFILE:/etc/yum.repos.d
-_EOT
-}
-
-copy_host_sources()
-{
-	TARGET_DIR="$(dirname $CONFIG_GUESTFS_DISTRO_SOURCE_AND_DEST_FILE)"
-	cat <<_EOT >>$cmdfile
-mkdir $TARGET_DIR
-copy-in $CONFIG_GUESTFS_DISTRO_SOURCE_AND_DEST_FILE:$TARGET_DIR
-_EOT
-}
-
-pre_install_customizations()
-{
-	KDEVOPS_UID=""
-	if getent passwd kdevops > /dev/null 2>&1; then
-		KDEVOPS_UID="-u `id -u kdevops`"
-	fi
-	if echo $OS_VERSION | grep -qE "^(rhel|fedora|centos)"; then
-		UPDATE_GRUB_CMD="/usr/sbin/grub2-mkconfig -o /boot/grub2/grub.cfg"
-	else
-		UPDATE_GRUB_CMD="/usr/sbin/update-grub2"
-	fi
-	cat <<_EOT >>$cmdfile
-install sudo,qemu-guest-agent,python3,bash
-run-command useradd ${KDEVOPS_UID} -s /bin/bash -m kdevops
-append-line /etc/sudoers.d/kdevops:kdevops   ALL=(ALL)       NOPASSWD: ALL
-edit /etc/default/grub:s/^GRUB_CMDLINE_LINUX_DEFAULT=.*/GRUB_CMDLINE_LINUX_DEFAULT="console=ttyS0"/
-run-command $UPDATE_GRUB_CMD
-root-password password:kdevops
-_EOT
-}
-
-# Ugh, debian has to be told to bring up the network and regenerate ssh keys
-# Hope we get that interface name right!
-debian_pre_install_hacks()
-{
-	cat <<_EOT >>$cmdfile
-install isc-dhcp-client,ifupdown
-mkdir /etc/network/interfaces.d/
-append-line /etc/network/interfaces.d/enp1s0:auto enp1s0
-append-line /etc/network/interfaces.d/enp1s0:allow-hotplug enp1s0
-append-line /etc/network/interfaces.d/enp1s0:iface enp1s0 inet dhcp
-firstboot-command systemctl disable systemd-networkd-wait-online.service
-firstboot-command systemctl stop ssh
-firstboot-command DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true dpkg-reconfigure -p low --force openssh-server
-firstboot-command systemctl start ssh
-firstboot-command apt update && apt upgrade --yes
-uninstall unattended-upgrades
-_EOT
-	# CONFIG_GUESTFS_COPY_SOURCES_FROM_HOST_TO_GUEST will not work
-	# if /etc/nsswitch.conf has a line like this:
-	#
-	# hosts:          files myhostname resolve [!UNAVAIL=return] dns
-	#
-	# We need DNS to be used so virb0 will be used for a DNS request
-	# For the life of me I can't get the following line to work with
-	# the virt-builder command and so we do a full edit of the file for now
-	# edit /etc/nsswitch.conf:'s/\[!UNAVAIL=return\]//'
-	if [[ "${CONFIG_GUESTFS_DEBIAN_TRIXIE+x}" && \
-		  "$CONFIG_GUESTFS_DEBIAN_TRIXIE" == "y" ]]; then
-		cat <<_EOT >>$cmdfile
-write /etc/nsswitch.conf: # kdevops generated /etc/nsswitch.conf
-append-line /etc/nsswitch.conf:passwd:         files
-append-line /etc/nsswitch.conf:group:          files
-append-line /etc/nsswitch.conf:shadow:         files
-append-line /etc/nsswitch.conf:gshadow:        files
-append-line /etc/nsswitch.conf:hosts:          files myhostname resolve dns
-append-line /etc/nsswitch.conf:networks:       files
-append-line /etc/nsswitch.conf:protocols:      db files
-append-line /etc/nsswitch.conf:services:       db files
-append-line /etc/nsswitch.conf:ethers:         db files
-append-line /etc/nsswitch.conf:rpc:            db files
-append-line /etc/nsswitch.conf:netgroup:       nis
-uninstall cloud-init
-write /etc/default/locale:LANG=en_US.UTF-8
-append-line /etc/default/locale:LANGUAGE=en_US:en
-write /etc/locale.gen:en_US.UTF-8 UTF-8
-firstboot-command locale-gen en_US.UTF-8
-firstboot-command update-locale LANG=en_US.UTF-8
-firstboot-command DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true dpkg-reconfigure -p low --force locales
-firstboot-command systemctl stop ssh
-firstboot-command systemctl start ssh
-_EOT
-		if [[ "${CONFIG_GUESTFS_COPY_SOURCES_FROM_HOST_TO_GUEST+x}" && \
-			  "$CONFIG_GUESTFS_COPY_SOURCES_FROM_HOST_TO_GUEST" == "y" ]]; then
-		cat <<_EOT >>$cmdfile
-delete /etc/apt/sources.list.d/debian.sources
-_EOT
-		fi
-	fi
-}
-
-USE_SUDO=""
-if [[ "$CONFIG_LIBVIRT_URI_SYSTEM" == "y" ]]; then
-	USE_SUDO="sudo "
-fi
-
-cmdfile=$(mktemp)
-
-if [ ! -f $BASE_IMAGE ]; then
-	if [[ "${CONFIG_GUESTFS_HAS_CUSTOM_RAW_IMAGE+x}" && \
-		  "$CONFIG_GUESTFS_HAS_CUSTOM_RAW_IMAGE" == "y" ]]; then
-		build_custom_image
-	fi
-
-	DO_UNREG=0
-	if echo $OS_VERSION | grep -q '^rhel'; then
-		handle_rhel_activation
-	fi
-
-	if [ -n "$CONFIG_KDEVOPS_CUSTOM_YUM_REPOFILE" ]; then
-		copy_yum_repo
-	fi
-
-	if [[ "${CONFIG_GUESTFS_COPY_SOURCES_FROM_HOST_TO_GUEST+x}" && \
-		  "$CONFIG_GUESTFS_COPY_SOURCES_FROM_HOST_TO_GUEST" == "y" ]]; then
-		copy_host_sources
-	fi
-
-	pre_install_customizations
-
-	if [ $DO_UNREG -ne 0 ]; then
-		handle_rhel_unreg
-	fi
-
-	if echo $OS_VERSION | grep -q '^debian'; then
-		debian_pre_install_hacks
-	fi
-
-	echo "Generating new base image for ${OS_VERSION}"
-	$USE_SUDO virt-builder ${OS_VERSION} --arch `uname -m` -o $BASE_IMAGE --size 20G --format raw --commands-from-file $cmdfile
-	if [[ $? -ne 0 ]]; then
-		echo "Failed to build custom image $BASE_IMAGE"
-		exit 1
-	fi
-fi
-
-# FIXME: is there a yaml equivalent of jq?
-grep -e '^  - name: ' ${TOPDIR}/guestfs/kdevops_nodes.yaml | sed 's/^  - name: //' | while read name
-do
-	#
-	# If the guest is already defined, then just stop what we're doing
-	# and plead to the developer to clean things up.
-	#
-	if virsh list --all | grep --quiet --word-regexp "$name"; then
-		output_domstate=$(virsh domstate $name 2>/dev/null)
-		echo "Domain $name is already defined. (state: $output_domstate)"
-		if [ "$output_domstate" != "running" ]; then
-			virsh start $name
-		fi
-		exit 0
-	fi
-
-	SSH_KEY_DIR="${GUESTFSDIR}/$name/ssh"
-	SSH_KEY="${SSH_KEY_DIR}/id_ed25519"
-
-	# Generate a new ssh key
-	mkdir -p "$SSH_KEY_DIR"
-	chmod 0700 "$SSH_KEY_DIR"
-	rm -f $SSH_KEY $SSH_KEY.pub
-	ssh-keygen -q -t ed25519 -f $SSH_KEY -N ""
-
-	mkdir -p "$STORAGEDIR/$name"
-
-	# Copy the base image and prep it
-	ROOTIMG="$STORAGEDIR/$name/root.raw"
-	cp --reflink=auto $BASE_IMAGE $ROOTIMG
-	TZ="$(timedatectl show -p Timezone --value)"
-	$USE_SUDO virt-sysprep -a $ROOTIMG --hostname $name --ssh-inject "kdevops:file:$SSH_KEY.pub" --timezone $TZ
-
-	if [[ "${CONFIG_LIBVIRT_ENABLE_LARGEIO+x}" && \
-		  "$CONFIG_LIBVIRT_ENABLE_LARGEIO" == "y" ]]; then
-		lbs_idx=0
-		for i in $(seq 1 $(($CONFIG_QEMU_LARGEIO_MAX_POW_LIMIT+1))); do
-			for x in $(seq 0 $CONFIG_QEMU_EXTRA_DRIVE_LARGEIO_NUM_DRIVES_PER_SPACE); do
-				diskimg="$STORAGEDIR/$name/extra${lbs_idx}.${IMG_FMT}"
-				rm -f $diskimg
-				qemu-img create -f $IMG_FMT "$diskimg" 100G
-				if [[ "$CONFIG_LIBVIRT_URI_SYSTEM" == "y" ]]; then
-					chmod g+rw $diskimg
-					chgrp $QEMU_GROUP $diskimg
-				fi
-				let lbs_idx=$lbs_idx+1
-			done
-		done
-	else
-		# build some extra disks
-		for i in $(seq 0 3); do
-			diskimg="$STORAGEDIR/$name/extra${i}.${IMG_FMT}"
-			rm -f $diskimg
-			qemu-img create -f $IMG_FMT "$STORAGEDIR/$name/extra${i}.$IMG_FMT" 100G
-			if [[ "$CONFIG_LIBVIRT_URI_SYSTEM" == "y" ]]; then
-				chmod g+rw $STORAGEDIR/$name/extra${i}.$IMG_FMT
-				chgrp $QEMU_GROUP $STORAGEDIR/$name/extra${i}.$IMG_FMT
-			fi
-		done
-	fi
-
-	virsh define $GUESTFSDIR/$name/$name.xml
-	XML_DEVICES_COUNT=$(find $GUESTFSDIR/$name/ -name pcie_passthrough_*.xml | wc -l)
-	if [[ $XML_DEVICES_COUNT -gt 0 ]]; then
-		for xml in $GUESTFSDIR/$name/pcie_passthrough_*.xml; do
-			echo "Doing PCI-E passthrough for device $xml"
-			virsh attach-device $name $xml --config
-		done
-	fi
-	virsh start $name
-	if [[ $? -ne 0 ]]; then
-		echo "Failed to start $name"
-		exit 1
-	fi
-done
Signature · 1 line
2.49.0
#12 lore raw

PATCH v2 12/12 scripts: Remove the destroy_guestfs.sh script

In reply to Chuck Lever

From: Chuck Lever <[email protected]>

Clean up: This script is no longer used.

---
 scripts/destroy_guestfs.sh | 36 ------------------------------------
 1 file changed, 36 deletions(-)
 delete mode 100755 scripts/destroy_guestfs.sh
scripts/destroy_guestfs.sh deleted +0 -36
deleted file mode 100755
index dfbb4f15f4ca..000000000000
@@ -1,36 +0,0 @@
-#!/bin/bash
-# SPDX-License-Identifier: copyleft-next-0.3.1
-
-[ -z "${TOPDIR}" ] && TOPDIR='.'
-source ${TOPDIR}/.config
-source ${TOPDIR}/scripts/lib.sh
-
-export LIBVIRT_DEFAULT_URI=$CONFIG_LIBVIRT_URI
-
-STORAGEDIR="${CONFIG_LIBVIRT_STORAGE_POOL_PATH}/${CONFIG_KDEVOPS_STORAGE_POOL_USER}/guestfs"
-GUESTFSDIR="${TOPDIR}/guestfs"
-
-if [ -f "$GUESTFSDIR/kdevops_nodes.yaml" ]; then
-	# FIXME: is there a yaml equivalent to jq ?
-	grep -e '^  - name: ' "${GUESTFSDIR}/kdevops_nodes.yaml"  | sed 's/^  - name: //' | while read name
-	do
-		domstate=$(virsh domstate $name 2>/dev/null)
-		if [ $? -eq 0 ]; then
-			if [ "$domstate" = 'running' ]; then
-				virsh destroy $name
-			fi
-			virsh undefine --nvram $name
-		fi
-		rm -rf "$GUESTFSDIR/$name"
-		rm -rf "$STORAGEDIR/$name"
-		ssh-keygen -q -f ~/.ssh/known_hosts -R $name 1> /dev/null 2>&1
-	done
-fi
-
-if [[ "$CONFIG_TOPDIR_PATH_HAS_SHA256SUM" == "y" ]]; then
-	rm -f ~/.ssh/config_kdevops_$CONFIG_TOPDIR_PATH_SHA256SUM
-else
-	rm -f ~/.ssh/config_kdevops_$CONFIG_KDEVOPS_HOSTS_PREFIX
-fi
-rm -f $GUESTFSDIR/.provisioned_once
-rm -f $GUESTFSDIR/kdevops_nodes.yaml
Signature · 1 line
2.49.0
#13 lore raw
In reply to Chuck Lever
Quoted 9 lines · Chuck Lever

From: Chuck Lever <[email protected]>

This series demonstrates some ideas about how libvirt/guestfs bring- up might be expressed using only Ansible (ie. with a minimal use of shell scripting). Benefits include:

- Starting guests is now done in parallel
- "make bringup" is more idempotent
- Lets us create utilities that both guestfs and Terraform can use

All looks good but I would have removed parts of the script as its replacement is added on ansible piece-meal wise. But at this point I'd rather have this merged than ask for a respin.

Quoted 2 lines

The new parts that handle custom upstream images has not yet been tested.

What is missing exactly here to test, is this just to test to ensure that debian testing custom images work?

Luis

#14 lore raw
Quoted 7 lines · Luis Chamberlain
Quoted 6 lines · Chuck Lever

From: Chuck Lever <[email protected]>

This series demonstrates some ideas about how libvirt/guestfs bring- up might be expressed using only Ansible (ie. with a minimal use of shell scripting). Benefits include:

Quoted 6 lines
Quoted 3 lines

- Starting guests is now done in parallel
- "make bringup" is more idempotent
- Lets us create utilities that both guestfs and Terraform can use

All looks good but I would have removed parts of the script as its replacement is added on ansible piece-meal wise.

I tried that way at first, actually. It made each patch more messy and the series difficult to re-order.

Quoted 7 lines

But at this point
I'd rather have this merged than ask for a respin.

Quoted 2 lines
Quoted 1 line

The new parts that handle custom upstream images has not yet been

tested.

What is missing exactly here to test, is this just to test to ensure that debian testing custom images work?

Well I've never had need to use the custom image mechanism, so I'm not real sure what are the use cases that should be tested. My usual wheelhouse is Fedora, not Debian, fwiw.

The first 6 patches are probably well enough tested to push now. Let me know if you have ideas about how to test custom images, or we can push everything now and just fix the bugs as they are found.

Signature · 1 line
Chuck Lever
#15 lore raw
Quoted 12 lines · Chuck Lever
Quoted 11 lines · Luis Chamberlain
Quoted 9 lines · Chuck Lever

From: Chuck Lever <[email protected]>

This series demonstrates some ideas about how libvirt/guestfs bring- up might be expressed using only Ansible (ie. with a minimal use of shell scripting). Benefits include:

- Starting guests is now done in parallel
- "make bringup" is more idempotent
- Lets us create utilities that both guestfs and Terraform can use

Quoted 5 lines
Quoted 2 lines

All looks good but I would have removed parts of the script as its replacement is added on ansible piece-meal wise.

I tried that way at first, actually. It made each patch more messy and the series difficult to re-order.

Oh wow! Hopefully LLMs will pick up the delta between different commits. I menion this as I expect each kdevops commit later to be useful for further automation / conversions.

Quoted 8 lines
Quoted 7 lines

But at this point
I'd rather have this merged than ask for a respin.

Quoted 2 lines
Quoted 1 line

The new parts that handle custom upstream images has not yet been

tested.

What is missing exactly here to test, is this just to test to ensure that debian testing custom images work?

Quoted 7 lines

Well I've never had need to use the custom image mechanism, so I'm not real sure what are the use cases that should be tested. My usual wheelhouse is Fedora, not Debian, fwiw.

Let
me know if you have ideas about how to test custom images, or we can push everything now and just fix the bugs as they are found.

Let's just merge it all!

Luis