Skip to content

Commit f3a0d85

Browse files
gabriel-samfiragabriel-samfira
authored
Merge pull request #16 from fabi200123/add-common-extra-specs
Add common extra specs
2 parents 23a95ad + be6337e commit f3a0d85

File tree

2 files changed

+108
-8
lines changed

2 files changed

+108
-8
lines changed

‎README.md

+62-5
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,39 @@ To this end, this provider supports the following extra specs schema:
7575
},
7676
"description": "A list of image owners to allow when creating the instance. If not specified, all images will be allowed."
7777
},
78-
"image_visibility": {
79-
"type": "string",
80-
"description": "The visibility of the image to use."
81-
}
78+
"image_visibility": {
79+
"type": "string",
80+
"description": "The visibility of the image to use."
81+
},
82+
"disable_updates": {
83+
"type": "boolean",
84+
"description": "Disable automatic updates on the VM."
85+
},
86+
"extra_packages": {
87+
"type": "array",
88+
"description": "Extra packages to install on the VM.",
89+
"items": {
90+
"type": "string"
91+
}
92+
},
93+
"runner_install_template": {
94+
"type": "string",
95+
"description": "This option can be used to override the default runner install template. If used, the caller is responsible for the correctness of the template as well as the suitability of the template for the target OS. Use the extra_context extra spec if your template has variables in it that need to be expanded."
96+
},
97+
"extra_context": {
98+
"type": "object",
99+
"description": "Extra context that will be passed to the runner_install_template.",
100+
"additionalProperties": {
101+
"type": "string"
102+
}
103+
},
104+
"pre_install_scripts": {
105+
"type": "object",
106+
"description": "A map of pre-install scripts that will be run before the runner install script. These will run as root and can be used to prep a generic image before we attempt to install the runner. The key of the map is the name of the script as it will be written to disk. The value is a byte array with the contents of the script.",
107+
"additionalProperties": {
108+
"type": "string"
109+
}
110+
}
82111
},
83112
"additionalProperties": false
84113
}
@@ -93,10 +122,38 @@ An example extra specs json would look like this:
93122
"network_id": "542b68dd-4b3d-459d-8531-34d5e779d4d6",
94123
"storage_backend": "cinder_nvme",
95124
"boot_disk_size": 150,
96-
"use_config_drive": false
125+
"use_config_drive": false,
126+
"disable_updates": true,
127+
"enable_boot_debug": true,
128+
"extra_context": {
129+
"GolangDownloadURL": "https://go.dev/dl/go1.22.4.linux-amd64.tar.gz"
130+
},
131+
"extra_packages": [
132+
"apg",
133+
"tmux"
134+
],
135+
"pre_install_scripts": {
136+
"01-script": "IyEvYmluL2Jhc2gKCgplY2hvICJIZWxsbyBmcm9tICQwIiA+PiAvMDEtc2NyaXB0LnR4dAo=",
137+
"02-script": "IyEvYmluL2Jhc2gKCgplY2hvICJIZWxsbyBmcm9tICQwIiA+PiAvMDItc2NyaXB0LnR4dAo="
138+
},
139+
"runner_install_template": "#!/bin/bash

set -e
set -o pipefail

{{- if .EnableBootDebug }}
set -x
{{- end }}

CALLBACK_URL="{{ .CallbackURL }}"
METADATA_URL="{{ .MetadataURL }}"
BEARER_TOKEN="{{ .CallbackToken }}"

if [ -z "$METADATA_URL" ];then
	echo "no token is available and METADATA_URL is not set"
	exit 1
fi

function call() {
	PAYLOAD="$1"
	[[ $CALLBACK_URL =~ ^(.*)/status(/)?$ ]] || CALLBACK_URL="${CALLBACK_URL}/status"
	curl --retry 5 --retry-delay 5 --retry-connrefused --fail -s -X POST -d "${PAYLOAD}" -H 'Accept: application/json' -H "Authorization: Bearer ${BEARER_TOKEN}" "${CALLBACK_URL}" || echo "failed to call home: exit code ($?)"
}

