v1

package
v0.16.13 Latest Latest
Warning

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

Go to latest
Published: Jul 9, 2025 License: Apache-2.0 Imports: 6 Imported by: 28

Documentation

Overview

+k8s:deepcopy-gen=package +groupName=helm.cattle.io

+k8s:deepcopy-gen=package +groupName=helm.cattle.io

+k8s:deepcopy-gen=package +groupName=helm.cattle.io

Index

Constants

This section is empty.

Variables

View Source
var (
	HelmChartResourceName       = "helmcharts"
	HelmChartConfigResourceName = "helmchartconfigs"
)
View Source
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: helm.GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type FailurePolicy added in v0.16.12

type FailurePolicy string

+kubebuilder:validation:Enum={"abort","reinstall"}

type HelmChart

type HelmChart struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   HelmChartSpec   `json:"spec,omitempty"`
	Status HelmChartStatus `json:"status,omitempty"`
}

HelmChart represents configuration and state for the deployment of a Helm chart.

func NewHelmChart

func NewHelmChart(namespace, name string, obj HelmChart) *HelmChart

func (*HelmChart) DeepCopy

func (in *HelmChart) DeepCopy() *HelmChart

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChart.

func (*HelmChart) DeepCopyInto

func (in *HelmChart) DeepCopyInto(out *HelmChart)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HelmChart) DeepCopyObject

func (in *HelmChart) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HelmChartCondition added in v0.15.12

type HelmChartCondition struct {
	// Type of job condition.
	Type HelmChartConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

func (*HelmChartCondition) DeepCopy added in v0.15.12

func (in *HelmChartCondition) DeepCopy() *HelmChartCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartCondition.

func (*HelmChartCondition) DeepCopyInto added in v0.15.12

func (in *HelmChartCondition) DeepCopyInto(out *HelmChartCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HelmChartConditionType added in v0.15.12

type HelmChartConditionType string
const (
	HelmChartJobCreated HelmChartConditionType = "JobCreated"
	HelmChartFailed     HelmChartConditionType = "Failed"
)

type HelmChartConfig

type HelmChartConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec HelmChartConfigSpec `json:"spec,omitempty"`
}

HelmChartConfig represents additional configuration for the installation of Helm chart release. This resource is intended for use when additional configuration needs to be passed to a HelmChart that is managed by an external system.

func NewHelmChartConfig

func NewHelmChartConfig(namespace, name string, obj HelmChartConfig) *HelmChartConfig

func (*HelmChartConfig) DeepCopy

func (in *HelmChartConfig) DeepCopy() *HelmChartConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartConfig.

func (*HelmChartConfig) DeepCopyInto

func (in *HelmChartConfig) DeepCopyInto(out *HelmChartConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HelmChartConfig) DeepCopyObject

func (in *HelmChartConfig) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HelmChartConfigList

type HelmChartConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []HelmChartConfig `json:"items"`
}

HelmChartConfigList is a list of HelmChartConfig resources

func (*HelmChartConfigList) DeepCopy

func (in *HelmChartConfigList) DeepCopy() *HelmChartConfigList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartConfigList.

func (*HelmChartConfigList) DeepCopyInto

func (in *HelmChartConfigList) DeepCopyInto(out *HelmChartConfigList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HelmChartConfigList) DeepCopyObject

