fpoc

README

fleeting-plugin-openstack

GitLab fleeting plugin for OpenStack.

https://docs.gitlab.com/runner/executors/docker_autoscaler.html

Plugin Configuration

The following parameters are supported:

Parameter	Type	Description
cloud	string	Name of the cloud config from clouds.yaml to use
clouds_config	string	Optional. Path to clouds.yaml
name	string	Name of the Auto Scaling Group
boot_time	string	Optional. Maximum wait time for instance to boot up. During that time plugin check Cloud-Init signatures.
server_spec	object	Server spec used to create instances. See: Compute API

Default connector config

Parameter	Default
os	linux
protocol	ssh
username	unset
use_static_credentials	true

OpenStack setup

1. You should create a special user (recommended) and project (optional), then export clouds.yaml with credentials for that cloud.

2. You may create a tenant network for workers, in that case don't forget to add a router. In that case manager VM should have two ports: external and that tenant network, so it will be able to connect to the worker instances.

3. You should upload a special image with gitlab-runner and container runtime installed in it. For example we use Fedora 38 with Podman.

4. You should generate SSH keypair which will be used my manager instance to connect to workers. Public key must be added to Nova from the user.

Example runner config

concurrent = 16
check_interval = 0
shutdown_timeout = 0
log_level = "info"

[session_server]
session_timeout = 1800

[[runners]]
name = "manager"
url = "https://gitlab.com"
token = "token"
executor = "docker-autoscaler"
output_limit = 10240
shell = "bash"
environment = [
  "FF_NETWORK_PER_BUILD=1"
  ]

[runners.cache]
Type = "s3"
Shared = true

[runners.cache.s3]
ServerAddress = "s3.foo.bar"
AccessKey = "access"
SecretKey = "secret"
BucketName = "cache"

[runners.docker]
disable_entrypoint_overwrite = false
oom_kill_disable = false
disable_cache = true
shm_size = 0
network_mtu = 0
host = "unix:///run/user/1000/podman/podman.sock"
tls_verify = false
image = "quay.io/podman/stable"
privileged = true
pull_policy = ["always", "always"]

[runners.autoscaler]
capacity_per_instance = 1
max_use_count = 10
max_instances = 16
plugin = "fleeting-plugin-openstack"

[runners.autoscaler.plugin_config]
cloud = "runner"
# clouds_file = "/etc/openstack/clouds.yaml"
name = "podman-runners"
boot_time = "10m"

[runners.autoscaler.plugin_config.server_spec]
name = "podman-runner-%d"                                               # %d replaced with instance index
description = "GitLab CI Podman runners with autoscaling"
tags = ["GitLab", "CI", "Podman"]
imageRef = "d5460af5-83f3-47d7-9c4f-80294c66b267"                       # Fedora 38 + gitlab-runner
flavorRef = "4e9d4fa4-a703-4850-8bc1-58b5e139ab57"                      # xlarge flavor
key_name = "runner_key"                                                 # SSH public key for worker nodes
networks = [ { uuid = "f05e7f64-9e0f-4c5c-acb0-b636000d7301" } ]        # tenant network
security_groups = [ "cee22d91-bb9a-455d-be88-e911d3cb066a" ]            # allow SSH ingress from tenant network
scheduler_hints = { group = "a9c941cb-5b34-46e0-8fc6-7471e3b77c75" }    # [Soft-]Anti-Affinity group
# runcmd required for podman, see also gitlab docs
user_data = '''#cloud-config
package_update: true
package_upgrade: true
runcmd:
- systemctl --now enable podman.socket
- sudo -u fedora systemctl --user --now enable podman.socket
- loginctl enable-linger gitlab-runner
'''

[runners.autoscaler.connector_config]
username = "fedora"
password = ""
key_path = "/etc/gitlab-runner/id_rsa"
use_static_credentials = true
keepalive = "30s"
timeout = "0m"
use_external_addr = false

