Skip to content
DRAFT

Application Deployment Runbooks

Step-by-step guides for deploying self-hosted applications and services. These runbooks cover end-to-end deployment workflows, from initial setup through ongoing management.

Overview

These runbooks focus on deploying specific applications and services. Each runbook provides a complete, self-contained guide that includes:

  • Prerequisites and dependencies
  • Configuration and setup
  • Deployment procedures
  • Ongoing management and maintenance
  • Troubleshooting guidance

Available Application Runbooks

🏃 Self-Hosted GitHub Actions Runners

Step-by-step guides for setting up GitHub Actions runners on various platforms:

  • VM Runner Setup: Deploy a GitHub Actions runner on an Ubuntu VM running on IncusOS. Leverages the standard VM creation workflow for consistent, manageable runner deployments. Recommended for most use cases.
  • Bare Metal Runner Setup: Set up Ubuntu-based GitHub Actions runners on bare metal Raspberry Pi (ARM64) or Intel NUC (x86_64) devices. Covers Ubuntu Server installation, post-installation configuration, and runner setup.

Getting Started

  1. Choose an application: Select the application runbook that matches your needs
  2. Review prerequisites: Each runbook lists specific requirements and dependencies
  3. Follow step-by-step: Complete each step in order, as they build upon each other
  4. Customize as needed: Adapt the deployment to your specific environment and requirements

Common Prerequisites

Most application runbooks require:

  • Workspace initialized: Follow the Initialize Workspace runbook if you haven't already
  • Secrets management: Configure encrypted secrets using SOPS for sensitive configuration
  • Windsor CLI: Installed and configured on your local machine
  • Network access: Proper network configuration for the application to function

Additional Resources