Documentation ¶
Overview ¶
Package v1 contains API Schema definitions for the app v1 API group +k8s:deepcopy-gen=package,register +groupName=apps.open-cluster-management.io
Package v1 contains API Schema definitions for the apps v1 API group +k8s:deepcopy-gen=package,register +groupName=apps.open-cluster-management.io
Index ¶
- Constants
- Variables
- type AltSource
- type ConditionStatus
- type Git
- type GitHub
- type HelmAppCondition
- type HelmAppConditionReason
- type HelmAppConditionType
- type HelmAppRelease
- type HelmAppSpec
- type HelmAppStatus
- func (in *HelmAppStatus) DeepCopy() *HelmAppStatus
- func (in *HelmAppStatus) DeepCopyInto(out *HelmAppStatus)
- func (s *HelmAppStatus) RemoveCondition(conditionType HelmAppConditionType) *HelmAppStatus
- func (s *HelmAppStatus) SetCondition(condition HelmAppCondition) *HelmAppStatus
- func (s *HelmAppStatus) ToMap() (map[string]interface{}, error)
- type HelmRelease
- type HelmReleaseList
- type HelmReleaseRepo
- type HelmRepo
- type Source
- type SourceTypeEnum
Constants ¶
const ( ConditionInitialized HelmAppConditionType = "Initialized" ConditionDeployed HelmAppConditionType = "Deployed" ConditionReleaseFailed HelmAppConditionType = "ReleaseFailed" ConditionIrreconcilable HelmAppConditionType = "Irreconcilable" StatusTrue ConditionStatus = "True" StatusFalse ConditionStatus = "False" StatusUnknown ConditionStatus = "Unknown" ReasonInstallSuccessful HelmAppConditionReason = "InstallSuccessful" ReasonUpgradeSuccessful HelmAppConditionReason = "UpgradeSuccessful" ReasonUninstallSuccessful HelmAppConditionReason = "UninstallSuccessful" ReasonInstallError HelmAppConditionReason = "InstallError" ReasonUpgradeError HelmAppConditionReason = "UpgradeError" ReasonReconcileError HelmAppConditionReason = "ReconcileError" ReasonUninstallError HelmAppConditionReason = "UninstallError" )
const ChartsDir = "CHARTS_DIR"
ChartsDir env variable name which contains the directory where the charts are installed
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "apps.open-cluster-management.io", Version: "v1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
This section is empty.
Types ¶
type AltSource ¶
type AltSource struct { // SourceType represents the type of the source SourceType SourceTypeEnum `json:"type,omitempty"` // GitHub provides the parameters to access the Helm chart located in a GitHub repo GitHub *GitHub `json:"github,omitempty"` // Git provides the parameters to access the Helm chart located in a Git repo Git *Git `json:"git,omitempty"` // HelmRepo provides the urls to retrieve the Helm chart HelmRepo *HelmRepo `json:"helmRepo,omitempty"` // SecretRef is a reference to a Secret resource SecretRef *corev1.ObjectReference `json:"secretRef,omitempty"` // ConfigMapRef is a reference to a ConfigMap resource ConfigMapRef *corev1.ObjectReference `json:"configMapRef,omitempty"` // InsecureSkipVerify if true enables insecure skip verify connection InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty"` }
AltSource holds the alternative source
func (*AltSource) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AltSource.
func (*AltSource) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionStatus ¶
type ConditionStatus string
type Git ¶
type Git struct { // Urls are the URLs of the Git repo. Urls []string `json:"urls,omitempty"` // ChartPath is the Helm chart path. ChartPath string `json:"chartPath,omitempty"` // Branch is the Git branch. Branch string `json:"branch,omitempty"` }
Git provides the parameters to access the Helm chart located in a Git repo
func (*Git) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Git.
func (*Git) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GitHub ¶
type GitHub struct { // Urls are the URLs of the Git repo. Urls []string `json:"urls,omitempty"` // ChartPath is the Helm chart path. ChartPath string `json:"chartPath,omitempty"` // Branch is the Git branch. Branch string `json:"branch,omitempty"` }
GitHub provides the parameters to access the Helm chart located in a GitHub repo
func (*GitHub) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitHub.
func (*GitHub) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmAppCondition ¶
type HelmAppCondition struct { Type HelmAppConditionType `json:"type"` Status ConditionStatus `json:"status"` Reason HelmAppConditionReason `json:"reason,omitempty"` Message string `json:"message,omitempty"` LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` }
func (*HelmAppCondition) DeepCopy ¶
func (in *HelmAppCondition) DeepCopy() *HelmAppCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmAppCondition.
func (*HelmAppCondition) DeepCopyInto ¶
func (in *HelmAppCondition) DeepCopyInto(out *HelmAppCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmAppConditionReason ¶
type HelmAppConditionReason string
type HelmAppConditionType ¶
type HelmAppConditionType string
type HelmAppRelease ¶
type HelmAppRelease struct { Name string `json:"name,omitempty"` Manifest string `json:"manifest,omitempty"` }
func (*HelmAppRelease) DeepCopy ¶
func (in *HelmAppRelease) DeepCopy() *HelmAppRelease
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmAppRelease.
func (*HelmAppRelease) DeepCopyInto ¶
func (in *HelmAppRelease) DeepCopyInto(out *HelmAppRelease)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmAppSpec ¶
type HelmAppSpec interface{} // modified
type HelmAppStatus ¶
type HelmAppStatus struct { Conditions []HelmAppCondition `json:"conditions"` DeployedRelease *HelmAppRelease `json:"deployedRelease,omitempty"` }
func StatusFor ¶
func StatusFor(cr *unstructured.Unstructured) *HelmAppStatus
StatusFor safely returns a typed status block from a custom resource.
func (*HelmAppStatus) DeepCopy ¶
func (in *HelmAppStatus) DeepCopy() *HelmAppStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmAppStatus.
func (*HelmAppStatus) DeepCopyInto ¶
func (in *HelmAppStatus) DeepCopyInto(out *HelmAppStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HelmAppStatus) RemoveCondition ¶
func (s *HelmAppStatus) RemoveCondition(conditionType HelmAppConditionType) *HelmAppStatus
RemoveCondition removes the condition with the passed condition type from the status object. If the condition is not already present, the returned status object is returned unchanged. RemoveCondition does not update the resource in the cluster.
func (*HelmAppStatus) SetCondition ¶
func (s *HelmAppStatus) SetCondition(condition HelmAppCondition) *HelmAppStatus
SetCondition sets a condition on the status object. If the condition already exists, it will be replaced. SetCondition does not update the resource in the cluster.
func (*HelmAppStatus) ToMap ¶
func (s *HelmAppStatus) ToMap() (map[string]interface{}, error)
type HelmRelease ¶
type HelmRelease struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Repo HelmReleaseRepo `json:"repo,omitempty"` Spec HelmAppSpec `json:"spec,omitempty"` Status HelmAppStatus `json:"status,omitempty"` }
HelmRelease is the Schema for the subscriptionreleases API +k8s:openapi-gen=true +kubebuilder:resource:scope=Namespaced +kubebuilder:subresource:status
func (*HelmRelease) DeepCopy ¶
func (in *HelmRelease) DeepCopy() *HelmRelease
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmRelease.
func (*HelmRelease) DeepCopyInto ¶
func (in *HelmRelease) DeepCopyInto(out *HelmRelease)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HelmRelease) DeepCopyObject ¶
func (in *HelmRelease) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HelmReleaseList ¶
type HelmReleaseList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []HelmRelease `json:"items"` }
HelmReleaseList contains a list of HelmRelease
func (*HelmReleaseList) DeepCopy ¶
func (in *HelmReleaseList) DeepCopy() *HelmReleaseList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmReleaseList.
func (*HelmReleaseList) DeepCopyInto ¶
func (in *HelmReleaseList) DeepCopyInto(out *HelmReleaseList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HelmReleaseList) DeepCopyObject ¶
func (in *HelmReleaseList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type HelmReleaseRepo ¶
type HelmReleaseRepo struct { // Source holds the url toward the Helm chart Source *Source `json:"source,omitempty"` // AltSource holds the url toward the Helm chart AltSource *AltSource `json:"altSource,omitempty"` // ChartName is the name of the chart within the repo ChartName string `json:"chartName,omitempty"` // Version is the chart version Version string `json:"version,omitempty"` // Digest is the helm repo chart digest Digest string `json:"digest,omitempty"` // Secret to use to access the helm-repo defined in the CatalogSource. SecretRef *corev1.ObjectReference `json:"secretRef,omitempty"` // Configuration parameters to access the helm-repo defined in the CatalogSource ConfigMapRef *corev1.ObjectReference `json:"configMapRef,omitempty"` // InsecureSkipVerify is used to skip repo server's TLS certificate verification InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty"` // WatchNamespaceScopedResources is used to enable watching namespace scope Helm chart resources WatchNamespaceScopedResources bool `json:"watchNamespaceScopedResources,omitempty"` }
HelmReleaseRepo defines the repository of HelmRelease +k8s:openapi-gen=true
func (HelmReleaseRepo) AltSourceToSource ¶
func (repo HelmReleaseRepo) AltSourceToSource() HelmReleaseRepo
func (HelmReleaseRepo) Clone ¶
func (repo HelmReleaseRepo) Clone() HelmReleaseRepo
func (*HelmReleaseRepo) DeepCopy ¶
func (in *HelmReleaseRepo) DeepCopy() *HelmReleaseRepo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmReleaseRepo.
func (*HelmReleaseRepo) DeepCopyInto ¶
func (in *HelmReleaseRepo) DeepCopyInto(out *HelmReleaseRepo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HelmRepo ¶
type HelmRepo struct { // Urls are the URLs of the Helm repo. Urls []string `json:"urls,omitempty"` }
HelmRepo provides the urls to retrieve the Helm chart
func (*HelmRepo) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmRepo.
func (*HelmRepo) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Source ¶
type Source struct { // SourceType represents the type of the source SourceType SourceTypeEnum `json:"type,omitempty"` // GitHub provides the parameters to access the Helm chart located in a GitHub repo GitHub *GitHub `json:"github,omitempty"` // Git provides the parameters to access the Helm chart located in a Git repo Git *Git `json:"git,omitempty"` // HelmRepo provides the urls to retrieve the Helm chart HelmRepo *HelmRepo `json:"helmRepo,omitempty"` }
Source holds the different types of repository
func (*Source) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Source.
func (*Source) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SourceTypeEnum ¶
type SourceTypeEnum string
SourceTypeEnum types of sources
const ( // HelmRepoSourceType helmrepo source type HelmRepoSourceType SourceTypeEnum = "helmrepo" // GitHubSourceType github source type GitHubSourceType SourceTypeEnum = "github" // GitSourceType git source type GitSourceType SourceTypeEnum = "git" )