Skip to content

charms.md

Latest commit

 

History

History
90 lines (60 loc) · 3.2 KB

charms.md

File metadata and controls

90 lines (60 loc) · 3.2 KB
Raw
myst
html_meta
description lang=en
Reference information for the GARM and garm-configurator Juju charms.

(reference_charm_reference)=

Charms

This page describes the GARM and GARM configurator charms. The relevant information for a minimal deployment is provided here.

GARM charm

The GARM charm deploys and manages the GARM service for managing GitHub self-hosted runners.

Actions

There is no mandatory action for GARM charm to function.

[Actions for GARM charm](https://charmhub.io/garm/actions)

Configurations

The credentials to access the GitHub API are supplied by the GARM configurator through the GARM integration. The configurator supports GitHub App authentication. See the configurations for the GARM configurator charm for details.

[Configurations for GARM charm](https://charmhub.io/garm/configurations)

Integrations

The GARM charm must be integrated with a PostgreSQL charm, and at least one GARM configurator charm. The PostgreSQL charm stores runner and job state, while GARM configurator charms provide the configuration for a single set GitHub self-hosted runners.

The GARM charm supports integration with COS (Canonical Observability Stack). See observe your charm with COS lite.

[Integrations for GARM charm](https://charmhub.io/garm/integrations)

GARM configurator charm

The GARM configurator charm provides a set of configurations of GitHub runner scaleset to the GARM charm. Multiple GARM configurator charms can be integrated to a single GARM charm, with each instance of GARM configurator charm representing a single GitHub runner scaleset in GARM.

Currently, the GARM charm and GARM configurator charm only support the GARM OpenStack provider.

Actions

The GARM configurator charm has no actions.

Configurations

The GARM configurator charm holds the configuration for one GARM scaleset. The os-arch option, which specifies the runner CPU architecture, is mandatory. The OpenStack credentials required by the provider include:

  • openstack-auth-url
  • openstack-password
  • openstack-project-domain-name
  • openstack-project-name
  • openstack-user-domain-name
  • openstack-username

The GitHub App ID, installation ID, and private key are also required for GitHub authentication. Review the remaining options and defaults before applying the configuration.

[Configurations for GARM configurator charm](https://charmhub.io/garm-configurator/configurations)

Integrations

The GARM configurator charm integrates with a GARM charm. The GARM charm manages GitHub self-hosted runners according to the scaleset configuration published by the configurator.

[Integrations for GARM configurator charm](https://charmhub.io/garm-configurator/integrations)

Security

For security-sensitive defaults, trust boundaries, and removal behavior, see the {ref}GARM security reference <reference_security>.