feat(ibmcloud): add GitHub Actions runner support for IBM Power and IBM Z

Author: deekay2310

cmd/mapt/cmd/ibmcloud/hosts/ibm-power.go

@@ -2,6 +2,7 @@ package hosts
 
 import (
 	"github.com/redhat-developer/mapt/cmd/mapt/cmd/params"
+	"github.com/redhat-developer/mapt/pkg/integrations/github"
 	"github.com/redhat-developer/mapt/pkg/integrations/gitlab"
 	maptContext "github.com/redhat-developer/mapt/pkg/manager/context"
 	ibmpower "github.com/redhat-developer/mapt/pkg/provider/ibmcloud/action/ibm-power"
@@ -43,6 +44,10 @@ func ibmPowerCreate() *cobra.Command {
 			if err := viper.BindPFlags(cmd.Flags()); err != nil {
 				return err
 			}
+			ghRunnerArgs := params.GithubRunnerArgs()
+			if ghRunnerArgs != nil {
+				ghRunnerArgs.Arch = &github.Ppc64le
+			}
 			return ibmpower.New(
 				&maptContext.ContextArgs{
 					Context:       cmd.Context(),
@@ -52,7 +57,7 @@ func ibmPowerCreate() *cobra.Command {
 					Debug:         viper.IsSet(params.Debug),
 					DebugLevel:    viper.GetUint(params.DebugLevel),
 					CirrusPWArgs:  params.CirrusPersistentWorkerArgs(),
-					GHRunnerArgs:  params.GithubRunnerArgs(),
+					GHRunnerArgs:  ghRunnerArgs,
 					GLRunnerArgs:  params.GitLabRunnerArgs(&gitlab.Ppc64le),
 					Tags:          viper.GetStringMapString(params.Tags),
 				},

cmd/mapt/cmd/ibmcloud/hosts/ibm-z.go

@@ -2,6 +2,7 @@ package hosts
 
 import (
 	"github.com/redhat-developer/mapt/cmd/mapt/cmd/params"
+	"github.com/redhat-developer/mapt/pkg/integrations/github"
 	"github.com/redhat-developer/mapt/pkg/integrations/gitlab"
 	maptContext "github.com/redhat-developer/mapt/pkg/manager/context"
 	ibmz "github.com/redhat-developer/mapt/pkg/provider/ibmcloud/action/ibm-z"
@@ -43,6 +44,10 @@ func ibmZCreate() *cobra.Command {
 			if err := viper.BindPFlags(cmd.Flags()); err != nil {
 				return err
 			}
+			ghRunnerArgs := params.GithubRunnerArgs()
+			if ghRunnerArgs != nil {
+				ghRunnerArgs.Arch = &github.S390x
+			}
 			return ibmz.New(
 				&maptContext.ContextArgs{
 					Context:       cmd.Context(),
@@ -52,7 +57,7 @@ func ibmZCreate() *cobra.Command {
 					Debug:         viper.IsSet(params.Debug),
 					DebugLevel:    viper.GetUint(params.DebugLevel),
 					CirrusPWArgs:  params.CirrusPersistentWorkerArgs(),
-					GHRunnerArgs:  params.GithubRunnerArgs(),
+					GHRunnerArgs:  ghRunnerArgs,
 					GLRunnerArgs:  params.GitLabRunnerArgs(&gitlab.S390x),
 					Tags:          viper.GetStringMapString(params.Tags),
 				},

cmd/mapt/cmd/params/params.go

@@ -73,9 +73,14 @@ const (
 	CreateCmdName  string = "create"
 	DestroyCmdName string = "destroy"
 
-	ghActionsRunnerToken  string = "ghactions-runner-token"
-	ghActionsRunnerRepo   string = "ghactions-runner-repo"
-	ghActionsRunnerLabels string = "ghactions-runner-labels"
+	ghActionsRunnerToken    string = "ghactions-runner-token"
+	ghActionsRunnerRepo     string = "ghactions-runner-repo"
+	ghActionsRunnerLabels   string = "ghactions-runner-labels"
+	ghActionsRunnerImageRepo string = "ghactions-runner-image-repo"
+	// TODO: once the RHEL script is merged to https://github.com/IBM/action-runner-image-pz,
+	// switch default from deekay2310 fork to IBM upstream.
+	ghActionsRunnerImageRepoDefault string = "https://github.com/deekay2310/action-runner-image-pz.git"
+	GHActionsRunnerImageRepoDesc    string = "Git clone URL for the action-runner-image-pz repository, used to build the GitHub Actions runner from source on ppc64le/s390x (no official binaries exist for these architectures)"
 
 	cirrusPWToken      string = "it-cirrus-pw-token"
 	cirrusPWTokenDesc  string = "Add mapt target as a cirrus persistent worker. The value will hold a valid token to be used by cirrus cli to join the project."
@@ -278,17 +283,18 @@ func AddGHActionsFlags(fs *pflag.FlagSet) {
 	fs.StringP(ghActionsRunnerToken, "", "", GHActionsRunnerTokenDesc)
 	fs.StringP(ghActionsRunnerRepo, "", "", GHActionsRunnerRepoDesc)
 	fs.StringSlice(ghActionsRunnerLabels, nil, GHActionsRunnerLabelsDesc)
+	fs.StringP(ghActionsRunnerImageRepo, "", ghActionsRunnerImageRepoDefault, GHActionsRunnerImageRepoDesc)
 }
 
 func GithubRunnerArgs() *github.GithubRunnerArgs {
 	if viper.IsSet(ghActionsRunnerToken) {
 		return &github.GithubRunnerArgs{
-			Token:    viper.GetString(ghActionsRunnerToken),
-			RepoURL:  viper.GetString(ghActionsRunnerRepo),
-			Labels:   viper.GetStringSlice(ghActionsRunnerLabels),
-			Platform: &github.Linux,
-			Arch: linuxArchAsGithubActionsArch(
-				viper.GetString(LinuxArch)),
+			Token:           viper.GetString(ghActionsRunnerToken),
+			RepoURL:         viper.GetString(ghActionsRunnerRepo),
+			Labels:          viper.GetStringSlice(ghActionsRunnerLabels),
+			Platform:        &github.Linux,
+			Arch:            linuxArchAsGithubActionsArch(viper.GetString(LinuxArch)),
+			RunnerImageRepo: viper.GetString(ghActionsRunnerImageRepo),
 		}
 	}
 	return nil
@@ -359,6 +365,10 @@ func linuxArchAsGithubActionsArch(arch string) *github.Arch {
 	switch arch {
 	case "x86_64":
 		return &github.Amd64
+	case "ppc64le":
+		return &github.Ppc64le
+	case "s390x":
+		return &github.S390x
 	}
 	return &github.Arm64
 }

pkg/integrations/github/ghrunner.go

@@ -23,12 +23,23 @@ var snippetLinux []byte
 //go:embed snippet-windows.ps1
 var snippetWindows []byte
 
+//go:embed snippet-linux-ppc64le.sh
+var snippetLinuxPpc64le []byte
+
+//go:embed snippet-linux-s390x.sh
+var snippetLinuxS390x []byte
+
 var snippets map[Platform][]byte = map[Platform][]byte{
 	Darwin:  snippetDarwin,
 	Linux:   snippetLinux,
 	Windows: snippetWindows,
 }
 
+var archSnippets map[Arch][]byte = map[Arch][]byte{
+	Ppc64le: snippetLinuxPpc64le,
+	S390x:   snippetLinuxS390x,
+}
+
 var runnerArgs *GithubRunnerArgs
 
 func Init(args *GithubRunnerArgs) {
@@ -40,17 +51,22 @@ func (args *GithubRunnerArgs) GetUserDataValues() *integrations.UserDataValues {
 		return nil
 	}
 	return &integrations.UserDataValues{
-		Name:    args.Name,
-		Token:   args.Token,
-		Labels:  getLabels(),
-		RepoURL: args.RepoURL,
-		CliURL:  downloadURL(),
+		Name:            args.Name,
+		Token:           args.Token,
+		Labels:          getLabels(),
+		RepoURL:         args.RepoURL,
+		CliURL:          downloadURL(),
+		RunnerImageRepo: args.RunnerImageRepo,
 	}
 }
 
 func (args *GithubRunnerArgs) GetSetupScriptTemplate() string {
-	templateConfig := string(snippets[*runnerArgs.Platform][:])
-	return templateConfig
+	if *runnerArgs.Platform == Linux && runnerArgs.Arch != nil {
+		if archSnippet, ok := archSnippets[*runnerArgs.Arch]; ok {
+			return string(archSnippet[:])
+		}
+	}
+	return string(snippets[*runnerArgs.Platform][:])
 }
 
 func GetRunnerArgs() *GithubRunnerArgs {

pkg/integrations/github/snippet-linux-ppc64le.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+git clone {{ .RunnerImageRepo }} /opt/action-runner-image-pz
+
+cd /opt/action-runner-image-pz
+bash -c '. scripts/vm.sh rhel 9 minimal --skip-snap-lxd'
+
+cd /opt/runner-cache
+export DOTNET_ROOT=/opt/dotnet
+export PATH=$PATH:$DOTNET_ROOT
+
+./config.sh \
+    --unattended \
+    --disableupdate \
+    --ephemeral \
+    --name "{{ .Name }}" \
+    --labels "{{ .Labels }}" \
+    --url "{{ .RepoURL }}" \
+    --token "{{ .Token }}"
+
+nohup ./run.sh > /var/log/gh-runner.log 2>&1 &

pkg/integrations/github/snippet-linux-s390x.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+git clone {{ .RunnerImageRepo }} /opt/action-runner-image-pz
+
+cd /opt/action-runner-image-pz
+bash -c '. scripts/vm.sh ubuntu 22.04 minimal --skip-snap-lxd'
+
+cd /opt/runner-cache
+export DOTNET_ROOT=/opt/dotnet
+export PATH=$PATH:$DOTNET_ROOT
+
+./config.sh \
+    --unattended \
+    --disableupdate \
+    --ephemeral \
+    --name "{{ .Name }}" \
+    --labels "{{ .Labels }}" \
+    --url "{{ .RepoURL }}" \
+    --token "{{ .Token }}"
+
+nohup ./run.sh > /var/log/gh-runner.log 2>&1 &

pkg/integrations/github/types.go

@@ -8,17 +8,20 @@ var (
 	Linux   Platform = "linux"
 	Darwin  Platform = "osx"
 
-	Arm64 Arch = "arm64"
-	Amd64 Arch = "x64"
-	Arm   Arch = "arm"
+	Arm64   Arch = "arm64"
+	Amd64   Arch = "x64"
+	Arm     Arch = "arm"
+	Ppc64le Arch = "ppc64le"
+	S390x   Arch = "s390x"
 )
 
 type GithubRunnerArgs struct {
-	Token    string
-	RepoURL  string
-	Name     string
-	Platform *Platform
-	Arch     *Arch
-	Labels   []string
-	User     string
+	Token          string
+	RepoURL        string
+	Name           string
+	Platform       *Platform
+	Arch           *Arch
+	Labels         []string
+	User           string
+	RunnerImageRepo string
 }

pkg/integrations/integrations.go

@@ -6,16 +6,17 @@ import (
 )
 
 type UserDataValues struct {
-	CliURL     string
-	User       string
-	Name       string
-	Token      string
-	Labels     string
-	Port       string
-	RepoURL    string
-	Executor   string
-	Unsecure   bool
-	Concurrent int
+	CliURL          string
+	User            string
+	Name            string
+	Token           string
+	Labels          string
+	Port            string
+	RepoURL         string
+	Executor        string
+	Unsecure        bool
+	Concurrent      int
+	RunnerImageRepo string
 }
 
 type IntegrationConfig interface {

pkg/provider/ibmcloud/action/ibm-power/cloud-config

@@ -80,6 +80,13 @@ write_files:
     content: |
 {{.GitLabRunnerScript}}
 {{- end}}
+{{- if .GHActionsRunnerScript}}
+  - path: /opt/install-ghrunner.sh
+    permissions: '0700'
+    owner: root:root
+    content: |
+{{.GHActionsRunnerScript}}
+{{- end}}
 runcmd:
   - systemctl enable mount-data-home.service
   - dnf install -y git podman policycoreutils-python-utils
@@ -98,3 +105,6 @@ runcmd:
   - mkdir -p /var/log/gitlab-runner
   - bash /opt/install-glrunner.sh
 {{- end}}
+{{- if .GHActionsRunnerScript}}
+  - bash /opt/install-ghrunner.sh
+{{- end}}

pkg/provider/ibmcloud/action/ibm-power/ibm-power.go

@@ -11,6 +11,7 @@ import (
 	"github.com/pulumi/pulumi/sdk/v3/go/auto"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 	"github.com/redhat-developer/mapt/pkg/integrations"
+	"github.com/redhat-developer/mapt/pkg/integrations/github"
 	"github.com/redhat-developer/mapt/pkg/integrations/gitlab"
 	"github.com/redhat-developer/mapt/pkg/integrations/otelcol"
 	"github.com/redhat-developer/mapt/pkg/manager"
@@ -29,9 +30,10 @@ import (
 var CloudConfig []byte
 
 type userDataValues struct {
-	Gateway            string
-	OtelColScript      string
-	GitLabRunnerScript string
+	Gateway                string
+	OtelColScript          string
+	GitLabRunnerScript     string
+	GHActionsRunnerScript  string
 }
 
 const (
@@ -183,6 +185,15 @@ func (r *pwRequest) deploy(ctx *pulumi.Context) error {
 	}
 	hasOtel := otelSet == 3
 
+	ghRunnerScript := ""
+	if ghRunnerArgs := github.GetRunnerArgs(); ghRunnerArgs != nil {
+		s, err := integrations.GetIntegrationSnippetAsCloudInitWritableFile(ghRunnerArgs, defaultUser)
+		if err != nil {
+			return err
+		}
+		ghRunnerScript = *s
+	}
+
 	var piUserDataInput pulumi.StringPtrInput
 	glRunnerArgs := gitlab.GetRunnerArgs()
 	if glRunnerArgs != nil {
@@ -192,6 +203,7 @@ func (r *pwRequest) deploy(ctx *pulumi.Context) error {
 		}
 		gateway := subnetInfo.Gateway
 		localArgs := *glRunnerArgs
+		localGHScript := ghRunnerScript
 		piUserDataInput = authToken.ApplyT(func(token string) (*string, error) {
 			localArgs.AuthToken = token
 			glSnippet, err := integrations.GetIntegrationSnippetAsCloudInitWritableFile(&localArgs, defaultUser)
@@ -202,7 +214,7 @@ func (r *pwRequest) deploy(ctx *pulumi.Context) error {
 			if hasOtel {
 				otelArgs = r.otelArgs(true)
 			}
-			ud, err := piUserData(gateway, otelArgs, *glSnippet)
+			ud, err := piUserData(gateway, otelArgs, *glSnippet, localGHScript)
 			if err != nil {
 				return nil, err
 			}
@@ -213,7 +225,7 @@ func (r *pwRequest) deploy(ctx *pulumi.Context) error {
 		if hasOtel {
 			otelArgs = r.otelArgs(false)
 		}
-		ud, err := piUserData(subnetInfo.Gateway, otelArgs, "")
+		ud, err := piUserData(subnetInfo.Gateway, otelArgs, "", ghRunnerScript)
 		if err != nil {
 			return fmt.Errorf("failed to render user data: %w", err)
 		}
@@ -455,7 +467,7 @@ func (r *pwRequest) otelArgs(monitorGitLabRunner bool) *otelcol.OtelcolArgs {
 
 // piUserData renders the cloud-config template and returns it base64-encoded
 // for use as PiUserData on a PowerVS instance.
-func piUserData(gateway string, otelArgs *otelcol.OtelcolArgs, glRunnerScript string) (string, error) {
+func piUserData(gateway string, otelArgs *otelcol.OtelcolArgs, glRunnerScript, ghRunnerScript string) (string, error) {
 	otelScript := ""
 	if otelArgs != nil {
 		s, err := otelcol.GetSnippetAsCloudInitWritableFile(otelArgs)
@@ -466,9 +478,10 @@ func piUserData(gateway string, otelArgs *otelcol.OtelcolArgs, glRunnerScript st
 	}
 	script, err := file.Template(
 		userDataValues{
-			Gateway:            gateway,
-			OtelColScript:      otelScript,
-			GitLabRunnerScript: glRunnerScript,
+			Gateway:               gateway,
+			OtelColScript:         otelScript,
+			GitLabRunnerScript:    glRunnerScript,
+			GHActionsRunnerScript: ghRunnerScript,
 		},
 		string(CloudConfig))
 	if err != nil {