v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=app.ibm.com

Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=app.ibm.com

Index

• Constants
• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• type ConditionStatus
• type GitHub
  • func (in *GitHub) DeepCopy() *GitHub
  • func (in *GitHub) DeepCopyInto(out *GitHub)
• type HelmAppCondition
  • func (in *HelmAppCondition) DeepCopy() *HelmAppCondition
  • func (in *HelmAppCondition) DeepCopyInto(out *HelmAppCondition)
• type HelmAppConditionReason
• type HelmAppConditionType
• type HelmAppRelease
  • func (in *HelmAppRelease) DeepCopy() *HelmAppRelease
  • func (in *HelmAppRelease) DeepCopyInto(out *HelmAppRelease)
• type HelmAppSpec
• type HelmAppStatus
  • func (in *HelmAppStatus) DeepCopy() *HelmAppStatus
  • func (in *HelmAppStatus) DeepCopyInto(out *HelmAppStatus)
  • func (s *HelmAppStatus) SetCondition(condition HelmAppCondition) *HelmAppStatus
• type HelmRelease
  • func (in *HelmRelease) DeepCopy() *HelmRelease
  • func (in *HelmRelease) DeepCopyInto(out *HelmRelease)
  • func (in *HelmRelease) DeepCopyObject() runtime.Object
• type HelmReleaseList
  • func (in *HelmReleaseList) DeepCopy() *HelmReleaseList
  • func (in *HelmReleaseList) DeepCopyInto(out *HelmReleaseList)
  • func (in *HelmReleaseList) DeepCopyObject() runtime.Object
• type HelmReleaseRepo
  • func (in *HelmReleaseRepo) DeepCopy() *HelmReleaseRepo
  • func (in *HelmReleaseRepo) DeepCopyInto(out *HelmReleaseRepo)
• type HelmRepo
  • func (in *HelmRepo) DeepCopy() *HelmRepo
  • func (in *HelmRepo) DeepCopyInto(out *HelmRepo)
• type Source
  • func (in *Source) DeepCopy() *Source
  • func (in *Source) DeepCopyInto(out *Source)
  • func (s Source) String() string
• 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"
	ReasonUpdateSuccessful    HelmAppConditionReason = "UpdateSuccessful"
	ReasonUninstallSuccessful HelmAppConditionReason = "UninstallSuccessful"
	ReasonInstallError        HelmAppConditionReason = "InstallError"
	ReasonUpdateError         HelmAppConditionReason = "UpdateError"
	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: "app.ibm.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Functions

func GetOpenAPIDefinitions

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

Types

type ConditionStatus

type ConditionStatus string

type GitHub

type GitHub struct {
	Urls      []string `json:"urls,omitempty"`
	ChartPath string   `json:"chartPath,omitempty"`
	Branch    string   `json:"branch,omitempty"`
}

GitHub provides the parameters to access the helm-chart located in a github repo

func (*GitHub) DeepCopy

func (in *GitHub) DeepCopy() *GitHub

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitHub.

func (*GitHub) DeepCopyInto

func (in *GitHub) DeepCopyInto(out *GitHub)

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 (*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) 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.

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 {
	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
	// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
	// Add custom validation using kubebuilder tags: https://book-v1.book.kubebuilder.io/beyond_basics/generating_crd.html
	// Source holds the url toward the helm-chart
	Source *Source `json:"source,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"`
	// 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"`
}

HelmReleaseRepo defines the repository of HelmRelease +k8s:openapi-gen=true

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 []string `json:"urls,omitempty"`
}

HelmRepo provides the urls to retrieve the helm-chart

func (*HelmRepo) DeepCopy

func (in *HelmRepo) DeepCopy() *HelmRepo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HelmRepo.

func (*HelmRepo) DeepCopyInto

func (in *HelmRepo) DeepCopyInto(out *HelmRepo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Source

type Source struct {
	SourceType SourceTypeEnum `json:"type,omitempty"`
	GitHub     *GitHub        `json:"github,omitempty"`
	HelmRepo   *HelmRepo      `json:"helmRepo,omitempty"`
}

Source holds the different types of repository

func (*Source) DeepCopy

func (in *Source) DeepCopy() *Source

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Source.

func (*Source) DeepCopyInto

func (in *Source) DeepCopyInto(out *Source)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Source) String

func (s Source) String() string

type SourceTypeEnum

type SourceTypeEnum string

SourceTypeEnum types of sources

const (
	// HelmRepoSourceType helmrepo source type
	HelmRepoSourceType SourceTypeEnum = "helmrepo"
	// GitHubSourceType github source type
	GitHubSourceType SourceTypeEnum = "github"
)