installparams

Documentation

Overview

Package installparams implements function parameters for agent install functions

Index

• type Option
  • func WithAPIKey(apiKey string) Option
  • func WithArch(arch string) Option
  • func WithFlavor(flavor string) Option
  • func WithMajorVersion(majorVersion string) Option
  • func WithPipelineID(id string) Option
  • func WithUpgrade(upgrade bool) Option
• type Params
  • func NewParams(options ...Option) *Params

Types

type Option

type Option func(*Params)

Option alias to a functional option changing a given Params instance

func WithAPIKey

func WithAPIKey(apiKey string) Option

WithAPIKey specify a custom api key to use when installing the agent

func WithArch

func WithArch(arch string) Option

WithArch specify the arch to use when installing the agent, needed to determine repo for deb repository

func WithFlavor

func WithFlavor(flavor string) Option

WithFlavor specify the flavor to use when installing the agent

func WithMajorVersion

func WithMajorVersion(majorVersion string) Option

WithMajorVersion set the major version of the agent to install

func WithPipelineID

func WithPipelineID(id string) Option

WithPipelineID specify a custom pipeline ID to use when installing the agent

func WithUpgrade

func WithUpgrade(upgrade bool) Option

WithUpgrade specify if the upgrade environment variable is used when installing the agent

type Params

type Params struct {
	PipelineID   string
	MajorVersion string
	Arch         string
	Flavor       string
	Upgrade      bool
	APIKey       string
}

Params struct containing install params

func NewParams

func NewParams(options ...Option) *Params

NewParams creates a new instance of Install params