installparams

package
v0.71.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2025 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package installparams implements function parameters for agent install functions

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Option

type Option func(*Params)

Option alias to a functional option changing a given Params instance

func WithAPIKey added in v0.51.0

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 added in v0.51.0

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 added in v0.51.0

func WithPipelineID(id string) Option

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

func WithTestingKeysURL added in v0.70.0

func WithTestingKeysURL(url string) Option

WithTestingKeysURL specify the url to get the GPG public keys from when installing the agent

func WithUpgrade added in v0.51.0

func WithUpgrade(upgrade bool) Option

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

func WithUsername added in v0.71.0

func WithUsername(username string) Option

WithUsername specify a custom username to use when installing the agent

type Params

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

Params struct containing install params

func NewParams

func NewParams(options ...Option) *Params

NewParams creates a new instance of Install params

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL