From c7a836ffb153e77e22995f914fca69e071af8b1f Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Thu, 21 May 2026 09:59:00 +0700 Subject: [PATCH 1/7] docs: add resource recommendation for charm deployment --- README.md | 16 +++++++++++++++- app/doc/tutorial/quick-start.md | 12 ++++++++++++ docs/tutorial/quick-start.md | 13 +++++++++++++ 3 files changed, 40 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bac61312..517eb01c 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,21 @@ Deploy GitHub runner image builder with GitHub runners. You'll need a working [OpenStack installation](https://microstack.run/docs/single-node) with -flavors with a minimum of 2 CPU cores, 8GB RAM and 10GB disk. +flavors for the builder VM. + +Recommended builder VM resources: + +- 2 vCPUs +- 8 GiB RAM +- 20 GiB disk + +Minimum accepted builder VM resources: + +- 2 vCPUs +- 1 GiB RAM +- 20 GiB disk + +Using the recommended resources helps avoid failures during image build and initialization. ### Set up diff --git a/app/doc/tutorial/quick-start.md b/app/doc/tutorial/quick-start.md index 9a1ebf26..2e24f5e8 100644 --- a/app/doc/tutorial/quick-start.md +++ b/app/doc/tutorial/quick-start.md @@ -14,6 +14,18 @@ - Working [OpenStack environment](https://microstack.run/docs/single-node) - A `clouds.yaml` configuration with the OpenStack environment +### Recommended resources for deployment + +For reliable image builds, ensure your OpenStack environment has a flavor for build VMs +with at least: + +- 2 vCPUs +- 8 GiB RAM +- 20 GiB disk + +The CLI can work with lower memory if a smaller flavor is selected, but using the +recommended flavor significantly reduces build failures. + ## Steps ### Install the CLI diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index f4c5e10f..272f1be9 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -15,6 +15,19 @@ This quick start guide will help you deploy the GitHub Runner Image Builder char [Set up your test environment](https://documentation.ubuntu.com/juju/3.6/howto/manage-your-juju-deployment/set-up-your-juju-deployment-local-testing-and-development/) - A running instance of [OpenStack](https://microstack.run/docs/single-node). +### Recommended resources for deployment + +For stable builds and fewer deployment failures, use a dedicated OpenStack flavor for +the builder VM with: + +- 2 vCPUs +- 8 GiB RAM +- 20 GiB disk + +The charm itself enforces a lower minimum flavor (2 vCPUs, 1 GiB RAM, 20 GiB disk). + +If possible, set the `build-flavor` config to a flavor that meets the recommendation. + ## Steps ### Shell into the Multipass VM From f0193b802618aca00add6948bfdb9c755c1bda43 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Thu, 21 May 2026 10:12:57 +0700 Subject: [PATCH 2/7] add changelog --- app/pyproject.toml | 2 +- docs/changelog.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/app/pyproject.toml b/app/pyproject.toml index 1deff3ce..01406142 100644 --- a/app/pyproject.toml +++ b/app/pyproject.toml @@ -3,7 +3,7 @@ [project] name = "github-runner-image-builder" -version = "0.13.0" +version = "0.14.0" authors = [ { name = "Canonical IS DevOps", email = "is-devops-team@canonical.com" }, ] diff --git a/docs/changelog.md b/docs/changelog.md index ef6c8a0c..57fe1d6d 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,5 +1,9 @@ +## [#221 Add resource recommendation for charm deployment](https://github.com/canonical/github-runner-image-builder-operator/pull/221) + +- Add 2 vCPUs, 8 GiB RAM, and 20 GiB disk OpenStack flavor recommendation. + ## [#219 Use Juju secrets](https://github.com/canonical/github-runner-image-builder-operator/pull/219) (2026-04-17) - Require `openstack-password-secret` configuration option to securely store OpenStack passwords using Juju secrets. From 5770a0d4780e8bcec8cade8a20f528d3abb95210 Mon Sep 17 00:00:00 2001 From: florentianayuwono <76247368+florentianayuwono@users.noreply.github.com> Date: Thu, 21 May 2026 10:14:09 +0700 Subject: [PATCH 3/7] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- app/doc/tutorial/quick-start.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/app/doc/tutorial/quick-start.md b/app/doc/tutorial/quick-start.md index 2e24f5e8..88f16e9c 100644 --- a/app/doc/tutorial/quick-start.md +++ b/app/doc/tutorial/quick-start.md @@ -16,8 +16,7 @@ ### Recommended resources for deployment -For reliable image builds, ensure your OpenStack environment has a flavor for build VMs -with at least: +For reliable image builds, use a recommended flavor for build VMs with: - 2 vCPUs - 8 GiB RAM From 88c5c7853fac8cc5ce0aa4d61892a119230d73fd Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 21 May 2026 10:36:57 +0000 Subject: [PATCH 4/7] docs: add vCPUs to vale vocabulary to fix spell check failure Agent-Logs-Url: https://github.com/canonical/github-runner-image-builder-operator/sessions/1446d291-aeb6-47e8-bfb6-4c4838f4750d Co-authored-by: florentianayuwono <76247368+florentianayuwono@users.noreply.github.com> --- .vale/styles/config/vocabularies/local/accept.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.vale/styles/config/vocabularies/local/accept.txt b/.vale/styles/config/vocabularies/local/accept.txt index e651c36b..42821fac 100644 --- a/.vale/styles/config/vocabularies/local/accept.txt +++ b/.vale/styles/config/vocabularies/local/accept.txt @@ -2,4 +2,5 @@ aproxy chroot cron opentelemetry -pipx \ No newline at end of file +pipx +vCPUs \ No newline at end of file From e57d5ce4737566027a1b99ab25ead32ee82e42e3 Mon Sep 17 00:00:00 2001 From: florentianayuwono <76247368+florentianayuwono@users.noreply.github.com> Date: Thu, 21 May 2026 20:55:11 +0700 Subject: [PATCH 5/7] Update app/doc/tutorial/quick-start.md Co-authored-by: Erin Conley --- app/doc/tutorial/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/doc/tutorial/quick-start.md b/app/doc/tutorial/quick-start.md index 88f16e9c..dee4f9a3 100644 --- a/app/doc/tutorial/quick-start.md +++ b/app/doc/tutorial/quick-start.md @@ -16,7 +16,7 @@ ### Recommended resources for deployment -For reliable image builds, use a recommended flavor for build VMs with: +For reliable image builds, use the following recommended flavor for build VMs: - 2 vCPUs - 8 GiB RAM From 701bce51e7e03ab6aec1efeb900e29f8d142dd86 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Thu, 21 May 2026 22:16:14 +0700 Subject: [PATCH 6/7] fix vale --- README.md | 2 ++ docs/changelog.md | 2 ++ docs/tutorial/quick-start.md | 4 +++- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 517eb01c..990b28a5 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ flavors for the builder VM. Recommended builder VM resources: + - 2 vCPUs - 8 GiB RAM - 20 GiB disk @@ -42,6 +43,7 @@ Minimum accepted builder VM resources: - 2 vCPUs - 1 GiB RAM - 20 GiB disk + Using the recommended resources helps avoid failures during image build and initialization. diff --git a/docs/changelog.md b/docs/changelog.md index 57fe1d6d..a4584878 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,7 +2,9 @@ ## [#221 Add resource recommendation for charm deployment](https://github.com/canonical/github-runner-image-builder-operator/pull/221) + - Add 2 vCPUs, 8 GiB RAM, and 20 GiB disk OpenStack flavor recommendation. + ## [#219 Use Juju secrets](https://github.com/canonical/github-runner-image-builder-operator/pull/219) (2026-04-17) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 272f1be9..4d06607a 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -9,7 +9,7 @@ This quick start guide will help you deploy the GitHub Runner Image Builder char ## Requirements -- A working station, e.g., a laptop, with amd64 architecture. +- A working station, for example, a laptop, with amd64 architecture. - Juju 3 installed and bootstrapped to a LXD controller. You can accomplish this process by using a Multipass VM as outlined in this guide: [Set up your test environment](https://documentation.ubuntu.com/juju/3.6/howto/manage-your-juju-deployment/set-up-your-juju-deployment-local-testing-and-development/) @@ -20,11 +20,13 @@ This quick start guide will help you deploy the GitHub Runner Image Builder char For stable builds and fewer deployment failures, use a dedicated OpenStack flavor for the builder VM with: + - 2 vCPUs - 8 GiB RAM - 20 GiB disk The charm itself enforces a lower minimum flavor (2 vCPUs, 1 GiB RAM, 20 GiB disk). + If possible, set the `build-flavor` config to a flavor that meets the recommendation. From bd0d63c2171b0a9a7f522f82f50fa299a60ec759 Mon Sep 17 00:00:00 2001 From: florentianayuwono Date: Mon, 25 May 2026 10:48:17 +0700 Subject: [PATCH 7/7] fix: allow adding label to pr --- .github/workflows/test.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 51d9c3eb..c0dab441 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -3,6 +3,9 @@ name: Tests on: pull_request: +permissions: + pull-requests: write + jobs: unit-tests: uses: canonical/operator-workflows/.github/workflows/test.yaml@main