-
Notifications
You must be signed in to change notification settings - Fork 20
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
Clean lxd code #423
base: main
Are you sure you want to change the base?
Clean lxd code #423
Conversation
Co-authored-by: Christopher Bartz <[email protected]>
This reverts commit d730cbf.
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.
Thanks for restructuring the docs! I took this opportunity to do a more careful review to try and switch the docs to using US English.
Co-authored-by: Erin Conley <[email protected]>
@@ -1,6 +1,6 @@ | |||
# GitHub Runner Operator | |||
|
|||
A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) for deploying and managing [GitHub self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) on virtual machines. The charm maintains a set of ephemeral self-hosted runners, each isolated in a single-use virtual machine instance. | |||
A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) for deploying and managing [GitHub self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) on virtual machines. The charm maintains a set of self-hosted runners, each isolated in a single-use virtual machine instance. |
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.
I think the runners are still ephemeral. i.e., the runner disappear after one job.
Although the "each isolated in a single-use virtual machine instance" part also points that out.
I am fine either way.
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.
Thank you Javi!
| [Overview](https://charmhub.io/github-runner)</br> Overview of the charm </br> | [How-to guides](https://charmhub.io/github-runner/docs/how-to-openstack-runner) </br> Step-by-step guides covering key operations and common tasks | | ||
| [Reference](https://charmhub.io/github-runner/docs/reference-actions) </br> Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/github-runner/docs/explanation-charm-architecture) </br> Concepts - discussion and clarification of key topics | | ||
|
||
If you want to use ephemeral LXD virtual machines spawned by charm, you can refer to the section [Track local-lxd](https://charmhub.io/github-runner/docs/local-lxd). |
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.
If you want to use ephemeral LXD virtual machines spawned by charm, you can refer to the section [Track local-lxd](https://charmhub.io/github-runner/docs/local-lxd). | |
If you want to use ephemeral LXD virtual machines spawned by the charm, you can refer to the section [Track local-lxd](https://charmhub.io/github-runner/docs/local-lxd). |
@@ -726,7 +670,7 @@ async def basic_app_fixture(request: pytest.FixtureRequest) -> Application: | |||
|
|||
|
|||
@pytest_asyncio.fixture(scope="function", name="instance_helper") | |||
async def instance_helper_fixture(request: pytest.FixtureRequest) -> InstanceHelper: | |||
async def instance_helper_fixture(request: pytest.FixtureRequest) -> OpenStackInstanceHelper: |
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.
the dynamic fixture request is no longer required
Test coverage for 02be48c
Static code analysis report
|
source: scripts | ||
organize: | ||
build-lxd-image.sh: scripts/build-lxd-image.sh | ||
reactive_runner.py: scripts/reactive_runner.py |
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.
Is this still needed?
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.
The source docs can be deleted now, we will figure out an alternative
Applicable spec:
Overview
This PR removed LXD runners from the main branch. The reason for this is that there were really two different code paths without a common interface in the charm.
LXD
runners will still be supported in the tracklocal-lxd
(see announcement) https://discourse.charmhub.io/t/important-update-new-track-local-lxd-for-lxd-runners-in-the-github-runner-charm/16139.This PR has also strong implications for documentation, as lot of information is now outdated. As a first step it has been removed, but some of it, like a tutorial, will have to be created in following PRs.
Rationale
Maintaining two codepaths inhibits big refactors and also is a risk for regression, as we are concentrating our development in openstack runners and we can break lxd. Having two different tracks brings clarity and reduces risks and improves maintanability.
If in the future lxd support is required in the main branch, it could be better added using a common interface for both types of runners, using an external lxc cluster (or microcloud cluster).
Juju Events Changes
Module Changes
Library Changes
Checklist
src-docs
.urgent
,trivial
,complex
).