Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group +kubebuilder:object:generate=true +groupName=core.rukpak.io
Index ¶
- Constants
- Variables
- type Authorization
- type Bundle
- type BundleDeployment
- type BundleDeploymentList
- type BundleDeploymentSpec
- type BundleDeploymentStatus
- type BundleList
- type BundleSource
- type BundleSpec
- type BundleStatus
- type BundleTemplate
- type ConfigMapSource
- type GitRef
- type GitSource
- type HTTPSource
- type ImageSource
- type ProvisionerID
- type SourceType
- type UploadSource
Constants ¶
const ( SourceTypeImage SourceType = "image" SourceTypeGit SourceType = "git" SourceTypeConfigMaps SourceType = "configMaps" SourceTypeUpload SourceType = "upload" SourceTypeHTTP SourceType = "http" TypeUnpacked = "Unpacked" ReasonUnpackPending = "UnpackPending" ReasonUnpacking = "Unpacking" ReasonUnpackSuccessful = "UnpackSuccessful" ReasonUnpackFailed = "UnpackFailed" ReasonProcessingFinalizerFailed = "ProcessingFinalizerFailed" PhasePending = "Pending" PhaseUnpacking = "Unpacking" PhaseFailing = "Failing" PhaseUnpacked = "Unpacked" )
const ( TypeHasValidBundle = "HasValidBundle" TypeHealthy = "Healthy" TypeInstalled = "Installed" ReasonBundleLoadFailed = "BundleLoadFailed" ReasonCreateDynamicWatchFailed = "CreateDynamicWatchFailed" ReasonErrorGettingClient = "ErrorGettingClient" ReasonErrorGettingReleaseState = "ErrorGettingReleaseState" ReasonHealthy = "Healthy" ReasonInstallationStatusFalse = "InstallationStatusFalse" ReasonInstallationStatusUnknown = "InstallationStatusUnknown" ReasonInstallationSucceeded = "InstallationSucceeded" ReasonInstallFailed = "InstallFailed" ReasonObjectLookupFailure = "ObjectLookupFailure" ReasonReadingContentFailed = "ReadingContentFailed" ReasonReconcileFailed = "ReconcileFailed" ReasonUnhealthy = "Unhealthy" ReasonUpgradeFailed = "UpgradeFailed" )
Variables ¶
var ( BundleGVK = SchemeBuilder.GroupVersion.WithKind("Bundle") BundleKind = BundleGVK.Kind )
var ( BundleDeploymentGVK = SchemeBuilder.GroupVersion.WithKind("BundleDeployment") BundleDeploymentKind = BundleDeploymentGVK.Kind )
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "core.rukpak.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Authorization ¶ added in v0.5.0
type Authorization struct { // Secret contains reference to the secret that has authorization information and is in the namespace that the provisioner is deployed. // The secret is expected to contain `data.username` and `data.password` for the username and password, respectively for http(s) scheme. // Refer to https://kubernetes.io/docs/concepts/configuration/secret/#basic-authentication-secret // For the ssh authorization of the GitSource, the secret is expected to contain `data.ssh-privatekey` and `data.ssh-knownhosts` for the ssh privatekey and the host entry in the known_hosts file respectively. // Refer to https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets Secret corev1.LocalObjectReference `json:"secret,omitempty"` // InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. If InsecureSkipVerify // is true, the clone operation will accept any certificate presented by the server and any host name in that // certificate. In this mode, TLS is susceptible to machine-in-the-middle attacks unless custom verification is // used. This should be used only for testing. InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty"` }
func (*Authorization) DeepCopy ¶ added in v0.5.0
func (in *Authorization) DeepCopy() *Authorization
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Authorization.
func (*Authorization) DeepCopyInto ¶ added in v0.5.0
func (in *Authorization) DeepCopyInto(out *Authorization)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Bundle ¶
type Bundle struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BundleSpec `json:"spec"` Status BundleStatus `json:"status,omitempty"` }
Bundle is the Schema for the bundles API
func (*Bundle) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Bundle.
func (*Bundle) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Bundle) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Bundle) ProvisionerClassName ¶ added in v0.5.0
type BundleDeployment ¶ added in v0.6.0
type BundleDeployment struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BundleDeploymentSpec `json:"spec"` Status BundleDeploymentStatus `json:"status,omitempty"` }
BundleDeployment is the Schema for the bundledeployments API
func (*BundleDeployment) DeepCopy ¶ added in v0.6.0
func (in *BundleDeployment) DeepCopy() *BundleDeployment
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleDeployment.
func (*BundleDeployment) DeepCopyInto ¶ added in v0.6.0
func (in *BundleDeployment) DeepCopyInto(out *BundleDeployment)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BundleDeployment) DeepCopyObject ¶ added in v0.6.0
func (in *BundleDeployment) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BundleDeploymentList ¶ added in v0.6.0
type BundleDeploymentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []BundleDeployment `json:"items"` }
BundleDeploymentList contains a list of BundleDeployment
func (*BundleDeploymentList) DeepCopy ¶ added in v0.6.0
func (in *BundleDeploymentList) DeepCopy() *BundleDeploymentList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleDeploymentList.
func (*BundleDeploymentList) DeepCopyInto ¶ added in v0.6.0
func (in *BundleDeploymentList) DeepCopyInto(out *BundleDeploymentList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BundleDeploymentList) DeepCopyObject ¶ added in v0.6.0
func (in *BundleDeploymentList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BundleDeploymentSpec ¶ added in v0.6.0
type BundleDeploymentSpec struct { //+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ // ProvisionerClassName sets the name of the provisioner that should reconcile this BundleDeployment. ProvisionerClassName string `json:"provisionerClassName"` // Template describes the generated Bundle that this deployment will manage. Template BundleTemplate `json:"template"` // Config is provisioner specific configurations // +kubebuilder:pruning:PreserveUnknownFields Config runtime.RawExtension `json:"config,omitempty"` }
BundleDeploymentSpec defines the desired state of BundleDeployment
func (*BundleDeploymentSpec) DeepCopy ¶ added in v0.6.0
func (in *BundleDeploymentSpec) DeepCopy() *BundleDeploymentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleDeploymentSpec.
func (*BundleDeploymentSpec) DeepCopyInto ¶ added in v0.6.0
func (in *BundleDeploymentSpec) DeepCopyInto(out *BundleDeploymentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BundleDeploymentStatus ¶ added in v0.6.0
type BundleDeploymentStatus struct { Conditions []metav1.Condition `json:"conditions,omitempty"` ActiveBundle string `json:"activeBundle,omitempty"` ObservedGeneration int64 `json:"observedGeneration,omitempty"` }
BundleDeploymentStatus defines the observed state of BundleDeployment
func (*BundleDeploymentStatus) DeepCopy ¶ added in v0.6.0
func (in *BundleDeploymentStatus) DeepCopy() *BundleDeploymentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleDeploymentStatus.
func (*BundleDeploymentStatus) DeepCopyInto ¶ added in v0.6.0
func (in *BundleDeploymentStatus) DeepCopyInto(out *BundleDeploymentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BundleList ¶
type BundleList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Bundle `json:"items"` }
BundleList contains a list of Bundle
func (*BundleList) DeepCopy ¶
func (in *BundleList) DeepCopy() *BundleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleList.
func (*BundleList) DeepCopyInto ¶
func (in *BundleList) DeepCopyInto(out *BundleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BundleList) DeepCopyObject ¶
func (in *BundleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BundleSource ¶ added in v0.2.0
type BundleSource struct { // Type defines the kind of Bundle content being sourced. Type SourceType `json:"type"` // Image is the bundle image that backs the content of this bundle. Image *ImageSource `json:"image,omitempty"` // Git is the git repository that backs the content of this Bundle. Git *GitSource `json:"git,omitempty"` // ConfigMaps is a list of config map references and their relative // directory paths that represent a bundle filesystem. ConfigMaps []ConfigMapSource `json:"configMaps,omitempty"` // Upload is a source that enables this Bundle's content to be uploaded // via Rukpak's bundle upload service. This source type is primarily useful // with bundle development workflows because it enables bundle developers // to inject a local bundle directly into the cluster. Upload *UploadSource `json:"upload,omitempty"` // HTTP is the remote location that backs the content of this Bundle. HTTP *HTTPSource `json:"http,omitempty"` }
func (*BundleSource) DeepCopy ¶ added in v0.2.0
func (in *BundleSource) DeepCopy() *BundleSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleSource.
func (*BundleSource) DeepCopyInto ¶ added in v0.2.0
func (in *BundleSource) DeepCopyInto(out *BundleSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BundleSpec ¶
type BundleSpec struct { //+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ // ProvisionerClassName sets the name of the provisioner that should reconcile this BundleDeployment. ProvisionerClassName string `json:"provisionerClassName"` // Source defines the configuration for the underlying Bundle content. Source BundleSource `json:"source"` }
BundleSpec defines the desired state of Bundle
func (*BundleSpec) DeepCopy ¶
func (in *BundleSpec) DeepCopy() *BundleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleSpec.
func (*BundleSpec) DeepCopyInto ¶
func (in *BundleSpec) DeepCopyInto(out *BundleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BundleStatus ¶
type BundleStatus struct { Phase string `json:"phase,omitempty"` ResolvedSource *BundleSource `json:"resolvedSource,omitempty"` ObservedGeneration int64 `json:"observedGeneration,omitempty"` Conditions []metav1.Condition `json:"conditions,omitempty"` ContentURL string `json:"contentURL,omitempty"` }
BundleStatus defines the observed state of Bundle
func (*BundleStatus) DeepCopy ¶
func (in *BundleStatus) DeepCopy() *BundleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleStatus.
func (*BundleStatus) DeepCopyInto ¶
func (in *BundleStatus) DeepCopyInto(out *BundleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BundleTemplate ¶ added in v0.4.0
type BundleTemplate struct { // Standard object's metadata. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // Specification of the desired behavior of the Bundle. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Spec BundleSpec `json:"spec"` }
BundleTemplate defines the desired state of a Bundle resource
func (*BundleTemplate) DeepCopy ¶ added in v0.4.0
func (in *BundleTemplate) DeepCopy() *BundleTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleTemplate.
func (*BundleTemplate) DeepCopyInto ¶ added in v0.4.0
func (in *BundleTemplate) DeepCopyInto(out *BundleTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConfigMapSource ¶ added in v0.12.0
type ConfigMapSource struct { // ConfigMap is a reference to a configmap in the rukpak system namespace ConfigMap corev1.LocalObjectReference `json:"configMap"` // Path is the relative directory path within the bundle where the files // from the configmap will be present when the bundle is unpacked. Path string `json:"path,omitempty"` }
func (*ConfigMapSource) DeepCopy ¶ added in v0.12.0
func (in *ConfigMapSource) DeepCopy() *ConfigMapSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigMapSource.
func (*ConfigMapSource) DeepCopyInto ¶ added in v0.12.0
func (in *ConfigMapSource) DeepCopyInto(out *ConfigMapSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitRef ¶ added in v0.2.0
type GitRef struct { // Branch refers to the branch to checkout from the repository. // The Branch should contain the bundle manifests in the specified directory. Branch string `json:"branch,omitempty"` // Tag refers to the tag to checkout from the repository. // The Tag should contain the bundle manifests in the specified directory. Tag string `json:"tag,omitempty"` // Commit refers to the commit to checkout from the repository. // The Commit should contain the bundle manifests in the specified directory. Commit string `json:"commit,omitempty"` }
func (*GitRef) DeepCopy ¶ added in v0.2.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitRef.
func (*GitRef) DeepCopyInto ¶ added in v0.2.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitSource ¶ added in v0.2.0
type GitSource struct { // Repository is a URL link to the git repository containing the bundle. // Repository is required and the URL should be parsable by a standard git tool. Repository string `json:"repository"` // Directory refers to the location of the bundle within the git repository. // Directory is optional and if not set defaults to ./manifests. Directory string `json:"directory,omitempty"` // Ref configures the git source to clone a specific branch, tag, or commit // from the specified repo. Ref is required, and exactly one field within Ref // is required. Setting more than one field or zero fields will result in an // error. Ref GitRef `json:"ref"` // Auth configures the authorization method if necessary. Auth Authorization `json:"auth,omitempty"` }
func (*GitSource) DeepCopy ¶ added in v0.2.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitSource.
func (*GitSource) DeepCopyInto ¶ added in v0.2.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HTTPSource ¶ added in v0.9.0
type HTTPSource struct { // URL is where the bundle contents is. URL string `json:"url"` // Auth configures the authorization method if necessary. Auth Authorization `json:"auth,omitempty"` }
func (*HTTPSource) DeepCopy ¶ added in v0.9.0
func (in *HTTPSource) DeepCopy() *HTTPSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPSource.
func (*HTTPSource) DeepCopyInto ¶ added in v0.9.0
func (in *HTTPSource) DeepCopyInto(out *HTTPSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ImageSource ¶ added in v0.2.0
type ImageSource struct { // Ref contains the reference to a container image containing Bundle contents. Ref string `json:"ref"` // ImagePullSecretName contains the name of the image pull secret in the namespace that the provisioner is deployed. ImagePullSecretName string `json:"pullSecret,omitempty"` }
func (*ImageSource) DeepCopy ¶ added in v0.2.0
func (in *ImageSource) DeepCopy() *ImageSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageSource.
func (*ImageSource) DeepCopyInto ¶ added in v0.2.0
func (in *ImageSource) DeepCopyInto(out *ImageSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProvisionerID ¶
type ProvisionerID string
type SourceType ¶ added in v0.5.0
type SourceType string
type UploadSource ¶ added in v0.8.0
type UploadSource struct{}
func (*UploadSource) DeepCopy ¶ added in v0.8.0
func (in *UploadSource) DeepCopy() *UploadSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UploadSource.
func (*UploadSource) DeepCopyInto ¶ added in v0.8.0
func (in *UploadSource) DeepCopyInto(out *UploadSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.