Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package,register +groupName=helm.fluxcd.io Package v1 is the v1 version of the API. The prior version was flux.weave.works/v1beta1.
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type ChartFileSelector
- type ChartSource
- type ExternalSourceSelector
- type GitChartSource
- type HelmRelease
- func (in *HelmRelease) DeepCopy() *HelmRelease
- func (in *HelmRelease) DeepCopyInto(out *HelmRelease)
- func (in *HelmRelease) DeepCopyObject() runtime.Object
- func (hr HelmRelease) GetDefaultedNamespace() string
- func (hr HelmRelease) GetTargetNamespace() string
- func (hr HelmRelease) GetTimeout() int64
- func (hr HelmRelease) GetValuesFromSources() []ValuesFromSource
- func (hr HelmRelease) ReleaseName() string
- func (hr HelmRelease) ResourceID() resource.ID
- type HelmReleaseCondition
- type HelmReleaseConditionType
- type HelmReleaseList
- type HelmReleaseSpec
- type HelmReleaseStatus
- type HelmValues
- type RepoChartSource
- type Rollback
- type ValuesFromSource
Constants ¶
const DefaultGitRef = "master"
DefaultGitRef is the ref assumed if the Ref field is not given in a GitChartSource
const Version = "v1"
Variables ¶
var ( // SchemeBuilder will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder // AddToScheme will stay in k8s.io/kubernetes. AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: helm.GroupName, Version: Version}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type ChartFileSelector ¶
type ChartFileSelector struct { Path string `json:"path"` // Do not fail if chart file could not be retrieved // +optional Optional *bool `json:"optional,omitempty"` }
func (*ChartFileSelector) DeepCopy ¶
func (in *ChartFileSelector) DeepCopy() *ChartFileSelector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChartFileSelector.
func (*ChartFileSelector) DeepCopyInto ¶
func (in *ChartFileSelector) DeepCopyInto(out *ChartFileSelector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChartSource ¶
type ChartSource struct { // one of the following... // +optional *GitChartSource // +optional *RepoChartSource }
func (*ChartSource) DeepCopy ¶
func (in *ChartSource) DeepCopy() *ChartSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChartSource.
func (*ChartSource) DeepCopyInto ¶
func (in *ChartSource) DeepCopyInto(out *ChartSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExternalSourceSelector ¶
type ExternalSourceSelector struct { URL string `json:"url"` // Do not fail if external source could not be retrieved // +optional Optional *bool `json:"optional,omitempty"` }
func (*ExternalSourceSelector) DeepCopy ¶
func (in *ExternalSourceSelector) DeepCopy() *ExternalSourceSelector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalSourceSelector.
func (*ExternalSourceSelector) DeepCopyInto ¶
func (in *ExternalSourceSelector) DeepCopyInto(out *ExternalSourceSelector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitChartSource ¶
type GitChartSource struct { GitURL string `json:"git"` Ref string `json:"ref"` Path string `json:"path"` // Do not run 'dep' update (assume requirements.yaml is already fulfilled) // +optional SkipDepUpdate bool `json:"skipDepUpdate,omitempty"` }
func (*GitChartSource) DeepCopy ¶
func (in *GitChartSource) DeepCopy() *GitChartSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitChartSource.
func (*GitChartSource) DeepCopyInto ¶
func (in *GitChartSource) DeepCopyInto(out *GitChartSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GitChartSource) RefOrDefault ¶
func (s GitChartSource) RefOrDefault() string
type HelmRelease ¶
type HelmRelease struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` Spec HelmReleaseSpec `json:"spec"` Status HelmReleaseStatus `json:"status"` }
FluxHelmRelease represents custom resource associated with a Helm Chart
func (*HelmRelease) DeepCopy ¶
func (in *HelmRelease) DeepCopy() *HelmRelease
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmRelease.
func (*HelmRelease) DeepCopyInto ¶
func (in *HelmRelease) DeepCopyInto(out *HelmRelease)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HelmRelease) DeepCopyObject ¶
func (in *HelmRelease) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (HelmRelease) GetDefaultedNamespace ¶
func (hr HelmRelease) GetDefaultedNamespace() string
GetDefaultedNamespace returns the HelmRelease's namespace defaulting to the "default" if not set.
func (HelmRelease) GetTargetNamespace ¶
func (hr HelmRelease) GetTargetNamespace() string
GetTargetNamespace returns the configured release targetNamespace defaulting to the namespace of the HelmRelease if not set.
func (HelmRelease) GetTimeout ¶
func (hr HelmRelease) GetTimeout() int64
GetTimeout returns the install or upgrade timeout (defaults to 300s)
func (HelmRelease) GetValuesFromSources ¶
func (hr HelmRelease) GetValuesFromSources() []ValuesFromSource
GetValuesFromSources maintains backwards compatibility with ValueFileSecrets by merging them into the ValuesFrom array.
func (HelmRelease) ReleaseName ¶
func (hr HelmRelease) ReleaseName() string
ReleaseName returns the configured release name, or constructs and returns one based on the namespace and name of the HelmRelease. When the HelmRelease's metadata.namespace and spec.targetNamespace differ, both are used in the generated name. This name is used for naming and operating on the release in Helm.
func (HelmRelease) ResourceID ¶
func (hr HelmRelease) ResourceID() resource.ID
ResourceID returns an ID made from the identifying parts of the resource, as a convenience for Flux, which uses them everywhere.
type HelmReleaseCondition ¶
type HelmReleaseCondition struct { Type HelmReleaseConditionType `json:"type"` Status v1.ConditionStatus `json:"status"` // +optional LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"` // +optional LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` // +optional Reason string `json:"reason,omitempty"` // +optional Message string `json:"message,omitempty"` }
func (*HelmReleaseCondition) DeepCopy ¶
func (in *HelmReleaseCondition) DeepCopy() *HelmReleaseCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmReleaseCondition.
func (*HelmReleaseCondition) DeepCopyInto ¶
func (in *HelmReleaseCondition) DeepCopyInto(out *HelmReleaseCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmReleaseConditionType ¶
type HelmReleaseConditionType string
const ( // ChartFetched means the chart to which the HelmRelease refers // has been fetched successfully HelmReleaseChartFetched HelmReleaseConditionType = "ChartFetched" // Released means the chart release, as specified in this // HelmRelease, has been processed by Helm. HelmReleaseReleased HelmReleaseConditionType = "Released" // RolledBack means the chart to which the HelmRelease refers // has been rolled back HelmReleaseRolledBack HelmReleaseConditionType = "RolledBack" )
type HelmReleaseList ¶
type HelmReleaseList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []HelmRelease `json:"items"` }
HelmReleaseList is a list of FluxHelmRelease resources
func (*HelmReleaseList) DeepCopy ¶
func (in *HelmReleaseList) DeepCopy() *HelmReleaseList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmReleaseList.
func (*HelmReleaseList) DeepCopyInto ¶
func (in *HelmReleaseList) DeepCopyInto(out *HelmReleaseList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HelmReleaseList) DeepCopyObject ¶
func (in *HelmReleaseList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HelmReleaseSpec ¶
type HelmReleaseSpec struct { ChartSource `json:"chart"` ReleaseName string `json:"releaseName,omitempty"` ValueFileSecrets []v1.LocalObjectReference `json:"valueFileSecrets,omitempty"` ValuesFrom []ValuesFromSource `json:"valuesFrom,omitempty"` HelmValues `json:",inline"` // Override the target namespace, defaults to metadata.namespace // +optional TargetNamespace string `json:"targetNamespace,omitempty"` // Install or upgrade timeout in seconds // +optional Timeout *int64 `json:"timeout,omitempty"` // Reset values on helm upgrade // +optional ResetValues bool `json:"resetValues,omitempty"` // Force resource update through delete/recreate, allows recovery from a failed state // +optional ForceUpgrade bool `json:"forceUpgrade,omitempty"` // Enable rollback and configure options // +optional Rollback Rollback `json:"rollback,omitempty"` }
HelmReleaseSpec is the spec for a HelmRelease resource
func (*HelmReleaseSpec) DeepCopy ¶
func (in *HelmReleaseSpec) DeepCopy() *HelmReleaseSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmReleaseSpec.
func (*HelmReleaseSpec) DeepCopyInto ¶
func (in *HelmReleaseSpec) DeepCopyInto(out *HelmReleaseSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmReleaseStatus ¶
type HelmReleaseStatus struct { // ReleaseName is the name as either supplied or generated. // +optional ReleaseName string `json:"releaseName"` // ReleaseStatus is the status as given by Helm for the release // managed by this resource. ReleaseStatus string `json:"releaseStatus"` // ObservedGeneration is the most recent generation observed by // the controller. ObservedGeneration int64 `json:"observedGeneration"` // ValuesChecksum holds the SHA256 checksum of the last applied // values. ValuesChecksum string `json:"valuesChecksum"` // Revision would define what Git hash or Chart version has currently // been deployed. // +optional Revision string `json:"revision,omitempty"` // Conditions contains observations of the resource's state, e.g., // has the chart which it refers to been fetched. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions []HelmReleaseCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` }
func (*HelmReleaseStatus) DeepCopy ¶
func (in *HelmReleaseStatus) DeepCopy() *HelmReleaseStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmReleaseStatus.
func (*HelmReleaseStatus) DeepCopyInto ¶
func (in *HelmReleaseStatus) DeepCopyInto(out *HelmReleaseStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmValues ¶
FluxHelmValues embeds chartutil.Values so we can implement deepcopy on map[string]interface{} +k8s:deepcopy-gen=false
func (*HelmValues) DeepCopyInto ¶
func (in *HelmValues) DeepCopyInto(out *HelmValues)
DeepCopyInto implements deepcopy-gen method for use in generated code
type RepoChartSource ¶
type RepoChartSource struct { RepoURL string `json:"repository"` Name string `json:"name"` Version string `json:"version"` // An authentication secret for accessing the chart repo // +optional ChartPullSecret *v1.LocalObjectReference `json:"chartPullSecret,omitempty"` }
func (RepoChartSource) CleanRepoURL ¶
func (s RepoChartSource) CleanRepoURL() string
CleanRepoURL returns the RepoURL but ensures it ends with a trailing slash
func (*RepoChartSource) DeepCopy ¶
func (in *RepoChartSource) DeepCopy() *RepoChartSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepoChartSource.
func (*RepoChartSource) DeepCopyInto ¶
func (in *RepoChartSource) DeepCopyInto(out *RepoChartSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Rollback ¶
type Rollback struct { Enable bool `json:"enable,omitempty"` Force bool `json:"force,omitempty"` Recreate bool `json:"recreate,omitempty"` DisableHooks bool `json:"disableHooks,omitempty"` Timeout *int64 `json:"timeout,omitempty"` Wait bool `json:"wait,omitempty"` }
func (*Rollback) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Rollback.
func (*Rollback) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (Rollback) GetTimeout ¶
type ValuesFromSource ¶
type ValuesFromSource struct { // Selects a key of a ConfigMap. // +optional ConfigMapKeyRef *v1.ConfigMapKeySelector `json:"configMapKeyRef,omitempty"` // Selects a key of a Secret. // +optional SecretKeyRef *v1.SecretKeySelector `json:"secretKeyRef,omitempty"` // Selects an URL. // +optional ExternalSourceRef *ExternalSourceSelector `json:"externalSourceRef,omitempty"` // Selects a file from git source helm chart. // +optional ChartFileRef *ChartFileSelector `json:"chartFileRef,omitempty"` }
ValuesFromSource represents a source of values. Only one of its fields may be set.
func (*ValuesFromSource) DeepCopy ¶
func (in *ValuesFromSource) DeepCopy() *ValuesFromSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ValuesFromSource.
func (*ValuesFromSource) DeepCopyInto ¶
func (in *ValuesFromSource) DeepCopyInto(out *ValuesFromSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.