function systemInfo() {
	if [ -f "/etc/os-release" ];then
		. /etc/os-release
	fi
	OS_NAME=${NAME:-""}
	OS_VERSION=${VERSION_ID:-""}
	AGENT_ID=${1:-null}
	# strip status from the callback url
	[[ $CALLBACK_URL =~ ^(.*)/status(/)?$ ]] && CALLBACK_URL="${BASH_REMATCH[1]}" || true
	SYSINFO_URL="${CALLBACK_URL}/system-info/"
	PAYLOAD="{\"os_name\": \"$OS_NAME\", \"os_version\": \"$OS_VERSION\", \"agent_id\": $AGENT_ID}"
	curl --retry 5 --retry-delay 5 --retry-connrefused --fail -s -X POST -d "${PAYLOAD}" -H 'Accept: application/json' -H "Authorization: Bearer ${BEARER_TOKEN}" "${SYSINFO_URL}" || true
}

function sendStatus() {
	MSG="$1"
	call "{\"status\": \"installing\", \"message\": \"$MSG\"}"
}

function success() {
	MSG="$1"
	ID=${2:-null}
	call "{\"status\": \"idle\", \"message\": \"$MSG\", \"agent_id\": $ID}"
}

function fail() {
	MSG="$1"
	call "{\"status\": \"failed\", \"message\": \"$MSG\"}"
	exit 1
}

# This will echo the version number in the filename. Given a file name like: actions-runner-osx-x64-2.299.1.tar.gz
# this will output: 2.299.1
function getRunnerVersion() {
	FILENAME="{{ .FileName }}"
	[[ $FILENAME =~ ([0-9]+\.[0-9]+\.[0-9+]) ]]
	echo $BASH_REMATCH
}

function getCachedToolsPath() {
	CACHED_RUNNER="/opt/cache/actions-runner/latest"
	if [ -d "$CACHED_RUNNER" ];then
		echo "$CACHED_RUNNER"
		return 0
	fi

	VERSION=$(getRunnerVersion)
	if [ -z "$VERSION" ]; then
		return 0
	fi

	CACHED_RUNNER="/opt/cache/actions-runner/$VERSION"
	if [ -d "$CACHED_RUNNER" ];then
		echo "$CACHED_RUNNER"
		return 0
	fi
	return 0
}

function downloadAndExtractRunner() {
	sendStatus "downloading tools from {{ .DownloadURL }}"
	if [ ! -z "{{ .TempDownloadToken }}" ]; then
	TEMP_TOKEN="Authorization: Bearer {{ .TempDownloadToken }}"
	fi
	curl --retry 5 --retry-delay 5 --retry-connrefused --fail -L -H "${TEMP_TOKEN}" -o "/home/{{ .RunnerUsername }}/{{ .FileName }}" "{{ .DownloadURL }}" || fail "failed to download tools"
	mkdir -p /home/{{ .RunnerUsername }}/actions-runner || fail "failed to create actions-runner folder"
	sendStatus "extracting runner"
	tar xf "/home/{{ .RunnerUsername }}/{{ .FileName }}" -C /home/{{ .RunnerUsername }}/actions-runner/ || fail "failed to extract runner"
	# chown {{ .RunnerUsername }}:{{ .RunnerGroup }} -R /home/{{ .RunnerUsername }}/actions-runner/ || fail "failed to change owner"
}

CACHED_RUNNER=$(getCachedToolsPath)
if [ -z "$CACHED_RUNNER" ];then
	downloadAndExtractRunner
	sendStatus "installing dependencies"
	cd /home/{{ .RunnerUsername }}/actions-runner
	sudo ./bin/installdependencies.sh || fail "failed to install dependencies"
