charmcraft.yaml

# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

name: github-runner-image-builder
title: Github runner image builder
summary: Provide Github runners with images available to use.
description: |
  A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) managing
  runner images for
  [self-hosted runners for GitHub Actions](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners).

  A single unit of this charm provides pre-built images for Github runner operator to spawn and
  register the self-hosted runners on Github. The charm will periodically rebuild and provide the
  latest version of the images.
links:
  contact: https://github.com/orgs/canonical/teams/is-charms
  documentation: https://discourse.charmhub.io/t/github-runner-image-builder-documentation-overview/15390
  issues: https://github.com/canonical/github-runner-image-builder-operator/issues
  source: https://github.com/canonical/github-runner-image-builder-operator
  website: https://charmhub.io/github-runner-image-builder

type: charm

parts:
  charm:
    build-snaps:
      - rustup
    build-packages:
      - libffi-dev # for cffi
      - libssl-dev # for cryptography
      - rust-all # for cryptography
      - pkg-config # for cryptography
      - cython3 # for building PyYAML from source
      - libyaml-dev # for PyYAML C extension
      - python3-dev # for Python C extensions
    charm-python-packages:
      - "wheel>=0.45"
      - pip
      - setuptools
    override-build: |
      rustup default stable
      craftctl default
  app:
    plugin: nil
    override-build: |
      cd /root/project
      tar -cvzf app.tar.gz app
      cp app.tar.gz /root/stage
    organize:
      app.tar.gz: app.tar.gz
    prime:
      - app.tar.gz

bases:
  - build-on:
      - name: ubuntu
        channel: "22.04"
        architectures:
          - amd64
    run-on:
      - name: ubuntu
        channel: "22.04"
        architectures:
          - amd64

actions:
  run:
    description: Trigger an image builder run immediately.

config:
  options:
    architecture:
      type: string
      description: |
        The image architecture to build for using external builder. Can be one of "amd64", "arm64", "s390x",
        "ppc64le" (alternatively "ppc64el") or "armhf" (alternatively "arm", 32-bit ARM).
        Support for "s390x", "ppc64el" and "armhf" is considered experimental.
        Note: "armhf" images are built on arm64 (aarch64) hardware running a 32-bit userspace, and use
        the GitHub runner binary published by the canonical/github-actions-runner fork.
    base-image:
      type: string
      default: noble
      description: |
        The base ubuntu OS image to use for the runners. Codename (e.g. "noble") or version tag
        (e.g. 24.04) is supported as input. Currently only supports LTS versions of focal and
        higher, i.e. focal, jammy, noble, resolute.
    build-flavor:
      type: string
      default: ""
      description: |
        The flavor to use when launching a builder VM machine. Will default to
        minimum matching flavor: 2 vCPU, 1G Memory, 20G Disk.
    build-network:
      type: string
      default: ""
      description: |
        The network to launch the builder VM machine on. Will default to whatever
        network with accessible subnet is available.
    build-interval:
      type: int
      default: 6
      description: |
        The interval in hours between each scheduled image builds.
    openstack-auth-url:
      type: string
      default: ""
      description: |
        The auth_url section of the clouds.yaml contents, used to authenticate the OpenStack \
        client (e.g. http://my-openstack-deployment/openstack-keystone). See https://docs.\
        openstack.org/python-openstackclient/queens/configuration/index.html for more information.
    openstack-password-secret:
      type: secret
      description: |
        The password section of the clouds.yaml contents, used to authenticate the OpenStack
        client. A Juju user secret ID should be passed in the format of secret:<secret-id>.
        The secret must contain a 'password' key with the OpenStack password as its value.
        Example: juju add-secret openstack-password password=<value>.
    openstack-project-domain-name:
      type: string
      default: ""
      description: |
        The project_domain_name section of the clouds.yaml contents, used to find the OpenStack
        project-domain to use to store images. See https://docs.openstack.org/python-\
        openstackclient/queens/configuration/index.html for more information.
    openstack-project-name:
      type: string
      default: ""
      description: |
        The project_name section of the clouds.yaml contents, used to find the OpenStack project to
        use to store images. See https://docs.openstack.org/python-openstackclient/queens/\
        configuration/index.html for more information.
    openstack-user-domain-name:
      type: string
      default: ""
      description: |
        The user_domain_name section of the clouds.yaml contents, used to find the OpenStack
        user domain to authenticate the client. See https://docs.openstack.org/python-\
        openstackclient/queens/configuration/index.html for more information.
    openstack-user-name:
      type: string
      default: ""
      description: |
        The username section of the clouds.yaml contents, used to find the OpenStack user to \
        authenticate the client. See https://docs.openstack.org/python-openstackclient/queens/\
        configuration/index.html for more information.
    revision-history-limit:
      type: int
      default: 5
      description: Number of image revisions to keep before deletion.
    runner-version:
      type: string
      default: ""
      description: |
        The GitHub runner version to use, e.g. 2.317.0. Empty default value will fetch the latest
        version by default. See https://github.com/actions/runner/releases.
    script-url:
      type: string
      default: ""
      description: |
        URL to external script to run during cloud-init. Allows user-defined customization scripts
        to be run. This script is run as root, within the cloud-init user-data script.
    script-secret-id:
      type: secret
      description: |
        Environment variables to be loaded for execution of the script-url. Juju user secret ID
        should be passed in in the format of secret:<secret-id>.
        See https://juju.is/docs/juju/manage-secrets.
    script-secret:
      type: string
      default: ""
      description: |
        Environment variables to be loaded for execution of the script-url. Multiple secrets can be
        passed in, delimited by space. i.e. firstsecret=first secondsecret=second

provides:
  image:
    interface: github_runner_image_v0
  cos-agent:
    interface: cos_agent