Skip to content

docs: add resource recommendation for charm deployment#221

Open
florentianayuwono wants to merge 3 commits into
mainfrom
docs/charm-deployment-isd-3720
Open

docs: add resource recommendation for charm deployment#221
florentianayuwono wants to merge 3 commits into
mainfrom
docs/charm-deployment-isd-3720

Conversation

@florentianayuwono
Copy link
Copy Markdown
Contributor

@florentianayuwono florentianayuwono commented May 21, 2026

Applicable spec:

Overview

Add the following recommendation for openstack flavor:

  • 2 vCPUs
  • 8 GiB RAM
  • 20 GiB disk

which is the superset of the requirements stated in the code:

MIN_CPU = 2
MIN_RAM = 1024 # M
MIN_DISK = 20 # G

and existing README guidance:

You'll need a working OpenStack installation with
flavors with a minimum of 2 CPU cores, 8GB RAM and 10GB disk.

Rationale

So that user knows the recommended resource for deploying image builder and doesn't run into issues.

Juju Events Changes

Module Changes

Library Changes

Checklist

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds clearer OpenStack flavor sizing guidance (recommended vs minimum) for deploying/running the GitHub runner image builder, aligning documentation with the minimums enforced by the OpenStack builder logic.

Changes:

  • Updated README prerequisites to list recommended and minimum accepted builder VM resources.
  • Added a “Recommended resources” section to the charm quick-start tutorial.
  • Added a similar resources recommendation to the CLI quick-start tutorial.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
README.md Adds recommended and minimum accepted OpenStack flavor sizing for the builder VM.
docs/tutorial/quick-start.md Documents recommended builder VM flavor resources and references build-flavor.
app/doc/tutorial/quick-start.md Adds recommended OpenStack flavor sizing guidance for CLI-driven builds.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread app/doc/tutorial/quick-start.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants