commands

Documentation

Index

• func CreateJobURL(projectURL string, jobID int) string
• func RunServiceControl(c *cli.Context)
• type AccessLevel
• type ExecCommand
  • func (c *ExecCommand) Execute(context *cli.Context)
• type ListCommand
  • func (c *ListCommand) Execute(context *cli.Context)
  • func (c *ListCommand) RunnerByName(name string) (*common.RunnerConfig, error)
• type NullService
  • func (n *NullService) Start(s service.Service) error
  • func (n *NullService) Stop(s service.Service) error
• type RegisterCommand
  • func (s *RegisterCommand) Execute(context *cli.Context)
  • func (c *RegisterCommand) RunnerByName(name string) (*common.RunnerConfig, error)
• type RunCommand
  • func (mr *RunCommand) Collect(ch chan<- prometheus.Metric)
  • func (mr *RunCommand) Describe(ch chan<- *prometheus.Desc)
  • func (mr *RunCommand) Execute(_ *cli.Context)
  • func (mr *RunCommand) Start(_ service.Service) error
  • func (mr *RunCommand) Stop(_ service.Service) error
• type RunSingleCommand
  • func (r *RunSingleCommand) Execute(c *cli.Context)
• type UnregisterCommand
  • func (c *UnregisterCommand) Execute(context *cli.Context)
  • func (c *UnregisterCommand) RunnerByName(name string) (*common.RunnerConfig, error)
• type VerifyCommand
  • func (c *VerifyCommand) Execute(context *cli.Context)
  • func (c *VerifyCommand) RunnerByName(name string) (*common.RunnerConfig, error)

Functions

func CreateJobURL

func CreateJobURL(projectURL string, jobID int) string

func RunServiceControl

func RunServiceControl(c *cli.Context)

Types

type AccessLevel

type AccessLevel string

const (
	NotProtected AccessLevel = "not_protected"
	RefProtected AccessLevel = "ref_protected"
)

type ExecCommand

type ExecCommand struct {
	common.RunnerSettings
	Job     string
	Timeout int `long:"timeout" description:"Job execution timeout (in seconds)"`
}

func (*ExecCommand) Execute

func (c *ExecCommand) Execute(context *cli.Context)

type ListCommand

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

func (*ListCommand) Execute

func (c *ListCommand) Execute(context *cli.Context)

func (*ListCommand) RunnerByName

func (c *ListCommand) RunnerByName(name string) (*common.RunnerConfig, error)

type NullService

type NullService struct {
}

func (*NullService) Start

func (n *NullService) Start(s service.Service) error

func (*NullService) Stop

func (n *NullService) Stop(s service.Service) error

type RegisterCommand

type RegisterCommand struct {
	ConfigTemplate configTemplate `namespace:"template"`

	TagList           string `long:"tag-list" env:"RUNNER_TAG_LIST" description:"Tag list"`
	NonInteractive    bool   `short:"n" long:"non-interactive" env:"REGISTER_NON_INTERACTIVE" description:"Run registration unattended"`
	LeaveRunner       bool   `long:"leave-runner" env:"REGISTER_LEAVE_RUNNER" description:"Don't remove runner if registration fails"`
	RegistrationToken string `short:"r" long:"registration-token" env:"REGISTRATION_TOKEN" description:"Runner's registration token"`
	RunUntagged       bool   `` /* 138-byte string literal not displayed */
	Locked            bool   `long:"locked" env:"REGISTER_LOCKED" description:"Lock Runner for current project, defaults to 'true'"`
	AccessLevel       string `` /* 153-byte string literal not displayed */
	MaximumTimeout    int    `` /* 156-byte string literal not displayed */
	Paused            bool   `long:"paused" env:"REGISTER_PAUSED" description:"Set Runner to be paused, defaults to 'false'"`

	common.RunnerConfig
	// contains filtered or unexported fields
}

func (*RegisterCommand) Execute

func (s *RegisterCommand) Execute(context *cli.Context)

func (*RegisterCommand) RunnerByName

func (c *RegisterCommand) RunnerByName(name string) (*common.RunnerConfig, error)

type RunCommand

type RunCommand struct {
	ServiceName      string `short:"n" long:"service" description:"Use different names for different services"`
	WorkingDirectory string `short:"d" long:"working-directory" description:"Specify custom working directory"`
	User             string `short:"u" long:"user" description:"Use specific user to execute shell scripts"`
	Syslog           bool   `long:"syslog" description:"Log to system service logger" env:"LOG_SYSLOG"`
	// contains filtered or unexported fields
}

func (*RunCommand) Collect

func (mr *RunCommand) Collect(ch chan<- prometheus.Metric)

Collect implements prometheus.Collector.

func (*RunCommand) Describe

func (mr *RunCommand) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

func (*RunCommand) Execute

func (mr *RunCommand) Execute(_ *cli.Context)

func (*RunCommand) Start

func (mr *RunCommand) Start(_ service.Service) error

Start is the method implementing `github.com/ayufan/golang-kardianos-service`.`Interface` interface. It's responsible for a non-blocking initialization of the process. When it exits, the main control flow is passed to runWait() configured as service's RunWait method. Take a look into Execute() for details.

func (*RunCommand) Stop

func (mr *RunCommand) Stop(_ service.Service) error

Stop is the method implementing `github.com/ayufan/golang-kardianos-service`.`Interface` interface. It's responsible for triggering the process stop. First it starts a goroutine that starts broadcasting the interrupt signal (used to stop workers scaling goroutine). Next it triggers graceful shutdown, which will be handled only if a proper signal is used. At the end it triggers the forceful shutdown, which handles the forceful the process termination.

type RunSingleCommand

type RunSingleCommand struct {
	common.RunnerConfig

	WaitTimeout int `long:"wait-timeout" description:"How long to wait in seconds before receiving the first job"`

	MaxBuilds int `long:"max-builds" description:"How many builds to process before exiting"`
	// contains filtered or unexported fields
}

func (*RunSingleCommand) Execute

func (r *RunSingleCommand) Execute(c *cli.Context)

type UnregisterCommand

type UnregisterCommand struct {
	common.RunnerCredentials

	Name       string `toml:"name" json:"name" short:"n" long:"name" description:"Name of the runner you wish to unregister"`
	AllRunners bool   `toml:"all_runners" json:"all-runners" long:"all-runners" description:"Unregister all runners"`
	// contains filtered or unexported fields
}

func (*UnregisterCommand) Execute

func (c *UnregisterCommand) Execute(context *cli.Context)

func (*UnregisterCommand) RunnerByName

func (c *UnregisterCommand) RunnerByName(name string) (*common.RunnerConfig, error)

type VerifyCommand

type VerifyCommand struct {
	common.RunnerCredentials

	Name              string `toml:"name" json:"name" short:"n" long:"name" description:"Name of the runner you wish to verify"`
	DeleteNonExisting bool   `long:"delete" description:"Delete no longer existing runners?"`
	// contains filtered or unexported fields
}

func (*VerifyCommand) Execute

func (c *VerifyCommand) Execute(context *cli.Context)

func (*VerifyCommand) RunnerByName

func (c *VerifyCommand) RunnerByName(name string) (*common.RunnerConfig, error)