Update & backup
Updating runners
To update the runner to the newest version of Buddy, sign in to the server that hosts the runner and run:
bashbuddy update$
Warning
The version of the runner and the main instance must be the same. If the versions are different, you can't assign new pipelines to the runner, and all pipelines assigned previously will fail with the "Wrong version" status.
Updating runner configuration
To update runner configuration (memory limits, tag, network settings, etc.), run this command on the runner server:
bashbuddy update-runner-config$
Supported flags
| Name | Description |
|---|---|
--drain | Sets the runner to draining mode. |
--config | Fetches the data from a configuration file. Must have the path to the file set. |
--standalone-host | The new IP address of the main instance. Requires restart. |
--token | Overwrites the default authorization token. If not provided, Buddy will use the most recently provided token. |
--runner-memory | The amount of RAM in MB allocated for the runner service. |
--name | The name of the runner. Ignored if empty. |
--tag | The new tag applied to the runner. Ignored if empty. |
--clear-tag | Clears the current tag applied to the runner. |
--cpus | The new number of CPUs that can be used by the build actions on the runner. Must be greater than 0 or will be ignored. |
--clear-cpus | Clears the limit on the number of CPUs available for the build actions on the runner. |
--memory | The new amount of RAM in MB that can be used by the build actions on the runner. Must be greater than 0 or will be ignored. |
--clear-memory | Clears the RAM limit for build actions on the runner. |
--shm | The new amount of shared memory in MB. Must be greater than 0 or will be ignored. |
--clear-memory | Clears the shared memory limit on the runner. |
--concurrent | The new number of pipeline runners on the runner. Must be greater than 0 or will be ignored.) |
--clear-concurrent | Clears the limit of pipeline runners on the runner. |
--internal-host | The IP address that will be bound by the runner. Default value: empty (binds to all IP's on the server). Requires restart. |
--external-host | The external IP address of the server as seen by the primary server. Default value: the first detected external IP address. Requires restart. |
--runner-internal-port | The listening port of the runner. Default: 1090. Requires restart. |
--runner-external-port | The external port of the runner to which Buddy self-hosted is connecting. Default: 1090. Requires restart. |
--registry-internal-port | The listening port of the registry. Default: 1091. Requires restart. |
--registry-external-port | The external port of the registry to which Buddy self-hosted is connecting. Default: 1091. Requires restart. |
Hint
Flags have higher priority than the data in the configuration file. For example, setting the memory limit with a parameter flag will overwrite the value from the config file.
Backup
Backing up runners follows the same process as backing up the main Buddy self-hosted instance.
Last modified on Sep 24, 2024