Skip to content

Commit

Permalink
PR review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
javierdelapuente committed Dec 18, 2024
1 parent 1632def commit d6433e6
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
5 changes: 2 additions & 3 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ options:
type: string
default: ""
description: >-
Providing a valid clouds.yaml will enable OpenStack integration. Setting the
openstack-clouds-yaml would enable spawning runners on OpenStack. The format for the clouds.yaml
is described in the docs:
The clouds.yaml yaml content that will enable OpenStack integration.
The format for the clouds.yaml is described in the docs:
(https://docs.openstack.org/python-openstackclient/pike/configuration/index.html#clouds-yaml).
openstack-flavor:
type: string
Expand Down
4 changes: 2 additions & 2 deletions docs/explanation/charm-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Conceptually, the charm can be divided into the following:
- Management of [Python web service for checking GitHub repository settings](https://github.com/canonical/repo-policy-compliance)
- Management of dependencies

## Ephemeral virtual machines
## Virtual machines

To ensure a clean and isolated environment for every runner, self-hosted runners use Openstack virtual machines. The charm spawns virtual machines, setting resources based on charm configurations. The self-hosted runners start with the ephemeral option and will clean themselves up once the execution has finished, freeing the resources. This is [similar to how GitHub hosts their runners due to security concerns](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security).
To ensure a clean and isolated environment for every runner, self-hosted runners use Openstack virtual machines. The charm spawns virtual machines, setting resources based on charm configurations. Virtual machines will not be reused between jobs, this is [similar to how GitHub hosts their runners due to security concerns](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security).

Check warning on line 16 in docs/explanation/charm-architecture.md

View workflow job for this annotation

GitHub Actions / unit-tests / Style checker

[vale] reported by reviewdog 🐶 [Canonical.005-Industry-product-names] Use 'OpenStack' instead of 'Openstack' Raw Output: {"message": "[Canonical.005-Industry-product-names] Use 'OpenStack' instead of 'Openstack'", "location": {"path": "docs/explanation/charm-architecture.md", "range": {"start": {"line": 16, "column": 86}}}, "severity": "WARNING"}

Check warning on line 16 in docs/explanation/charm-architecture.md

View workflow job for this annotation

GitHub Actions / unit-tests-github-runner-manager / Style checker

[vale] reported by reviewdog 🐶 [Canonical.005-Industry-product-names] Use 'OpenStack' instead of 'Openstack' Raw Output: {"message": "[Canonical.005-Industry-product-names] Use 'OpenStack' instead of 'Openstack'", "location": {"path": "docs/explanation/charm-architecture.md", "range": {"start": {"line": 16, "column": 86}}}, "severity": "WARNING"}

As the virtual machines are single-use, the charm will replenish virtual machines on a regular schedule. This time period is determined by the [`reconcile-interval` configuration](https://charmhub.io/github-runner/configure#reconcile-interval).

Expand Down
2 changes: 1 addition & 1 deletion tests/integration/test_debug_ssh.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ async def test_ssh_debug(
unit = app_no_wait_tmate.units[0]
# We need the runner to connect to the current machine, instead of the tmate_ssh_server unit,
# as the tmate_ssh_server is not routable.
dnat_comman_in_runner = "sudo iptables -t nat -A OUTPUT -p tcp --dport 10022 -j DNAT --to-destination 127.0.0.1:10022"
dnat_comman_in_runner = f"sudo iptables -t nat -A OUTPUT -p tcp -d {tmate_ssh_server_unit_ip} --dport 10022 -j DNAT --to-destination 127.0.0.1:10022"
_, _, _ = await instance_helper.run_in_instance(
unit,
dnat_comman_in_runner,
Expand Down

0 comments on commit d6433e6

Please sign in to comment.