docs: add resource recommendation for charm deployment

.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

.vale/styles/config/vocabularies/local/accept.txt

@@ -2,4 +2,5 @@ aproxy
 chroot
 cron
 opentelemetry
-pipx
+pipx
+vCPUs

README.md

@@ -29,7 +29,23 @@ Deploy GitHub runner image builder with GitHub runners.
 <!--Indicate software and hardware prerequisites-->
 
 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:
+
+<!-- vale Canonical.013-Spell-out-numbers-below-10 = NO -->
+- 2 vCPUs
+- 8 GiB RAM
+- 20 GiB disk
+
+Minimum accepted builder VM resources:
+
+- 2 vCPUs
+- 1 GiB RAM
+- 20 GiB disk
+<!-- vale Canonical.013-Spell-out-numbers-below-10 = YES -->
+
+Using the recommended resources helps avoid failures during image build and initialization.
 
 ### Set up
 

app/doc/tutorial/quick-start.md

@@ -14,6 +14,17 @@
 - 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, use the following recommended flavor for build VMs:
+
+- 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

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" },
 ]

docs/changelog.md

@@ -1,5 +1,11 @@
 <!-- vale Canonical.007-Headings-sentence-case = NO -->
 
+## [#221 Add resource recommendation for charm deployment](https://github.com/canonical/github-runner-image-builder-operator/pull/221)
+
+<!-- vale Canonical.013-Spell-out-numbers-below-10 = NO -->
+- Add 2 vCPUs, 8 GiB RAM, and 20 GiB disk OpenStack flavor recommendation.
+<!-- vale Canonical.013-Spell-out-numbers-below-10 = YES -->
+
 ## [#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.

docs/tutorial/quick-start.md

@@ -9,12 +9,27 @@ 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/)
 - 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:
+
+<!-- vale Canonical.013-Spell-out-numbers-below-10 = NO -->
+- 2 vCPUs
+- 8 GiB RAM
+- 20 GiB disk
+
+The charm itself enforces a lower minimum flavor (2 vCPUs, 1 GiB RAM, 20 GiB disk).
+<!-- vale Canonical.013-Spell-out-numbers-below-10 = YES -->
+
+If possible, set the `build-flavor` config to a flavor that meets the recommendation.
+
 ## Steps
 
 ### Shell into the Multipass VM