func (in *HelmChartConfigList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HelmChartConfigSpec

type HelmChartConfigSpec struct {
	// Override complex Chart values via inline YAML content.
	// Helm CLI positional argument/flag: `--values`
	ValuesContent string `json:"valuesContent,omitempty"`
	// Override complex Chart values via references to external Secrets.
	// Helm CLI positional argument/flag: `--values`
	ValuesSecrets []SecretSpec `json:"valuesSecrets,omitempty"`
	// Configures handling of failed chart installation or upgrades.
	// - `reinstall` will perform a clean uninstall and reinstall of the chart.
	// - `abort` will take no action and leave the chart in a failed state so that the administrator can manually resolve the error.
	// +kubebuilder:default=reinstall
	FailurePolicy FailurePolicy `json:"failurePolicy,omitempty"`
}

HelmChartConfigSpec represents additional user-configurable details of an installed and configured Helm chart release. These fields are merged with or override the corresponding fields on the related HelmChart resource.

func (*HelmChartConfigSpec) DeepCopy

func (in *HelmChartConfigSpec) DeepCopy() *HelmChartConfigSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartConfigSpec.

func (*HelmChartConfigSpec) DeepCopyInto

func (in *HelmChartConfigSpec) DeepCopyInto(out *HelmChartConfigSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HelmChartList

type HelmChartList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []HelmChart `json:"items"`
}

HelmChartList is a list of HelmChart resources

func (*HelmChartList) DeepCopy

func (in *HelmChartList) DeepCopy() *HelmChartList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartList.

func (*HelmChartList) DeepCopyInto

func (in *HelmChartList) DeepCopyInto(out *HelmChartList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HelmChartList) DeepCopyObject

func (in *HelmChartList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HelmChartSpec

type HelmChartSpec struct {
	// Helm Chart target namespace.
	// Helm CLI positional argument/flag: `--namespace`
	TargetNamespace string `json:"targetNamespace,omitempty"`
	// Create target namespace if not present.
	// Helm CLI positional argument/flag: `--create-namespace`
	CreateNamespace bool `json:"createNamespace,omitempty"`
	// Helm Chart name in repository, or complete HTTPS URL to chart archive (.tgz)
	// Helm CLI positional argument/flag: `CHART`
	Chart string `json:"chart,omitempty"`
	// Helm Chart version. Only used when installing from repository; ignored when .spec.chart or .spec.chartContent is used to install a specific chart archive.
	// Helm CLI positional argument/flag: `--version`
	Version string `json:"version,omitempty"`
	// Helm Chart repository URL.
	// Helm CLI positional argument/flag: `--repo`
	Repo string `json:"repo,omitempty"`
	// Verify certificates of HTTPS-enabled servers using this CA bundle. Should be a string containing one or more PEM-encoded CA Certificates.
	// Helm CLI positional argument/flag: `--ca-file`
	RepoCA string `json:"repoCA,omitempty"`
	// Reference to a ConfigMap containing CA Certificates to be be trusted by Helm. Can be used along with or instead of `.spec.repoCA`
	// Helm CLI positional argument/flag: `--ca-file`
	RepoCAConfigMap *corev1.LocalObjectReference `json:"repoCAConfigMap,omitempty"`
	// Override simple Chart values. These take precedence over options set via valuesContent.
	// Helm CLI positional argument/flag: `--set`, `--set-string`
	Set map[string]intstr.IntOrString `json:"set,omitempty"`
	// Override complex Chart values via inline YAML content.
	// Helm CLI positional argument/flag: `--values`
	ValuesContent string `json:"valuesContent,omitempty"`
	// Override complex Chart values via references to external Secrets.
	// Helm CLI positional argument/flag: `--values`
	ValuesSecrets []SecretSpec `json:"valuesSecrets,omitempty"`
	// DEPRECATED. Helm version to use. Only v3 is currently supported.
	HelmVersion string `json:"helmVersion,omitempty"`
	// Set to True if this chart is needed to bootstrap the cluster (Cloud Controller Manager, CNI, etc)
	Bootstrap bool `json:"bootstrap,omitempty"`
	// Base64-encoded chart archive .tgz; overides `.spec.chart` and `.spec.version`
	// Helm CLI positional argument/flag: `CHART`
	ChartContent string `json:"chartContent,omitempty"`
	// Specify the image to use for tht helm job pod when installing or upgrading the helm chart.
	JobImage string `json:"jobImage,omitempty"`
	// Specify the number of retries before considering the helm job failed.
	BackOffLimit *int32 `json:"backOffLimit,omitempty"`
	// Timeout for Helm operations.
	// Helm CLI positional argument/flag: `--timeout`
	Timeout *metav1.Duration `json:"timeout,omitempty"`
	// Configures handling of failed chart installation or upgrades.
	// - `reinstall` will perform a clean uninstall and reinstall of the chart.
	// - `abort` will take no action and leave the chart in a failed state so that the administrator can manually resolve the error.
	// +kubebuilder:default=reinstall
	FailurePolicy FailurePolicy `json:"failurePolicy,omitempty"`
	// Reference to Secret of type kubernetes.io/basic-auth holding Basic auth credentials for the Chart repo.
	AuthSecret *corev1.LocalObjectReference `json:"authSecret,omitempty"`
	// Pass Basic auth credentials to all domains.
	// Helm CLI positional argument/flag: `--pass-credentials`
	AuthPassCredentials bool `json:"authPassCredentials,omitempty"`
	// Skip TLS certificate checks for the chart download.
	// Helm CLI positional argument/flag: `--insecure-skip-tls-verify`
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
	// Use insecure HTTP connections for the chart download.
	// Helm CLI positional argument/flag: `--plain-http`
	PlainHTTP bool `json:"plainHTTP,omitempty"`
	// Reference to Secret of type kubernetes.io/dockerconfigjson holding Docker auth credentials for the OCI-based registry acting as the Chart repo.
	DockerRegistrySecret *corev1.LocalObjectReference `json:"dockerRegistrySecret,omitempty"`
	// Custom PodSecurityContext for the helm job pod.
	PodSecurityContext *corev1.PodSecurityContext `json:"podSecurityContext,omitempty"`
	// custom SecurityContext for the helm job pod.
	SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`
}

HelmChartSpec represents the user-configurable details for installation and upgrade of a Helm chart release.

func (*HelmChartSpec) DeepCopy

func (in *HelmChartSpec) DeepCopy() *HelmChartSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartSpec.

func (*HelmChartSpec) DeepCopyInto

func (in *HelmChartSpec) DeepCopyInto(out *HelmChartSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HelmChartStatus

type HelmChartStatus struct {
	// The name of the job created to install or upgrade the chart.
	JobName string `json:"jobName,omitempty"`
	// `JobCreated` indicates that a job has been created to install or upgrade the chart.
	// `Failed` indicates that the helm job has failed and the failure policy is set to `abort`.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=type
	Conditions []HelmChartCondition `json:"conditions,omitempty"`
}

HelmChartStatus represents the resulting state from processing HelmChart events

func (*HelmChartStatus) DeepCopy

func (in *HelmChartStatus) DeepCopy() *HelmChartStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartStatus.

func (*HelmChartStatus) DeepCopyInto

func (in *HelmChartStatus) DeepCopyInto(out *HelmChartStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecretSpec added in v0.16.7

type SecretSpec struct {
	// Name of the secret. Must be in the same namespace as the HelmChart resource.
	Name string `json:"name,omitempty"`
	// Keys to read values content from. If no keys are specified, the secret is not used.
	Keys []string `json:"keys,omitempty"`
	// Ignore changes to the secret, and mark the secret as optional.
	// By default, the secret must exist, and changes to the secret will trigger an upgrade of the chart to apply the updated values.
	// If `ignoreUpdates` is true, the secret is optional, and changes to the secret will not trigger an upgrade of the chart.
	IgnoreUpdates bool `json:"ignoreUpdates,omitempty"`
}

SecretSpec describes a key in a secret to load chart values from.

func (*SecretSpec) DeepCopy added in v0.16.7

func (in *SecretSpec) DeepCopy() *SecretSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretSpec.

func (*SecretSpec) DeepCopyInto added in v0.16.7

func (in *SecretSpec) DeepCopyInto(out *SecretSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

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