cattery/examples/example-config.yaml at 2697a52ccd25aad980c2b4e9998ad4d2e388f22b · paritytech/cattery · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
server:
  listenAddress: "0.0.0.0:5137"
  advertiseUrl: https://cattery.my-org.com

database:
  uri: mongodb://localhost:27017/cattery
  database: cattery

github:
  - name: paritytech-stg
    appId: 123456
    installationId: 654321
    appClientId: Iv123abC
    privateKeyPath: path/to/github-private-key.pem
    webhookSecret: my-webhook-secret

  - name: paritytech
    appId: 123456
    installationId: 654321
    appClientId: Iv123abC
    privateKeyPath: path/to/github-private-key.pem
    webhookSecret: my-webhook-secret

providers:
  - name: docker-local
    type: docker
    catteryUrl: http://host.containers.internal:5137 # example for podman

  - name: gce-stg
    type: google
    project: my-gcp-project
    credentialsFile: path/to/credentials.json

trayTypes:
  # Bootstrap is enabled by default for every tray type. The provider injects
  # a script that downloads the cattery agent from /agent/download and runs it.
  # The agent itself downloads the GH Actions runner if not present on disk
  # (latest release by default, or pinned via runnerVersion).

  - name: cattery-gce-default
    provider: gce
    githubOrg: My-Github-Org
    runnerGroupId: 3
    shutdown: true
    maxTrays: 3
    config:
      instanceTemplate: global/instanceTemplates/<instance-template>
      machineType: e2-standard-2
      project: my-gcp-project
      zones:
        - us-west1-a
        - us-west1-b

  - name: cattery-gce-custom
    provider: gce
    githubOrg: My-Github-Org
    runnerGroupId: 3
    shutdown: true
    runnerVersion: "2.332.0"          # pin runner version (default: latest)
    bootstrap:
      user: cattery                   # run agent as this user (default: root)
      agentFolder: /home/cattery
      runnerFolder: /home/cattery/actions-runner
      # script: |                     # optional template override
      #   #!/bin/bash
      #   curl -sSfL {{.ServerURL}}/agent/download -o /tmp/cattery
      #   ...
    config:
      instanceTemplate: global/instanceTemplates/<instance-template>
      machineType: e2-standard-2
      project: my-gcp-project
      zones:
        - us-west1-a

  # Opt out: legacy pre-baked image where the agent is already installed and
  # started by your own systemd unit (e.g. the cattery.service chain).
  - name: cattery-gce-legacy
    provider: gce
    githubOrg: My-Github-Org
    runnerGroupId: 3
    shutdown: true
    bootstrap:
      enabled: false
    extraMetadata:
      cattery-agent-version: 0.0.4    # consumed by your image's install-agent.sh
    config:
      instanceTemplate: global/instanceTemplates/legacy-image
      machineType: e2-standard-2
      project: my-gcp-project
      zones:
        - us-west1-a

  - name: cattery-tiny
    provider: docker-local
    shutdown: false
    runnerGroupId: 3
    githubOrg: My-Github-Org
    config:
      image: ubuntu:24.04             # plain image -- bootstrap installs the agent