options

Documentation

Index

• Constants
• type GetOptions
• type InstallOptions
• type KubernetesClusterAccess
• type ListOptions
• type SearchRepoOptions
• type ShowOptions
• type ShowOutputFormat
• type UninstallOptions

Constants

const (
	GetAll      releaseResource = "all"
	GetHooks    releaseResource = "hooks"
	GetManifest releaseResource = "manifest"
	GetNotes    releaseResource = "notes"
	GetValues   releaseResource = "values"
)

Types

type GetOptions

type GetOptions struct {
	Name                    string
	Namespace               string
	ReleaseResource         releaseResource
	KubernetesClusterAccess *KubernetesClusterAccess
}

type InstallOptions

type InstallOptions struct {
	Name                    string
	Chart                   string
	Namespace               string
	Repo                    string
	Wait                    bool
	ValuesFile              string
	PostRenderer            string
	KubernetesClusterAccess *KubernetesClusterAccess
}

type KubernetesClusterAccess

type KubernetesClusterAccess struct {
	ClusterServerURL         string `example:"https://mycompany.k8s.com"`
	CertificateAuthorityFile string `example:"/data/tls/localhost.crt"`
	AuthToken                string `example:"ey..."`
}

KubernetesClusterAccess represents core details which can be used to generate KubeConfig file/data

type ListOptions

type ListOptions struct {
	Filter                  string
	Selector                string
	Namespace               string
	KubernetesClusterAccess *KubernetesClusterAccess
}

ListOptions are portainer supported options for `helm list`

type SearchRepoOptions

type SearchRepoOptions struct {
	Repo string
}

type ShowOptions

type ShowOptions struct {
	OutputFormat ShowOutputFormat
	Chart        string
	Repo         string
}

ShowOptions are portainer supported options for `helm install`

type ShowOutputFormat

type ShowOutputFormat string

ShowOutputFormat is the format of the output of `helm show`

const (
	// ShowAll is the format which shows all the information of a chart
	ShowAll ShowOutputFormat = "all"
	// ShowChart is the format which only shows the chart's definition
	ShowChart ShowOutputFormat = "chart"
	// ShowValues is the format which only shows the chart's values
	ShowValues ShowOutputFormat = "values"
	// ShowReadme is the format which only shows the chart's README
	ShowReadme ShowOutputFormat = "readme"
)

type UninstallOptions

type UninstallOptions struct {
	Name                    string
	Namespace               string
	KubernetesClusterAccess *KubernetesClusterAccess
}

UninstallOptions are portainer supported options for `helm uninstall`