else
	sendStatus "using cached runner found in $CACHED_RUNNER"
	sudo cp -a "$CACHED_RUNNER"  "/home/{{ .RunnerUsername }}/actions-runner"
	sudo chown {{ .RunnerUsername }}:{{ .RunnerGroup }} -R "/home/{{ .RunnerUsername }}/actions-runner" || fail "failed to change owner"
	cd /home/{{ .RunnerUsername }}/actions-runner
fi


sendStatus "configuring runner"
{{- if .UseJITConfig }}
function getRunnerFile() {
	curl --retry 5 --retry-delay 5 \
		--retry-connrefused --fail -s \
		-X GET -H 'Accept: application/json' \
		-H "Authorization: Bearer ${BEARER_TOKEN}" \
		"${METADATA_URL}/$1" -o "$2"
}

sendStatus "downloading JIT credentials"
getRunnerFile "credentials/runner" "/home/{{ .RunnerUsername }}/actions-runner/.runner" || fail "failed to get runner file"
getRunnerFile "credentials/credentials" "/home/{{ .RunnerUsername }}/actions-runner/.credentials" || fail "failed to get credentials file"
getRunnerFile "credentials/credentials_rsaparams" "/home/{{ .RunnerUsername }}/actions-runner/.credentials_rsaparams" || fail "failed to get credentials_rsaparams file"
getRunnerFile "system/service-name" "/home/{{ .RunnerUsername }}/actions-runner/.service" || fail "failed to get service name file"
sed -i 's/$/\.service/' /home/{{ .RunnerUsername }}/actions-runner/.service

SVC_NAME=$(cat /home/{{ .RunnerUsername }}/actions-runner/.service)

sendStatus "generating systemd unit file"
getRunnerFile "systemd/unit-file?runAsUser={{ .RunnerUsername }}" "$SVC_NAME" || fail "failed to get service file"
sudo mv $SVC_NAME /etc/systemd/system/ || fail "failed to move service file"
sudo chown root:root /etc/systemd/system/$SVC_NAME || fail "failed to change owner"
if [ -e "/sys/fs/selinux" ];then
	sudo chcon -h system_u:object_r:systemd_unit_file_t:s0 /etc/systemd/system/$SVC_NAME || fail "failed to change selinux context"
fi

sendStatus "enabling runner service"
cp /home/{{ .RunnerUsername }}/actions-runner/bin/runsvc.sh /home/{{ .RunnerUsername }}/actions-runner/ || fail "failed to copy runsvc.sh"
sudo chown {{ .RunnerUsername }}:{{ .RunnerGroup }} -R /home/{{ .RunnerUsername }} || fail "failed to change owner"
sudo systemctl daemon-reload || fail "failed to reload systemd"
sudo systemctl enable $SVC_NAME
{{- else}}

GITHUB_TOKEN=$(curl --retry 5 --retry-delay 5 --retry-connrefused --fail -s -X GET -H 'Accept: application/json' -H "Authorization: Bearer ${BEARER_TOKEN}" "${METADATA_URL}/runner-registration-token/")

set +e
attempt=1
while true; do
	ERROUT=$(mktemp)
	{{- if .GitHubRunnerGroup }}
	./config.sh --unattended --url "{{ .RepoURL }}" --token "$GITHUB_TOKEN" --runnergroup {{.GitHubRunnerGroup}} --name "{{ .RunnerName }}" --labels "{{ .RunnerLabels }}" --no-default-labels --ephemeral 2>$ERROUT
	{{- else}}
	./config.sh --unattended --url "{{ .RepoURL }}" --token "$GITHUB_TOKEN" --name "{{ .RunnerName }}" --labels "{{ .RunnerLabels }}" --no-default-labels --ephemeral 2>$ERROUT
	{{- end}}
	if [ $? -eq 0 ]; then
		rm $ERROUT || true
		sendStatus "runner successfully configured after $attempt attempt(s)"
		break
	fi
	LAST_ERR=$(cat $ERROUT)
	echo "$LAST_ERR"

	# if the runner is already configured, remove it and try again. In the past configuring a runner
	# managed to register it but timed out later, resulting in an error.
	./config.sh remove --token "$GITHUB_TOKEN" || true

	if [ $attempt -gt 5 ];then
		rm $ERROUT || true
		fail "failed to configure runner: $LAST_ERR"
	fi

	sendStatus "failed to configure runner (attempt $attempt): $LAST_ERR (retrying in 5 seconds)"
	attempt=$((attempt+1))
	rm $ERROUT || true
	sleep 5
