Last generated February 8, 2023
KVMConfig
Deprecation: Support for KVM clusters has reached end of life and this CRD will be removed in future versions.
Version v1alpha1
Properties
.apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
.kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
.metadata
.spec
.spec.cluster
.spec.cluster.calico
.spec.cluster.calico.cidr
.spec.cluster.calico.mtu
.spec.cluster.calico.subnet
.spec.cluster.customer
.spec.cluster.customer.id
.spec.cluster.docker
.spec.cluster.docker.daemon
.spec.cluster.docker.daemon.cidr
.spec.cluster.etcd
.spec.cluster.etcd.altNames
.spec.cluster.etcd.domain
.spec.cluster.etcd.port
.spec.cluster.etcd.prefix
.spec.cluster.id
.spec.cluster.kubernetes
.spec.cluster.kubernetes.api
.spec.cluster.kubernetes.api.clusterIPRange
.spec.cluster.kubernetes.api.domain
.spec.cluster.kubernetes.api.securePort
.spec.cluster.kubernetes.cloudProvider
.spec.cluster.kubernetes.dns
.spec.cluster.kubernetes.dns.ip
.spec.cluster.kubernetes.domain
.spec.cluster.kubernetes.ingressController
.spec.cluster.kubernetes.ingressController.docker
.spec.cluster.kubernetes.ingressController.docker.image
.spec.cluster.kubernetes.ingressController.domain
.spec.cluster.kubernetes.ingressController.insecurePort
.spec.cluster.kubernetes.ingressController.securePort
.spec.cluster.kubernetes.ingressController.wildcardDomain
.spec.cluster.kubernetes.kubelet
.spec.cluster.kubernetes.kubelet.altNames
.spec.cluster.kubernetes.kubelet.domain
.spec.cluster.kubernetes.kubelet.labels
.spec.cluster.kubernetes.kubelet.port
.spec.cluster.kubernetes.networkSetup
.spec.cluster.kubernetes.networkSetup.docker
.spec.cluster.kubernetes.networkSetup.docker.image
.spec.cluster.kubernetes.networkSetup.kubeProxy
ClusterKubernetesNetworkSetupKubeProxy describes values passed to the kube-proxy running in a workload cluster.
.spec.cluster.kubernetes.networkSetup.kubeProxy.conntrackMaxPerCore
Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). Passed to kube-proxy as –conntrack-max-per-core.
.spec.cluster.kubernetes.ssh
.spec.cluster.kubernetes.ssh.userList
.spec.cluster.kubernetes.ssh.userList[*]
.spec.cluster.kubernetes.ssh.userList[*].name
.spec.cluster.kubernetes.ssh.userList[*].publicKey
.spec.cluster.masters
.spec.cluster.masters[*]
.spec.cluster.masters[*].id
.spec.cluster.scaling
.spec.cluster.scaling.max
Max defines maximum number of worker nodes the workload cluster is allowed to have.
.spec.cluster.scaling.min
Min defines minimum number of worker nodes required to be present in the workload cluster.
.spec.cluster.version
Version is DEPRECATED and should just be dropped.
.spec.cluster.workers
.spec.cluster.workers[*]
.spec.cluster.workers[*].id
.spec.kvm
.spec.kvm.endpointUpdater
.spec.kvm.endpointUpdater.docker
.spec.kvm.endpointUpdater.docker.image
.spec.kvm.k8sKVM
.spec.kvm.k8sKVM.docker
.spec.kvm.k8sKVM.docker.image
.spec.kvm.k8sKVM.storageType
.spec.kvm.masters
.spec.kvm.masters[*]
.spec.kvm.masters[*].cpus
.spec.kvm.masters[*].disk
.spec.kvm.masters[*].dockerVolumeSizeGB
.spec.kvm.masters[*].hostVolumes
.spec.kvm.masters[*].hostVolumes[*]
.spec.kvm.masters[*].hostVolumes[*].hostPath
.spec.kvm.masters[*].hostVolumes[*].mountTag
.spec.kvm.masters[*].memory
.spec.kvm.network
.spec.kvm.network.flannel
.spec.kvm.network.flannel.vni
.spec.kvm.nodeController
NOTE THIS IS DEPRECATED
.spec.kvm.nodeController.docker
NOTE THIS IS DEPRECATED
.spec.kvm.nodeController.docker.image
.spec.kvm.portMappings
.spec.kvm.portMappings[*]
.spec.kvm.portMappings[*].name
.spec.kvm.portMappings[*].nodePort
.spec.kvm.portMappings[*].targetPort
.spec.kvm.workers
.spec.kvm.workers[*]
.spec.kvm.workers[*].cpus
.spec.kvm.workers[*].disk
.spec.kvm.workers[*].dockerVolumeSizeGB
.spec.kvm.workers[*].hostVolumes
.spec.kvm.workers[*].hostVolumes[*]
.spec.kvm.workers[*].hostVolumes[*].hostPath
.spec.kvm.workers[*].hostVolumes[*].mountTag
.spec.kvm.workers[*].memory
.spec.versionBundle
.spec.versionBundle.version
.status
.status.cluster
.status.cluster.conditions
Conditions is a list of status information expressing the current conditional state of a workload cluster. This may reflect the status of the workload cluster being updating or being up to date.
.status.cluster.conditions[*]
StatusClusterCondition expresses the conditions in which a workload cluster may is.
.status.cluster.conditions[*].lastTransitionTime
LastTransitionTime is the last time the condition transitioned from one status to another.
.status.cluster.conditions[*].status
Status may be True, False or Unknown.
.status.cluster.conditions[*].type
Type may be Creating, Created, Scaling, Scaled, Draining, Drained, Updating, Updated, Deleting, Deleted.
.status.cluster.network
StatusClusterNetwork expresses the network segment that is allocated for a workload cluster.
.status.cluster.network.cidr
.status.cluster.nodes
Nodes is a list of workload cluster node information reflecting the current state of the workload cluster nodes.
.status.cluster.nodes[*]
StatusClusterNode holds information about a workload cluster node.
.status.cluster.nodes[*].labels
Labels contains the kubernetes labels for corresponding node.
.status.cluster.nodes[*].lastTransitionTime
LastTransitionTime is the last time the condition transitioned from one status to another.
.status.cluster.nodes[*].name
Name referrs to a workload cluster node name.
.status.cluster.nodes[*].version
Version referrs to the version used by the node as mandated by the provider operator.
.status.cluster.resources
Resources is a list of arbitrary conditions of operatorkit resource implementations.
.status.cluster.resources[*]
Resource is structure holding arbitrary conditions of operatorkit resource implementations. Imagine an operator implements an instance resource. This resource may operates sequentially but has to operate based on a certain system state it manages. So it tracks the status as needed here specific to its own implementation and means in order to fulfil its premise.
.status.cluster.resources[*].conditions
.status.cluster.resources[*].conditions[*]
StatusClusterResourceCondition expresses the conditions in which an operatorkit resource may is.
.status.cluster.resources[*].conditions[*].lastTransitionTime
LastTransitionTime is the last time the condition transitioned from one status to another.
.status.cluster.resources[*].conditions[*].status
Status may be True, False or Unknown.
.status.cluster.resources[*].conditions[*].type
Type may be anything an operatorkit resource may define.
.status.cluster.resources[*].name
.status.cluster.scaling
StatusClusterScaling expresses the current status of desired number of worker nodes in the workload cluster.
.status.cluster.scaling.desiredCapacity
.status.cluster.versions
Versions is a list that acts like a historical track record of versions a workload cluster went through. A version is only added to the list as soon as the workload cluster successfully migrated to the version added here.
.status.cluster.versions[*]
StatusClusterVersion expresses the versions in which a workload cluster was and may still be.
.status.cluster.versions[*].date
TODO date is deprecated due to LastTransitionTime This can be removed ones the new properties are properly used in all workload clusters. https://github.com/giantswarm/giantswarm/issues/3988
.status.cluster.versions[*].lastTransitionTime
LastTransitionTime is the last time the condition transitioned from one status to another.
.status.cluster.versions[*].semver
Semver is some semver version, e.g. 1.0.0.
.status.kvm
.status.kvm.nodeIndexes
NodeIndexes is a map from nodeID -> nodeIndex. This is used to create deterministic iSCSI initiator names.
This documentation page shows information based on apiextensions v5.0.0.
Need help with the Management API?
We listen in your Slack support channel. And of course, we welcome your pull requests to improve these docs!
