Publish roles and playbooks as Ansible galaxy collection

.github/workflows/ansible-galaxy.yml

@@ -0,0 +1,23 @@
+---
+name: Release
+run-name: Release Ansible Galaxy Collection
+on:
+  push:
+    tags:
+    - 'v[0-9]+.[0-9]+.[0-9]+*'
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Ansible Publish Linux/UNIX
+      uses: artis3n/ansible_galaxy_collection@v2
+      with:
+        api_key: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
+        collection_dir: "images/capi/ansible/"
+    - name: Ansible Publish Windows
+      uses: artis3n/ansible_galaxy_collection@v2
+      with:
+        api_key: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
+        collection_dir: "images/capi/ansible/windows/"

.gitignore

@@ -1,3 +1,4 @@
 .vscode/
 .idea/
 .venv/
+*.tar.gz

README.md

@@ -9,6 +9,7 @@ Image Builder is a tool for building Kubernetes virtual machine images across mu
 ### Useful links
 
 - [Quick Start for Cluster API Image Builder](https://image-builder.sigs.k8s.io/capi/quickstart.html)
+- [Ansible Galaxy Collection](https://galaxy.ansible.com/ui/repo/published/kubernetes_sigs/image_builder/)
 
 ## Community, discussion, contribution, and support
 

docs/book/src/capi/windows/windows.md

@@ -63,7 +63,7 @@ ansible_connection=winrm
 ansible_winrm_server_cert_validation=ignore
 ```
 
-Then run: `ansible-playbook -vvv node_windows.yml --extra-vars "@example.vars.yml`
+Then run: `ansible-playbook -vvv playbooks/node_windows.yml --extra-vars "@example.vars.yml`
 
 ## macOS with ansible
 The WinRM connection plugin for Ansible on macOS causes connection issues which can result in `ERROR! A worker was found in a dead state`. See https://docs.ansible.com/ansible/latest/user_guide/windows_winrm.html#what-is-winrm for more details.
@@ -75,7 +75,7 @@ To fix the issue on macOS is to set the no_proxy environment variable. Example:
 ```
 
 ## Annual Channel
-The [Windows Server Annual](https://techcommunity.microsoft.com/t5/windows-server-news-and-best/windows-server-annual-channel-for-containers/ba-p/3866248) channel licensing  requires users to host their own image.  
+The [Windows Server Annual](https://techcommunity.microsoft.com/t5/windows-server-news-and-best/windows-server-annual-channel-for-containers/ba-p/3866248) channel licensing  requires users to host their own image.
 
 In Azure this can be uploaded to an [Azure SIG](https://learn.microsoft.com/en-us/azure/virtual-machines/azure-compute-gallery), and the following environment variables should be set to use the source [shared image gallery](https://developer.hashicorp.com/packer/integrations/hashicorp/azure/v1.4.5/components/builder/arm#shared-image-gallery).
 

images/capi/.ansible-lint-ignore

@@ -1,10 +1,10 @@
 # This file contains ignores rule violations for ansible-lint
-ansible/firstboot.yml name[missing]
-ansible/firstboot.yml name[play]
-ansible/node.yml name[missing]
-ansible/node.yml name[play]
-ansible/python.yml name[missing]
-ansible/python.yml name[play]
+ansible/playbooks/firstboot.yml name[missing]
+ansible/playbooks/firstboot.yml name[play]
+ansible/playbooks/node.yml name[missing]
+ansible/playbooks/node.yml name[play]
+ansible/playbooks/python.yml name[missing]
+ansible/playbooks/python.yml name[play]
 ansible/roles/containerd/tasks/main.yml name[missing]
 ansible/roles/containerd/tasks/main.yml risky-file-permissions
 ansible/roles/containerd/tasks/photon.yml no-changed-when
@@ -117,10 +117,10 @@ ansible/roles/sysprep/tasks/redhat.yml name[missing]
 ansible/roles/sysprep/tasks/redhat.yml no-changed-when
 ansible/roles/sysprep/tasks/rpm_repos.yml no-changed-when
 ansible/windows/example.vars.yml yaml[line-length]
-ansible/windows/node_windows.yml name[missing]
-ansible/windows/node_windows.yml name[play]
-ansible/windows/node_windows.yml schema[playbook]
-ansible/windows/roles/cloudbase-init/tasks/main.yml schema[tasks]
+ansible/windows/playbooks/node_windows.yml name[missing]
+ansible/windows/playbooks/node_windows.yml name[play]
+ansible/windows/playbooks/node_windows.yml schema[playbook]
+ansible/windows/roles/cloudbase_init/tasks/main.yml schema[tasks]
 ansible/windows/roles/debug/defaults/main.yml var-naming[no-role-prefix]
 ansible/windows/roles/gmsa/tasks/main.yml name[missing]
 ansible/windows/roles/kubernetes/tasks/kubelet.yml name[missing]

images/capi/.gitignore

@@ -7,6 +7,7 @@
 /.local/bin/
 manifest.json
 **.DS_Store
+*.tar.gz
 
 # Goss test droppings
 debug-goss-spec.yaml

images/capi/Makefile

@@ -1243,3 +1243,16 @@ update-centos-9-iso-checksums: ## Updates checksums for Centos 9 ISOs
 update-photon-iso-checksums: ## Updates checksums for Photon ISOs
 	hack/update-iso-checksums.sh photon true
 	$(MAKE) json-sort
+
+.PHONY: ansible-galaxy-build-linux
+ansible-galaxy-build-linux:
+	ansible-galaxy collection build ansible/
+
+.PHONY: ansible-galaxy-build-windows
+ansible-galaxy-build-windows:
+	ansible-galaxy collection build ansible/windows
+
+.PHONY: ansible-galaxy-publish
+ansible-galaxy-publish: ansible-galaxy-build-linux ansible-galaxy-build-windows
+	ansible-galaxy collection publish --api-key "${ANSIBLE_GALAXY_API_KEY}" ansible/
+	ansible-galaxy collection publish --api-key "${ANSIBLE_GALAXY_API_KEY}" ansible/windows/

images/capi/ansible/.gitignore

@@ -1 +1,2 @@
-*.pyc
+*.pyc
+*.tar.gz

images/capi/ansible/LICENSE

@@ -0,0 +1 @@
+../../../LICENSE

images/capi/ansible/README.md

@@ -0,0 +1,3 @@
+# Ansible Galaxy Collection: kubernetes_sigs.image_builder
+
+Collection of ansible roles that install and configure Kubernetes orchestrator and related software compatible with UNIX and Linux operating systems.

images/capi/ansible/galaxy.yml

@@ -0,0 +1,17 @@
+namespace: kubernetes_sigs
+name: image_builder
+version: 0.2.0
+readme: "README.md"
+authors:
+- image-builder-maintainers (see OWNERS_ALIASES)
+description: Collection of ansible roles that install and configure Kubernetes orchestrator and related software compatible with UNIX and Linux operating systems.
+license_file: 'LICENSE'
+tags: ["kubernetes", "k8s", "image_building"]
+dependencies: {}
+repository: https://github.com/kubernetes-sigs/image-builder
+documentation: https://image-builder.sigs.k8s.io/
+homepage: https://image-builder.sigs.k8s.io/
+issues: https://github.com/kubernetes-sigs/image-builder/issues
+build_ignore:
+- windows
+- "*.tar.gz"

images/capi/ansible/meta/runtime.yml

@@ -0,0 +1,2 @@
+---
+requires_ansible: '>=2.15,<2.16'

images/capi/ansible/firstboot.yml → images/capi/ansible/playbooks/firstboot.yml

@@ -42,7 +42,7 @@
         loop_var: role
       when: firstboot_custom_roles_pre != ""
     - ansible.builtin.include_role:
-        name: firstboot
+        name: kubernetes_sigs.image_builder.firstboot
     - ansible.builtin.include_role:
         name: "{{ role }}"
       loop: "{{ firstboot_custom_roles_post.split() }}"

images/capi/ansible/node.yml → images/capi/ansible/playbooks/node.yml

@@ -27,18 +27,18 @@
         loop_var: role
       when: node_custom_roles_pre != ""
     - ansible.builtin.include_role:
-        name: node
+        name: kubernetes_sigs.image_builder.node
     - ansible.builtin.include_role:
-        name: providers
+        name: kubernetes_sigs.image_builder.providers
     - ansible.builtin.include_role:
-        name: containerd
+        name: kubernetes_sigs.image_builder.containerd
     - ansible.builtin.include_role:
-        name: kubernetes
+        name: kubernetes_sigs.image_builder.kubernetes
     - ansible.builtin.include_role:
-        name: load_additional_components
+        name: kubernetes_sigs.image_builder.load_additional_components
       when: load_additional_components | bool
     - ansible.builtin.include_role:
-        name: ecr_credential_provider
+        name: kubernetes_sigs.image_builder.ecr_credential_provider
       when: ecr_credential_provider | bool
     - ansible.builtin.include_role:
         name: "{{ role }}"
@@ -47,7 +47,7 @@
         loop_var: role
       when: custom_role_names != "" or node_custom_roles_post != ""
     - ansible.builtin.include_role:
-        name: sysprep
+        name: kubernetes_sigs.image_builder.sysprep
 
   environment:
     http_proxy: "{{ http_proxy | default('') }}"

images/capi/ansible/python.yml → images/capi/ansible/playbooks/python.yml

@@ -20,7 +20,7 @@
 
   tasks:
     - ansible.builtin.include_role:
-        name: python
+        name: kubernetes_sigs.image_builder.python
 
   environment:
     http_proxy: "{{ http_proxy | default('') }}"

images/capi/ansible/roles/containerd/README.md

@@ -0,0 +1 @@
+# Containerd Ansible Role

images/capi/ansible/roles/ecr_credential_provider/README.md

@@ -0,0 +1 @@
+# ECR Credential Ansible Role

images/capi/ansible/roles/firstboot/README.md

@@ -1,2 +1,4 @@
+# Firstboot Ansible Role
+
 This role is to be used for operating systems that require some operations
 that require a reboot.

images/capi/ansible/roles/kubernetes/README.md

@@ -0,0 +1 @@
+# Kubernetes Ansible Role

images/capi/ansible/roles/load_additional_components/README.md

@@ -0,0 +1 @@
+# Load Additional Component Ansible Role

images/capi/ansible/roles/node/README.md

@@ -0,0 +1 @@
+# Node Ansible Role

images/capi/ansible/roles/providers/README.md

@@ -0,0 +1 @@
+# Providers Ansible Role

images/capi/ansible/roles/python/README.md

@@ -0,0 +1 @@
+# Python Ansible Role

images/capi/ansible/roles/setup/README.md

@@ -0,0 +1 @@
+# Setup Ansible Role

images/capi/ansible/roles/sysprep/README.md

@@ -0,0 +1 @@
+# Sysprep Ansible Role

images/capi/ansible/windows/LICENSE

@@ -0,0 +1 @@
+../../../../LICENSE

images/capi/ansible/windows/README.md

@@ -0,0 +1,3 @@
+# Ansible Galaxy Collection: kubernetes_sigs.image_builder_windows
+
+Collection of ansible roles that install and configure Kubernetes orchestrator and related software compatible with Windows operating system.

images/capi/ansible/windows/galaxy.yml

@@ -0,0 +1,19 @@
+namespace: kubernetes_sigs
+name: image_builder_windows
+version: 0.2.0
+readme: "README.md"
+authors:
+- image-builder-maintainers (see OWNERS_ALIASES)
+description: Collection of ansible roles that install and configure Kubernetes orchestrator and related software compatible with Windows operating system.
+license_file: 'LICENSE'
+tags: ["kubernetes", "k8s", "image_building"]
+dependencies: {}
+repository: https://github.com/kubernetes-sigs/image-builder
+documentation: https://image-builder.sigs.k8s.io/
+homepage: https://image-builder.sigs.k8s.io/
+issues: https://github.com/kubernetes-sigs/image-builder/issues
+build_ignore:
+- ansible_winrm.ps1
+- example.vars.yml
+- OWNERS
+- "*.tar.gz"

images/capi/ansible/windows/meta/runtime.yml

@@ -0,0 +1,2 @@
+---
+requires_ansible: '>=2.15,<2.16'

images/capi/ansible/windows/node_windows.yml → images/capi/ansible/windows/playbooks/node_windows.yml

@@ -72,23 +72,23 @@
         loop_var: role
       when: node_custom_roles_pre != ""
     - ansible.builtin.include_role:
-        name: systemprep
+        name: kubernetes_sigs.image_builder_windows.systemprep
     - ansible.builtin.include_role:
-        name: cloudbase-init
+        name: kubernetes_sigs.image_builder_windows.cloudbase_init
       when: install_cloudbase_init
     - ansible.builtin.include_role:
-        name: providers
+        name: kubernetes_sigs.image_builder_windows.providers
     - ansible.builtin.include_role:
-        name: runtimes
+        name: kubernetes_sigs.image_builder_windows.runtimes
     - ansible.builtin.include_role:
-        name: kubernetes
+        name: kubernetes_sigs.image_builder_windows.kubernetes
     - ansible.builtin.include_role:
-        name: gmsa
+        name: kubernetes_sigs.image_builder_windows.gmsa
     - ansible.builtin.include_role:
-        name: load_additional_components
+        name: kubernetes_sigs.image_builder_windows.load_additional_components
       when: load_additional_components | bool
     - ansible.builtin.include_role:
-        name: debug
+        name: kubernetes_sigs.image_builder_windows.debug
     - ansible.builtin.include_role:
         name: "{{ role }}"
       loop: "{{ custom_role_names.split() + node_custom_roles_post.split() }}"

images/capi/ansible/windows/roles/cloudbase_init/README.md

@@ -0,0 +1 @@
+# Cloudbase Init Ansible Role (Windows)

images/capi/ansible/windows/roles/debug/README.md

@@ -0,0 +1 @@
+# Debug Ansible Role (Windows)

images/capi/ansible/windows/roles/gmsa/README.md

@@ -0,0 +1 @@
+# GMSA Ansible Role (Windows)

images/capi/ansible/windows/roles/kubernetes/README.md

@@ -0,0 +1 @@
+# Kubernetes Ansible Role (Windows)

images/capi/ansible/windows/roles/load_additional_components/README.md

@@ -0,0 +1 @@
+# Load Additional Components Ansible Role (Windows)

images/capi/ansible/windows/roles/providers/README.md

@@ -0,0 +1 @@
+# Providers Ansible Role (Windows)

images/capi/ansible/windows/roles/runtimes/README.md

@@ -0,0 +1 @@
+# Runtimes Ansible Role (Windows)

images/capi/ansible/windows/roles/systemprep/README.md

@@ -0,0 +1 @@
+# Systemprep Ansible Role (Windows)

images/capi/packer/ami/packer-windows.json

@@ -92,7 +92,7 @@
         "--extra-vars",
         "{{user `ansible_user_vars`}}"
       ],
-      "playbook_file": "ansible/windows/node_windows.yml",
+      "playbook_file": "ansible/windows/playbooks/node_windows.yml",
       "type": "ansible",
       "use_proxy": false,
       "user": "Administrator"

images/capi/packer/ami/packer.json

@@ -102,7 +102,7 @@
         "--scp-extra-args",
         "{{user `ansible_scp_extra_args`}}"
       ],
-      "playbook_file": "./ansible/node.yml",
+      "playbook_file": "./ansible/playbooks/node.yml",
       "type": "ansible"
     },
     {

images/capi/packer/azure/packer-windows.json

@@ -141,7 +141,7 @@
       ],
       "max_retries": 5,
       "pause_before": "15s",
-      "playbook_file": "ansible/windows/node_windows.yml",
+      "playbook_file": "ansible/windows/playbooks/node_windows.yml",
       "type": "ansible",
       "use_proxy": false,
       "user": "packer"

images/capi/packer/azure/packer.json

@@ -134,7 +134,7 @@
         "--scp-extra-args",
         "{{user `ansible_scp_extra_args`}}"
       ],
-      "playbook_file": "./ansible/python.yml",
+      "playbook_file": "./ansible/playbooks/python.yml",
       "type": "ansible",
       "user": "packer"
     },
@@ -152,7 +152,7 @@
         "--scp-extra-args",
         "{{user `ansible_scp_extra_args`}}"
       ],
-      "playbook_file": "./ansible/node.yml",
+      "playbook_file": "./ansible/playbooks/node.yml",
       "type": "ansible",
       "user": "packer"
     },

images/capi/packer/digitalocean/packer.json

@@ -43,7 +43,7 @@
         "--scp-extra-args",
         "{{user `ansible_scp_extra_args`}}"
       ],
-      "playbook_file": "./ansible/node.yml",
+      "playbook_file": "./ansible/playbooks/node.yml",
       "type": "ansible",
       "user": "packer"
     }

images/capi/packer/gce/packer.json

@@ -39,7 +39,7 @@
         "--scp-extra-args",
         "{{user `ansible_scp_extra_args`}}"
       ],
-      "playbook_file": "./ansible/node.yml",
+      "playbook_file": "./ansible/playbooks/node.yml",
       "type": "ansible"
     },
     {

images/capi/packer/hcloud/packer-flatcar.json

@@ -72,7 +72,7 @@
         "--scp-extra-args",
         "{{user `ansible_scp_extra_args`}}"
       ],
-      "playbook_file": "./ansible/python.yml",
+      "playbook_file": "./ansible/playbooks/python.yml",
       "type": "ansible",
       "user": "packer"
     },
@@ -90,7 +90,7 @@
         "--scp-extra-args",
         "{{user `ansible_scp_extra_args`}}"
       ],
-      "playbook_file": "./ansible/node.yml",
+      "playbook_file": "./ansible/playbooks/node.yml",
       "type": "ansible",
       "user": "packer"
     },