done
set -e

sendStatus "installing runner service"
sudo ./svc.sh install {{ .RunnerUsername }} || fail "failed to install service"
{{- end}}

if [ -e "/sys/fs/selinux" ];then
	sudo chcon -R -h user_u:object_r:bin_t:s0 /home/runner/ || fail "failed to change selinux context"
fi

AGENT_ID=""
{{- if .UseJITConfig }}
sudo systemctl start $SVC_NAME || fail "failed to start service"
{{- else}}
sendStatus "starting service"
sudo ./svc.sh start || fail "failed to start service"

set +e
AGENT_ID=$(grep "agentId" /home/{{ .RunnerUsername }}/actions-runner/.runner |  tr -d -c 0-9)
if [ $? -ne 0 ];then
	fail "failed to get agent ID"
fi
set -e
{{- end}}
systemInfo $AGENT_ID

success "runner successfully installed" $AGENT_ID
{{- if .ExtraContext.GolangDownloadURL }}
curl -LO {{ .ExtraContext.GolangDownloadURL }}
rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.22.4.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin
{{- end }}"
97140
}
98141
```
99142

143+
*NOTE*: The `extra_context` spec adds a map of key/value pairs that may be expected in the `runner_install_template`.
144+
The `runner_install_template` allows us to completely override the script that installs and starts the runner. In the example above, I have added a copy of the current template from `garm-provider-common`, with the adition of:
145+
146+
```bash
147+
{{- if .ExtraContext.GolangDownloadURL }}
148+
curl -LO {{ .ExtraContext.GolangDownloadURL }}
149+
rm -rf /usr/local/go && sudo tar -C /usr/local -xzf go1.22.4.linux-amd64.tar.gz
150+
export PATH=$PATH:/usr/local/go/bin
151+
{{- end }}
152+
```
153+
154+
*NOTE*: `runner_install_template` is a [golang template](https://pkg.go.dev/text/template), which is used to install the runner. An example on how you can extend the currently existing template with a function that downloads, extracts and installs Go on the runner is provided above.
155+
156+
100157
To set it on an existing pool, simply run:
101158
102159
```bash

‎provider/spec.go

+46-3
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ var (
4343
)
4444

4545
const jsonSchema string = `
46+
4647
{
4748
"$schema": "http://cloudbase.it/garm-provider-openstack/schemas/extra_specs#",
4849
"type": "object",
@@ -88,7 +89,36 @@ const jsonSchema string = `
8889
"image_visibility": {
8990
"type": "string",
9091
"description": "The visibility of the image to use."
91-
}
92+
},
93+
"disable_updates": {
94+
"type": "boolean",
95+
"description": "Disable automatic updates on the VM."
96+
},
97+
"extra_packages": {
98+
"type": "array",
99+
"description": "Extra packages to install on the VM.",
100+
"items": {
101+
"type": "string"
102+
}
103+
},
104+
"runner_install_template": {
105+
"type": "string",
106+
"description": "This option can be used to override the default runner install template. If used, the caller is responsible for the correctness of the template as well as the suitability of the template for the target OS. Use the extra_context extra spec if your template has variables in it that need to be expanded."
107+
},
108+
"extra_context": {
109+
"type": "object",
110+
"description": "Extra context that will be passed to the runner_install_template.",
111+
"additionalProperties": {
112+
"type": "string"
113+
}
114+
},
115+
"pre_install_scripts": {
116+
"type": "object",
117+
"description": "A map of pre-install scripts that will be run before the runner install script. These will run as root and can be used to prep a generic image before we attempt to install the runner. The key of the map is the name of the script as it will be written to disk. The value is a byte array with the contents of the script.",
118+
"additionalProperties": {
119+
"type": "string"
120+
}
121+
}
92122
},
93123
"additionalProperties": false
94124
}
@@ -104,6 +134,8 @@ type extraSpecs struct {
104134
BootDiskSize *int64 `json:"boot_disk_size,omitempty"`
105135
UseConfigDrive *bool `json:"use_config_drive"`
106136
EnableBootDebug *bool `json:"enable_boot_debug"`
137+
DisableUpdates *bool `json:"disable_updates"`
138+
ExtraPackages []string `json:"extra_packages"`
107139
}
108140

