Cluster API reference

Detailed documentation on the clusters API

Packages:

cluster.kurator.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group

Resource Types:

AttachedCluster

AttachedCluster is the schema for the external cluster that are not created by kurator.

Field Description
apiVersion
string		 cluster.kurator.dev/v1alpha1
kind
string 		AttachedCluster
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AttachedClusterSpec
kubeconfig
SecretKeyRef 		(Optional)

Kubeconfig represents the secret that contains the credential to access this cluster.
status
AttachedClusterStatus

Cluster

Cluster is the schema for the cluster’s API

Field Description
apiVersion
string		 cluster.kurator.dev/v1alpha1
kind
string 		Cluster
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ClusterSpec
infraType
ClusterInfraType

InfraType is the infra type of the cluster.
credential
CredentialConfig 		(Optional)

Credential is the credential used to access the cloud provider.
version
string

Version is the Kubernetes version to use for the cluster.
region
string

Region is the region to deploy the cluster.
network
NetworkConfig

Network is the network configuration for the cluster.
master
MasterConfig

Master is the configuration for the master node.
workers
[]WorkerConfig

Workers is the list of worker nodes.
podIdentity
PodIdentityConfig 		(Optional)

PodIdentity is the configuration for the pod identity.
additionalResources
[]ResourceRef 		(Optional)

AdditionalResources provides a way to automatically apply a set of resources to cluster after it’s ready. Note: the resources will only apply once.
status
ClusterStatus

AttachedClusterSpec

(Appears on: AttachedCluster)

Field Description
kubeconfig
SecretKeyRef 		(Optional)

Kubeconfig represents the secret that contains the credential to access this cluster.

AttachedClusterStatus

(Appears on: AttachedCluster)

Field Description
ready
bool 		(Optional)

Ready indicates whether the cluster is ready to be registered with Kurator Fleet.

CIDRBlocks ([]string alias)

(Appears on: NetworkConfig)

CNIConfig

(Appears on: NetworkConfig)

Field Description
type
string

Type is the type of CNI.
extraArgs
Kubernetes /apiextensions/v1.JSON 		(Optional)

ExtraArgs is the set of extra arguments for CNI.

ClusterInfraType (string alias)

(Appears on: ClusterSpec)

ClusterPhase (string alias)

ClusterPhase is a string representation of the cluster’s phase.

ClusterSpec

(Appears on: Cluster)

ClusterSpec defines the desired state of the Cluster

Field Description
infraType
ClusterInfraType

InfraType is the infra type of the cluster.
credential
CredentialConfig 		(Optional)

Credential is the credential used to access the cloud provider.
version
string

Version is the Kubernetes version to use for the cluster.
region
string

Region is the region to deploy the cluster.
network
NetworkConfig

Network is the network configuration for the cluster.
master
MasterConfig

Master is the configuration for the master node.
workers
[]WorkerConfig

Workers is the list of worker nodes.
podIdentity
PodIdentityConfig 		(Optional)

PodIdentity is the configuration for the pod identity.
additionalResources
[]ResourceRef 		(Optional)

AdditionalResources provides a way to automatically apply a set of resources to cluster after it’s ready. Note: the resources will only apply once.

ClusterStatus

(Appears on: Cluster)

ClusterStatus defines the observed state of Cluster

Field Description
conditions
Cluster API /v1beta1.Conditions 		(Optional)

Conditions defines current service state of the cluster.
phase
string 		(Optional)

Phase is the current lifecycle phase of the cluster.
apiEndpoint
string 		(Optional)

APIEndpoint is the endpoint to communicate with the apiserver. Format should be: https://host:port
kubeconfigSecretRef
string 		(Optional)

KubeconfigSecretRef represents the secret that contains the credential to access this cluster.
serviceAccountIssuer
string 		(Optional)

ServiceAccountIssuer is the URL of the service account issuer.

CredentialConfig

(Appears on: ClusterSpec)

Field Description
secretRef
string

MachineConfig

(Appears on: NodeConfig)

MachineConfig defines the configuration for the machine.

Field Description
replicas
int

Replicas is the number of replicas of the machine.
instanceType
string

InstanceType is the type of instance to use for the instance.
sshKeyName
string 		(Optional)

SSHKeyName is the name of the SSH key to use for the instance.
imageOS
string 		(Optional)

ImageOS is the OS of the image to use for the instance. Defaults to “ubuntu-20.04”.
rootVolumeSize
Volume 		(Optional)

