Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the orkestra v1alpha1 API group +kubebuilder:object:generate=true +groupName=orkestra.azure.microsoft.com
Index ¶
- Constants
- Variables
- func GetInterval(appGroup *ApplicationGroup) time.Duration
- func GetJSON(values map[string]interface{}) (*apiextensionsv1.JSON, error)
- type Application
- type ApplicationGroup
- func (in *ApplicationGroup) DeepCopy() *ApplicationGroup
- func (in *ApplicationGroup) DeepCopyInto(out *ApplicationGroup)
- func (in *ApplicationGroup) DeepCopyObject() runtime.Object
- func (in *ApplicationGroup) DeployFailed(message string)
- func (in *ApplicationGroup) DeploySucceeded()
- func (in *ApplicationGroup) GetDeployCondition() string
- func (in *ApplicationGroup) GetReadyCondition() string
- func (in *ApplicationGroup) GetStatusConditions() *[]metav1.Condition
- func (in *ApplicationGroup) Progressing()
- func (in *ApplicationGroup) ReadyFailed(message string)
- func (in *ApplicationGroup) ReadySucceeded()
- func (in *ApplicationGroup) RollingBack()
- type ApplicationGroupList
- type ApplicationGroupSpec
- type ApplicationGroupStatus
- type ApplicationSpec
- type ApplicationStatus
- type ChartRef
- type ChartStatus
- type DAG
- type ReconciliationPhase
- type Release
- type ReleaseInstallSpec
- type ReleaseRollbackSpec
- type ReleaseUpgradeSpec
Constants ¶
const ( DefaultProgressingRequeue = 5 * time.Second DefaultSucceededRequeue = 5 * time.Minute )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "orkestra.azure.microsoft.com", 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 ¶
func GetInterval ¶ added in v0.4.1
func GetInterval(appGroup *ApplicationGroup) time.Duration
GetInterval returns the interval if specified in the application group Otherwise, it returns the default requeue time for the appGroup
Types ¶
type Application ¶
type Application struct {
// DAG contains the dependency information
DAG `json:",inline"`
// Spec contains the application spec including the chart info and overlay values
Spec ApplicationSpec `json:"spec,omitempty"`
}
Application spec and dependency on other applications
func (*Application) DeepCopy ¶
func (in *Application) DeepCopy() *Application
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Application.
func (*Application) DeepCopyInto ¶
func (in *Application) DeepCopyInto(out *Application)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Application) GetValues ¶ added in v0.5.0
func (in *Application) GetValues() map[string]interface{}
GetValues unmarshals the raw values to a map[string]interface{} and returns the result.
func (*Application) SetValues ¶ added in v0.5.0
func (in *Application) SetValues(values map[string]interface{}) error
SetValues marshals the raw values into the JSON values
type ApplicationGroup ¶
type ApplicationGroup struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ApplicationGroupSpec `json:"spec,omitempty"`
Status ApplicationGroupStatus `json:"status,omitempty"`
}
ApplicationGroup is the Schema for the applicationgroups API
func (*ApplicationGroup) DeepCopy ¶
func (in *ApplicationGroup) DeepCopy() *ApplicationGroup
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationGroup.
func (*ApplicationGroup) DeepCopyInto ¶
func (in *ApplicationGroup) DeepCopyInto(out *ApplicationGroup)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApplicationGroup) DeepCopyObject ¶
func (in *ApplicationGroup) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ApplicationGroup) DeployFailed ¶ added in v0.4.1
func (in *ApplicationGroup) DeployFailed(message string)
Failed sets the meta.DeployCondition to 'True' and meta.FailedReason reason and message
func (*ApplicationGroup) DeploySucceeded ¶ added in v0.4.1
func (in *ApplicationGroup) DeploySucceeded()
Succeeded sets the meta.DeployCondition to 'True', with the given meta.Succeeded reason and message
func (*ApplicationGroup) GetDeployCondition ¶ added in v0.4.1
func (in *ApplicationGroup) GetDeployCondition() string
GetDeployCondition gets the string condition.Reason of the meta.ReadyCondition type
func (*ApplicationGroup) GetReadyCondition ¶ added in v0.4.1
func (in *ApplicationGroup) GetReadyCondition() string
GetReadyCondition gets the string condition.Reason of the meta.ReadyCondition type
func (*ApplicationGroup) GetStatusConditions ¶ added in v0.4.1
func (in *ApplicationGroup) GetStatusConditions() *[]metav1.Condition
GetStatusConditions gets the status conditions from the ApplicationGroup status
func (*ApplicationGroup) Progressing ¶ added in v0.4.1
func (in *ApplicationGroup) Progressing()
Progressing resets the conditions of the ApplicationGroup to metav1.Condition of type meta.ReadyCondition with status 'Unknown' and meta.StartingReason reason and message.
func (*ApplicationGroup) ReadyFailed ¶ added in v0.4.1
func (in *ApplicationGroup) ReadyFailed(message string)
Failed sets the meta.ReadyCondition to 'True' and meta.FailedReason reason and message
func (*ApplicationGroup) ReadySucceeded ¶ added in v0.4.1
func (in *ApplicationGroup) ReadySucceeded()
Succeeded sets the meta.ReadyCondition to 'True', with the given meta.Succeeded reason and message
func (*ApplicationGroup) RollingBack ¶ added in v0.4.1
func (in *ApplicationGroup) RollingBack()
RollingBack sets the meta.ReadyCondition to 'True' and meta.RollingBack reason and message
type ApplicationGroupList ¶
type ApplicationGroupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ApplicationGroup `json:"items"`
}
ApplicationGroupList contains a list of ApplicationGroup
func (*ApplicationGroupList) DeepCopy ¶
func (in *ApplicationGroupList) DeepCopy() *ApplicationGroupList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationGroupList.
func (*ApplicationGroupList) DeepCopyInto ¶
func (in *ApplicationGroupList) DeepCopyInto(out *ApplicationGroupList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApplicationGroupList) DeepCopyObject ¶
func (in *ApplicationGroupList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApplicationGroupSpec ¶
type ApplicationGroupSpec struct {
// Applications that make up the application group
Applications []Application `json:"applications,omitempty"`
// Interval specifies the between reconciliations of the ApplicationGroup
// Defaults to 5s for short requeue and 30s for long requeue
// +optional
Interval *metav1.Duration `json:"interval,omitempty"`
}
ApplicationGroupSpec defines the desired state of ApplicationGroup
func (*ApplicationGroupSpec) DeepCopy ¶
func (in *ApplicationGroupSpec) DeepCopy() *ApplicationGroupSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationGroupSpec.
func (*ApplicationGroupSpec) DeepCopyInto ¶
func (in *ApplicationGroupSpec) DeepCopyInto(out *ApplicationGroupSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ApplicationGroupStatus ¶
type ApplicationGroupStatus struct {
// Applications status
// +optional
Applications []ApplicationStatus `json:"status,omitempty"`
// Phase is the reconciliation phase
// +optional
Update bool `json:"update,omitempty"`
// ObservedGeneration captures the last generation
// that was captured and completed by the reconciler
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// Conditions holds the conditions of the ApplicationGroup
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
ApplicationGroupStatus defines the observed state of ApplicationGroup
func (*ApplicationGroupStatus) DeepCopy ¶
func (in *ApplicationGroupStatus) DeepCopy() *ApplicationGroupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationGroupStatus.
func (*ApplicationGroupStatus) DeepCopyInto ¶
func (in *ApplicationGroupStatus) DeepCopyInto(out *ApplicationGroupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ApplicationSpec ¶
type ApplicationSpec struct {
// Chart holds the values needed to pull the chart
// +required
Chart *ChartRef `json:"chart"`
// Release holds the values to apply to the helm release
// +required
Release *Release `json:"release"`
// Subcharts provides the dependency order among the subcharts of the application
// +optional
Subcharts []DAG `json:"subcharts,omitempty"`
}
ApplicationSpec defines the desired state of Application
func (*ApplicationSpec) DeepCopy ¶
func (in *ApplicationSpec) DeepCopy() *ApplicationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationSpec.
func (*ApplicationSpec) DeepCopyInto ¶
func (in *ApplicationSpec) DeepCopyInto(out *ApplicationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ApplicationStatus ¶
type ApplicationStatus struct {
// Name of the application
// +optional
Name string `json:"name"`
// ChartStatus for the application helm chart
// +optional
ChartStatus `json:",inline"`
// Subcharts contains the subchart chart status
// +optional
Subcharts map[string]ChartStatus `json:"subcharts,omitempty"`
}
ApplicationStatus shows the current status of the application helm release
func (*ApplicationStatus) DeepCopy ¶
func (in *ApplicationStatus) DeepCopy() *ApplicationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApplicationStatus.
func (*ApplicationStatus) DeepCopyInto ¶
func (in *ApplicationStatus) DeepCopyInto(out *ApplicationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChartRef ¶ added in v0.4.0
type ChartRef struct {
// The Helm repository URL, a valid URL contains at least a protocol and host.
// +required
Url string `json:"url"` //nolint: golint
// The name or path the Helm chart is available at in the SourceRef.
// +required
Name string `json:"name"` //nolint: golint
// Version semver expression, ignored for charts from v1beta1.GitRepository and
// v1beta1.Bucket sources. Defaults to latest when omitted.
// +kubebuilder:default:=*
// +optional
Version string `json:"version,omitempty"`
// AuthSecretRef is a reference to the auth secret
// to access a private helm repository
// +optional
AuthSecretRef *corev1.ObjectReference `json:"authSecretRef,omitempty"`
}
func (*ChartRef) DeepCopy ¶ added in v0.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChartRef.
func (*ChartRef) DeepCopyInto ¶ added in v0.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ChartStatus ¶
type ChartStatus struct {
// Error string from the error during reconciliation (if any)
// +optional
Error string `json:"error,omitempty"`
// Version of the chart/subchart
// +optional
Version string `json:"version,omitempty"`
// Staged if true denotes that the chart/subchart has been pushed to the
// staging helm repo
// +optional
Staged bool `json:"staged,omitempty"`
// +optional
// Conditions holds the conditions for the ChartStatus
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
ChartStatus shows the current status of the Application Reconciliation process
func (*ChartStatus) DeepCopy ¶
func (in *ChartStatus) DeepCopy() *ChartStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChartStatus.
func (*ChartStatus) DeepCopyInto ¶
func (in *ChartStatus) DeepCopyInto(out *ChartStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChartStatus) GetStatusConditions ¶ added in v0.5.0
func (in *ChartStatus) GetStatusConditions() *[]metav1.Condition
GetStatusConditions gets the status conditions from the ChartStatus status
type DAG ¶
type DAG struct {
// Name of the application
// +required
Name string `json:"name"`
// Dependencies on other applications by name
// +optional
Dependencies []string `json:"dependencies,omitempty"`
}
DAG contains the dependency information
func (*DAG) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DAG.
func (*DAG) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReconciliationPhase ¶ added in v0.3.0
type ReconciliationPhase string
ReconciliationPhase is an enum
const ( Init ReconciliationPhase = "Init" Running ReconciliationPhase = "Running" Succeeded ReconciliationPhase = "Succeeded" Error ReconciliationPhase = "Error" Rollback ReconciliationPhase = "Rollback" )
type Release ¶ added in v0.4.0
type Release struct {
// Interval at which to reconcile the Helm release.
// +kubebuilder:default:="5m"
// +optional
Interval metav1.Duration `json:"interval,omitempty"`
// TargetNamespace to target when performing operations for the HelmRelease.
// Defaults to the namespace of the HelmRelease.
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=63
// +kubebuilder:validation:Optional
// +optional
TargetNamespace string `json:"targetNamespace,omitempty"`
// Timeout is the time to wait for any individual Kubernetes operation (like Jobs
// for hooks) during the performance of a Helm action. Defaults to '5m0s'.
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
// Values holds the values for this Helm release.
// +optional
Values *apiextensionsv1.JSON `json:"values,omitempty"`
// Install holds the configuration for Helm install actions for this HelmRelease.
// +optional
Install *ReleaseInstallSpec `json:"install,omitempty"`
// Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.
// +optional
Upgrade *ReleaseUpgradeSpec `json:"upgrade,omitempty"`
// Rollback holds the configuration for Helm rollback actions for this HelmRelease.
// +optional
Rollback *ReleaseRollbackSpec `json:"rollback,omitempty"`
}
func (*Release) DeepCopy ¶ added in v0.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Release.
func (*Release) DeepCopyInto ¶ added in v0.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReleaseInstallSpec ¶ added in v0.5.0
type ReleaseInstallSpec struct {
// DisableWait disables the waiting for resources to be ready after a Helm
// install has been performed.
// +optional
DisableWait bool `json:"disableWait,omitempty"`
}
func (*ReleaseInstallSpec) DeepCopy ¶ added in v0.5.0
func (in *ReleaseInstallSpec) DeepCopy() *ReleaseInstallSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReleaseInstallSpec.
func (*ReleaseInstallSpec) DeepCopyInto ¶ added in v0.5.0
func (in *ReleaseInstallSpec) DeepCopyInto(out *ReleaseInstallSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReleaseRollbackSpec ¶ added in v0.5.0
type ReleaseRollbackSpec struct {
// DisableWait disables the waiting for resources to be ready after a Helm
// rollback has been performed.
// +optional
DisableWait bool `json:"disableWait,omitempty"`
}
func (*ReleaseRollbackSpec) DeepCopy ¶ added in v0.5.0
func (in *ReleaseRollbackSpec) DeepCopy() *ReleaseRollbackSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReleaseRollbackSpec.
func (*ReleaseRollbackSpec) DeepCopyInto ¶ added in v0.5.0
func (in *ReleaseRollbackSpec) DeepCopyInto(out *ReleaseRollbackSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReleaseUpgradeSpec ¶ added in v0.5.0
type ReleaseUpgradeSpec struct {
// DisableWait disables the waiting for resources to be ready after a Helm
// upgrade has been performed.
// +optional
DisableWait bool `json:"disableWait,omitempty"`
// Force forces resource updates through a replacement strategy.
// +optional
Force bool `json:"force,omitempty"`
}
func (*ReleaseUpgradeSpec) DeepCopy ¶ added in v0.5.0
func (in *ReleaseUpgradeSpec) DeepCopy() *ReleaseUpgradeSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReleaseUpgradeSpec.
func (*ReleaseUpgradeSpec) DeepCopyInto ¶ added in v0.5.0
func (in *ReleaseUpgradeSpec) DeepCopyInto(out *ReleaseUpgradeSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.