Edit

Single Node with Docker Compose

This is an example configuration of Sider Enterprise. It fits for testing Sider Enterprise in your environment, and we strongly recommend NOT using it for production.

Single Node with Docker Compose

Prerequisites

This configuration assumes you've already installed Docker Compose on your node, and it supposes your environment is described the following items:

  • The host name of your node is resolved with sider.example.com
  • Your GitHub Enterprise Server is accessible via https://ghe.example.com
  • Your environment does not have HTTP proxy servers

Step-by-step to configure the Single Node with Docker Compose

Let's set up your Sider Enterprise for a single node with these steps:

  1. Get a Docker image
  2. Create your GitHub App
  3. Create the environment variables file (See below)
  4. Create your docker-compose.yml
  5. Run services

Creating Environment Variables Files

Create /etc/sider/env with content like this, and change the file permission accessible only to be specific users. Be careful to make sure your GitHub App configurations satisfy the settings on GitHub Enterprise Server.

RAILS_ENV=onprem
SECRET_KEY_BASE=81efee29dbcad46f33f366f8e55e8a4b29d199b4a5f3b82c55dddab5b3107e3cf656d5ab713bdf871a2d4128334933d08bbcee49a0b0cb18d1b54af6866e7b75
DATABASE_URL=mysql2://mysql:3306/sideci?encoding=utf8mb4&connectTimeout=5000
BASE_URL=https://sider.example.com
REDIS_URL=redis://redis:6379/0
GITHUB_APP_ID=1
GITHUB_APP_NAME=sider
GITHUB_APP_PRIVATE_KEY=REPLACE
GITHUB_APP_OAUTH2_CLIENT_ID=REPLACE
GITHUB_APP_OAUTH2_CLIENT_SECRET=REPLACE
GITHUB_APP_WEBHOOK_SECRET=REPLACE
GITHUB_API_ENDPOINT=https://ghe.example.com/api/v3/
GITHUB_ENDPOINT=https://ghe.example.com/
ENCRYPTION_SERVICE_KEY=hs2n6oI4as302bYpuQdPeIN5bft9b1VD
ENCRYPTION_SERVICE_SALT=lhYLt2NRfLi0KiriwMt1opRahpVRuy9b
RUNNERS_TRACES_S3_BUCKET_NAME=runner-traces
DOCKER_RUNNERS_CONFIG={"docker_host_url":"unix:///var/run/docker.sock","s3_endpoint":"http://minio:9000","aws_access_key_id":"access-key","aws_secret_access_key":"secret-key","network_mode":"sider_default"}

Creating docker-compose.yml

Configure /etc/sider/docker-compose.yml like this:

version: "3"
services:
  sideci_web:
    image: 480130971618.dkr.ecr.us-east-1.amazonaws.com/sideci_onprem:release-202006.0
    env_file:
      - /etc/sider/env
    command: ["bundle", "exec", "puma"]
    restart: always
    ports:
      - "80:3000"
    depends_on:
      - mysql
      - redis
      - minio
  sideci_worker:
    image: 480130971618.dkr.ecr.us-east-1.amazonaws.com/sideci_onprem:release-202006.0
    env_file:
      - /etc/sider/env
    command: ["bundle", "exec", "sidekiq"]
    restart: always
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
    depends_on:
      - mysql
      - redis
      - minio
  mysql:
    image: mysql:5.7
    restart: always
    environment:
      MYSQL_ALLOW_EMPTY_PASSWORD: "true"
    volumes:
      - mysql_data:/var/lib/mysql
  redis:
    image: redis:5
    command: ["redis-server", "--bind", "0.0.0.0", "--appendonly", "yes"]
    restart: always
    volumes:
      - redis_data:/data
  minio:
    image: minio/minio
    command: ["server", "/data"]
    restart: always
    environment:
      MINIO_ACCESS_KEY: access-key
      MINIO_SECRET_KEY: secret-key
    volumes:
      - minio_data:/data

volumes:
  mysql_data:
  redis_data:
  minio_data:

Run Services

Before running the services, the database migration is necessary:

docker-compose --file /etc/sider/docker-compose.yml up --detach mysql
docker-compose --file /etc/sider/docker-compose.yml run sideci_worker bundle exec rails db:setup

After that, the services should be up and running with the command:

docker-compose --file /etc/sider/docker-compose.yml up --detach --scale sideci_worker=2

What's next

← ClusteringOverview →