109141
func jsonSchemaValidation(schema json.RawMessage) error {
@@ -196,6 +228,7 @@ func NewMachineSpec(data params.BootstrapInstance, cfg *config.Config, controlle
196228
Tags: getTags(controllerID, data.PoolID),
197229
BootstrapParams: data,
198230
Properties: getProperties(data, controllerID),
231+
ExtraPackages: extraSpec.ExtraPackages,
199232
}
200233
spec.MergeExtraSpecs(extraSpec)
201234

@@ -217,6 +250,8 @@ type machineSpec struct {
217250
UseConfigDrive bool
218251
Flavor string
219252
Image string
253+
DisableUpdates bool
254+
ExtraPackages []string
220255
Tools params.RunnerApplicationDownload
221256
Tags []string
222257
Properties map[string]string
@@ -307,6 +342,10 @@ func (m *machineSpec) MergeExtraSpecs(spec extraSpecs) {
307342
m.BootstrapParams.UserDataOptions.EnableBootDebug = *spec.EnableBootDebug
308343
}
309344

345+
if spec.DisableUpdates != nil {
346+
m.DisableUpdates = *spec.DisableUpdates
347+
}
348+
310349
// an empty visibility in the extra specs should not override the
311350
// the config's visibility
312351
if config.IsValidVisibility(spec.ImageVisibility) {
@@ -315,15 +354,19 @@ func (m *machineSpec) MergeExtraSpecs(spec extraSpecs) {
315354
}
316355

317356
func (m *machineSpec) ComposeUserData() ([]byte, error) {
357+
bootstrapParams := m.BootstrapParams
358+
bootstrapParams.UserDataOptions.DisableUpdatesOnBoot = m.DisableUpdates
359+
bootstrapParams.UserDataOptions.ExtraPackages = m.ExtraPackages
360+
bootstrapParams.UserDataOptions.EnableBootDebug = m.BootstrapParams.UserDataOptions.EnableBootDebug
318361
switch m.BootstrapParams.OSType {
319362
case params.Linux, params.Windows:
320-
udata, err := DefaultGetCloudconfig(m.BootstrapParams, m.Tools, m.BootstrapParams.Name)
363+
udata, err := cloudconfig.GetCloudConfig(bootstrapParams, m.Tools, bootstrapParams.Name)
321364
if err != nil {
322365
return nil, fmt.Errorf("failed to generate userdata: %w", err)
323366
}
324367
return []byte(udata), nil
325368
}
326-
return nil, fmt.Errorf("unsupported OS type for cloud config: %s", m.BootstrapParams.OSType)
369+
return nil, fmt.Errorf("unsupported OS type for cloud config: %s", bootstrapParams.OSType)
327370
}
328371

329372
func (m *machineSpec) GetServerCreateOpts(flavor flavors.Flavor, net networks.Network, img images.Image) (servers.CreateOpts, error) {

0 commit comments

Comments
 (0)