[[runners.autoscaler.policy]]
idle_count = 2
idle_time = "30m0s"
scale_factor = 0.0
scale_factor_limit = 0

Documentation

Index

• Constants
• Variables
• func BuildInfo() string
• func IsCloudInitFinished(log string) bool
• type Address
• type ExtCreateOpts
  • func (opts ExtCreateOpts) ToServerCreateMap() (map[string]interface{}, error)
• type InstanceGroup
  • func (g *InstanceGroup) ConnectInfo(ctx context.Context, instanceID string) (provider.ConnectInfo, error)
  • func (g *InstanceGroup) Decrease(ctx context.Context, instances []string) (succeeded []string, err error)
  • func (g *InstanceGroup) Increase(ctx context.Context, delta int) (succeeded int, err error)
  • func (g *InstanceGroup) Init(ctx context.Context, log hclog.Logger, settings provider.Settings) (provider.ProviderInfo, error)
  • func (g *InstanceGroup) Shutdown(ctx context.Context) error
  • func (g *InstanceGroup) Update(ctx context.Context, update func(instance string, state provider.State)) error

Constants

const MetadataKey = "fleeting-cluster"

Variables

var (
	Version   string = "dev"
	Revision  string = "HEAD"
	Branch    string = "HEAD"
	BuildUser string = "nobody"
	BuildDate string = "now"
)

Functions

func BuildInfo

func BuildInfo() string

func IsCloudInitFinished

func IsCloudInitFinished(log string) bool

Types

type Address

type Address struct {
	Version int    `json:"version"`
	Address string `json:"addr"`
	MACAddr string `json:"OS-EXT-IPS-MAC:mac_addr,omitempty"`
	Type    string `json:"OS-EXT-IPS:type,omitempty"`
}

type ExtCreateOpts

type ExtCreateOpts struct {
	servers.CreateOpts

	// fields absent in gophercloud
	Description string `json:"description,omitempty"`
	KeyName     string `json:"key_name,omitempty"`

	// annotation overrides
	Networks       []servers.Network       `json:"networks,omitempty"`
	SecurityGroups []string                `json:"security_groups,omitempty"`
	UserData       string                  `json:"user_data,omitempty"`
	SchedulerHints *servers.SchedulerHints `json:"scheduler_hints,omitempty"`
}

ExtCreateOpts extended version of servers.CreateOpts nolint:revive

func (ExtCreateOpts) ToServerCreateMap

func (opts ExtCreateOpts) ToServerCreateMap() (map[string]interface{}, error)

ToServerCreateMap for extended opts

type InstanceGroup

type InstanceGroup struct {
	Cloud        string        `json:"cloud"`         // cloud to use
	CloudsConfig string        `json:"clouds_config"` // optional: path to clouds.yaml
	Name         string        `json:"name"`          // name of the cluster
	ServerSpec   ExtCreateOpts `json:"server_spec"`   // instance creation spec
	BootTimeS    string        `json:"boot_time"`     // optional: wait some time before report machine as available
	BootTime     time.Duration
	// contains filtered or unexported fields
}

func (*InstanceGroup) ConnectInfo

func (g *InstanceGroup) ConnectInfo(ctx context.Context, instanceID string) (provider.ConnectInfo, error)

func (*InstanceGroup) Decrease

func (g *InstanceGroup) Decrease(ctx context.Context, instances []string) (succeeded []string, err error)

func (*InstanceGroup) Increase

func (g *InstanceGroup) Increase(ctx context.Context, delta int) (succeeded int, err error)

func (*InstanceGroup) Init

func (g *InstanceGroup) Init(ctx context.Context, log hclog.Logger, settings provider.Settings) (provider.ProviderInfo, error)

func (*InstanceGroup) Shutdown

func (g *InstanceGroup) Shutdown(ctx context.Context) error

func (*InstanceGroup) Update

func (g *InstanceGroup) Update(ctx context.Context, update func(instance string, state provider.State)) error