API Reference
v1 Reference for cluster.kubernetes-fleet.io KubeFleet APIs
cluster.kubernetes-fleet.io/v1
Resource Types
AgentStatus
AgentStatus defines the observed status of the member agent of the given type.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type AgentType | Type of the member agent. | ||
conditions Condition array | Conditions is an array of current observed conditions for the member agent. | ||
lastReceivedHeartbeat Time | Last time we received a heartbeat from the member agent. |
AgentType
Underlying type: string
AgentType defines a type of agent/binary running in a member cluster.
Appears in:
| Field | Description |
|---|---|
MemberAgent | MemberAgent (core) handles member cluster joining/leaving as well as k8s object placement from hub to member clusters. |
MultiClusterServiceAgent | MultiClusterServiceAgent (networking) is responsible for exposing multi-cluster services via L4 load balancer. |
ServiceExportImportAgent | ServiceExportImportAgent (networking) is responsible for export or import services across multi-clusters. |
ClusterState
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Join | |
Leave |
InternalMemberCluster
InternalMemberCluster is used by hub agent to notify the member agents about the member cluster state changes, and is used by the member agents to report their status.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | cluster.kubernetes-fleet.io/v1 | ||
kind string | InternalMemberCluster | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec InternalMemberClusterSpec | The desired state of InternalMemberCluster. | ||
status InternalMemberClusterStatus | The observed status of InternalMemberCluster. |
InternalMemberClusterList
InternalMemberClusterList contains a list of InternalMemberCluster.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | cluster.kubernetes-fleet.io/v1 | ||
kind string | InternalMemberClusterList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items InternalMemberCluster array |
InternalMemberClusterSpec
InternalMemberClusterSpec defines the desired state of InternalMemberCluster. Set by the hub agent.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
state ClusterState | The desired state of the member cluster. Possible values: Join, Leave. | ||
heartbeatPeriodSeconds integer | How often (in seconds) for the member cluster to send a heartbeat to the hub cluster. Default: 60 seconds. Min: 1 second. Max: 10 minutes. | 60 | Maximum: 600 Minimum: 1 |
InternalMemberClusterStatus
InternalMemberClusterStatus defines the observed state of InternalMemberCluster.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Conditions is an array of current observed conditions for the member cluster. | ||
properties object (keys:PropertyName, values:PropertyValue) | Properties is an array of properties observed for the member cluster. This field is beta-level; it is for the property-based scheduling feature and is only populated when a property provider is enabled in the deployment. | ||
resourceUsage ResourceUsage | The current observed resource usage of the member cluster. It is populated by the member agent. | ||
agentStatus AgentStatus array | AgentStatus is an array of current observed status, each corresponding to one member agent running in the member cluster. |
MemberCluster
MemberCluster is a resource created in the hub cluster to represent a member cluster within a fleet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | cluster.kubernetes-fleet.io/v1 | ||
kind string | MemberCluster | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec MemberClusterSpec | The desired state of MemberCluster. | ||
status MemberClusterStatus | The observed status of MemberCluster. |
MemberClusterList
MemberClusterList contains a list of MemberCluster.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | cluster.kubernetes-fleet.io/v1 | ||
kind string | MemberClusterList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items MemberCluster array |
MemberClusterSpec
MemberClusterSpec defines the desired state of MemberCluster.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
identity Subject | The identity used by the member cluster to access the hub cluster. The hub agents deployed on the hub cluster will automatically grant the minimal required permissions to this identity for the member agents deployed on the member cluster to access the hub cluster. | ||
heartbeatPeriodSeconds integer | How often (in seconds) for the member cluster to send a heartbeat to the hub cluster. Default: 60 seconds. Min: 1 second. Max: 10 minutes. | 60 | Maximum: 600 Minimum: 1 |
taints Taint array | If specified, the MemberCluster’s taints. This field is beta-level and is for the taints and tolerations feature. | MaxItems: 100 |
MemberClusterStatus
MemberClusterStatus defines the observed status of MemberCluster.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Conditions is an array of current observed conditions for the member cluster. | ||
properties object (keys:PropertyName, values:PropertyValue) | Properties is an array of properties observed for the member cluster. This field is beta-level; it is for the property-based scheduling feature and is only populated when a property provider is enabled in the deployment. | ||
resourceUsage ResourceUsage | The current observed resource usage of the member cluster. It is copied from the corresponding InternalMemberCluster object. | ||
agentStatus AgentStatus array | AgentStatus is an array of current observed status, each corresponding to one member agent running in the member cluster. |
PropertyName
Underlying type: string
PropertyName is the name of a cluster property; it should be a Kubernetes label name.
Appears in:
PropertyValue
PropertyValue is the value of a cluster property.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
value string | Value is the value of the cluster property. Currently, it should be a valid Kubernetes quantity. For more information, see https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity. | ||
observationTime Time | ObservationTime is when the cluster property is observed. |
ResourceUsage
ResourceUsage contains the observed resource usage of a member cluster.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
capacity ResourceList | Capacity represents the total resource capacity of all the nodes on a member cluster. A node’s total capacity is the amount of resource installed on the node. | ||
allocatable ResourceList | Allocatable represents the total allocatable resources of all the nodes on a member cluster. A node’s allocatable capacity is the amount of resource that can actually be used for user workloads, i.e., allocatable capacity = total capacity - capacities reserved for the OS, kubelet, etc. For more information, see https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/. | ||
available ResourceList | Available represents the total available resources of all the nodes on a member cluster. A node’s available capacity is the amount of resource that has not been used yet, i.e., available capacity = allocatable capacity - capacity that has been requested by workloads. This field is beta-level; it is for the property-based scheduling feature and is only populated when a property provider is enabled in the deployment. | ||
observationTime Time | When the resource usage is observed. |
Taint
Taint attached to MemberCluster has the “effect” on any ClusterResourcePlacement that does not tolerate the Taint.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
key string | The taint key to be applied to a MemberCluster. | ||
value string | The taint value corresponding to the taint key. | ||
effect TaintEffect | The effect of the taint on ClusterResourcePlacements that do not tolerate the taint. Only NoSchedule is supported. | Enum: [NoSchedule] |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can further improve.
Sorry to hear that. Please tell us how we can fix the experience for you.