Documentation
¶
Overview ¶
Package v1 contains the kubepkg API.
The types are served under kubepkg.dev by default. A platform that embeds kubepkg may serve them under its own group instead.
+kubebuilder:object:generate=true +groupName=kubepkg.dev
Index ¶
- Constants
- Variables
- func AddToSchemeForGroup(group string) func(*runtime.Scheme) error
- type ChartRef
- type Cluster
- type ClusterList
- type ClusterSpec
- type ClusterStatus
- type Component
- type ComponentInstall
- type ComponentRevisionStatus
- type ComponentSnapshot
- type DependencyStatus
- type HealthCheck
- type Library
- type Package
- type PackageComponent
- type PackageList
- type PackageRevision
- type PackageRevisionList
- type PackageRevisionSpec
- type PackageRevisionStatus
- type PackageSet
- type PackageSetClusterStatus
- type PackageSetList
- type PackageSetPackage
- type PackageSetRepository
- type PackageSetRollout
- type PackageSetSpec
- type PackageSetStatus
- type PackageSource
- type PackageSourceList
- type PackageSourceRef
- type PackageSourceSpec
- type PackageSourceStatus
- type PackageSpec
- type PackageStatus
- type Permissions
- type ReadyCondition
- type Repository
- type RepositoryList
- type RepositorySpec
- type RepositoryStatus
- type RepositoryTrust
- type RequiredComponent
- type Requirement
- type RetryStatus
- type RevisionSummary
- type RollbackPolicy
- type SecretKeyRef
- type UpgradePolicy
- type Variant
Constants ¶
const ( // GroupName is the native API group. GroupName = "kubepkg.dev" // Version is the version clusters store; v1beta1 and v1alpha1 are // still served, with a deprecation warning, and have the same schema. Version = "v1" )
const ( ReasonVersionMismatch = "VersionMismatch" ReasonRequirementsNotMet = "RequirementsNotMet" ReasonConflict = "Conflict" ReasonCRDOwnershipConflict = "CRDOwnershipConflict" ReasonUpgradeFailed = "UpgradeFailed" ReasonUpgradeRolledBack = "UpgradeRolledBack" // ReasonRolledBack: the package runs an earlier revision someone asked // for, and holds it until the Package changes. ReasonRolledBack = "RolledBack" ReasonPackageSourceNotFound = "PackageSourceNotFound" ReasonVariantNotFound = "VariantNotFound" // ReasonConflictingRequirements: packages that require this one ask // for different variants of it or pass different values for the same // key; the message names them. ReasonConflictingRequirements = "ConflictingRequirements" ReasonApplied = "ReconciliationSucceeded" ReasonProgressing = "Progressing" )
Condition reasons a Package reports on its Ready condition.
const ( CRDPolicyRetain = "Retain" CRDPolicyDelete = "Delete" )
CRD policies applied when a package is removed.
const ( PhasePending = "Pending" PhaseApplying = "Applying" PhaseApplied = "Applied" PhaseFailed = "Failed" PhaseRolledBack = "RolledBack" PhaseSuperseded = "Superseded" )
Revision phases.
const ( SourceKindGitRepository = "GitRepository" SourceKindOCIRepository = "OCIRepository" SourceKindOCIArtifact = "OCIArtifact" )
Source kinds a PackageSource can point at.
const AnnotationPackageSetChange = "kubepkg.dev/package-set-change"
AnnotationPackageSetChange on an object a set wrote names the change of the set it carries.
const LabelPackage = "kubepkg.dev/package"
LabelPackage marks objects that belong to a package.
const LabelPackageSet = "kubepkg.dev/package-set"
LabelPackageSet marks objects a PackageSet manages in a member cluster; the value is the PackageSet name. Objects without it are never touched.
const LabelRepository = "kubepkg.dev/repository"
LabelRepository marks a PackageSource that kubepkg made from a repository index; the value is the repository name. PackageSources without it are written by hand and never touched.
const PhasePreUpgrade = "PreUpgrade"
PhasePreUpgrade marks a component as a pre-upgrade hook.
const UnversionedVersion = "0.0.0-unversioned"
UnversionedVersion is the version of a PackageSource that declares none. It satisfies only an empty constraint, so unversioned packages keep working while anything that asks for a version fails loudly.
Variables ¶
var AddToScheme = AddToSchemeForGroup(GroupName)
AddToScheme registers the types under the native group.
var GroupVersion = schema.GroupVersion{Group: GroupName, Version: Version}
GroupVersion is the native group version.
Functions ¶
Types ¶
type ChartRef ¶
type ChartRef struct {
// Repository is an HTTP(S) Helm repository URL, or an oci:// path the
// chart is pushed under, e.g. oci://ghcr.io/example/charts.
// +required
// +kubebuilder:validation:Pattern=`^(https?|oci)://`
Repository string `json:"repository"`
// Name is the chart name.
// +required
Name string `json:"name"`
// Version is the exact chart version. Ranges are not accepted: a
// package version must always install the same chart.
// +required
Version string `json:"version"`
// Digest is the sha256 of the chart archive, sha256:<hex>. When set, a
// chart that does not match is refused, so a repository that changes a
// published version cannot change what gets installed.
// +optional
// +kubebuilder:validation:Pattern=`^sha256:[a-f0-9]{64}$`
Digest string `json:"digest,omitempty"`
}
ChartRef points at one version of a published Helm chart.
func (*ChartRef) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChartRef.
func (*ChartRef) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Cluster ¶
type Cluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ClusterSpec `json:"spec,omitempty"`
Status ClusterStatus `json:"status,omitempty"`
}
Cluster is a member cluster a hub installs packages into; its labels are what PackageSets select.
func (*Cluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.
func (*Cluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterList ¶
type ClusterList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Cluster `json:"items"`
}
ClusterList contains a list of Cluster.
func (*ClusterList) DeepCopy ¶
func (in *ClusterList) DeepCopy() *ClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterList.
func (*ClusterList) DeepCopyInto ¶
func (in *ClusterList) DeepCopyInto(out *ClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterList) DeepCopyObject ¶
func (in *ClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterSpec ¶
type ClusterSpec struct {
// KubeconfigSecretRef holds a kubeconfig for the member, with its
// current context set.
// +required
KubeconfigSecretRef SecretKeyRef `json:"kubeconfigSecretRef"`
}
ClusterSpec says how a hub reaches a member cluster. The member runs kubepkg itself; the hub writes Repositories and Packages there.
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶
type ClusterStatus struct {
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
// KubernetesVersion of the member.
// +optional
KubernetesVersion string `json:"kubernetesVersion,omitempty"`
}
ClusterStatus reports whether the member can be used.
func (*ClusterStatus) DeepCopy ¶
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Component ¶
type Component struct {
// Name is the unique identifier for this component within the package source
// +required
Name string `json:"name"`
// Path is the chart directory inside the package tree.
// +optional
Path string `json:"path,omitempty"`
// Chart is a chart published in a Helm repository, used as is. A
// package made only of such components needs no package tree.
// +optional
Chart *ChartRef `json:"chart,omitempty"`
// Install defines installation parameters for this component
// +optional
Install *ComponentInstall `json:"install,omitempty"`
// Libraries is a list of library names that this component depends on
// These libraries must be defined at the variant level
// +optional
Libraries []string `json:"libraries,omitempty"`
// ValuesFiles is a list of values file names to use
// +optional
ValuesFiles []string `json:"valuesFiles,omitempty"`
}
Component defines a single Helm release component within a package source +kubebuilder:validation:XValidation:rule="has(self.path) != has(self.chart)",message="set exactly one of path and chart" +kubebuilder:validation:XValidation:rule="!has(self.chart) || (!has(self.libraries) && !has(self.valuesFiles))",message="libraries and valuesFiles apply to charts in the package tree only"
func (*Component) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Component.
func (*Component) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentInstall ¶
type ComponentInstall struct {
// ReleaseName is the name of the HelmRelease resource that will be created
// If not specified, defaults to the component Name field
// +optional
ReleaseName string `json:"releaseName,omitempty"`
// Namespace is the Kubernetes namespace where the release will be installed
// +optional
Namespace string `json:"namespace,omitempty"`
// Privileged indicates whether this release requires privileged access
// +optional
Privileged bool `json:"privileged,omitempty"`
// DependsOn is a list of component names that must be installed before this component
// +optional
DependsOn []string `json:"dependsOn,omitempty"`
// UpgradeCRDs controls how CRDs from the chart's crds/ directory are
// handled on upgrades. Empty keeps the backend default (Skip). With
// Create or CreateReplace, kubepkg also applies them on the first
// install, taking over CRDs that already exist.
// Use "CreateReplace" for operators that evolve their CRD set between
// versions. Warning: CreateReplace overwrites CRDs and may cause data
// loss if upstream drops fields from a CRD with live objects.
// +optional
// +kubebuilder:validation:Enum=Skip;Create;CreateReplace
UpgradeCRDs string `json:"upgradeCRDs,omitempty"`
// WaitStrategy is one of poller|legacy (flux backend).
// +optional
// +kubebuilder:validation:Enum=poller;legacy
WaitStrategy string `json:"waitStrategy,omitempty"`
// HealthCheckExprs are CEL health expressions for the custom resource(s)
// this component renders, so the component reports Ready only when the
// resource is actually healthy.
// +optional
HealthCheckExprs []HealthCheck `json:"healthCheckExprs,omitempty"`
// Phase PreUpgrade makes the component a hook: it runs only when the
// package moves to another version, before every other component,
// with values kubepkg.fromVersion and kubepkg.toVersion, typically a
// Job that migrates data. A hook that fails stops the upgrade before
// anything else changes; it is uninstalled once the upgrade succeeds,
// so the next upgrade runs it afresh.
// +optional
// +kubebuilder:validation:Enum=PreUpgrade
Phase string `json:"phase,omitempty"`
// ReadyWhen lists object conditions that must hold before the
// component counts as ready, for resources whose own readiness Helm
// cannot see, such as an operator's custom resource reporting
// Available. Every backend honours it; not meeting it within the
// upgrade timeout fails the revision.
// +optional
ReadyWhen []ReadyCondition `json:"readyWhen,omitempty"`
}
ComponentInstall defines installation parameters for a component
func (*ComponentInstall) DeepCopy ¶
func (in *ComponentInstall) DeepCopy() *ComponentInstall
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentInstall.
func (*ComponentInstall) DeepCopyInto ¶
func (in *ComponentInstall) DeepCopyInto(out *ComponentInstall)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentRevisionStatus ¶
type ComponentRevisionStatus struct {
Name string `json:"name"`
// BackendRevision is e.g. the Helm release revision, used to roll back.
// +optional
BackendRevision int `json:"backendRevision,omitempty"`
}
ComponentRevisionStatus links a component to the backend state it produced.
func (*ComponentRevisionStatus) DeepCopy ¶
func (in *ComponentRevisionStatus) DeepCopy() *ComponentRevisionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentRevisionStatus.
func (*ComponentRevisionStatus) DeepCopyInto ¶
func (in *ComponentRevisionStatus) DeepCopyInto(out *ComponentRevisionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ComponentSnapshot ¶
type ComponentSnapshot struct {
Name string `json:"name"`
ReleaseName string `json:"releaseName"`
Namespace string `json:"namespace"`
// +optional
DependsOn []string `json:"dependsOn,omitempty"`
// ChartDigest identifies the chart content that was applied.
// +optional
ChartDigest string `json:"chartDigest,omitempty"`
// ValuesDigest identifies the values that were applied.
// +optional
ValuesDigest string `json:"valuesDigest,omitempty"`
}
ComponentSnapshot is what one component was rendered from.
func (*ComponentSnapshot) DeepCopy ¶
func (in *ComponentSnapshot) DeepCopy() *ComponentSnapshot
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentSnapshot.
func (*ComponentSnapshot) DeepCopyInto ¶
func (in *ComponentSnapshot) DeepCopyInto(out *ComponentSnapshot)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DependencyStatus ¶
type DependencyStatus struct {
// Ready indicates whether the dependency is ready
Ready bool `json:"ready"`
}
DependencyStatus represents the readiness status of a dependency
func (*DependencyStatus) DeepCopy ¶
func (in *DependencyStatus) DeepCopy() *DependencyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DependencyStatus.
func (*DependencyStatus) DeepCopyInto ¶
func (in *DependencyStatus) DeepCopyInto(out *DependencyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HealthCheck ¶
type HealthCheck struct {
// APIVersion of the custom resource.
APIVersion string `json:"apiVersion"`
// Kind of the custom resource.
Kind string `json:"kind"`
// Current is true when the resource is healthy.
Current string `json:"current"`
// InProgress is true while the resource is being reconciled.
// +optional
InProgress string `json:"inProgress,omitempty"`
// Failed is true when the resource has failed.
// +optional
Failed string `json:"failed,omitempty"`
}
HealthCheck tells when a custom resource a component renders is healthy, with CEL expressions over the object (flux backend).
func (*HealthCheck) DeepCopy ¶
func (in *HealthCheck) DeepCopy() *HealthCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HealthCheck.
func (*HealthCheck) DeepCopyInto ¶
func (in *HealthCheck) DeepCopyInto(out *HealthCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Library ¶
type Library struct {
// Name is the optional name for library placed in charts
// +optional
Name string `json:"name,omitempty"`
// Path is the path to the library chart directory
// +required
Path string `json:"path"`
}
Library defines a Helm library chart
func (*Library) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Library.
func (*Library) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Package ¶
type Package struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PackageSpec `json:"spec,omitempty"`
Status PackageStatus `json:"status,omitempty"`
}
Package is the desired state of one installed package. The name is the package name and matches its PackageSource.
func (*Package) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Package.
func (*Package) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Package) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageComponent ¶
type PackageComponent struct {
// Enabled indicates whether this component should be installed
// If false, the component will be disabled even if it's defined in the PackageSource
// +optional
Enabled *bool `json:"enabled,omitempty"`
// Values contains Helm chart values as a JSON object
// These values will be merged with the default values from the PackageSource
// +optional
Values *apiextensionsv1.JSON `json:"values,omitempty"`
// ReleaseName overrides the component's release name, e.g. to take
// over a release installed before under another name.
// +optional
ReleaseName string `json:"releaseName,omitempty"`
// Namespace overrides the namespace the component is installed into.
// +optional
Namespace string `json:"namespace,omitempty"`
}
PackageComponent defines overrides for a specific component
func (*PackageComponent) DeepCopy ¶
func (in *PackageComponent) DeepCopy() *PackageComponent
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageComponent.
func (*PackageComponent) DeepCopyInto ¶
func (in *PackageComponent) DeepCopyInto(out *PackageComponent)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageList ¶
type PackageList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Package `json:"items"`
}
PackageList contains a list of Packages
func (*PackageList) DeepCopy ¶
func (in *PackageList) DeepCopy() *PackageList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageList.
func (*PackageList) DeepCopyInto ¶
func (in *PackageList) DeepCopyInto(out *PackageList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageList) DeepCopyObject ¶
func (in *PackageList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageRevision ¶
type PackageRevision struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PackageRevisionSpec `json:"spec,omitempty"`
Status PackageRevisionStatus `json:"status,omitempty"`
}
PackageRevision is an immutable record of one applied state of a package. It is written by the operator.
func (*PackageRevision) DeepCopy ¶
func (in *PackageRevision) DeepCopy() *PackageRevision
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageRevision.
func (*PackageRevision) DeepCopyInto ¶
func (in *PackageRevision) DeepCopyInto(out *PackageRevision)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageRevision) DeepCopyObject ¶
func (in *PackageRevision) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageRevisionList ¶
type PackageRevisionList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []PackageRevision `json:"items"`
}
PackageRevisionList contains a list of PackageRevisions
func (*PackageRevisionList) DeepCopy ¶
func (in *PackageRevisionList) DeepCopy() *PackageRevisionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageRevisionList.
func (*PackageRevisionList) DeepCopyInto ¶
func (in *PackageRevisionList) DeepCopyInto(out *PackageRevisionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageRevisionList) DeepCopyObject ¶
func (in *PackageRevisionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageRevisionSpec ¶
type PackageRevisionSpec struct {
Package string `json:"package"`
Revision int64 `json:"revision"`
// +optional
Version string `json:"version,omitempty"`
// +optional
Variant string `json:"variant,omitempty"`
// RollbackSafe is copied from the PackageSource at the time of the revision.
// +optional
RollbackSafe bool `json:"rollbackSafe,omitempty"`
// RestoredFrom is set when this revision re-applies an earlier one.
// +optional
RestoredFrom int64 `json:"restoredFrom,omitempty"`
// +optional
Components []ComponentSnapshot `json:"components,omitempty"`
}
PackageRevisionSpec is the recorded state.
func (*PackageRevisionSpec) DeepCopy ¶
func (in *PackageRevisionSpec) DeepCopy() *PackageRevisionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageRevisionSpec.
func (*PackageRevisionSpec) DeepCopyInto ¶
func (in *PackageRevisionSpec) DeepCopyInto(out *PackageRevisionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageRevisionStatus ¶
type PackageRevisionStatus struct {
// +optional
Phase string `json:"phase,omitempty"`
// +optional
Message string `json:"message,omitempty"`
// +optional
Components []ComponentRevisionStatus `json:"components,omitempty"`
}
PackageRevisionStatus is the outcome of applying the revision.
func (*PackageRevisionStatus) DeepCopy ¶
func (in *PackageRevisionStatus) DeepCopy() *PackageRevisionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageRevisionStatus.
func (*PackageRevisionStatus) DeepCopyInto ¶
func (in *PackageRevisionStatus) DeepCopyInto(out *PackageRevisionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSet ¶
type PackageSet struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PackageSetSpec `json:"spec,omitempty"`
Status PackageSetStatus `json:"status,omitempty"`
}
PackageSet installs packages on every Cluster it selects.
func (*PackageSet) DeepCopy ¶
func (in *PackageSet) DeepCopy() *PackageSet
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSet.
func (*PackageSet) DeepCopyInto ¶
func (in *PackageSet) DeepCopyInto(out *PackageSet)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageSet) DeepCopyObject ¶
func (in *PackageSet) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageSetClusterStatus ¶
type PackageSetClusterStatus struct {
Name string `json:"name"`
// Ready and Total count the set's packages on the cluster.
Ready int32 `json:"ready"`
Total int32 `json:"total"`
// +optional
Message string `json:"message,omitempty"`
// Updated is true once the cluster has the set's current change.
// +optional
Updated bool `json:"updated,omitempty"`
// Versions are the versions the set's packages run on the cluster.
// +optional
Versions map[string]string `json:"versions,omitempty"`
}
PackageSetClusterStatus is the set's state on one cluster.
func (*PackageSetClusterStatus) DeepCopy ¶
func (in *PackageSetClusterStatus) DeepCopy() *PackageSetClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSetClusterStatus.
func (*PackageSetClusterStatus) DeepCopyInto ¶
func (in *PackageSetClusterStatus) DeepCopyInto(out *PackageSetClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSetList ¶
type PackageSetList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []PackageSet `json:"items"`
}
PackageSetList contains a list of PackageSet.
func (*PackageSetList) DeepCopy ¶
func (in *PackageSetList) DeepCopy() *PackageSetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSetList.
func (*PackageSetList) DeepCopyInto ¶
func (in *PackageSetList) DeepCopyInto(out *PackageSetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageSetList) DeepCopyObject ¶
func (in *PackageSetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageSetPackage ¶
type PackageSetPackage struct {
// +required
Name string `json:"name"`
// Spec is the Package spec written to every selected cluster.
// +optional
Spec PackageSpec `json:"spec,omitempty"`
}
PackageSetPackage is one package a set installs.
func (*PackageSetPackage) DeepCopy ¶
func (in *PackageSetPackage) DeepCopy() *PackageSetPackage
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSetPackage.
func (*PackageSetPackage) DeepCopyInto ¶
func (in *PackageSetPackage) DeepCopyInto(out *PackageSetPackage)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSetRepository ¶
type PackageSetRepository struct {
// +required
Name string `json:"name"`
// +required
Spec RepositorySpec `json:"spec"`
}
PackageSetRepository is one repository a set subscribes members to.
func (*PackageSetRepository) DeepCopy ¶
func (in *PackageSetRepository) DeepCopy() *PackageSetRepository
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSetRepository.
func (*PackageSetRepository) DeepCopyInto ¶
func (in *PackageSetRepository) DeepCopyInto(out *PackageSetRepository)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSetRollout ¶
type PackageSetRollout struct {
// MaxInProgress is how many clusters may be taking a change at once;
// 0 means all of them.
// +optional
MaxInProgress int32 `json:"maxInProgress,omitempty"`
// Canary picks clusters that take a change first; the others follow
// once every canary is done with it.
// +optional
Canary *metav1.LabelSelector `json:"canary,omitempty"`
// PauseOnFailure stops a change from reaching more clusters once a
// cluster that took it reports a failed or rolled back upgrade.
// Default true. A new change to the set resumes the rollout.
// +optional
PauseOnFailure *bool `json:"pauseOnFailure,omitempty"`
}
PackageSetRollout paces a change to a set across its clusters. A change is any edit of the set's repositories or packages; a cluster has it once every object the set writes there carries it, and is done with it once every package is ready with it.
func (*PackageSetRollout) DeepCopy ¶
func (in *PackageSetRollout) DeepCopy() *PackageSetRollout
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSetRollout.
func (*PackageSetRollout) DeepCopyInto ¶
func (in *PackageSetRollout) DeepCopyInto(out *PackageSetRollout)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSetSpec ¶
type PackageSetSpec struct {
// ClusterSelector picks Clusters by label; empty selects all.
// +optional
ClusterSelector metav1.LabelSelector `json:"clusterSelector,omitempty"`
// Repositories are written to every selected cluster first.
// +optional
Repositories []PackageSetRepository `json:"repositories,omitempty"`
// +optional
Packages []PackageSetPackage `json:"packages,omitempty"`
// Rollout says how a change to the set reaches its clusters; without
// it every cluster gets the change at once.
// +optional
Rollout *PackageSetRollout `json:"rollout,omitempty"`
}
PackageSetSpec says which packages go to which clusters.
func (*PackageSetSpec) DeepCopy ¶
func (in *PackageSetSpec) DeepCopy() *PackageSetSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSetSpec.
func (*PackageSetSpec) DeepCopyInto ¶
func (in *PackageSetSpec) DeepCopyInto(out *PackageSetSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSetStatus ¶
type PackageSetStatus struct {
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
// +optional
Clusters []PackageSetClusterStatus `json:"clusters,omitempty"`
// ReadyClusters counts clusters where every package is ready.
// +optional
ReadyClusters int32 `json:"readyClusters,omitempty"`
// UpdatedClusters counts clusters that have the current change.
// +optional
UpdatedClusters int32 `json:"updatedClusters,omitempty"`
// Change identifies the set's current repositories and packages.
// +optional
Change string `json:"change,omitempty"`
}
PackageSetStatus aggregates the set over its clusters.
func (*PackageSetStatus) DeepCopy ¶
func (in *PackageSetStatus) DeepCopy() *PackageSetStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSetStatus.
func (*PackageSetStatus) DeepCopyInto ¶
func (in *PackageSetStatus) DeepCopyInto(out *PackageSetStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSource ¶
type PackageSource struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PackageSourceSpec `json:"spec,omitempty"`
Status PackageSourceStatus `json:"status,omitempty"`
}
PackageSource is one package at one version: where its charts come from, what it provides and requires, and how its components are installed. The name is the package name.
func (*PackageSource) DeepCopy ¶
func (in *PackageSource) DeepCopy() *PackageSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSource.
func (*PackageSource) DeepCopyInto ¶
func (in *PackageSource) DeepCopyInto(out *PackageSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageSource) DeepCopyObject ¶
func (in *PackageSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageSourceList ¶
type PackageSourceList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []PackageSource `json:"items"`
}
PackageSourceList contains a list of PackageSources
func (*PackageSourceList) DeepCopy ¶
func (in *PackageSourceList) DeepCopy() *PackageSourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSourceList.
func (*PackageSourceList) DeepCopyInto ¶
func (in *PackageSourceList) DeepCopyInto(out *PackageSourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PackageSourceList) DeepCopyObject ¶
func (in *PackageSourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PackageSourceRef ¶
type PackageSourceRef struct {
// Kind of the source reference. GitRepository and OCIRepository are Flux
// sources and need the flux backend; OCIArtifact is fetched by kubepkg.
// +kubebuilder:validation:Enum=GitRepository;OCIRepository;OCIArtifact
// +required
Kind string `json:"kind"`
// Name of the source reference (Flux kinds)
// +optional
Name string `json:"name,omitempty"`
// Namespace of the source reference (Flux kinds)
// +optional
Namespace string `json:"namespace,omitempty"`
// URL of an OCI artifact holding the package tree, e.g.
// oci://ghcr.io/example/packages:1.0.0 (OCIArtifact only).
// +optional
URL string `json:"url,omitempty"`
// Path is the base path where packages are located in the source.
// For GitRepository, defaults to "packages" if not specified.
// For OCIRepository and OCIArtifact, defaults to empty string (root) if not specified.
// +optional
Path string `json:"path,omitempty"`
}
PackageSourceRef defines the source reference for package source charts +kubebuilder:validation:XValidation:rule="self.kind == 'OCIArtifact' ? has(self.url) : (has(self.name) && has(self.namespace))",message="OCIArtifact needs url; GitRepository and OCIRepository need name and namespace"
func (*PackageSourceRef) DeepCopy ¶
func (in *PackageSourceRef) DeepCopy() *PackageSourceRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSourceRef.
func (*PackageSourceRef) DeepCopyInto ¶
func (in *PackageSourceRef) DeepCopyInto(out *PackageSourceRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSourceSpec ¶
type PackageSourceSpec struct {
// Version is the semantic version of this package.
// Empty means unversioned (see UnversionedVersion).
// +optional
Version string `json:"version,omitempty"`
// Build numbers the packagings of one upstream version: a new patch or
// default in the recipe makes a new build of the same version. Version
// constraints apply to Version; of two equal versions the higher build
// is newer.
// +optional
// +kubebuilder:validation:Minimum=0
Build int32 `json:"build,omitempty"`
// SourceRef is the source reference for the package source charts
// +optional
SourceRef *PackageSourceRef `json:"sourceRef,omitempty"`
// Provides lists capabilities this package offers, e.g. "ingress" or
// "api:cert-manager.io/v1". The package name is always provided implicitly.
// +optional
Provides []string `json:"provides,omitempty"`
// Conflicts lists package names or capabilities that must not be
// installed alongside this package.
// +optional
Conflicts []string `json:"conflicts,omitempty"`
// CRDs lists the names of CustomResourceDefinitions this package owns.
// +optional
CRDs []string `json:"crds,omitempty"`
// Permissions declares what the package needs in the cluster. It is shown
// in plans so the operator of the cluster sees it before installing; it is
// not enforced yet.
// +optional
Permissions *Permissions `json:"permissions,omitempty"`
// Rollback describes whether going back from this version is safe.
// +optional
Rollback *RollbackPolicy `json:"rollback,omitempty"`
// Variants is a list of package source variants
// Each variant defines components, applications, dependencies, and libraries for a specific configuration
// +optional
Variants []Variant `json:"variants,omitempty"`
// Images are the container images the package runs, each pinned by
// digest: registry/repository:tag@sha256:..., including those an
// operator in the package deploys on its own. A signed index covers
// them like the charts, and kubepkg bundle copies them for
// air-gapped clusters.
// +optional
Images []string `json:"images,omitempty"`
}
PackageSourceSpec defines the desired state of PackageSource
func (*PackageSourceSpec) DeepCopy ¶
func (in *PackageSourceSpec) DeepCopy() *PackageSourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSourceSpec.
func (*PackageSourceSpec) DeepCopyInto ¶
func (in *PackageSourceSpec) DeepCopyInto(out *PackageSourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSourceStatus ¶
type PackageSourceStatus struct {
// Conditions represents the latest available observations of a PackageSource's state
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
PackageSourceStatus defines the observed state of PackageSource
func (*PackageSourceStatus) DeepCopy ¶
func (in *PackageSourceStatus) DeepCopy() *PackageSourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSourceStatus.
func (*PackageSourceStatus) DeepCopyInto ¶
func (in *PackageSourceStatus) DeepCopyInto(out *PackageSourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageSpec ¶
type PackageSpec struct {
// Variant is the name of the variant to use from the PackageSource
// If not specified, defaults to "default"
// +optional
Variant string `json:"variant,omitempty"`
// Version is a semver constraint the PackageSource version must satisfy,
// e.g. "~1.16". Empty accepts any version.
// +optional
Version string `json:"version,omitempty"`
// Repository restricts version selection to the named Repository. Empty
// considers all of them, by priority. Ignored when a PackageSource for
// the package was written by hand.
// +optional
Repository string `json:"repository,omitempty"`
// IgnoreDependencies is a list of package source dependencies to ignore
// Dependencies listed here will not be installed even if they are specified in the PackageSource
// +optional
IgnoreDependencies []string `json:"ignoreDependencies,omitempty"`
// Components is a map of release name to component overrides
// Allows overriding values and enabling/disabling specific components from the PackageSource
// +optional
Components map[string]PackageComponent `json:"components,omitempty"`
// Upgrade controls how changes are applied.
// +optional
Upgrade *UpgradePolicy `json:"upgrade,omitempty"`
// RevisionHistoryLimit is how many PackageRevisions to keep. Default 10.
// +optional
// +kubebuilder:validation:Minimum=1
RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty"`
// CRDPolicy decides what happens to owned CRDs when the package is
// removed. Retain (default) keeps them; Delete removes them and every
// object of their kinds.
// +optional
// +kubebuilder:validation:Enum=Retain;Delete
CRDPolicy string `json:"crdPolicy,omitempty"`
}
PackageSpec defines the desired state of Package
func (*PackageSpec) DeepCopy ¶
func (in *PackageSpec) DeepCopy() *PackageSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageSpec.
func (*PackageSpec) DeepCopyInto ¶
func (in *PackageSpec) DeepCopyInto(out *PackageSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PackageStatus ¶
type PackageStatus struct {
// Conditions represents the latest available observations of a Package's state
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
// Dependencies tracks the readiness status of each dependency
// Key is the dependency package name, value indicates if the dependency is ready
// +optional
Dependencies map[string]DependencyStatus `json:"dependencies,omitempty"`
// Version is the package version currently applied.
// +optional
Version string `json:"version,omitempty"`
// CurrentRevision is the revision currently applied.
// +optional
CurrentRevision int64 `json:"currentRevision,omitempty"`
// History lists recent revisions, newest first.
// +optional
History []RevisionSummary `json:"history,omitempty"`
// Retry is set while a change that failed waits to be tried again.
// The operator retries on its own, waiting longer after each failure;
// the kubepkg.dev/retry annotation tries again at once.
// +optional
Retry *RetryStatus `json:"retry,omitempty"`
}
PackageStatus defines the observed state of Package
func (*PackageStatus) DeepCopy ¶
func (in *PackageStatus) DeepCopy() *PackageStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PackageStatus.
func (*PackageStatus) DeepCopyInto ¶
func (in *PackageStatus) DeepCopyInto(out *PackageStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Permissions ¶
type Permissions struct {
// ClusterWide is true when the package needs cluster-scoped access.
// +optional
ClusterWide bool `json:"clusterWide,omitempty"`
// Rules are the RBAC rules the package's components need.
// +optional
Rules []rbacv1.PolicyRule `json:"rules,omitempty"`
}
Permissions declares the access a package needs.
func (*Permissions) DeepCopy ¶
func (in *Permissions) DeepCopy() *Permissions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Permissions.
func (*Permissions) DeepCopyInto ¶
func (in *Permissions) DeepCopyInto(out *Permissions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReadyCondition ¶
type ReadyCondition struct {
// +required
APIVersion string `json:"apiVersion"`
// +required
Kind string `json:"kind"`
// +required
Name string `json:"name"`
// Namespace defaults to the component's install namespace and is
// ignored for cluster-scoped kinds.
// +optional
Namespace string `json:"namespace,omitempty"`
// Condition is the type in status.conditions, e.g. Available.
// +required
Condition string `json:"condition"`
// Status is the wanted status of the condition. Default "True".
// +optional
Status string `json:"status,omitempty"`
}
ReadyCondition is a condition an object must report.
func (*ReadyCondition) DeepCopy ¶
func (in *ReadyCondition) DeepCopy() *ReadyCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReadyCondition.
func (*ReadyCondition) DeepCopyInto ¶
func (in *ReadyCondition) DeepCopyInto(out *ReadyCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Repository ¶
type Repository struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec RepositorySpec `json:"spec,omitempty"`
Status RepositoryStatus `json:"status,omitempty"`
}
Repository is a package repository the operator installs packages from.
func (*Repository) DeepCopy ¶
func (in *Repository) DeepCopy() *Repository
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Repository.
func (*Repository) DeepCopyInto ¶
func (in *Repository) DeepCopyInto(out *Repository)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Repository) DeepCopyObject ¶
func (in *Repository) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RepositoryList ¶
type RepositoryList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Repository `json:"items"`
}
RepositoryList contains a list of Repository.
func (*RepositoryList) DeepCopy ¶
func (in *RepositoryList) DeepCopy() *RepositoryList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryList.
func (*RepositoryList) DeepCopyInto ¶
func (in *RepositoryList) DeepCopyInto(out *RepositoryList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RepositoryList) DeepCopyObject ¶
func (in *RepositoryList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RepositorySpec ¶
type RepositorySpec struct {
// URL of the index, e.g. https://packages.example.org/index.yaml. The
// scheme picks the fetcher; https:// and http:// are built in.
// +required
URL string `json:"url"`
// Priority orders repositories that carry the same package: the
// highest priority one shadows the others for that package, whatever
// versions they have. Default 0.
// +optional
Priority int32 `json:"priority,omitempty"`
// Interval between index refreshes. Default 10m.
// +optional
Interval *metav1.Duration `json:"interval,omitempty"`
// PublicKeys are PEM encoded ed25519 keys the index must be signed
// with: the signature is fetched from the index URL plus ".sig".
// Several keys allow rotation. A repository with neither publicKeys
// nor trust is refused unless allowUnsigned is set.
// +optional
PublicKeys []string `json:"publicKeys,omitempty"`
// Trust verifies the repository the way TUF does: the root keys pinned
// here sign root/1.yaml, each later root version is signed by enough
// root keys of the one before and of itself, the current root names
// the keys and threshold the index needs, and both expire. Use it
// instead of publicKeys for threshold signing and key rotation.
// +optional
Trust *RepositoryTrust `json:"trust,omitempty"`
// AllowUnsigned accepts an index nobody signed, for local testing. Its
// packages then install whatever the server says they are.
// +optional
AllowUnsigned bool `json:"allowUnsigned,omitempty"`
// PlainHTTPRegistries are OCI registries, host or host:port, that the
// charts and package trees of this repository are fetched from without
// TLS, such as a registry in the cluster. Every other registry keeps
// TLS. A registry either speaks TLS or does not, so a host listed here
// is reached without TLS for whatever package lives on it. The index
// URL itself is fetched with the scheme it names.
// +optional
// +kubebuilder:validation:items:Pattern=`^(\[[0-9a-fA-F:]+\]|[A-Za-z0-9.-]+)(:[0-9]+)?$`
PlainHTTPRegistries []string `json:"plainHTTPRegistries,omitempty"`
}
RepositorySpec says where a repository index is and how much to trust it relative to other repositories.
func (*RepositorySpec) DeepCopy ¶
func (in *RepositorySpec) DeepCopy() *RepositorySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositorySpec.
func (*RepositorySpec) DeepCopyInto ¶
func (in *RepositorySpec) DeepCopyInto(out *RepositorySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RepositoryStatus ¶
type RepositoryStatus struct {
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
// Packages is the number of packages in the index.
// +optional
Packages int32 `json:"packages,omitempty"`
// IndexDigest is the sha256 of the last accepted index.
// +optional
IndexDigest string `json:"indexDigest,omitempty"`
// LastFetched is when the index was last fetched successfully.
// +optional
LastFetched *metav1.Time `json:"lastFetched,omitempty"`
// IndexGenerated is when the accepted index was built; an older one is
// refused.
// +optional
IndexGenerated *metav1.Time `json:"indexGenerated,omitempty"`
// RootVersion and RootDigest are the root accepted last; an older root
// or another root under the same version is refused.
// +optional
RootVersion int32 `json:"rootVersion,omitempty"`
// +optional
RootDigest string `json:"rootDigest,omitempty"`
}
RepositoryStatus reports the last index fetch.
func (*RepositoryStatus) DeepCopy ¶
func (in *RepositoryStatus) DeepCopy() *RepositoryStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryStatus.
func (*RepositoryStatus) DeepCopyInto ¶
func (in *RepositoryStatus) DeepCopyInto(out *RepositoryStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RepositoryTrust ¶
type RepositoryTrust struct {
// RootKeys are PEM encoded ed25519 keys of version 1 of the root.
// +required
// +kubebuilder:validation:MinItems=1
RootKeys []string `json:"rootKeys"`
// RootThreshold is how many of them must have signed it. Default 1.
// +optional
// +kubebuilder:validation:Minimum=1
RootThreshold int32 `json:"rootThreshold,omitempty"`
}
RepositoryTrust pins a repository's root of trust.
func (*RepositoryTrust) DeepCopy ¶
func (in *RepositoryTrust) DeepCopy() *RepositoryTrust
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryTrust.
func (*RepositoryTrust) DeepCopyInto ¶
func (in *RepositoryTrust) DeepCopyInto(out *RepositoryTrust)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RequiredComponent ¶ added in v1.3.0
type RequiredComponent struct {
// Values are Helm values for the component.
// +optional
Values *apiextensionsv1.JSON `json:"values,omitempty"`
}
RequiredComponent is what a package passes to one component of a package it requires.
func (*RequiredComponent) DeepCopy ¶ added in v1.3.0
func (in *RequiredComponent) DeepCopy() *RequiredComponent
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RequiredComponent.
func (*RequiredComponent) DeepCopyInto ¶ added in v1.3.0
func (in *RequiredComponent) DeepCopyInto(out *RequiredComponent)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Requirement ¶
type Requirement struct {
// Package is the name of a required package.
// +optional
Package string `json:"package,omitempty"`
// Capability is a required capability, e.g. "ingress" or
// "api:cert-manager.io/v1".
// +optional
Capability string `json:"capability,omitempty"`
// Version is a semver constraint on the required package, e.g. ">=1.2 <2".
// Only meaningful with Package.
// +optional
Version string `json:"version,omitempty"`
// Optional requirements only order installation: if present, they must
// be ready first; if absent, the package proceeds.
// +optional
Optional bool `json:"optional,omitempty"`
// Variant is the variant of the required package this one needs. The
// CLI installs the package in it; the requirement is met only while
// the package runs it. Only meaningful with Package.
// +optional
Variant string `json:"variant,omitempty"`
// Components passes values to components of the required package, by
// component name, so a distribution shapes the packages it requires
// without forking them. They go over the package's defaults and the
// platform values, and under the values set on the required package's
// Package. Two packages passing different values for the same key are
// a conflict, reported on the required package. Only meaningful with
// Package. Versions that use it need kubepkg 1.3 or later.
// +optional
Components map[string]RequiredComponent `json:"components,omitempty"`
}
Requirement is a dependency on a package or a capability. +kubebuilder:validation:XValidation:rule="has(self.package) != has(self.capability)",message="exactly one of package or capability must be set" +kubebuilder:validation:XValidation:rule="has(self.package) || (!has(self.variant) && !has(self.components))",message="variant and components apply to a required package only"
func (*Requirement) DeepCopy ¶
func (in *Requirement) DeepCopy() *Requirement
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Requirement.
func (*Requirement) DeepCopyInto ¶
func (in *Requirement) DeepCopyInto(out *Requirement)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RetryStatus ¶ added in v1.3.0
type RetryStatus struct {
// Attempts is how many times the change has failed so far.
Attempts int32 `json:"attempts"`
// NextAttempt is when the operator tries it again.
// +optional
NextAttempt *metav1.Time `json:"nextAttempt,omitempty"`
}
RetryStatus tells when a change that failed is tried again.
func (*RetryStatus) DeepCopy ¶ added in v1.3.0
func (in *RetryStatus) DeepCopy() *RetryStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RetryStatus.
func (*RetryStatus) DeepCopyInto ¶ added in v1.3.0
func (in *RetryStatus) DeepCopyInto(out *RetryStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RevisionSummary ¶
type RevisionSummary struct {
Revision int64 `json:"revision"`
Version string `json:"version,omitempty"`
Phase string `json:"phase,omitempty"`
}
RevisionSummary is a short record of one revision.
func (*RevisionSummary) DeepCopy ¶
func (in *RevisionSummary) DeepCopy() *RevisionSummary
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RevisionSummary.
func (*RevisionSummary) DeepCopyInto ¶
func (in *RevisionSummary) DeepCopyInto(out *RevisionSummary)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RollbackPolicy ¶
type RollbackPolicy struct {
// Safe is true when rolling back from this version to the previous one
// does not lose data. Only then does a failed upgrade roll back
// automatically.
// +optional
Safe bool `json:"safe,omitempty"`
}
RollbackPolicy describes rollback safety of a package version.
func (*RollbackPolicy) DeepCopy ¶
func (in *RollbackPolicy) DeepCopy() *RollbackPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RollbackPolicy.
func (*RollbackPolicy) DeepCopyInto ¶
func (in *RollbackPolicy) DeepCopyInto(out *RollbackPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretKeyRef ¶
type SecretKeyRef struct {
// +required
Namespace string `json:"namespace"`
// +required
Name string `json:"name"`
// Key defaults to "kubeconfig".
// +optional
Key string `json:"key,omitempty"`
}
SecretKeyRef points at one key of a Secret.
func (*SecretKeyRef) DeepCopy ¶
func (in *SecretKeyRef) DeepCopy() *SecretKeyRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretKeyRef.
func (*SecretKeyRef) DeepCopyInto ¶
func (in *SecretKeyRef) DeepCopyInto(out *SecretKeyRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UpgradePolicy ¶
type UpgradePolicy struct {
// Atomic rolls the whole package back when a revision fails, if the
// version being left declares rollback as safe. Default true.
// +optional
Atomic *bool `json:"atomic,omitempty"`
// Timeout for every component to become healthy. Default 10m.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
}
UpgradePolicy controls how a new revision is applied.
func (*UpgradePolicy) DeepCopy ¶
func (in *UpgradePolicy) DeepCopy() *UpgradePolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UpgradePolicy.
func (*UpgradePolicy) DeepCopyInto ¶
func (in *UpgradePolicy) DeepCopyInto(out *UpgradePolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Variant ¶
type Variant struct {
// Name is the unique identifier for this variant
// +required
Name string `json:"name"`
// DependsOn is a list of package source dependencies
// For example: "networking"
// Equivalent to Requires entries with only Package set.
// +optional
DependsOn []string `json:"dependsOn,omitempty"`
// Requires lists packages or capabilities this variant needs.
// +optional
Requires []Requirement `json:"requires,omitempty"`
// Libraries is a list of Helm library charts used by components in this variant
// +optional
Libraries []Library `json:"libraries,omitempty"`
// Components is a list of Helm releases to be installed as part of this variant
// +optional
Components []Component `json:"components,omitempty"`
}
Variant defines a single variant configuration
func (*Variant) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Variant.
func (*Variant) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.