v1beta2

Documentation

Overview

Package v1beta2 contains API Schema definitions for the preflight v1beta2 API group +kubebuilder:object:generate=true +groupName=troubleshoot.sh

Index

• Variables
• type ClusterAccessAnalyze
• type ClusterRegion
• type ClusterRegionAnalyze
• type ExtendAnalyze
• type ExtendCollect
• type ExtendHostAnalyze
• type ExtendHostCollect
• type HostPreflight
• type HostPreflightList
• type HostPreflightSpec
• type HostPreflightStatus
• type HostUtility
• type HostUtilityAnalyze
• type KBStorageClassAnalyze
• type KBTaintAnalyze
• type Preflight
• type PreflightList
• type PreflightSpec
• type PreflightStatus

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "troubleshoot.sh", Version: "v1beta2"}

	// 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
)

Types

type ClusterAccessAnalyze

type ClusterAccessAnalyze struct {
	// AnalyzeMeta is defined in troubleshoot.sh
	troubleshoot.AnalyzeMeta `json:",inline"`
	// Outcomes are expected user defined results.
	// +kubebuilder:validation:Required
	Outcomes []*troubleshoot.Outcome `json:"outcomes"`
}

ClusterAccessAnalyze analyzes the accessibility of target

type ClusterRegion

type ClusterRegion struct {
	// HostCollectorMeta is defined in troubleshoot.sh
	troubleshoot.HostCollectorMeta `json:",inline"`
	// ProviderName denotes the cloud provider target k8s located on
	// +kubebuilder:validation:Required
	ProviderName string `json:"providerName"`
}

type ClusterRegionAnalyze

type ClusterRegionAnalyze struct {
	// AnalyzeMeta is defined in troubleshoot.sh
	troubleshoot.AnalyzeMeta `json:",inline"`
	// Outcomes are expected user defined results.
	// +kubebuilder:validation:Required
	Outcomes []*troubleshoot.Outcome `json:"outcomes"`
	// RegionNames is a set of expected region names
	// +kubebuilder:validation:Required
	RegionNames []string `json:"regionNames"`
}

type ExtendAnalyze

type ExtendAnalyze struct {
	// ClusterAccess is to determine the accessibility of target k8s cluster
	// +optional
	ClusterAccess *ClusterAccessAnalyze `json:"clusterAccess,omitempty"`
	// StorageClass is to determine the correctness of target storage class
	// +optional
	StorageClass *KBStorageClassAnalyze `json:"storageClass,omitempty"`
	// Taint is to Determine the matching between the taint and toleration
	// +optional
	Taint *KBTaintAnalyze `json:"taint,omitempty"`
}

type ExtendCollect

type ExtendCollect struct {
}

ExtendCollect defines extended data collector for k8s cluster

type ExtendHostAnalyze

type ExtendHostAnalyze struct {
	// HostUtility is to analyze the presence of target utility
	// +optional
	HostUtility *HostUtilityAnalyze `json:"hostUtility,omitempty"`
	// ClusterRegion is to validate the regionName of target k8s cluster
	// +optional
	ClusterRegion *ClusterRegionAnalyze `json:"clusterRegion,omitempty"`
}

type ExtendHostCollect

type ExtendHostCollect struct {
	// HostUtility is to collect the data of target utility.
	// +optional
	HostUtility *HostUtility `json:"hostUtility,omitempty"`
	// ClusterRegion is region of target k8s
	// +optional
	ClusterRegion *ClusterRegion `json:"clusterRegion,omitempty"`
}

type HostPreflight

type HostPreflight struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   HostPreflightSpec   `json:"spec,omitempty"`
	Status HostPreflightStatus `json:"status,omitempty"`
}

HostPreflight is the Schema for the hostpreflights API

type HostPreflightList

type HostPreflightList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []HostPreflight `json:"items"`
}

HostPreflightList contains a list of HostPreflight

type HostPreflightSpec

