Merge pull request #253 from stackhpc/srt-runners

docs: move GH runner README to docs

Author: markgoddard

docs/operations/github.md

@@ -1,3 +1,148 @@
 # Operations - GitHub
 
-TODO: cover repository management, GitHub Actions runners, etc.
+## GitHub Actions runners
+
+This Terraform configuration deploys a GitHub Actions runner VMs on an
+OpenStack cloud for the stackhpc-release-train repository.
+
+### Usage
+
+These instructions show how to use this Terraform configuration
+manually. They assume you are running an Ubuntu host that will be used
+to run Terraform. The machine should have network access to the VM that
+will be created by this configuration.
+
+Install Terraform:
+
+```
+wget -qO - terraform.gpg https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/terraform-archive-keyring.gpg
+sudo echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/terraform-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/terraform.list
+sudo apt update
+sudo apt install terraform
+```
+
+Clone and initialise the repo:
+
+```
+git clone https://github.com/stackhpc/stackhpc-release-train
+cd stackhpc-release-train
+```
+
+Change to the `terraform/github-runners` directory:
+
+```
+cd terraform/github-runners
+```
+
+Initialise Terraform:
+
+```
+terraform init
+```
+
+Create an OpenStack `clouds.yaml` file with your credentials to access an
+OpenStack cloud. Alternatively, download one from Horizon. The
+credentials should be scoped to the `stackhpc-release` project.
+
+```
+cat << EOF > clouds.yaml
+---
+clouds:
+  sms-lab:
+    auth:
+      auth_url: https://api.sms-lab.cloud:5000
+      username: <username>
+      project_name: stackhpc-release
+      domain_name: default
+    interface: public
+EOF
+```
+
+Export environment variables to use the correct cloud and provide a
+password:
+
+```
+export OS_CLOUD=sms-lab
+read -p OS_PASSWORD -s OS_PASSWORD
+export OS_PASSWORD
+```
+
+Verify that the Terraform variables in `terraform.tfvars` are correct.
+
+Generate a plan:
+
+```
+terraform plan
+```
+
+Apply the changes:
+
+```
+terraform apply -auto-approve
+```
+
+Create a virtualenv:
+
+```
+python3 -m venv venv
+```
+
+Activate the virtualenv:
+
+```
+source venv/bin/activate
+```
+
+Install Python dependencies:
+
+```
+pip install -r ansible/requirements.txt
+```
+
+Install Ansible Galaxy dependencies:
+
+```
+ansible-galaxy collection install -r ansible/requirements.yml
+ansible-galaxy role install -r ansible/requirements.yml
+```
+
+Create a GitHub PAT token (classic) with repo:all scope. Export an
+environment variable with the token.
+
+```
+read -p PERSONAL_ACCESS_TOKEN -s PERSONAL_ACCESS_TOKEN
+export PERSONAL_ACCESS_TOKEN
+```
+
+Deploy runners:
+
+```
+ansible-playbook ansible/site.yml -i ansible/inventory.yml
+```
+
+To remove runners:
+
+```
+ansible-playbook ansible/site.yml -i ansible/inventory.yml -e runner_state=absent
+```
+
+### Troubleshooting
+
+#### Install service fails
+
+If you see the following:
+
+```
+TASK [monolithprojects.github_actions_runner : Install service] ********************************************************************************************************************************************
+fatal: [10.205.0.50]: FAILED! => changed=true
+  cmd: ./svc.sh install ubuntu
+  msg: '[Errno 2] No such file or directory: b''./svc.sh'''
+  rc: 2
+  stderr: ''
+  stderr_lines: <omitted>
+  stdout: ''
+  stdout_lines: <omitted>
+```
+
+It might mean the runner is already registered, possibly from a previous
+VM. Remove the runner using Ansible or the GitHub settings.

terraform/github-runners/README.rst

@@ -13,6 +13,8 @@
         name: monolithprojects.github_actions_runner
       become: true
 
+    # FIXME: Sometimes the runner service is not running at the end of the role.
+    # Start the service manually.
     - name: Ensure runner service is running
       ansible.builtin.service:
         name: actions.runner.stackhpc-stackhpc-release-train.{{ ansible_facts.hostname }}.service