Skip to content

canonical/tmate-ssh-server-operator

Repository files navigation

Tmate SSH server operator

A Juju charm that provides the self-hosted GitHub runner an integration with self-hosted SSH debug server. The self-hosted SSH debug server is automatically available via the forked version of action-tmate. By default, the connection is allowed only for the actor of the debug workflow for security considerations. This charm is deployed as a VM.

Like any Juju charm, this charm supports one-line deployment, integration, scaling, and more. For Charmed Tmate SSH server, there are no configurations required and the charm works out of the box.

For information about how to deploy, integrate, and manage this charm, see the Official CharmHub Documentation.

Get started

Deploy Tmate SSH server with GitHub runners.

You'll need a working OpenStack installation to deploy the GitHub runners on.

Set up

Follow MicroStack's single-node starting guide to set up MicroStack.

Follow the tutorial on GitHub runner to deploy the GitHub runner.

Deploy

Deploy the charm.

juju deploy tmate-ssh-server

juju integrate tmate-ssh-server github-runner

Basic operations

After having deployed and integrated the charm with the GitHub runner charm, the SSH connection to the runner VM should be accessible via action-tmate. To find out more about how to configure the workflow, refer to the Getting Started section of action tmate.

Integrations

  • debug-ssh: Provides GitHub runners with addresses to connect to for action-tmate.

For a full list of integrations, please refer to the Charmhub documentation.

Learn more

Project and community