docs(readme): update ecosystem overview for planner integration#795
Draft
cbartz wants to merge 2 commits into
Draft
docs(readme): update ecosystem overview for planner integration#795cbartz wants to merge 2 commits into
cbartz wants to merge 2 commits into
Conversation
erinecon
approved these changes
May 21, 2026
| * [GitHub Runner](https://charmhub.io/github-runner): The central component that manages self-hosted GitHub runners. It interacts with OpenStack to spawn runner VMs and communicates with GitHub to register and manage runners. | ||
| * [Image Builder](https://charmhub.io/github-runner-image-builder): Responsible for generating images. It builds images on the builder OpenStack project and uploads them to the GitHub Runner OpenStack project. | ||
| * [MongoDB](https://charmhub.io/mongodb): Acts as a message queue to handle reactive runner requests. The [github-runner-webhook-router](https://charmhub.io/github-runner-webhook-router) charm will put events in MongoDB that will be consumed by the `github-runner` charm. Only for reactive runners. | ||
| * [Planner](https://charmhub.io/github-runner-planner): Consumes webhook events from an AMQP broker, tracks job state in PostgreSQL, and streams runner demand ("pressure") to the `github-runner` charm. Optional — without it the charm pre-spawns a fixed pool of runners configured via `base-virtual-machines`. The Planner integration requires: |
Contributor
There was a problem hiding this comment.
I think we should be more clear about what we mean by without it the charm pre-spawns... if I'm understanding correctly, you mean "without the planner charm, the GitHub runner charm pre-spawns". Please correct me if I'm mistaken!
Comment on lines
+104
to
+105
| MQ(["RabbitMQ"]) | ||
| PG[(PostgreSQL)] |
Contributor
There was a problem hiding this comment.
Nit: AFAIK RabbitMQ and PostgreSQL are both deployed as charms, so why are they represented differently in the diagram?
| githubrunner <-->|"manage runners"| GH | ||
| tmate -->|"debug-ssh credentials"| githubrunner | ||
| GH -->|"workflow job webhooks"| webhookgateway | ||
| webhookgateway -->|"validated webhooks"| MQ |
Contributor
There was a problem hiding this comment.
Suggested change
| webhookgateway -->|"validated webhooks"| MQ | |
| webhookgateway -->|"validates webhooks"| MQ |
Nit, to be consistent in the verb tense throughout the diagram
| imagebuilder -->|"builds images"| OS_BUILD | ||
| imagebuilder -->|"uploads images"| OS_RUNNERS | ||
| imagebuilder -->|"image ids"| githubrunner | ||
| githubrunner -->|"OpenStack credentials"| imagebuilder |
Contributor
There was a problem hiding this comment.
Nit: Thinking about adding a verb to this relation. Would it be correct to say:
Suggested change
| githubrunner -->|"OpenStack credentials"| imagebuilder | |
| githubrunner -->|"provides OpenStack credentials"| imagebuilder |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
Why we need it
Checklist
docs/changelog.mdwith user-relevant changesterraform fmtpasses andtflintreports no errorsgithub-runner-manager/pyproject.toml.