Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group +kubebuilder:object:generate=true +groupName=utils.projectsveltos.io
Index ¶
- Constants
- Variables
- func Convert_v1alpha1_Log_To_v1beta1_Log(in *Log, out *v1beta1.Log, s conversion.Scope) error
- func Convert_v1alpha1_Resource_To_v1beta1_Resource(in *Resource, out *v1beta1.Resource, s conversion.Scope) error
- func Convert_v1alpha1_SnapshotList_To_v1beta1_SnapshotList(in *SnapshotList, out *v1beta1.SnapshotList, s conversion.Scope) error
- func Convert_v1alpha1_SnapshotSpec_To_v1beta1_SnapshotSpec(in *SnapshotSpec, out *v1beta1.SnapshotSpec, s conversion.Scope) error
- func Convert_v1alpha1_SnapshotStatus_To_v1beta1_SnapshotStatus(in *SnapshotStatus, out *v1beta1.SnapshotStatus, s conversion.Scope) error
- func Convert_v1alpha1_Snapshot_To_v1beta1_Snapshot(in *Snapshot, out *v1beta1.Snapshot, s conversion.Scope) error
- func Convert_v1alpha1_TechsupportList_To_v1beta1_TechsupportList(in *TechsupportList, out *v1beta1.TechsupportList, s conversion.Scope) error
- func Convert_v1alpha1_TechsupportSpec_To_v1beta1_TechsupportSpec(srcSpec *TechsupportSpec, dstSpec *utilsv1beta1.TechsupportSpec, ...) error
- func Convert_v1alpha1_TechsupportStatus_To_v1beta1_TechsupportStatus(in *TechsupportStatus, out *v1beta1.TechsupportStatus, s conversion.Scope) error
- func Convert_v1alpha1_Techsupport_To_v1beta1_Techsupport(in *Techsupport, out *v1beta1.Techsupport, s conversion.Scope) error
- func Convert_v1beta1_Log_To_v1alpha1_Log(in *v1beta1.Log, out *Log, s conversion.Scope) error
- func Convert_v1beta1_Resource_To_v1alpha1_Resource(in *v1beta1.Resource, out *Resource, s conversion.Scope) error
- func Convert_v1beta1_SnapshotList_To_v1alpha1_SnapshotList(in *v1beta1.SnapshotList, out *SnapshotList, s conversion.Scope) error
- func Convert_v1beta1_SnapshotSpec_To_v1alpha1_SnapshotSpec(in *v1beta1.SnapshotSpec, out *SnapshotSpec, s conversion.Scope) error
- func Convert_v1beta1_SnapshotStatus_To_v1alpha1_SnapshotStatus(in *v1beta1.SnapshotStatus, out *SnapshotStatus, s conversion.Scope) error
- func Convert_v1beta1_Snapshot_To_v1alpha1_Snapshot(in *v1beta1.Snapshot, out *Snapshot, s conversion.Scope) error
- func Convert_v1beta1_TechsupportList_To_v1alpha1_TechsupportList(in *v1beta1.TechsupportList, out *TechsupportList, s conversion.Scope) error
- func Convert_v1beta1_TechsupportSpec_To_v1alpha1_TechsupportSpec(srcSpec *utilsv1beta1.TechsupportSpec, dstSpec *TechsupportSpec, ...) error
- func Convert_v1beta1_TechsupportStatus_To_v1alpha1_TechsupportStatus(in *v1beta1.TechsupportStatus, out *TechsupportStatus, s conversion.Scope) error
- func Convert_v1beta1_Techsupport_To_v1alpha1_Techsupport(in *v1beta1.Techsupport, out *Techsupport, s conversion.Scope) error
- func RegisterConversions(s *runtime.Scheme) error
- type CollectionStatus
- type Log
- type Resource
- type Snapshot
- type SnapshotList
- type SnapshotSpec
- type SnapshotStatus
- type Techsupport
- type TechsupportList
- type TechsupportSpec
- type TechsupportStatus
Constants ¶
const ( // CollectionStatusStatusInProgress indicates that collection is being collected CollectionStatusInProgress = CollectionStatus("InProgress") // CollectionStatusStatusCollected indicates that collection succeeded CollectionStatusCollected = CollectionStatus("Collected") // CollectionStatusStatusFailed indicates that last collection failed CollectionStatusFailed = CollectionStatus("Failed") )
const ( // SnapshotFinalizer allows SnapshotReconciler to clean up resources associated with // Snapshot instance before removing it from the apiserver. SnapshotFinalizer = "snapshotfinalizer.projectsveltos.io" )
const ( // TechsupportFinalizer allows TechsupportReconciler to clean up resources associated with // Techsupport instance before removing it from the apiserver. TechsupportFinalizer = "techsupportfinalizer.projectsveltos.io" )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "utils.projectsveltos.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 ¶
func Convert_v1alpha1_Log_To_v1beta1_Log ¶ added in v0.33.0
Convert_v1alpha1_Log_To_v1beta1_Log is an autogenerated conversion function.
func Convert_v1alpha1_Resource_To_v1beta1_Resource ¶ added in v0.33.0
func Convert_v1alpha1_Resource_To_v1beta1_Resource(in *Resource, out *v1beta1.Resource, s conversion.Scope) error
Convert_v1alpha1_Resource_To_v1beta1_Resource is an autogenerated conversion function.
func Convert_v1alpha1_SnapshotList_To_v1beta1_SnapshotList ¶ added in v0.33.0
func Convert_v1alpha1_SnapshotList_To_v1beta1_SnapshotList(in *SnapshotList, out *v1beta1.SnapshotList, s conversion.Scope) error
Convert_v1alpha1_SnapshotList_To_v1beta1_SnapshotList is an autogenerated conversion function.
func Convert_v1alpha1_SnapshotSpec_To_v1beta1_SnapshotSpec ¶ added in v0.33.0
func Convert_v1alpha1_SnapshotSpec_To_v1beta1_SnapshotSpec(in *SnapshotSpec, out *v1beta1.SnapshotSpec, s conversion.Scope) error
Convert_v1alpha1_SnapshotSpec_To_v1beta1_SnapshotSpec is an autogenerated conversion function.
func Convert_v1alpha1_SnapshotStatus_To_v1beta1_SnapshotStatus ¶ added in v0.33.0
func Convert_v1alpha1_SnapshotStatus_To_v1beta1_SnapshotStatus(in *SnapshotStatus, out *v1beta1.SnapshotStatus, s conversion.Scope) error
Convert_v1alpha1_SnapshotStatus_To_v1beta1_SnapshotStatus is an autogenerated conversion function.
func Convert_v1alpha1_Snapshot_To_v1beta1_Snapshot ¶ added in v0.33.0
func Convert_v1alpha1_Snapshot_To_v1beta1_Snapshot(in *Snapshot, out *v1beta1.Snapshot, s conversion.Scope) error
Convert_v1alpha1_Snapshot_To_v1beta1_Snapshot is an autogenerated conversion function.
func Convert_v1alpha1_TechsupportList_To_v1beta1_TechsupportList ¶ added in v0.33.0
func Convert_v1alpha1_TechsupportList_To_v1beta1_TechsupportList(in *TechsupportList, out *v1beta1.TechsupportList, s conversion.Scope) error
Convert_v1alpha1_TechsupportList_To_v1beta1_TechsupportList is an autogenerated conversion function.
func Convert_v1alpha1_TechsupportSpec_To_v1beta1_TechsupportSpec ¶ added in v0.33.0
func Convert_v1alpha1_TechsupportSpec_To_v1beta1_TechsupportSpec(srcSpec *TechsupportSpec, dstSpec *utilsv1beta1.TechsupportSpec, scope apimachineryconversion.Scope) error
func Convert_v1alpha1_TechsupportStatus_To_v1beta1_TechsupportStatus ¶ added in v0.33.0
func Convert_v1alpha1_TechsupportStatus_To_v1beta1_TechsupportStatus(in *TechsupportStatus, out *v1beta1.TechsupportStatus, s conversion.Scope) error
Convert_v1alpha1_TechsupportStatus_To_v1beta1_TechsupportStatus is an autogenerated conversion function.
func Convert_v1alpha1_Techsupport_To_v1beta1_Techsupport ¶ added in v0.33.0
func Convert_v1alpha1_Techsupport_To_v1beta1_Techsupport(in *Techsupport, out *v1beta1.Techsupport, s conversion.Scope) error
Convert_v1alpha1_Techsupport_To_v1beta1_Techsupport is an autogenerated conversion function.
func Convert_v1beta1_Log_To_v1alpha1_Log ¶ added in v0.33.0
Convert_v1beta1_Log_To_v1alpha1_Log is an autogenerated conversion function.
func Convert_v1beta1_Resource_To_v1alpha1_Resource ¶ added in v0.33.0
func Convert_v1beta1_Resource_To_v1alpha1_Resource(in *v1beta1.Resource, out *Resource, s conversion.Scope) error
Convert_v1beta1_Resource_To_v1alpha1_Resource is an autogenerated conversion function.
func Convert_v1beta1_SnapshotList_To_v1alpha1_SnapshotList ¶ added in v0.33.0
func Convert_v1beta1_SnapshotList_To_v1alpha1_SnapshotList(in *v1beta1.SnapshotList, out *SnapshotList, s conversion.Scope) error
Convert_v1beta1_SnapshotList_To_v1alpha1_SnapshotList is an autogenerated conversion function.
func Convert_v1beta1_SnapshotSpec_To_v1alpha1_SnapshotSpec ¶ added in v0.33.0
func Convert_v1beta1_SnapshotSpec_To_v1alpha1_SnapshotSpec(in *v1beta1.SnapshotSpec, out *SnapshotSpec, s conversion.Scope) error
Convert_v1beta1_SnapshotSpec_To_v1alpha1_SnapshotSpec is an autogenerated conversion function.
func Convert_v1beta1_SnapshotStatus_To_v1alpha1_SnapshotStatus ¶ added in v0.33.0
func Convert_v1beta1_SnapshotStatus_To_v1alpha1_SnapshotStatus(in *v1beta1.SnapshotStatus, out *SnapshotStatus, s conversion.Scope) error
Convert_v1beta1_SnapshotStatus_To_v1alpha1_SnapshotStatus is an autogenerated conversion function.
func Convert_v1beta1_Snapshot_To_v1alpha1_Snapshot ¶ added in v0.33.0
func Convert_v1beta1_Snapshot_To_v1alpha1_Snapshot(in *v1beta1.Snapshot, out *Snapshot, s conversion.Scope) error
Convert_v1beta1_Snapshot_To_v1alpha1_Snapshot is an autogenerated conversion function.
func Convert_v1beta1_TechsupportList_To_v1alpha1_TechsupportList ¶ added in v0.33.0
func Convert_v1beta1_TechsupportList_To_v1alpha1_TechsupportList(in *v1beta1.TechsupportList, out *TechsupportList, s conversion.Scope) error
Convert_v1beta1_TechsupportList_To_v1alpha1_TechsupportList is an autogenerated conversion function.
func Convert_v1beta1_TechsupportSpec_To_v1alpha1_TechsupportSpec ¶ added in v0.33.0
func Convert_v1beta1_TechsupportSpec_To_v1alpha1_TechsupportSpec(srcSpec *utilsv1beta1.TechsupportSpec, dstSpec *TechsupportSpec, scope apimachineryconversion.Scope) error
func Convert_v1beta1_TechsupportStatus_To_v1alpha1_TechsupportStatus ¶ added in v0.33.0
func Convert_v1beta1_TechsupportStatus_To_v1alpha1_TechsupportStatus(in *v1beta1.TechsupportStatus, out *TechsupportStatus, s conversion.Scope) error
Convert_v1beta1_TechsupportStatus_To_v1alpha1_TechsupportStatus is an autogenerated conversion function.
func Convert_v1beta1_Techsupport_To_v1alpha1_Techsupport ¶ added in v0.33.0
func Convert_v1beta1_Techsupport_To_v1alpha1_Techsupport(in *v1beta1.Techsupport, out *Techsupport, s conversion.Scope) error
Convert_v1beta1_Techsupport_To_v1alpha1_Techsupport is an autogenerated conversion function.
func RegisterConversions ¶ added in v0.33.0
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
Types ¶
type CollectionStatus ¶ added in v0.6.0
type CollectionStatus string
+kubebuilder:validation:Enum:=Collected;InProgress;Failed
type Log ¶ added in v0.6.0
type Log struct {
// Namespace of the pods deployed in the Cluster.
// +optional
Namespace string `json:"namespace,omitempty"`
// LabelFilters allows to filter pods based on current labels.
LabelFilters []libsveltosv1alpha1.LabelFilter `json:"labelFilters,omitempty"`
// A relative time in seconds before the current time from which to collect logs.
// If this value precedes the time a pod was started, only logs since the pod start will be returned.
// If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
// +optional
SinceSeconds *int64 `json:"sinceSeconds,omitempty"`
}
LogFilter allows to select which logs to collect
func (*Log) DeepCopy ¶ added in v0.6.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Log.
func (*Log) DeepCopyInto ¶ added in v0.6.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Resource ¶ added in v0.6.0
type Resource struct {
// Namespace of the resource deployed in the Cluster.
// Empty for resources scoped at cluster level.
// +optional
Namespace string `json:"namespace,omitempty"`
// Group of the resource deployed in the Cluster.
Group string `json:"group"`
// Version of the resource deployed in the Cluster.
Version string `json:"version"`
// Kind of the resource deployed in the Cluster.
// +kubebuilder:validation:MinLength=1
Kind string `json:"kind"`
// LabelFilters allows to filter resources based on current labels.
LabelFilters []libsveltosv1alpha1.LabelFilter `json:"labelFilters,omitempty"`
}
Resource indicates the type of resources to collect.
func (*Resource) DeepCopy ¶ added in v0.6.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.
func (*Resource) DeepCopyInto ¶ added in v0.6.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Snapshot ¶
type Snapshot struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec SnapshotSpec `json:"spec,omitempty"`
Status SnapshotStatus `json:"status,omitempty"`
}
Snapshot is the Schema for the snapshot API
func (*Snapshot) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Snapshot.
func (*Snapshot) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Snapshot) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SnapshotList ¶
type SnapshotList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Snapshot `json:"items"`
}
SnapshotList contains a list of Snapshot
func (*SnapshotList) DeepCopy ¶
func (in *SnapshotList) DeepCopy() *SnapshotList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapshotList.
func (*SnapshotList) DeepCopyInto ¶
func (in *SnapshotList) DeepCopyInto(out *SnapshotList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SnapshotList) DeepCopyObject ¶
func (in *SnapshotList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SnapshotSpec ¶
type SnapshotSpec struct {
// Schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
Schedule string `json:"schedule"`
// Optional deadline in seconds for starting the job if it misses scheduled
// time for any reason. Missed jobs executions will be counted as failed ones.
// +optional
StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`
// Storage represents directory where snapshots will be stored.
// It must be an existing directory.
// Snapshots will be stored in this directory in a subdirectory named
// with Snapshot instance name.
Storage string `json:"storage"`
// The number of successful finished snapshots to retains.
// If specified, only SuccessfulSnapshotLimit will be retained. Once such
// number is reached, for any new successful snapshots, the oldest one is
// deleted.
// +optional
SuccessfulSnapshotLimit *int32 `json:"successfulSnapshotLimit,omitempty"`
}
SnapshotSpec defines the desired state of Snapshot
func (*SnapshotSpec) DeepCopy ¶
func (in *SnapshotSpec) DeepCopy() *SnapshotSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapshotSpec.
func (*SnapshotSpec) DeepCopyInto ¶
func (in *SnapshotSpec) DeepCopyInto(out *SnapshotSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SnapshotStatus ¶
type SnapshotStatus struct {
// Information when next snapshot is scheduled
// +optional
NextScheduleTime *metav1.Time `json:"nextScheduleTime,omitempty"`
// Information when was the last time a snapshot was successfully scheduled.
// +optional
LastRunTime *metav1.Time `json:"lastRunTime,omitempty"`
// Status indicates what happened to last snapshot collection.
LastRunStatus *CollectionStatus `json:"lastRunStatus,omitempty"`
// FailureMessage provides more information about the error, if
// any occurred
FailureMessage *string `json:"failureMessage,omitempty"`
}
SnapshotStatus defines the observed state of Snapshot
func (*SnapshotStatus) DeepCopy ¶
func (in *SnapshotStatus) DeepCopy() *SnapshotStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapshotStatus.
func (*SnapshotStatus) DeepCopyInto ¶
func (in *SnapshotStatus) DeepCopyInto(out *SnapshotStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Techsupport ¶ added in v0.6.0
type Techsupport struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TechsupportSpec `json:"spec,omitempty"`
Status TechsupportStatus `json:"status,omitempty"`
}
Techsupport is the Schema for the snapshot API
func (*Techsupport) ConvertFrom ¶ added in v0.33.0
func (dst *Techsupport) ConvertFrom(srcRaw conversion.Hub) error
ConvertFrom converts from the Hub version (v1beta1) to this v1alpha1.
func (*Techsupport) ConvertTo ¶ added in v0.33.0
func (src *Techsupport) ConvertTo(dstRaw conversion.Hub) error
ConvertTo converts v1alpha1 to the Hub version (v1beta1).
func (*Techsupport) DeepCopy ¶ added in v0.6.0
func (in *Techsupport) DeepCopy() *Techsupport
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Techsupport.
func (*Techsupport) DeepCopyInto ¶ added in v0.6.0
func (in *Techsupport) DeepCopyInto(out *Techsupport)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Techsupport) DeepCopyObject ¶ added in v0.6.0
func (in *Techsupport) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TechsupportList ¶ added in v0.6.0
type TechsupportList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Techsupport `json:"items"`
}
TechsupportList contains a list of Techsupport instances
func (*TechsupportList) DeepCopy ¶ added in v0.6.0
func (in *TechsupportList) DeepCopy() *TechsupportList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TechsupportList.
func (*TechsupportList) DeepCopyInto ¶ added in v0.6.0
func (in *TechsupportList) DeepCopyInto(out *TechsupportList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TechsupportList) DeepCopyObject ¶ added in v0.6.0
func (in *TechsupportList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TechsupportSpec ¶ added in v0.6.0
type TechsupportSpec struct {
// ClusterSelector identifies clusters to collect techsupport from.
ClusterSelector libsveltosv1alpha1.Selector `json:"clusterSelector"`
// Resources indicates what resorces to collect
// +optional
Resources []Resource `json:"resources,omitempty"`
// Logs indicates what pods' log to collect
// +optional
Logs []Log `json:"logs,omitempty"`
// If set denerates a tar file with all collected logs/resources
// +kubebuilder:default:=false
// +optional
Tar bool `json:"tar,omitempty"`
// Schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
Schedule string `json:"schedule"`
// Optional deadline in seconds for starting the job if it misses scheduled
// time for any reason. Missed jobs executions will be counted as failed ones.
// +optional
StartingDeadlineSeconds *int64 `json:"startingDeadlineSeconds,omitempty"`
// Storage represents directory where techsupports will be stored.
// It must be an existing directory.
// Techsupports will be stored in this directory in a subdirectory named
// with Techsupport instance name.
Storage string `json:"storage"`
// The number of successful finished techsupport to retains.
// If specified, only SuccessfulTechsupportLimit will be retained. Once such
// number is reached, for any new successful snapshots, the oldest one is
// deleted.
// +optional
SuccessfulTechsupportLimit *int32 `json:"successfulTechsupportLimit,omitempty"`
}
TechsupportSpec defines the desired state of Techsupport
func (*TechsupportSpec) DeepCopy ¶ added in v0.6.0
func (in *TechsupportSpec) DeepCopy() *TechsupportSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TechsupportSpec.
func (*TechsupportSpec) DeepCopyInto ¶ added in v0.6.0
func (in *TechsupportSpec) DeepCopyInto(out *TechsupportSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TechsupportStatus ¶ added in v0.6.0
type TechsupportStatus struct {
// Information when next snapshot is scheduled
// +optional
NextScheduleTime *metav1.Time `json:"nextScheduleTime,omitempty"`
// Information when was the last time a snapshot was successfully scheduled.
// +optional
LastRunTime *metav1.Time `json:"lastRunTime,omitempty"`
// Status indicates what happened to last techsupport collection.
LastRunStatus *CollectionStatus `json:"lastRunStatus,omitempty"`
// FailureMessage provides more information about the error, if
// any occurred
FailureMessage *string `json:"failureMessage,omitempty"`
// MatchingClusterRefs reference all the clusters currently matching
// Techsupport
MatchingClusterRefs []corev1.ObjectReference `json:"machingClusters,omitempty"`
}
TechsupportStatus defines the observed state of Techsupport
func (*TechsupportStatus) DeepCopy ¶ added in v0.6.0
func (in *TechsupportStatus) DeepCopy() *TechsupportStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TechsupportStatus.
func (*TechsupportStatus) DeepCopyInto ¶ added in v0.6.0
func (in *TechsupportStatus) DeepCopyInto(out *TechsupportStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.