worker

Documentation

Overview

Package worker provides the defined CLI worker actions for Vela.

Usage:

import "github.com/go-vela/cli/action/worker"

Index

• type Config
  • func (c *Config) Add(client *vela.Client) error
  • func (c *Config) Get(client *vela.Client) error
  • func (c *Config) Update(client *vela.Client) error
  • func (c *Config) Validate() error
  • func (c *Config) View(client *vela.Client) error

Types

type Config

type Config struct {
	Action            string
	Address           string
	Hostname          string
	Active            bool
	Routes            []string
	BuildLimit        int64
	RegistrationToken bool
	Output            string
}

Config represents the configuration necessary to perform worker related requests with Vela.

func (*Config) Add

func (c *Config) Add(client *vela.Client) error

Add creates a worker based off the provided configuration.

func (*Config) Get

func (c *Config) Get(client *vela.Client) error

Get captures a list of workers based off the provided configuration.

func (*Config) Update

func (c *Config) Update(client *vela.Client) error

Update modifies a worker based off the provided configuration.

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies the configuration provided.

func (*Config) View

func (c *Config) View(client *vela.Client) error

View inspects a worker based off the provided configuration. Based on the configuration, it will either return details of a worker or view the registration token for the given worker.