Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the cyclops v1alpha1 API group +kubebuilder:object:generate=true +groupName=cyclops-ui.com
Index ¶
- Constants
- Variables
- type GitOpsWriteDestination
- type GroupVersionResource
- type HistoryEntry
- type HistoryTemplateRef
- type Module
- type ModuleList
- type ModuleSpec
- type ModuleStatus
- type ModuleValue
- type ReconciliationStatus
- type ReconciliationStatusState
- type TemplateAuthRule
- type TemplateAuthRuleList
- type TemplateAuthRuleSpec
- type TemplateGitRef
- type TemplateRef
- type TemplateSourceType
- type TemplateStore
- type TemplateStoreList
Constants ¶
const ( TemplateSourceTypeGit TemplateSourceType = "git" TemplateSourceTypeHelm TemplateSourceType = "helm" TemplateSourceTypeOCI TemplateSourceType = "oci" GitOpsWriteRepoAnnotation = "cyclops-ui.com/write-repo" GitOpsWritePathAnnotation = "cyclops-ui.com/write-path" GitOpsWriteRevisionAnnotation = "cyclops-ui.com/write-revision" ModuleManagerLabel = "cyclops-ui.com/module-manager" AddonModuleLabel = "cyclops-ui.com/addon" MCPServerModuleLabel = "cyclops-ui.com/mcp-server" ResourceFinalizer = "cyclops-ui.com/module-resources" )
const IconURLAnnotation = "cyclops-ui.com/icon"
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "cyclops-ui.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 ¶
This section is empty.
Types ¶
type GitOpsWriteDestination ¶
type GitOpsWriteDestination struct {
Repo string `json:"repo"`
Path string `json:"path"`
Version string `json:"version"`
}
func (*GitOpsWriteDestination) DeepCopy ¶
func (in *GitOpsWriteDestination) DeepCopy() *GitOpsWriteDestination
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitOpsWriteDestination.
func (*GitOpsWriteDestination) DeepCopyInto ¶
func (in *GitOpsWriteDestination) DeepCopyInto(out *GitOpsWriteDestination)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GroupVersionResource ¶
type GroupVersionResource struct {
Group string `json:"group"`
Version string `json:"version"`
Resource string `json:"resource"`
}
func (*GroupVersionResource) DeepCopy ¶
func (in *GroupVersionResource) DeepCopy() *GroupVersionResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupVersionResource.
func (*GroupVersionResource) DeepCopyInto ¶
func (in *GroupVersionResource) DeepCopyInto(out *GroupVersionResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HistoryEntry ¶
type HistoryEntry struct {
Generation int64 `json:"generation"`
// +kubebuilder:validation:Optional
TargetNamespace string `json:"targetNamespace"`
TemplateRef HistoryTemplateRef `json:"template"`
Values apiextensionsv1.JSON `json:"values"`
}
func (*HistoryEntry) DeepCopy ¶
func (in *HistoryEntry) DeepCopy() *HistoryEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HistoryEntry.
func (*HistoryEntry) DeepCopyInto ¶
func (in *HistoryEntry) DeepCopyInto(out *HistoryEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HistoryTemplateRef ¶
type HistoryTemplateRef struct {
URL string `json:"repo"`
Path string `json:"path"`
Version string `json:"version"`
// +kubebuilder:validation:Enum=git;helm;oci
// +kubebuilder:validation:Optional
SourceType TemplateSourceType `json:"sourceType,omitempty"`
}
func (*HistoryTemplateRef) DeepCopy ¶
func (in *HistoryTemplateRef) DeepCopy() *HistoryTemplateRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HistoryTemplateRef.
func (*HistoryTemplateRef) DeepCopyInto ¶
func (in *HistoryTemplateRef) DeepCopyInto(out *HistoryTemplateRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Module ¶
type Module struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ModuleSpec `json:"spec,omitempty"`
Status ModuleStatus `json:"status,omitempty"`
History []HistoryEntry `json:"history,omitempty"`
}
Module is the Schema for the modules API
func (*Module) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Module.
func (*Module) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Module) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ModuleList ¶
type ModuleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Module `json:"items"`
}
ModuleList contains a list of Module
func (*ModuleList) DeepCopy ¶
func (in *ModuleList) DeepCopy() *ModuleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ModuleList.
func (*ModuleList) DeepCopyInto ¶
func (in *ModuleList) DeepCopyInto(out *ModuleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ModuleList) DeepCopyObject ¶
func (in *ModuleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ModuleSpec ¶
type ModuleSpec struct {
// +kubebuilder:validation:Optional
TargetNamespace string `json:"targetNamespace"`
TemplateRef TemplateRef `json:"template"`
Values apiextensionsv1.JSON `json:"values"`
}
ModuleSpec defines the desired state of Module
func (*ModuleSpec) DeepCopy ¶
func (in *ModuleSpec) DeepCopy() *ModuleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ModuleSpec.
func (*ModuleSpec) DeepCopyInto ¶
func (in *ModuleSpec) DeepCopyInto(out *ModuleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ModuleStatus ¶
type ModuleStatus struct {
ReconciliationStatus *ReconciliationStatus `json:"reconciliationStatus,omitempty"`
TemplateResolvedVersion string `json:"templateResolvedVersion,omitempty"`
// +kubebuilder:validation:Optional
ManagedGVRs []GroupVersionResource `json:"managedGVRs,omitempty"`
// +kubebuilder:validation:Optional
IconURL string `json:"iconURL,omitempty"`
}
ModuleStatus defines the observed state of Module
func (*ModuleStatus) DeepCopy ¶
func (in *ModuleStatus) DeepCopy() *ModuleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ModuleStatus.
func (*ModuleStatus) DeepCopyInto ¶
func (in *ModuleStatus) DeepCopyInto(out *ModuleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ModuleValue ¶
func (*ModuleValue) DeepCopy ¶
func (in *ModuleValue) DeepCopy() *ModuleValue
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ModuleValue.
func (*ModuleValue) DeepCopyInto ¶
func (in *ModuleValue) DeepCopyInto(out *ModuleValue)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReconciliationStatus ¶
type ReconciliationStatus struct {
// +kubebuilder:validation:Optional
// +kubebuilder:validation:Enum=unknown;succeeded;failed
// +kubebuilder:default:=unknown
Status ReconciliationStatusState `json:"status,omitempty"`
// +kubebuilder:validation:Optional
Reason string `json:"reason,omitempty"`
// +kubebuilder:validation:Optional
Errors []string `json:"errors"`
}
func (*ReconciliationStatus) DeepCopy ¶
func (in *ReconciliationStatus) DeepCopy() *ReconciliationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReconciliationStatus.
func (*ReconciliationStatus) DeepCopyInto ¶
func (in *ReconciliationStatus) DeepCopyInto(out *ReconciliationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReconciliationStatusState ¶
type ReconciliationStatusState string
const ( Unknown ReconciliationStatusState = "unknown" Succeeded ReconciliationStatusState = "succeeded" Failed ReconciliationStatusState = "failed" )
type TemplateAuthRule ¶
type TemplateAuthRule struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TemplateAuthRuleSpec `json:"spec,omitempty"`
}
TemplateAuthRule is the Schema for the modules API
func (*TemplateAuthRule) DeepCopy ¶
func (in *TemplateAuthRule) DeepCopy() *TemplateAuthRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateAuthRule.
func (*TemplateAuthRule) DeepCopyInto ¶
func (in *TemplateAuthRule) DeepCopyInto(out *TemplateAuthRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TemplateAuthRule) DeepCopyObject ¶
func (in *TemplateAuthRule) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TemplateAuthRuleList ¶
type TemplateAuthRuleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []TemplateAuthRule `json:"items"`
}
TemplateAuthRuleList contains a list of TemplateAuthRule
func (*TemplateAuthRuleList) DeepCopy ¶
func (in *TemplateAuthRuleList) DeepCopy() *TemplateAuthRuleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateAuthRuleList.
func (*TemplateAuthRuleList) DeepCopyInto ¶
func (in *TemplateAuthRuleList) DeepCopyInto(out *TemplateAuthRuleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TemplateAuthRuleList) DeepCopyObject ¶
func (in *TemplateAuthRuleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TemplateAuthRuleSpec ¶
type TemplateAuthRuleSpec struct {
Repo string `json:"repo"`
Username v1.SecretKeySelector `json:"username"`
Password v1.SecretKeySelector `json:"password"`
}
TemplateAuthRuleSpec defines the desired state of TemplateAuthRule
func (*TemplateAuthRuleSpec) DeepCopy ¶
func (in *TemplateAuthRuleSpec) DeepCopy() *TemplateAuthRuleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateAuthRuleSpec.
func (*TemplateAuthRuleSpec) DeepCopyInto ¶
func (in *TemplateAuthRuleSpec) DeepCopyInto(out *TemplateAuthRuleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateGitRef ¶
type TemplateGitRef struct {
Repo string `json:"repo"`
Path string `json:"path"`
Commit string `json:"commit"`
}
func (*TemplateGitRef) DeepCopy ¶
func (in *TemplateGitRef) DeepCopy() *TemplateGitRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateGitRef.
func (*TemplateGitRef) DeepCopyInto ¶
func (in *TemplateGitRef) DeepCopyInto(out *TemplateGitRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateRef ¶
type TemplateRef struct {
URL string `json:"repo"`
Path string `json:"path"`
Version string `json:"version"`
// +kubebuilder:validation:Enum=git;helm;oci
// +kubebuilder:validation:Optional
SourceType TemplateSourceType `json:"sourceType,omitempty"`
// +kubebuilder:validation:Optional
EnforceGitOpsWrite *GitOpsWriteDestination `json:"enforceGitOpsWrite,omitempty"`
}
func (*TemplateRef) DeepCopy ¶
func (in *TemplateRef) DeepCopy() *TemplateRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateRef.
func (*TemplateRef) DeepCopyInto ¶
func (in *TemplateRef) DeepCopyInto(out *TemplateRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateSourceType ¶
type TemplateSourceType string
type TemplateStore ¶
type TemplateStore struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TemplateRef `json:"spec,omitempty"`
}
TemplateStore holds reference to a template that can be offered as a starting point
func (*TemplateStore) DeepCopy ¶
func (in *TemplateStore) DeepCopy() *TemplateStore
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateStore.
func (*TemplateStore) DeepCopyInto ¶
func (in *TemplateStore) DeepCopyInto(out *TemplateStore)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TemplateStore) DeepCopyObject ¶
func (in *TemplateStore) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TemplateStoreList ¶
type TemplateStoreList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []TemplateStore `json:"items"`
}
TemplateStoreList contains a list of TemplateStore
func (*TemplateStoreList) DeepCopy ¶
func (in *TemplateStoreList) DeepCopy() *TemplateStoreList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateStoreList.
func (*TemplateStoreList) DeepCopyInto ¶
func (in *TemplateStoreList) DeepCopyInto(out *TemplateStoreList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TemplateStoreList) DeepCopyObject ¶
func (in *TemplateStoreList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.