Documentation
¶
Overview ¶
+groupName=helm.deployer.landscaper.gardener.cloud
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func RegisterDefaults(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- func SetObjectDefaults_Configuration(in *Configuration)
- type ArchiveAccess
- type Auth
- type Chart
- type Configuration
- type Controller
- type ExportConfiguration
- type HPAConfiguration
- type HelmChartRepo
- type HelmChartRepoCredentials
- type HelmDeploymentConfiguration
- type HelmInstallConfiguration
- type HelmUninstallConfiguration
- type HelmUpgradeConfiguration
- type ProviderConfiguration
- type ProviderStatus
- type RemoteArchiveAccess
- type RemoteChartReference
- type UpdateStrategy
Constants ¶
const GroupName = "helm.deployer.landscaper.gardener.cloud"
GroupName is the name of the Garden API group.
const HelmChartRepoCredentialsKey = "helmChartRepoCredentials"
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func RegisterDefaults ¶
RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
func SetObjectDefaults_Configuration ¶
func SetObjectDefaults_Configuration(in *Configuration)
Types ¶
type ArchiveAccess ¶
type ArchiveAccess struct {
// Raw defines a compressed tarred helm chart as base64 encoded string.
// +optional
Raw string `json:"raw,omitempty"`
// Remote defines the remote access for a helm chart as compressed archive.
// +optional
Remote *RemoteArchiveAccess `json:"remote,omitempty"`
}
ArchiveAccess defines the access for a helm chart as compressed archive.
func (*ArchiveAccess) DeepCopy ¶
func (in *ArchiveAccess) DeepCopy() *ArchiveAccess
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ArchiveAccess.
func (*ArchiveAccess) DeepCopyInto ¶
func (in *ArchiveAccess) DeepCopyInto(out *ArchiveAccess)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Auth ¶
type Auth struct {
// URL contains URL of helm chart repo
URL string `json:"url,omitempty"`
// CustomCAData allows you to add a custom CA, which is useful if your server speaks HTTPS with a self-
// signed certificate. The added certificate must be in PEM format and base64 encoded.
// +optional
CustomCAData string `json:"customCAData,omitempty"`
// AuthHeader contains the value that will be set in the "Authorization" header when fetching the Chart, e.g.
// "Basic dX...3dvcmQ=". Exactly one of the fields AuthHeader and SecretRef must be set.
// +optional
AuthHeader string `json:"authHeader,omitempty"`
// Reference to a secret containing the AuthHeader
// Exactly one of the fields AuthHeader and SecretRef must be set.
// +optional
SecretRef *lsv1alpha1.LocalSecretReference `json:"secretRef,omitempty"`
}
Auth contains authentication info for one helm chart repo
func (*Auth) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Auth.
func (*Auth) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Chart ¶
type Chart struct {
// Ref defines the reference to a helm chart in a oci repository.
// +optional
Ref string `json:"ref,omitempty"`
// FromResource fetches the chart based on the resource's access method.
// The resource is defined as part of a component descriptor which is necessary to also handle
// local artifacts.
// +optional
FromResource *RemoteChartReference `json:"fromResource,omitempty"`
// Archive defines a compressed tarred helm chart as base64 encoded string.
// +optional
Archive *ArchiveAccess `json:"archive,omitempty"`
// HelmChartRepo defines a reference to a chart in a helm chart repo.
// +optional
HelmChartRepo *HelmChartRepo `json:"helmChartRepo,omitempty"`
// ResourceKey defines a key that can be given to a corresponding API in order to fetch the content of the resource
// defined in the blueprint
// +optional
ResourceRef string `json:"resourceRef,omitempty"`
}
Chart defines the helm chart to render and apply.
func (*Chart) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Chart.
func (*Chart) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Configuration ¶
type Configuration struct {
metav1.TypeMeta `json:",inline"`
// Identity identity describes the unique identity of the deployer.
// +optional
Identity string `json:"identity,omitempty"`
// OCI configures the oci client of the controller
OCI *config.OCIConfiguration `json:"oci,omitempty"`
// TargetSelector describes all selectors the deployer should depend on.
TargetSelector []lsv1alpha1.TargetSelector `json:"targetSelector,omitempty"`
// Export defines the export configuration.
Export ExportConfiguration `json:"export,omitempty"`
// HPAConfiguration contains the configuration for horizontal pod autoscaling.
HPAConfiguration *HPAConfiguration `json:"hpa,omitempty"`
// Controller contains configuration concerning the controller framework.
Controller Controller `json:"controller,omitempty"`
}
Configuration is the helm deployer configuration that configures the controller
func (*Configuration) DeepCopy ¶
func (in *Configuration) DeepCopy() *Configuration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Configuration.
func (*Configuration) DeepCopyInto ¶
func (in *Configuration) DeepCopyInto(out *Configuration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Configuration) DeepCopyObject ¶
func (in *Configuration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Controller ¶
type Controller struct {
lsconfigv1alpha1.CommonControllerConfig
}
Controller contains configuration concerning the controller framework.
func (*Controller) DeepCopy ¶
func (in *Controller) DeepCopy() *Controller
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Controller.
func (*Controller) DeepCopyInto ¶
func (in *Controller) DeepCopyInto(out *Controller)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExportConfiguration ¶
type ExportConfiguration struct {
// DefaultTimeout configures the default timeout for all exports without a explicit export timeout defined.
// +optional
DefaultTimeout *lsv1alpha1.Duration `json:"defaultTimeout,omitempty"`
}
ExportConfiguration defines the export configuration for the deployer.
func (*ExportConfiguration) DeepCopy ¶
func (in *ExportConfiguration) DeepCopy() *ExportConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExportConfiguration.
func (*ExportConfiguration) DeepCopyInto ¶
func (in *ExportConfiguration) DeepCopyInto(out *ExportConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HPAConfiguration ¶
type HPAConfiguration struct {
MaxReplicas int32 `json:"maxReplicas,omitempty"`
}
HPAConfiguration contains the configuration for horizontal pod autoscaling.
func (*HPAConfiguration) DeepCopy ¶
func (in *HPAConfiguration) DeepCopy() *HPAConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HPAConfiguration.
func (*HPAConfiguration) DeepCopyInto ¶
func (in *HPAConfiguration) DeepCopyInto(out *HPAConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmChartRepo ¶
type HelmChartRepo struct {
HelmChartRepoUrl string `json:"helmChartRepoUrl,omitempty"`
HelmChartName string `json:"helmChartName,omitempty"`
HelmChartVersion string `json:"helmChartVersion,omitempty"`
}
HelmChartRepo defines a reference to a chart in a helm chart repo
func (*HelmChartRepo) DeepCopy ¶
func (in *HelmChartRepo) DeepCopy() *HelmChartRepo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartRepo.
func (*HelmChartRepo) DeepCopyInto ¶
func (in *HelmChartRepo) DeepCopyInto(out *HelmChartRepo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmChartRepoCredentials ¶
type HelmChartRepoCredentials struct {
Auths []Auth `json:"auths,omitempty"`
}
HelmChartRepoCredentials contains the credentials to access hepl chart repos
func (*HelmChartRepoCredentials) DeepCopy ¶
func (in *HelmChartRepoCredentials) DeepCopy() *HelmChartRepoCredentials
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmChartRepoCredentials.
func (*HelmChartRepoCredentials) DeepCopyInto ¶
func (in *HelmChartRepoCredentials) DeepCopyInto(out *HelmChartRepoCredentials)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmDeploymentConfiguration ¶
type HelmDeploymentConfiguration struct {
Install map[string]lscore.AnyJSON `json:"install,omitempty"`
Upgrade map[string]lscore.AnyJSON `json:"upgrade,omitempty"`
Uninstall map[string]lscore.AnyJSON `json:"uninstall,omitempty"`
}
HelmDeploymentConfiguration defines settings for a helm deployment.
func (*HelmDeploymentConfiguration) DeepCopy ¶
func (in *HelmDeploymentConfiguration) DeepCopy() *HelmDeploymentConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmDeploymentConfiguration.
func (*HelmDeploymentConfiguration) DeepCopyInto ¶
func (in *HelmDeploymentConfiguration) DeepCopyInto(out *HelmDeploymentConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmInstallConfiguration ¶
type HelmInstallConfiguration struct {
Atomic bool `json:"atomic,omitempty"`
Force bool `json:"force,omitempty"`
SkipSchemaValidation bool `json:"skipSchemaValidation,omitempty"`
TakeOwnership bool `json:"takeOwnership,omitempty"`
Wait bool `json:"wait,omitempty"`
// Timeout is the timeout for the operation in minutes.
// +optional
Timeout *lsv1alpha1.Duration `json:"timeout,omitempty"`
}
HelmInstallConfiguration defines settings for a helm install operation.
func (*HelmInstallConfiguration) DeepCopy ¶
func (in *HelmInstallConfiguration) DeepCopy() *HelmInstallConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmInstallConfiguration.
func (*HelmInstallConfiguration) DeepCopyInto ¶
func (in *HelmInstallConfiguration) DeepCopyInto(out *HelmInstallConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmUninstallConfiguration ¶
type HelmUninstallConfiguration struct {
Wait bool `json:"wait,omitempty"`
// Timeout is the timeout for the operation in minutes.
// +optional
Timeout *lsv1alpha1.Duration `json:"timeout,omitempty"`
}
HelmUninstallConfiguration defines settings for a helm uninstall operation.
func (*HelmUninstallConfiguration) DeepCopy ¶
func (in *HelmUninstallConfiguration) DeepCopy() *HelmUninstallConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmUninstallConfiguration.
func (*HelmUninstallConfiguration) DeepCopyInto ¶
func (in *HelmUninstallConfiguration) DeepCopyInto(out *HelmUninstallConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmUpgradeConfiguration ¶
type HelmUpgradeConfiguration = HelmInstallConfiguration
HelmUpgradeConfiguration defines settings for a helm upgrade operation.
type ProviderConfiguration ¶
type ProviderConfiguration struct {
metav1.TypeMeta `json:",inline"`
// ReadinessChecks configures the readiness checks.
// +optional
ReadinessChecks health.ReadinessCheckConfiguration `json:"readinessChecks,omitempty"`
// UpdateStrategy defines the strategy how the manifests are updated in the cluster.
// Defaults to "update".
// +optional
UpdateStrategy UpdateStrategy `json:"updateStrategy,omitempty"`
// Chart defines helm chart to be templated and applied.
Chart Chart `json:"chart"`
// Name is the release name of the chart
Name string `json:"name"`
// Namespace is the release namespace of the chart
Namespace string `json:"namespace"`
// CreateNamespace configures the deployer to create the release namespace if not present.
// The behavior is similar to the "helm install --create-namespace"
CreateNamespace bool `json:"createNamespace"`
// Values are the values that are used for templating.
Values json.RawMessage `json:"values,omitempty"`
// ExportsFromManifests describe the exports from the templated manifests that should be exported by the helm deployer.
// +optional
// DEPRECATED
ExportsFromManifests []managedresource.Export `json:"exportsFromManifests,omitempty"`
// Exports describe the exports from the templated manifests that should be exported by the helm deployer.
// +optional
Exports *managedresource.Exports `json:"exports,omitempty"`
// ContinuousReconcile contains the schedule for continuous reconciliation.
// +optional
ContinuousReconcile *cr.ContinuousReconcileSpec `json:"continuousReconcile,omitempty"`
// HelmDeployment indicates that helm is used as complete deployment mechanism and not only helm templating.
// Default is true.
// +optional
HelmDeployment *bool `json:"helmDeployment,omitempty"`
// HelmDeploymentConfig contains settings for helm operations. Only relevant if HelmDeployment is true.
// +optional
HelmDeploymentConfig *HelmDeploymentConfiguration `json:"helmDeploymentConfig,omitempty"`
// DeletionGroups defines the order in which objects are deleted. Only relevant if HelmDeployment is false.
// +optional
DeletionGroups []managedresource.DeletionGroupDefinition `json:"deletionGroups,omitempty"`
// DeletionGroupsDuringUpdate defines the order in which objects are deleted during an update.
// +optional
DeletionGroupsDuringUpdate []managedresource.DeletionGroupDefinition `json:"deletionGroupsDuringUpdate,omitempty"`
}
ProviderConfiguration is the helm deployer configuration that is expected in a DeployItem
func (*ProviderConfiguration) DeepCopy ¶
func (in *ProviderConfiguration) DeepCopy() *ProviderConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderConfiguration.
func (*ProviderConfiguration) DeepCopyInto ¶
func (in *ProviderConfiguration) DeepCopyInto(out *ProviderConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProviderConfiguration) DeepCopyObject ¶
func (in *ProviderConfiguration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ProviderStatus ¶
type ProviderStatus struct {
metav1.TypeMeta `json:",inline"`
// ManagedResources contains all kubernetes resources that are deployed by the helm deployer.
ManagedResources managedresource.ManagedResourceStatusList `json:"managedResources,omitempty"`
}
ProviderStatus is the helm provider specific status
func (*ProviderStatus) DeepCopy ¶
func (in *ProviderStatus) DeepCopy() *ProviderStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderStatus.
func (*ProviderStatus) DeepCopyInto ¶
func (in *ProviderStatus) DeepCopyInto(out *ProviderStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProviderStatus) DeepCopyObject ¶
func (in *ProviderStatus) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RemoteArchiveAccess ¶
type RemoteArchiveAccess struct {
// URL defines a compressed tarred helm chart that is fetched from a url.
// +optional
URL string `json:"url,omitempty"`
}
RemoteArchiveAccess defines the remote access for a helm chart as compressed archive.
func (*RemoteArchiveAccess) DeepCopy ¶
func (in *RemoteArchiveAccess) DeepCopy() *RemoteArchiveAccess
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RemoteArchiveAccess.
func (*RemoteArchiveAccess) DeepCopyInto ¶
func (in *RemoteArchiveAccess) DeepCopyInto(out *RemoteArchiveAccess)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RemoteChartReference ¶
type RemoteChartReference struct {
lsv1alpha1.ComponentDescriptorDefinition `json:",inline"`
// ResourceName is the name of the Helm chart as defined by a component descriptor.
ResourceName string `json:"resourceName"`
}
RemoteChartReference defines a reference to a remote Helm chart through a Component-Descriptor
func (*RemoteChartReference) DeepCopy ¶
func (in *RemoteChartReference) DeepCopy() *RemoteChartReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RemoteChartReference.
func (*RemoteChartReference) DeepCopyInto ¶
func (in *RemoteChartReference) DeepCopyInto(out *RemoteChartReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UpdateStrategy ¶
type UpdateStrategy string
UpdateStrategy defines the strategy that is used to apply resources to the cluster.
const ( UpdateStrategyUpdate UpdateStrategy = "update" UpdateStrategyPatch UpdateStrategy = "patch" )
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
+groupName=helm.deployer.landscaper.gardener.cloud
|
+groupName=helm.deployer.landscaper.gardener.cloud |