RootVolume is the root volume to attach to the instance.
nonRootVolumes
[]Volume 		(Optional)

NonRootVolumes is the list of non-root volumes to attach to the instance.
extraArgs
Kubernetes /apiextensions/v1.JSON 		(Optional)

ExtraArgs is the set of extra arguments to create Machine on different infra.

MasterConfig

(Appears on: ClusterSpec)

Field Description
NodeConfig
NodeConfig

(Members of NodeConfig are embedded into this type.)

NetworkConfig

(Appears on: ClusterSpec)

Field Description
vpc
VPCConfig

VPC is the configuration for the VPC.
podCIDRs
CIDRBlocks 		(Optional)

PodCIDRs is the CIDR block for pods in this cluster. Defaults to 192.168.0.0/16.
serviceCIDRs
CIDRBlocks 		(Optional)

ServiceCIDRs is the CIDR block for services in this cluster. Defaults to 10.96.0.0/12.
cni
CNIConfig

CNI is the configuration for the CNI.

NodeConfig

(Appears on: MasterConfig, WorkerConfig)

NodeConfig defines the configuration for the node.

Field Description
MachineConfig
MachineConfig

(Members of MachineConfig are embedded into this type.)

NodeRegistrationConfig
NodeRegistrationConfig

(Members of NodeRegistrationConfig are embedded into this type.)

NodeRegistrationConfig

(Appears on: NodeConfig)

NodeRegistrationConfig defines the configuration for the node registration.

Field Description
labels
map[string]string

Labels is the set of labels to apply to the nodes.
taints
[]Kubernetes core/v1.Taint

Taints is the set of taints to apply to the nodes.

NodeUpgradeStrategy

(Appears on: WorkerConfig)

Field Description
type
NodeUpgradeStrategyType 		(Optional)

Type of node replacement strategy. Default is RollingUpdate.
rollingUpdate
RollingUpdateNodeUpgradeStrategy 		(Optional)

RollingUpdate config params. Present only if NodeUpgradeStrategyType = RollingUpdate.

NodeUpgradeStrategyType (string alias)

(Appears on: NodeUpgradeStrategy)

PodIdentityConfig

(Appears on: ClusterSpec)

PodIdentityConfig defines the configuration for the pod identity.

Field Description
enabled
bool

Enabled is true when the pod identity is enabled.

ResourceRef

(Appears on: ClusterSpec)

Field Description
name
string

Name is the name of the resource.
kind
string

Kind Of the resource. e.g. ConfigMap, Secret, etc.

RollingUpdateNodeUpgradeStrategy

(Appears on: NodeUpgradeStrategy)

Field Description
maxUnavailable
Kubernetes intstr.IntOrString

MaxUnavailable is the maximum number of nodes that can be unavailable during the update.
maxSurge
Kubernetes intstr.IntOrString

MaxSurge is the maximum number of nodes that can be created above the desired number of nodes during the update.
deletePolicy
string 		(Optional)

DeletePolicy defines the policy used to identify nodes to delete when downscaling. Valid values are “Random”, “Newest” and “Oldest”. Defaults to “Newest”.

SecretKeyRef

(Appears on: AttachedClusterSpec)

SecretKeyRef holds the reference to a secret key.

Field Description
name
string

Name is the name of the secret.
key
string

Key is the key of the secret. If no key is specified, the secret’s default key is value.

VPCConfig

(Appears on: NetworkConfig)

Field Description
id
string 		(Optional)

ID defines a unique identifier to reference this resource.
name
string 		(Optional)

Name is the name of the VPC. if not set, the name will be generated from cluster name.
cidrBlock
string 		(Optional)

CIDRBlock is the CIDR block to be used when the provider creates a managed VPC. Defaults to 10.0.0.0/16.

Volume

(Appears on: MachineConfig)

Field Description
type
string 		(Optional)

Type is the type of the volume (e.g. gp2, io1, etc…).
size
int64

Size specifies size (in Gi) of the storage device. Must be greater than the image snapshot size or 8 (whichever is greater).

WorkerConfig

(Appears on: ClusterSpec)

Field Description
NodeConfig
NodeConfig

(Members of NodeConfig are embedded into this type.)

strategy
NodeUpgradeStrategy 		(Optional)

Strategy to use to replace existing nodes with new ones.

This page was automatically generated with gen-crd-api-reference-docs