Merge pull request #461 from gabriel-samfira/update-docs
Update docs to reflect new release
This commit is contained in:
Gabriel
GitHub
commit
50d2546055
3 changed files with 30 additions and 30 deletions
25
README.md
25
README.md
|
|
@ -1,19 +1,18 @@
|
|||
# GitHub Actions Runner Manager (GARM)
|
||||
|
||||
[](https://github.com/cloudbase/garm/actions/workflows/go-tests.yml)
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [About GARM](#about-garm)
|
||||
- [Join us on slack](#join-us-on-slack)
|
||||
- [Installing](#installing)
|
||||
- [Quickstart](#quickstart)
|
||||
- [Installing on Kubernetes](#installing-on-kubernetes)
|
||||
- [Using GARM](#using-garm)
|
||||
- [Supported providers](#supported-providers)
|
||||
- [Installing external providers](#installing-external-providers)
|
||||
- [Optimizing your runners](#optimizing-your-runners)
|
||||
- [Write your own provider](#write-your-own-provider)
|
||||
- [GitHub Actions Runner Manager GARM](#github-actions-runner-manager-garm)
|
||||
- [About GARM](#about-garm)
|
||||
- [Join us on slack](#join-us-on-slack)
|
||||
- [Installing](#installing)
|
||||
- [Quickstart](#quickstart)
|
||||
- [Installing on Kubernetes](#installing-on-kubernetes)
|
||||
- [Using GARM](#using-garm)
|
||||
- [Supported providers](#supported-providers)
|
||||
- [Installing external providers](#installing-external-providers)
|
||||
- [Optimizing your runners](#optimizing-your-runners)
|
||||
- [Write your own provider](#write-your-own-provider)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
|
|
@ -34,7 +33,7 @@ Here is a brief architectural diagram of how GARM reacts to workflows triggered
|
|||
|
||||
|
||||
|
||||
:warning: **Important note**: The README and documentation in the `main` branch are relevant to the not yet released code that is present in `main`. Following the documentation from the `main` branch for a stable release of GARM, may lead to errors. To view the documentation for the latest stable release, please switch to the appropriate tag. For information about setting up `v0.1.5`, please refer to the [v0.1.5 tag](https://github.com/cloudbase/garm/tree/v0.1.5).
|
||||
:warning: **Important note**: The README and documentation in the `main` branch are relevant to the not yet released code that is present in `main`. Following the documentation from the `main` branch for a stable release of GARM, may lead to errors. To view the documentation for the latest stable release, please switch to the appropriate tag. For information about setting up `v0.1.6`, please refer to the [v0.1.6 tag](https://github.com/cloudbase/garm/tree/v0.1.6).
|
||||
|
||||
## Join us on slack
|
||||
|
||||
|
|
|
|||
|
|
@ -2,18 +2,19 @@
|
|||
|
||||
<!-- TOC -->
|
||||
|
||||
- [Create the config folder](#create-the-config-folder)
|
||||
- [The config file](#the-config-file)
|
||||
- [The provider section](#the-provider-section)
|
||||
- [Starting the service](#starting-the-service)
|
||||
- [Using Docker](#using-docker)
|
||||
- [Setting up GARM as a system service](#setting-up-garm-as-a-system-service)
|
||||
- [Initializing GARM](#initializing-garm)
|
||||
- [Setting up the webhook](#setting-up-the-webhook)
|
||||
- [Creating a GitHub endpoint Optional](#creating-a-github-endpoint-optional)
|
||||
- [Adding credentials](#adding-credentials)
|
||||
- [Define a repo](#define-a-repo)
|
||||
- [Create a pool](#create-a-pool)
|
||||
- [Quick start](#quick-start)
|
||||
- [Create the config folder](#create-the-config-folder)
|
||||
- [The config file](#the-config-file)
|
||||
- [The provider section](#the-provider-section)
|
||||
- [Starting the service](#starting-the-service)
|
||||
- [Using Docker](#using-docker)
|
||||
- [Setting up GARM as a system service](#setting-up-garm-as-a-system-service)
|
||||
- [Initializing GARM](#initializing-garm)
|
||||
- [Setting up the webhook](#setting-up-the-webhook)
|
||||
- [Creating a GitHub endpoint Optional](#creating-a-github-endpoint-optional)
|
||||
- [Adding credentials](#adding-credentials)
|
||||
- [Define a repo](#define-a-repo)
|
||||
- [Create a pool](#create-a-pool)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
|
|
@ -133,7 +134,7 @@ docker run -d \
|
|||
-p 80:80 \
|
||||
-v /etc/garm:/etc/garm:rw \
|
||||
-v /var/snap/lxd/common/lxd/unix.socket:/var/snap/lxd/common/lxd/unix.socket:rw \
|
||||
ghcr.io/cloudbase/garm:v0.1.4
|
||||
ghcr.io/cloudbase/garm:v0.1.6
|
||||
```
|
||||
|
||||
You will notice that we also mounted the LXD unix socket from the host inside the container where the config you pasted expects to find it. If you plan to use an external provider that does not need to connect to LXD over a unix socket, feel free to remove that mount.
|
||||
|
|
@ -166,7 +167,7 @@ Adding the `garm` user to the LXD group will allow it to connect to the LXD unix
|
|||
Next, download the latest release from the [releases page](https://github.com/cloudbase/garm/releases).
|
||||
|
||||
```bash
|
||||
wget -q -O - https://github.com/cloudbase/garm/releases/download/v0.1.5/garm-linux-amd64.tgz | tar xzf - -C /usr/local/bin/
|
||||
wget -q -O - https://github.com/cloudbase/garm/releases/download/v0.1.6/garm-linux-amd64.tgz | tar xzf - -C /usr/local/bin/
|
||||
```
|
||||
|
||||
We'll be running under an unprivileged user. If we want to be able to listen on any port under `1024`, we'll have to set some capabilities on the binary:
|
||||
|
|
@ -199,7 +200,7 @@ Copy the sample `systemd` service file:
|
|||
|
||||
```bash
|
||||
wget -O /etc/systemd/system/garm.service \
|
||||
https://raw.githubusercontent.com/cloudbase/garm/v0.1.5/contrib/garm.service
|
||||
https://raw.githubusercontent.com/cloudbase/garm/v0.1.6/contrib/garm.service
|
||||
```
|
||||
|
||||
Reload the `systemd` daemon and start the service:
|
||||
|
|
@ -234,7 +235,7 @@ Before we can start using GARM, we need initialize it. This will create the `adm
|
|||
To initialize GARM, we'll use the `garm-cli` tool. You can download the latest release from the [releases page](https://github.com/cloudbase/garm/releases):
|
||||
|
||||
```bash
|
||||
wget -q -O - https://github.com/cloudbase/garm/releases/download/v0.1.5/garm-cli-linux-amd64.tgz | tar xzf - -C /usr/local/bin/
|
||||
wget -q -O - https://github.com/cloudbase/garm/releases/download/v0.1.6/garm-cli-linux-amd64.tgz | tar xzf - -C /usr/local/bin/
|
||||
```
|
||||
|
||||
Now we can initialize GARM:
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ garm-cli controller show
|
|||
| Webhook Base URL | https://garm.example.com/webhooks |
|
||||
| Controller Webhook URL | https://garm.example.com/webhooks/a4dd5f41-8e1e-42a7-af53-c0ba5ff6b0b3 |
|
||||
| Minimum Job Age Backoff | 30 |
|
||||
| Version | v0.1.5 |
|
||||
| Version | v0.1.6 |
|
||||
+-------------------------+----------------------------------------------------------------------------+
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue