Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the clustermanager v1alpha1 API group +kubebuilder:object:generate=true +groupName=clustermanager.onprem.openshift.io
Index ¶
- Variables
- type ClusterAgentInfo
- type ConditionStatus
- type JoinedCluster
- func (in *JoinedCluster) DeepCopy() *JoinedCluster
- func (in *JoinedCluster) DeepCopyInto(out *JoinedCluster)
- func (in *JoinedCluster) DeepCopyObject() runtime.Object
- func (j *JoinedCluster) IsCondition(condition JoinedClusterConditionType) *JoinedClusterConditions
- func (j *JoinedCluster) SetCondition(condition JoinedClusterConditionType) error
- type JoinedClusterConditionType
- type JoinedClusterConditions
- type JoinedClusterList
- type JoinedClusterSpec
- type JoinedClusterStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "clustermanager.onprem.openshift.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 ¶
This section is empty.
Types ¶
type ClusterAgentInfo ¶
type ClusterAgentInfo struct {
// Version of the cluster agent running in the spoke cluster.
Version string `json:"version"`
// Image of the cluster agent running in the spoke cluster.
Image string `json:"image"`
// Last update time written by cluster agent.
LastUpdateTime metav1.Time `json:"lastUpdateTime"`
// ClusterName provides the cluster name of the spoke cluster
ClusterName string `json:"clusterName"`
// ClusterVersion provides the version of openshift distribution running in the spoke cluster.
ClusterVersion string `json:"clusterVersion"`
// NodeCount provides the number of nodes present in the spoke cluster.
NodeCount int `json:"nodeCount"`
}
ClusterAgentInfo describes the metadata reported by the cluster agent in the spoke cluster.
func (*ClusterAgentInfo) DeepCopy ¶
func (in *ClusterAgentInfo) DeepCopy() *ClusterAgentInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterAgentInfo.
func (*ClusterAgentInfo) DeepCopyInto ¶
func (in *ClusterAgentInfo) DeepCopyInto(out *ClusterAgentInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionStatus ¶
type ConditionStatus string
ConditionStatus describes the status of the condition as described by the constants below +kubebuilder:validation:Enum=True;False;Unknown
const ( ConditionTrue ConditionStatus = "True" ConditionFalse ConditionStatus = "False" ConditionUnknown ConditionStatus = "Unknown" )
These are valid condition statuses. "ConditionTrue" means a resource is in the condition. "ConditionFalse" means a resource is not in the condition. "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.
type JoinedCluster ¶
type JoinedCluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec JoinedClusterSpec `json:"spec,omitempty"`
Status JoinedClusterStatus `json:"status,omitempty"`
}
JoinedCluster is the Schema for the joinedclusters API
func (*JoinedCluster) DeepCopy ¶
func (in *JoinedCluster) DeepCopy() *JoinedCluster
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JoinedCluster.
func (*JoinedCluster) DeepCopyInto ¶
func (in *JoinedCluster) DeepCopyInto(out *JoinedCluster)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*JoinedCluster) DeepCopyObject ¶
func (in *JoinedCluster) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*JoinedCluster) IsCondition ¶
func (j *JoinedCluster) IsCondition(condition JoinedClusterConditionType) *JoinedClusterConditions
func (*JoinedCluster) SetCondition ¶
func (j *JoinedCluster) SetCondition(condition JoinedClusterConditionType) error
type JoinedClusterConditionType ¶
type JoinedClusterConditionType string
JoinedClusterConditionType describes the possible type of conditions that can occur for this resource +kubebuilder:validation:Enum=ReadyToJoin;AgentConnected;AgentStale;AgentDisconnected
const ( ConditionTypeReadyToJoin JoinedClusterConditionType = "ReadyToJoin" ConditionTypeAgentConnected JoinedClusterConditionType = "AgentConnected" ConditionTypeAgentStale JoinedClusterConditionType = "AgentStale" ConditionTypeAgentDisconnected JoinedClusterConditionType = "AgentDisconnected" )
type JoinedClusterConditions ¶
type JoinedClusterConditions struct {
// Type defines the type of JoinedClusterCondition being populated by the controller
Type JoinedClusterConditionType `json:"type"`
// Status is the status of the condition.
// Can be True, False, Unknown.
Status ConditionStatus `json:"status"`
// Last transition time when this condition got set
// +optional
LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
// Unique, one-word, CamelCase reason for the condition's last transition.
// +optional
Reason *string `json:"reason,omitempty"`
// Human readable message indicating details about last transition
// +optional
Message *string `json:"message,omitempty"`
}
func (*JoinedClusterConditions) DeepCopy ¶
func (in *JoinedClusterConditions) DeepCopy() *JoinedClusterConditions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JoinedClusterConditions.
func (*JoinedClusterConditions) DeepCopyInto ¶
func (in *JoinedClusterConditions) DeepCopyInto(out *JoinedClusterConditions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JoinedClusterList ¶
type JoinedClusterList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []JoinedCluster `json:"items"`
}
JoinedClusterList contains a list of JoinedCluster
func (*JoinedClusterList) DeepCopy ¶
func (in *JoinedClusterList) DeepCopy() *JoinedClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JoinedClusterList.
func (*JoinedClusterList) DeepCopyInto ¶
func (in *JoinedClusterList) DeepCopyInto(out *JoinedClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*JoinedClusterList) DeepCopyObject ¶
func (in *JoinedClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type JoinedClusterSpec ¶
type JoinedClusterSpec struct {
// Optional service account name to allow spoke cluster to communicate with the hub when joining
// If the service account by this name doesn't exist, it will be created in the hub cluster
// If not specified, a service account will be generated for the spoke cluster to use.
// +optional
ServiceAccount *string `json:"serviceAccount,omitempty"`
// Optional stale duration used to configure the time to wait before
// determining that the spoke cluster connection has gone stale by not
// heartbeating back to the hub.
// +optional
StaleDuration *metav1.Duration `json:"staleDuration,omitempty"`
// Optional disconnect duration used to configure the time to wait before
// determining that the spoke cluster has disconnected by not heartbeating
// back to the hub after the connection became stale.
// +optional
DisconnectDuration *metav1.Duration `json:"disconnectDuration,omitempty"`
}
JoinedClusterSpec defines the desired state of JoinedCluster
func (*JoinedClusterSpec) DeepCopy ¶
func (in *JoinedClusterSpec) DeepCopy() *JoinedClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JoinedClusterSpec.
func (*JoinedClusterSpec) DeepCopyInto ¶
func (in *JoinedClusterSpec) DeepCopyInto(out *JoinedClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JoinedClusterStatus ¶
type JoinedClusterStatus struct {
//Conditions
Conditions []JoinedClusterConditions `json:"conditions"`
// JoinCommand
// +optional
JoinCommand *string `json:"joinCommand,omitempty"`
// ServiceAccount name chosen by the hub for the spoke to use
// +optional
ServiceAccountName *string `json:"serviceAccountName,omitempty"`
// When the cluster agent starts running and heartbeating, it will report
// metadata information in this field.
// +optional
ClusterAgentInfo *ClusterAgentInfo `json:"clusterAgentInfo,omitempty"`
}
JoinedClusterStatus defines the observed state of JoinedCluster
func (*JoinedClusterStatus) DeepCopy ¶
func (in *JoinedClusterStatus) DeepCopy() *JoinedClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JoinedClusterStatus.
func (*JoinedClusterStatus) DeepCopyInto ¶
func (in *JoinedClusterStatus) DeepCopyInto(out *JoinedClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.