-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add initial documentation for reactive mode #397
base: main
Are you sure you want to change the base?
Conversation
Test coverage for 30eb911
Static code analysis report
|
|
||
Note, that the specific revisions/channels in the steps are only marked here to have the howto reproducible, you should adapt these to your needs. | ||
|
||
We assume that you have a machine model (named "machine-model") for the runners and MongoDB, and a k8s model (named "k8s-model") for the webhook router. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This assumption should probably be moved to the "Requirements" section
|
||
### GitHub Runner flavors | ||
|
||
For this howto, we decided to have deployed three runner flavors: `large`, `large-arm`, `small` . We need |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: howto --> how-to guide
|
||
## Requirements | ||
|
||
You need to deploy a webhook router, which listens for incoming jobs from GitHub, transforms them into |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For my understanding, does this how-to guide have the user deploy the webhook router?
## Steps | ||
We are going to showcase the steps required to set up a reactive spawning environment with three runner flavors (large, large-arm, small) and a MongoDB database as a message queue. | ||
|
||
Note, that the specific revisions/channels in the steps are only marked here to have the howto reproducible, you should adapt these to your needs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: "to have the howto reproducible" --> "for reproducibility"
Applicable spec: ISD-116
Overview
Add a howto and some reference documentation.
Rationale
We have an initial deployment in production and need some documentation.
Checklist
src-docs
.urgent
,trivial
,complex
).