executor

README

gitlab-machine

A tool to deploy on demand Gitlab CI/CD runners using the Custom Executor.

What is it?

The Custom Executor is a mechanism from GitLab CI/CD that allows to plug specific runners to the CI/CD pipeline. This tool is a wrapper around the Custom Executor that allows to deploy on demand virtual instances.

It is currently in pre-alpha state, with support only for VMware Cloud Director and Windows machines (using SSH communication).

It should probably be replace with https://gitlab.com/gitlab-org/ci-cd/custom-executor-drivers/autoscaler

Expected config

# The config file is a YAML file with the following structure:
log_level: debug

drivers:
  vcd:
    motd: "Deploying a dedicated VM using https://github.com/juanfont/gitlab-machine"
    url: https://cloudirector
    org: tenant
    vdc: virtualdatancer
    insecure: false
    user: username
    password: password
    vdc_network: orgvdcnetwrok
    catalog: vcdcatalogue
    template: Windows_10
    num_cpus: 8
    cores_per_socket: 8
    memory_mb: 8192
    storage_profile: storageprofile
    default_password: VMpassword

More info

• GitLab Custom Executor
• Windows SaaS runners
• A practical guide to the Custom Executor

Documentation

Index

• type Executor
  • func NewExecutor(d drivers.Driver) (*Executor, error)
  • func (e *Executor) CleanUp() error
  • func (e *Executor) Prepare() error
  • func (e *Executor) Run(filePath string, stage string) error
  • func (e *Executor) Shell(cmd string) error

Types

type Executor

type Executor struct {
	// contains filtered or unexported fields
}

func NewExecutor

func NewExecutor(d drivers.Driver) (*Executor, error)

func (*Executor) CleanUp

func (e *Executor) CleanUp() error

Cleanup releases the resources once the job has finished

func (*Executor) Prepare

func (e *Executor) Prepare() error

Prepare calls the driver to ready up a new execution environment

func (*Executor) Run

func (e *Executor) Run(filePath string, stage string) error

Run executes the required script

func (*Executor) Shell

func (e *Executor) Shell(cmd string) error

Shell opens a shell with the specified command