type HostPreflightSpec struct {
	// hostPreflightSpec is defined by troubleshoot.sh and inherited by ApeCloud.
	troubleshoot.HostPreflightSpec `json:",inline"`
	// extendCollectors extends user defined hostCollectors by ApeCloud.
	// +optional
	ExtendCollectors []*ExtendHostCollect `json:"extendCollectors,omitempty"`
	// extendAnalyzers extends user defined hostAnalyzers by ApeCloud.
	// +optional
	ExtendAnalyzers []*ExtendHostAnalyze `json:"extendAnalyzers,omitempty"`
}

HostPreflightSpec defines the desired state of HostPreflight

type HostPreflightStatus

type HostPreflightStatus struct {
	// hostPreflightStatus is defined by troubleshoot.sh and inherited by ApeCloud.
	troubleshoot.HostPreflightStatus `json:",inline"`
}

HostPreflightStatus defines the observed state of HostPreflight

type HostUtility

type HostUtility struct {
	// HostCollectorMeta is defined in troubleshoot.sh
	troubleshoot.HostCollectorMeta `json:",inline"`
	// UtilityName indicates the utility which will be checked in local host
	// +kubebuilder:validation:Required
	UtilityName string `json:"utilityName"`
}

type HostUtilityAnalyze

type HostUtilityAnalyze struct {
	// HostCollectorMeta is defined in troubleshoot.sh
	troubleshoot.AnalyzeMeta `json:",inline"`
	// CollectorName indicates the collected data to be analyzed
	// +optional
	CollectorName string `json:"collectorName,omitempty"`
	// Outcomes are expected user defined results
	// +kubebuilder:validation:Required
	Outcomes []*troubleshoot.Outcome `json:"outcomes"`
}

type KBStorageClassAnalyze

type KBStorageClassAnalyze struct {
	// AnalyzeMeta is defined in troubleshoot.sh
	troubleshoot.AnalyzeMeta `json:",inline"`
	// Outcomes are expected user defined results.
	// +kubebuilder:validation:Required
	Outcomes []*troubleshoot.Outcome `json:"outcomes"`
	// StorageClassType is StorageClass type
	// +kubebuilder:validation:Required
	StorageClassType string `json:"storageClassType"`
	// Provisioner is the provisioner of StorageClass
	// +optional
	Provisioner string `json:"provisioner,omitempty"`
}

KBStorageClassAnalyze replaces default storageClassAnalyze in preflight

type KBTaintAnalyze

type KBTaintAnalyze struct {
	// AnalyzeMeta is defined in troubleshoot.sh
	troubleshoot.AnalyzeMeta `json:",inline"`
	// Outcomes are expected user defined results.
	// +kubebuilder:validation:Required
	Outcomes []*troubleshoot.Outcome `json:"outcomes"`
	// Tolerations are toleration configuration passed by kbcli
	// +optional
	TolerationsMap map[string][]v1.Toleration `json:"tolerations"`
}

KBTaintAnalyze matches the analysis of taints with TolerationsMap

type Preflight

type Preflight struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PreflightSpec   `json:"spec,omitempty"`
	Status PreflightStatus `json:"status,omitempty"`
}

Preflight is the Schema for the preflights API

type PreflightList

type PreflightList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Preflight `json:"items"`
}

PreflightList contains a list of Preflight

type PreflightSpec

type PreflightSpec struct {
	// preflightSpec is defined by troubleshoot.sh and inherited by ApeCloud.
	troubleshoot.PreflightSpec `json:",inline"`
	// extendCollectors extends user defined collectors by ApeCloud.
	// +optional
	ExtendCollectors []*ExtendCollect `json:"extendCollectors,omitempty"`
	// extendAnalyzers extends user defined analyzers by ApeCloud.
	// +optional
	ExtendAnalyzers []*ExtendAnalyze `json:"extendAnalyzers,omitempty"`
}

PreflightSpec defines the desired state of Preflight

type PreflightStatus

type PreflightStatus struct {
	// preflightStatus is defined by troubleshoot.sh and inherited by ApeCloud.
	troubleshoot.PreflightStatus `json:",inline"`
}

PreflightStatus defines the observed state of Preflight