Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
tenantID string | |
subscriptionID string | |
clientID string | |
clientSecret string |
Appears in:
| Field | Description |
|---|---|
DeploymentSettings DeploymentSettings | |
endpointReconcilingDisabled boolean | |
nodePortRange string |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
accessKeyID string | |
secretAccessKey string | |
assumeRoleARN string | |
assumeRoleExternalID string | |
vpcID string | |
routeTableID string | |
instanceProfileName string | |
securityGroupID string | |
roleARN string |
AWSCloudSpec specifies access data to Amazon Web Services.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
accessKeyID string | |
secretAccessKey string | |
assumeRoleARN string | |
assumeRoleExternalID string | |
vpcID string | |
roleARN string | The IAM role, the control plane will use. The control plane will perform an assume-role |
routeTableID string | |
instanceProfileName string | |
securityGroupID string | |
nodePortsAllowedIPRange string |
Addon specifies a add-on.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | Addon |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec AddonSpec | |
status AddonStatus |
Appears in:
| Field | Description |
|---|---|
status ConditionStatus | Status of the condition, one of True, False, Unknown. |
lastHeartbeatTime Time | Last time we got an update on a given condition. |
lastTransitionTime Time | Last time the condition transit from one status to another. |
Underlying type: string
Appears in:
AddonConfig specifies addon configuration.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AddonConfig |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec AddonConfigSpec |
AddonConfigList is a list of addon configs.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AddonConfigList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items AddonConfig array |
AddonConfigSpec specifies configuration of addon.
Appears in:
| Field | Description |
|---|---|
shortDescription string | ShortDescription of the configured addon that contains more detailed information about the addon, it will be displayed in the addon details view in the UI |
description string | Description of the configured addon, it will be displayed in the addon overview in the UI |
logo string | Logo of the configured addon, encoded in base64 |
logoFormat string | LogoFormat contains logo format of the configured addon, i.e. svg+xml |
formSpec AddonFormControl array | Controls that can be set for configured addon |
AddonFormControl specifies addon form control.
Appears in:
| Field | Description |
|---|---|
displayName string | DisplayName is visible in the UI |
internalName string | InternalName is used internally to save in the addon object |
helpText string | HelpText is visible in the UI next to the control |
required boolean | Required indicates if the control has to be set |
type string | Type of displayed control |
AddonList is a list of addons.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AddonList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Addon array |
AddonSpec specifies details of an addon.
Appears in:
| Field | Description |
|---|---|
name string | Name defines the name of the addon to install |
cluster ObjectReference | Cluster is the reference to the cluster the addon should be installed in |
variables RawExtension | Variables is free form data to use for parsing the manifest templates |
requiredResourceTypes GroupVersionKind array | RequiredResourceTypes allows to indicate that this addon needs some resource type before it can be installed. This can be used to indicate that a specific CRD and/or extension apiserver must be installed before this addon can be installed. The addon will not be installed until that resource is served. |
isDefault boolean | IsDefault indicates whether the addon is default |
Appears in:
| Field | Description |
|---|---|
conditions object (keys:AddonConditionType, values:AddonCondition) |
AdmissionPlugin is the type representing a AdmissionPlugin.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AdmissionPlugin |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec AdmissionPluginSpec |
AdmissionPluginList is the type representing a AdmissionPluginList.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AdmissionPluginList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items AdmissionPlugin array | List of Admission Plugins |
AdmissionPluginSpec specifies admission plugin name and from which k8s version is supported.
Appears in:
| Field | Description |
|---|---|
pluginName string | |
fromVersion Semver | FromVersion flag can be empty. It means the plugin fit to all k8s versions |
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | Alertmanager |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec AlertmanagerSpec | |
status AlertmanagerStatus |
AlertmanagerConfigurationStatus stores status information about the AlertManager configuration.
Appears in:
| Field | Description |
|---|---|
lastUpdated Time | LastUpdated stores the last successful time when the configuration was successfully applied |
status ConditionStatus | Status of whether the configuration was applied, one of True, False |
errorMessage string | ErrorMessage contains a default error message in case the configuration could not be applied. Will be reset if the error was resolved and condition becomes True |
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AlertmanagerList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Alertmanager array |
Appears in:
| Field | Description |
|---|---|
configSecret LocalObjectReference | ConfigSecret refers to the Secret in the same namespace as the Alertmanager object, which contains configuration for this Alertmanager. |
AlertmanagerStatus stores status information about the AlertManager.
Appears in:
| Field | Description |
|---|---|
configStatus AlertmanagerConfigurationStatus |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
accessKeyID string | |
accessKeySecret string |
AlibabaCloudSpec specifies the access data to Alibaba.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
accessKeyID string | |
accessKeySecret string |
AllowedRegistry is the object representing an allowed registry.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AllowedRegistry |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec AllowedRegistrySpec |
AllowedRegistryList specifies a list of allowed registries.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | AllowedRegistryList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items AllowedRegistry array |
AllowedRegistrySpec specifies the data for allowed registry spec.
Appears in:
| Field | Description |
|---|---|
registryPrefix string | RegistryPrefix contains the prefix of the registry which will be allowed. User clusters will be able to deploy only images which are prefixed with one of the allowed image registry prefixes. |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
token string | Token is used to authenticate with the Anexia API. |
AnexiaCloudSpec specifies the access data to Anexia.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
token string |
Appears in:
| Field | Description |
|---|---|
enabled boolean | |
policyPreset AuditPolicyPreset |
Underlying type: string
Appears in:
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
tenantID string | |
subscriptionID string | |
clientID string | |
clientSecret string | |
resourceGroup string | |
vnetResourceGroup string | |
vnet string | |
subnet string | |
routeTable string | |
securityGroup string | |
loadBalancerSKU LBSKU | LoadBalancerSKU sets the LB type that will be used for the Azure cluster, possible values are “basic” and “standard”, if empty, “basic” will be used |
AzureCloudSpec specifies access credentials to Azure cloud.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
tenantID string | |
subscriptionID string | |
clientID string | |
clientSecret string | |
resourceGroup string | |
vnetResourceGroup string | |
vnet string | |
subnet string | |
routeTable string | |
securityGroup string | |
nodePortsAllowedIPRange string | |
assignAvailabilitySet boolean | |
availabilitySet string | |
loadBalancerSKU LBSKU | LoadBalancerSKU sets the LB type that will be used for the Azure cluster, possible values are “basic” and “standard”, if empty, “basic” will be used |
BackupDestination defines the bucket name and endpoint as a backup destination, and holds reference to the credentials secret.
Appears in:
| Field | Description |
|---|---|
endpoint string | Endpoint is the API endpoint to use for backup and restore. |
bucketName string | BucketName is the bucket name to use for backup and restore. |
credentials SecretReference | Credentials hold the ref to the secret with backup credentials |
Appears in:
| Field | Description |
|---|---|
scheduledTime Time | ScheduledTime will always be set when the BackupStatus is created, so it’ll never be nil |
backupName string | |
jobName string | |
backupStartTime Time | |
backupFinishedTime Time | |
backupPhase BackupStatusPhase | |
backupMessage string | |
deleteJobName string | |
deleteStartTime Time | |
deleteFinishedTime Time | |
deletePhase BackupStatusPhase | |
deleteMessage string |
Underlying type: string
Appears in:
BringYourOwnCloudSpec specifies access data for a bring your own cluster.
Appears in:
CNIPluginSettings contains the spec of the CNI plugin used by the Cluster.
Appears in:
| Field | Description |
|---|---|
type CNIPluginType | |
version string |
Underlying type: string
CNIPluginType define the type of CNI plugin installed. e.g. Canal.
Appears in:
Appears in:
| Field | Description |
|---|---|
enabled boolean | |
enforced boolean |
CloudSpec mutually stores access data to a cloud provider.
Appears in:
| Field | Description |
|---|---|
dc string | DatacenterName where the users ‘cloud’ lives in. |
providerName string | ProviderName is the name of the cloud provider used for this cluster. This must match the given provider spec (e.g. if the providerName is “aws”, then the AWSCloudSpec must be set) |
fake FakeCloudSpec | |
digitalocean DigitaloceanCloudSpec | |
bringyourown BringYourOwnCloudSpec | |
aws AWSCloudSpec | |
azure AzureCloudSpec | |
openstack OpenstackCloudSpec | |
packet PacketCloudSpec | |
hetzner HetznerCloudSpec | |
vsphere VSphereCloudSpec | |
gcp GCPCloudSpec | |
kubevirt KubevirtCloudSpec | |
alibaba AlibabaCloudSpec | |
anexia AnexiaCloudSpec | |
nutanix NutanixCloudSpec |
Cluster is the object representing a cluster.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | Cluster |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec ClusterSpec | |
address ClusterAddress | |
status ClusterStatus |
ClusterAddress stores access and address information of a cluster.
Appears in:
| Field | Description |
|---|---|
url string | URL under which the Apiserver is available |
port integer | Port is the port the API server listens on |
externalName string | ExternalName is the DNS name for this cluster |
internalURL string | InternalName is the seed cluster internal absolute DNS name to the API server |
adminToken string | AdminToken is the token for the kubeconfig, the user can download |
ip string | IP is the external IP under which the apiserver is available |
Appears in:
| Field | Description |
|---|---|
status ConditionStatus | Status of the condition, one of True, False, Unknown. |
kubermaticVersion string | KubermaticVersion current kubermatic version. |
lastHeartbeatTime Time | Last time we got an update on a given condition. |
lastTransitionTime Time | Last time the condition transit from one status to another. |
reason string | (brief) reason for the condition’s last transition. |
message string | Human readable message indicating details about last transition. |
Underlying type: string
ClusterConditionType is used to indicate the type of a cluster condition. For all condition types, the true value must indicate success. All condition types must be registered within the AllClusterConditionTypes variable.
Appears in:
ClusterList specifies a list of clusters.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ClusterList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Cluster array |
ClusterNetworkingConfig specifies the different networking parameters for a cluster.
Appears in:
| Field | Description |
|---|---|
services NetworkRanges | The network ranges from which service VIPs are allocated. |
pods NetworkRanges | The network ranges from which POD networks are allocated. |
dnsDomain string | Domain name for services. |
proxyMode string | ProxyMode defines the kube-proxy mode (“ipvs” / “iptables” / “ebpf”). Defaults to “ipvs”. “ebpf” disables kube-proxy and requires CNI support. |
ipvs IPVSConfiguration | IPVS defines kube-proxy ipvs configuration options |
nodeLocalDNSCacheEnabled boolean | NodeLocalDNSCacheEnabled controls whether the NodeLocal DNS Cache feature is enabled. Defaults to true. |
konnectivityEnabled boolean | KonnectivityEnabled enables konnectivity for controlplane to node network communication. |
ClusterSpec specifies the data for a new cluster.
Appears in:
| Field | Description |
|---|---|
cloud CloudSpec | |
clusterNetwork ClusterNetworkingConfig | |
machineNetworks MachineNetworkingConfig array | |
version Semver | Version defines the wanted version of the control plane |
humanReadableName string | HumanReadableName is the cluster name provided by the user |
exposeStrategy ExposeStrategy | ExposeStrategy is the approach we use to expose this cluster, either via NodePort or via a dedicated LoadBalancer |
pause boolean | Pause tells that this cluster is currently not managed by the controller. It indicates that the user needs to do some action to resolve the pause. |
pauseReason string | PauseReason is the reason why the cluster is no being managed. |
debugLog boolean | DebugLog enables more verbose logging by KKP’s usercluster-controller-manager. |
componentsOverride ComponentSettings | Optional component specific overrides |
oidc OIDCSettings | |
features object (keys:string, values:boolean) | Feature flags This unfortunately has to be a string map, because we use it in templating and that can not cope with string types |
updateWindow UpdateWindow | |
usePodSecurityPolicyAdmissionPlugin boolean | |
usePodNodeSelectorAdmissionPlugin boolean | |
useEventRateLimitAdmissionPlugin boolean | |
enableUserSSHKeyAgent boolean | EnableUserSSHKeyAgent control whether the UserSSHKeyAgent will be deployed in the user cluster or not. If it was enabled, the agent will be deployed and used to sync the user ssh keys, that the user attach to the created cluster. If the agent was disabled, it won’t be deployed in the user cluster, thus after the cluster creation any attached ssh keys won’t be synced to the worker nodes. Once the agent is enabled/disabled it cannot be changed after the cluster is being created. |
enableOperatingSystemManager boolean | EnableOperatingSystemManager enables OSM which in-turn is responsible for creating and managing worker node configuration |
podNodeSelectorAdmissionPluginConfig object (keys:string, values:string) | PodNodeSelectorAdmissionPluginConfig provides the configuration for the PodNodeSelector. It’s used by the backend to create a configuration file for this plugin. The key:value from the map is converted to the namespace: in the file. The format in a file: podNodeSelectorPluginConfig: clusterDefaultNodeSelector: namespace1: namespace2: |
eventRateLimitConfig EventRateLimitConfig | EventRateLimitConfig allows configuring the EventRateLimit admission plugin (if enabled via useEventRateLimitAdmissionPlugin) to create limits on Kubernetes event generation. The EventRateLimit plugin is capable of comparing incoming Events to several configured buckets based on the type of event rate limit. |
admissionPlugins string array | AdmissionPlugins provides the ability to pass arbitrary names of admission plugins to kube-apiserver |
auditLogging AuditLoggingSettings | |
opaIntegration OPAIntegrationSettings | OPAIntegration is a preview feature that enables OPA integration with Kubermatic for the cluster. Enabling it causes gatekeeper and its resources to be deployed on the user cluster. By default it is disabled. |
serviceAccount ServiceAccountSettings | ServiceAccount contains service account related settings for the kube-apiserver of user cluster. |
mla MLASettings | MLA contains monitoring, logging and alerting related settings for the user cluster. |
containerRuntime string | ContainerRuntime to use, i.e. Docker or containerd. By default containerd will be used. |
cniPlugin CNIPluginSettings | CNIPlugin contains the spec of the CNI plugin to be installed in the cluster. |
ClusterStatus stores status information about a cluster.
Appears in:
| Field | Description |
|---|---|
lastUpdated Time | |
extendedHealth ExtendedClusterHealth | ExtendedHealth exposes information about the current health state. Extends standard health status for new states. |
lastProviderReconciliation Time | LastProviderReconciliation is the time when the cloud provider resources were last fully reconciled (during normal cluster reconciliation, KKP does not re-check things like security groups, networks etc.). |
namespaceName string | NamespaceName defines the namespace the control plane of this cluster is deployed in |
userName string | UserName contains the name of the owner of this cluster |
userEmail string | UserEmail contains the email of the owner of this cluster |
errorReason ClusterStatusError | ErrorReason contains a error reason in case the controller encountered an error. Will be reset if the error was resolved |
errorMessage string | ErrorMessage contains a default error message in case the controller encountered an error. Will be reset if the error was resolved |
conditions object (keys:ClusterConditionType, values:ClusterCondition) | Conditions contains conditions the cluster is in, its primary use case is status signaling between controllers or between controllers and the API |
cloudMigrationRevision integer | CloudMigrationRevision describes the latest version of the migration that has been done It is used to avoid redundant and potentially costly migrations |
inheritedLabels object (keys:string, values:string) | InheritedLabels are labels the cluster inherited from the project. They are read-only for users. |
Underlying type: string
Appears in:
ClusterTemplate is the object representing a cluster template.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ClusterTemplate |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
clusterLabels object (keys:string, values:string) | |
inheritedClusterLabels object (keys:string, values:string) | |
credential string | |
userSSHKeys ClusterTemplateSSHKey array | |
spec ClusterSpec |
ClusterTemplateInstance is the object representing a cluster template instance.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ClusterTemplateInstance |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec ClusterTemplateInstanceSpec |
ClusterTemplateInstanceList specifies a list of cluster template instances.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ClusterTemplateInstanceList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items ClusterTemplateInstance array |
ClusterTemplateInstanceSpec specifies the data for cluster instances.
Appears in:
| Field | Description |
|---|---|
projectID string | |
clusterTemplateID string | |
clusterTemplateName string | |
replicas integer |
ClusterTemplateList specifies a list of cluster templates.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ClusterTemplateList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items ClusterTemplate array |
ClusterTemplateSSHKey is the object for holding SSH key.
Appears in:
| Field | Description |
|---|---|
name string | |
id string |
Appears in:
| Field | Description |
|---|---|
apiserver APIServerSettings | Apiserver configures kube-apiserver settings. |
controllerManager ControllerSettings | ControllerManager configures kube-controller-manager settings. |
scheduler ControllerSettings | Scheduler configures kube-scheduler settings. |
etcd EtcdStatefulSetSettings | Etcd configures the etcd ring used to store Kubernetes data. |
prometheus StatefulSetSettings | Prometheus configures the Prometheus instance deployed into the cluster control plane. |
nodePortProxyEnvoy NodeportProxyComponent | NodePortProxyEnvoy configures the per-cluster nodeport-proxy-envoy that is deployed if the LoadBalancer expose strategy is used. This is not effective if a different expose strategy is configured. |
konnectivityProxy KonnectvityProxySettings | KonnectivityProxy configures resources limits/requests for konnectivity-server sidecar. |
Constraint specifies a kubermatic wrapper for the gatekeeper constraints.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | Constraint |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec ConstraintSpec |
ConstraintList specifies a list of constraints.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ConstraintList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Constraint array |
ConstraintSelector is the object holding the cluster selection filters.
Appears in:
| Field | Description |
|---|---|
providers string array | Providers is a list of cloud providers to which the Constraint applies to. Empty means all providers are selected. |
labelSelector LabelSelector | LabelSelector selects the Clusters to which the Constraint applies based on their labels |
ConstraintSpec specifies the data for the constraint.
Appears in:
| Field | Description |
|---|---|
constraintType string | ConstraintType specifies the type of gatekeeper constraint that the constraint applies to |
disabled boolean | Disabled is the flag for disabling OPA constraints |
match Match | Match contains the constraint to resource matching data |
parameters object (keys:string, values:integer array) | Parameters specifies the parameters used by the constraint template REGO. It supports both the legacy rawJSON parameters, in which all the parameters are set in a JSON string, and regular parameters like in Gatekeeper Constraints. If rawJSON is set, during constraint syncing to the user cluster, the other parameters are ignored Example with rawJSON parameters: |
| parameters: rawJSON: ‘{“labels”:[“gatekeeper”]}’ | |
| And with regular parameters: | |
| parameters: labels: [“gatekeeper”] | |
selector ConstraintSelector | Selector specifies the cluster selection filters |
ConstraintTemplate is the object representing a kubermatic wrapper for a gatekeeper constraint template.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ConstraintTemplate |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec ConstraintTemplateSpec |
ConstraintTemplateList specifies a list of constraint templates.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ConstraintTemplateList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items ConstraintTemplate array |
ConstraintTemplateSelector is the object holding the cluster selection filters.
Appears in:
| Field | Description |
|---|---|
providers string array | Providers is a list of cloud providers to which the Constraint Template applies to. Empty means all providers are selected. |
labelSelector LabelSelector | LabelSelector selects the Clusters to which the Constraint Template applies based on their labels |
ConstraintTemplateSpec is the object representing the gatekeeper constraint template spec and kubermatic related spec.
Appears in:
| Field | Description |
|---|---|
crd CRD | |
targets Target array | |
selector ConstraintTemplateSelector |
ContainerRuntimeContainerd defines containerd container runtime registries configs.
Appears in:
| Field | Description |
|---|---|
registries object (keys:string, values:ContainerdRegistry) | A map of registries to use to render configs and mirrors for containerd registries |
ContainerdRegistry defines endpoints and security for given container registry.
Appears in:
Appears in:
| Field | Description |
|---|---|
DeploymentSettings DeploymentSettings | |
leaderElection LeaderElectionSettings |
Appears in:
| Field | Description |
|---|---|
label string | |
url string | |
icon string | |
location string |
Appears in:
| Field | Description |
|---|---|
country string | Optional: Country of the seed as ISO-3166 two-letter code, e.g. DE or UK. For informational purposes in the Kubermatic dashboard only. |
location string | Optional: Detailed location of the cluster, like “Hamburg” or “Datacenter 7”. For informational purposes in the Kubermatic dashboard only. |
node NodeSettings | Node holds node-specific settings, like e.g. HTTP proxy, Docker registries and the like. Proxy settings are inherited from the seed if not specified here. |
spec DatacenterSpec | Spec describes the cloud provider settings used to manage resources in this datacenter. Exactly one cloud provider must be defined. |
DatacenterSpec mutually points to provider datacenter spec.
Appears in:
| Field | Description |
|---|---|
digitalocean DatacenterSpecDigitalocean | |
bringyourown DatacenterSpecBringYourOwn | BringYourOwn contains settings for clusters using manually created nodes via kubeadm. |
aws DatacenterSpecAWS | |
azure DatacenterSpecAzure | |
openstack DatacenterSpecOpenstack | |
packet DatacenterSpecPacket | |
hetzner DatacenterSpecHetzner | |
vsphere DatacenterSpecVSphere | |
gcp DatacenterSpecGCP | |
kubevirt DatacenterSpecKubevirt | |
alibaba DatacenterSpecAlibaba | |
anexia DatacenterSpecAnexia | |
nutanix DatacenterSpecNutanix | Nutanix is experimental and unsupported |
requiredEmails string array | Optional: When defined, only users with an e-mail address on the given domains can make use of this datacenter. You can define multiple domains, e.g. “example.com”, one of which must match the email domain exactly (i.e. “example.com” will not match “user@test.example.com”). |
enforceAuditLogging boolean | EnforceAuditLogging enforces audit logging on every cluster within the DC, ignoring cluster-specific settings. |
enforcePodSecurityPolicy boolean | EnforcePodSecurityPolicy enforces pod security policy plugin on every clusters within the DC, ignoring cluster-specific settings |
providerReconciliationInterval Duration | ProviderReconciliationInterval is the time that must have passed since a Cluster’s status.lastProviderReconciliation to make the cliuster controller perform an in-depth provider reconciliation, where for example missing security groups will be reconciled. Setting this too low can cause rate limits by the cloud provider, setting this too high means that if a resource at a cloud provider is removed/changed outside of KKP, it will take this long to fix it. |
DatacenterSpecAWS describes an AWS datacenter.
Appears in:
| Field | Description |
|---|---|
region string | The AWS region to use, e.g. “us-east-1”. For a list of available regions, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html |
images object (keys:OperatingSystem, values:string) | List of AMIs to use for a given operating system. This gets defaulted by querying for the latest AMI for the given distribution when machines are created, so under normal circumstances it is not necessary to define the AMIs statically. |
DatacenterSpecAlibaba describes a alibaba datacenter.
Appears in:
| Field | Description |
|---|---|
region string | Region to use, for a full list of regions see https://www.alibabacloud.com/help/doc-detail/40654.htm |
DatacenterSpecAnexia describes a anexia datacenter.
Appears in:
| Field | Description |
|---|---|
locationID string | LocationID the location of the region |
DatacenterSpecAzure describes an Azure cloud datacenter.
Appears in:
| Field | Description |
|---|---|
location string | Region to use, for example “westeurope”. A list of available regions can be found at https://azure.microsoft.com/en-us/global-infrastructure/locations/ |
DatacenterSpecBringYourOwn describes a datacenter our of bring your own nodes.
Appears in:
DatacenterSpecDigitalocean describes a DigitalOcean datacenter.
Appears in:
| Field | Description |
|---|---|
region string | Datacenter location, e.g. “ams3”. A list of existing datacenters can be found at https://www.digitalocean.com/docs/platform/availability-matrix/ |
DatacenterSpecGCP describes a GCP datacenter.
Appears in:
| Field | Description |
|---|---|
region string | Region to use, for example “europe-west3”, for a full list of regions see https://cloud.google.com/compute/docs/regions-zones/ |
zoneSuffixes string array | List of enabled zones, for example [a, c]. See the link above for the available zones in your chosen region. |
regional boolean | Optional: Regional clusters spread their resources across multiple availability zones. Refer to the official documentation for more details on this: https://cloud.google.com/kubernetes-engine/docs/concepts/regional-clusters |
DatacenterSpecHetzner describes a Hetzner cloud datacenter.
Appears in:
| Field | Description |
|---|---|
datacenter string | Datacenter location, e.g. “nbg1-dc3”. A list of existing datacenters can be found at https://wiki.hetzner.de/index.php/Rechenzentren_und_Anbindung/en |
network string | Network is the pre-existing Hetzner network in which the machines are running. While machines can be in multiple networks, a single one must be chosen for the HCloud CCM to work. |
location string | Optional: Detailed location of the datacenter, like “Hamburg” or “Datacenter 7”. For informational purposes only. |
DatacenterSpecKubevirt describes a kubevirt datacenter.
Appears in:
| Field | Description |
|---|---|
dnsPolicy string | DNSPolicy represents the dns policy for the pod. Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’. Defaults to “ClusterFirst”. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. |
dnsConfig PodDNSConfig | DNSConfig represents the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
DatacenterSpecNutanix describes a Nutanix datacenter.
Appears in:
| Field | Description |
|---|---|
endpoint string | Endpoint to use for accessing Nutanix Prism Central. No protocol or port should be passed, for example “nutanix.example.com” or “10.0.0.1” |
port integer | Optional: Port to use when connecting to the Nutanix Prism Central endpoint (defaults to 9440) |
allowInsecure boolean | Optional: AllowInsecure allows to disable the TLS certificate check against the endpoint (defaults to false) |
images object (keys:OperatingSystem, values:string) | Images to use for each supported operating system |
DatacenterSpecOpenstack describes an OpenStack datacenter.
Appears in:
| Field | Description |
|---|---|
authURL string | |
availabilityZone string | |
region string | |
ignoreVolumeAZ boolean | Optional |
enforceFloatingIP boolean | Optional |
dnsServers string array | Used for automatic network creation |
images object (keys:OperatingSystem, values:string) | Images to use for each supported operating system. |
manageSecurityGroups boolean | Optional: Gets mapped to the “manage-security-groups” setting in the cloud config. See https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#load-balancer This setting defaults to true. |
useOctavia boolean | Optional: Gets mapped to the “use-octavia” setting in the cloud config. use-octavia is enabled by default in CCM since v1.17.0, and disabled by default with the in-tree cloud provider. |
trustDevicePath boolean | Optional: Gets mapped to the “trust-device-path” setting in the cloud config. See https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#block-storage This setting defaults to false. |
nodeSizeRequirements OpenstackNodeSizeRequirements | |
enabledFlavors string array | Optional: List of enabled flavors for the given datacenter |
DatacenterSpecPacket describes a Packet datacenter.
Appears in:
| Field | Description |
|---|---|
facilities string array | The list of enabled facilities, for example “ams1”, for a full list of available facilities see https://support.packet.com/kb/articles/data-centers |
DatacenterSpecVSphere describes a vSphere datacenter.
Appears in:
| Field | Description |
|---|---|
endpoint string | Endpoint URL to use, including protocol, for example “https://vcenter.example.com”. |
allowInsecure boolean | If set to true, disables the TLS certificate check against the endpoint. |
datastore string | The default Datastore to be used for provisioning volumes using storage classes/dynamic provisioning and for storing virtual machine files in case no Datastore or DatastoreCluster is provided at Cluster level. |
datacenter string | The name of the datacenter to use. |
cluster string | The name of the vSphere cluster to use. Used for out-of-tree CSI Driver. |
storagePolicy string | The name of the storage policy to use for the storage class created in the user cluster. |
rootPath string | Optional: The root path for cluster specific VM folders. Each cluster gets its own folder below the root folder. Must be the FQDN (for example “/datacenter-1/vm/all-kubermatic-vms-in-here”) and defaults to the root VM folder: “/datacenter-1/vm” |
templates object (keys:OperatingSystem, values:string) | A list of VM templates to use for a given operating system. You must define at least one template. See: https://github.com/kubermatic/machine-controller/blob/master/docs/vsphere.md#template-vms-preparation |
infraManagementUser VSphereCredentials | Optional: Infra management user is the user that will be used for everything except the cloud provider functionality, which will still use the credentials passed in via the Kubermatic dashboard/API. |
Appears in:
| Field | Description |
|---|---|
replicas integer | |
resources ResourceRequirements | |
tolerations Toleration array |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
token string | Token is used to authenticate with the DigitalOcean API. |
DigitaloceanCloudSpec specifies access data to DigitalOcean.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
token string |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
accessKeyID string | |
secretAccessKey string | |
region string |
Appears in:
| Field | Description |
|---|---|
annotations object (keys:string, values:string) | Annotations are used to further tweak the LoadBalancer integration with the cloud provider. |
sourceRanges CIDR array | SourceRanges will restrict loadbalancer service to IP ranges specified using CIDR notation like 172.25.0.0/16. This field will be ignored if the cloud-provider does not support the feature. More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ |
EtcdBackupConfig specifies a add-on.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | EtcdBackupConfig |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec EtcdBackupConfigSpec | |
status EtcdBackupConfigStatus |
Appears in:
| Field | Description |
|---|---|
status ConditionStatus | Status of the condition, one of True, False, Unknown. |
lastHeartbeatTime Time | Last time we got an update on a given condition. |
lastTransitionTime Time | Last time the condition transit from one status to another. |
reason string | (brief) reason for the condition’s last transition. |
message string | Human readable message indicating details about last transition. |
Underlying type: string
EtcdBackupConfigConditionType is used to indicate the type of a EtcdBackupConfig condition. For all condition types, the true value must indicate success. All condition types must be registered within the AllClusterConditionTypes variable.
Appears in:
EtcdBackupConfigList is a list of etcd backup configs.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | EtcdBackupConfigList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items EtcdBackupConfig array |
EtcdBackupConfigSpec specifies details of an etcd backup.
Appears in:
| Field | Description |
|---|---|
name string | Name defines the name of the backup The name of the backup file in S3 will be - If a schedule is set (see below), - will be appended. |
cluster ObjectReference | Cluster is the reference to the cluster whose etcd will be backed up |
schedule string | Schedule is a cron expression defining when to perform the backup. If not set, the backup is performed exactly once, immediately. |
keep integer | Keep is the number of backups to keep around before deleting the oldest one If not set, defaults to DefaultKeptBackupsCount. Only used if Schedule is set. |
destination string | Destination indicates where the backup will be stored. The destination name must correspond to a destination in the cluster’s Seed.Spec.EtcdBackupRestore. |
Appears in:
| Field | Description |
|---|---|
currentBackups BackupStatus array | CurrentBackups tracks the creation and deletion progress of all backups managed by the EtcdBackupConfig |
conditions object (keys:EtcdBackupConfigConditionType, values:EtcdBackupConfigCondition) | Conditions contains conditions of the EtcdBackupConfig |
cleanupRunning boolean | If the controller was configured with a cleanupContainer, CleanupRunning keeps track of the corresponding job |
EtcdBackupRestore holds the configuration of the automatic backup and restores.
Appears in:
| Field | Description |
|---|---|
destinations object (keys:string, values:BackupDestination) | Destinations stores all the possible destinations where the backups for the Seed can be stored. If not empty, it enables automatic backup and restore for the seed. |
defaultDestination string | DefaultDestination marks the default destination that will be used for the default etcd backup config which is created for every user cluster. Has to correspond to a destination in Destinations. If removed, it removes the related default etcd backup configs. |
EtcdRestore specifies a add-on.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | EtcdRestore |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec EtcdRestoreSpec | |
status EtcdRestoreStatus |
EtcdRestoreList is a list of etcd restores.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | EtcdRestoreList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items EtcdRestore array |
EtcdRestoreSpec specifies details of an etcd restore.
Appears in:
| Field | Description |
|---|---|
name string | Name defines the name of the restore The name of the restore file in S3 will be - If a schedule is set (see below), - will be appended. |
cluster ObjectReference | Cluster is the reference to the cluster whose etcd will be backed up |
backupName string | BackupName is the name of the backup to restore from |
backupDownloadCredentialsSecret string | BackupDownloadCredentialsSecret is the name of a secret in the cluster-xxx namespace containing credentials needed to download the backup |
destination string | Destination indicates where the backup was stored. The destination name should correspond to a destination in the cluster’s Seed.Spec.EtcdBackupRestore. If empty, it will use the legacy destination configured in Seed.Spec.BackupRestore |
Appears in:
| Field | Description |
|---|---|
phase EtcdRestorePhase | |
restoreTime Time |
Appears in:
| Field | Description |
|---|---|
clusterSize integer | |
storageClass string | |
resources ResourceRequirements | |
tolerations Toleration array |
Appears in:
| Field | Description |
|---|---|
server EventRateLimitConfigItem | |
namespace EventRateLimitConfigItem | |
user EventRateLimitConfigItem | |
sourceAndObject EventRateLimitConfigItem |
Appears in:
| Field | Description |
|---|---|
qps integer | |
burst integer | |
cacheSize integer |
Underlying type: string
ExposeStrategy is the strategy to expose the cluster with.
Appears in:
ExtendedClusterHealth stores health information of a cluster.
Appears in:
| Field | Description |
|---|---|
apiserver HealthStatus | |
scheduler HealthStatus | |
controller HealthStatus | |
machineController HealthStatus | |
etcd HealthStatus | |
openvpn HealthStatus | |
cloudProviderInfrastructure HealthStatus | |
userClusterControllerManager HealthStatus | |
gatekeeperController HealthStatus | |
gatekeeperAudit HealthStatus | |
monitoring HealthStatus | |
logging HealthStatus | |
alertmanagerConfig HealthStatus | |
mlaGateway HealthStatus |
ExternalCluster is the object representing an external kubernetes cluster.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ExternalCluster |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec ExternalClusterSpec |
Appears in:
| Field | Description |
|---|---|
name string | |
tenantID string | |
subscriptionID string | |
clientID string | |
clientSecret string | |
resourceGroup string | |
credentialsReference GlobalSecretKeySelector |
ExternalClusterCloudSpec mutually stores access data to a cloud provider.
Appears in:
| Field | Description |
|---|---|
gke ExternalClusterGKECloudSpec | |
eks ExternalClusterEKSCloudSpec | |
aks ExternalClusterAKSCloudSpec |
Appears in:
| Field | Description |
|---|---|
name string | |
accessKeyID string | |
secretAccessKey string | |
credentialsReference GlobalSecretKeySelector | |
region string |
Appears in:
| Field | Description |
|---|---|
name string | |
serviceAccount string | |
credentialsReference GlobalSecretKeySelector | |
zone string |
ExternalClusterList specifies a list of external kubernetes clusters.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ExternalClusterList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items ExternalCluster array |
ExternalClusterSpec specifies the data for a new external kubernetes cluster.
Appears in:
| Field | Description |
|---|---|
humanReadableName string | HumanReadableName is the cluster name provided by the user |
kubeconfigReference GlobalSecretKeySelector | |
cloudSpec ExternalClusterCloudSpec |
FakeCloudSpec specifies access data for a fake cloud.
Appears in:
| Field | Description |
|---|---|
token string |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
serviceAccount string | |
network string | |
subnetwork string |
GCPCloudSpec specifies access data to GCP.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
serviceAccount string | The Google Service Account (JSON format), encoded with base64. |
network string | |
subnetwork string | |
nodePortsAllowedIPRange string |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
serviceAccount string |
GroupVersionKind unambiguously identifies a kind. It doesn’t anonymously include GroupVersion to avoid automatic coercion. It doesn’t use a GroupVersion to avoid custom marshalling.
Appears in:
| Field | Description |
|---|---|
group string | |
version string |
Underlying type: string
Appears in:
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
token string | Token is used to authenticate with the Hetzner API. |
network string | Network is the pre-existing Hetzner network in which the machines are running. While machines can be in multiple networks, a single one must be chosen for the HCloud CCM to work. If this is empty, the network configured on the datacenter will be used. |
HetznerCloudSpec specifies access data to hetzner cloud.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
token string | Token is used to authenticate with the Hetzner cloud API. |
network string | Network is the pre-existing Hetzner network in which the machines are running. While machines can be in multiple networks, a single one must be chosen for the HCloud CCM to work. If this is empty, the network configured on the datacenter will be used. |
IPVSConfiguration contains ipvs-related configuration details for kube-proxy.
Appears in:
| Field | Description |
|---|---|
strictArp boolean | StrictArp configure arp_ignore and arp_announce to avoid answering ARP queries from kube-ipvs0 interface. defaults to true. |
Incompatibility represents a version incompatibility for a user cluster.
Appears in:
| Field | Description |
|---|---|
provider ProviderType | Provider to which to apply the compatibility check. Empty string matches all providers |
version string | Version is the Kubernetes version that must be checked. Wildcards are allowed, e.g. “1.22.*”. |
condition ConditionType | Condition is the cluster or datacenter condition that must be met to block a specific version |
operation OperationType | Operation is the operation triggering the compatibility check (CREATE or UPDATE) |
Kind specifies the resource Kind and APIGroup.
Appears in:
| Field | Description |
|---|---|
kinds string array | Kinds specifies the kinds of the resources |
apiGroups string array | APIGroups specifies the APIGroups of the resources |
Appears in:
| Field | Description |
|---|---|
resources ResourceRequirements |
KubermaticAPIConfiguration configures the dashboard.
Appears in:
| Field | Description |
|---|---|
dockerRepository string | DockerRepository is the repository containing the Kubermatic REST API image. |
accessibleAddons string array | AccessibleAddons is a list of addons that should be enabled in the API. |
pprofEndpoint string | PProfEndpoint controls the port the API should listen on to provide pprof data. This port is never exposed from the container and only available via port-forwardings. |
resources ResourceRequirements | Resources describes the requested and maximum allowed CPU/memory usage. |
debugLog boolean | DebugLog enables more verbose logging. |
replicas integer | Replicas sets the number of pod replicas for the API deployment. |
KubermaticAddonConfiguration describes the addons for a given cluster runtime.
Appears in:
| Field | Description |
|---|---|
default string array | Default is the list of addons to be installed by default into each cluster. Mutually exclusive with “defaultManifests”. |
defaultManifests string | DefaultManifests is a list of addon manifests to install into all clusters. Mutually exclusive with “default”. |
dockerRepository string | DockerRepository is the repository containing the Docker image containing the possible addon manifests. |
dockerTagSuffix string | DockerTagSuffix is appended to the tag used for referring to the addons image. If left empty, the tag will be the KKP version (e.g. “v2.15.0”), with a suffix it becomes “v2.15.0-SUFFIX”. |
KubermaticAuthConfiguration defines keys and URLs for Dex.
Appears in:
| Field | Description |
|---|---|
clientID string | |
tokenIssuer string | |
issuerRedirectURL string | |
issuerClientID string | |
issuerClientSecret string | |
issuerCookieKey string | |
serviceAccountKey string | |
skipTokenIssuerTLSVerify boolean |
KubermaticConfiguration is the configuration required for running Kubermatic.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | KubermaticConfiguration |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec KubermaticConfigurationSpec |
KubermaticConfigurationList is a collection of KubermaticConfigurations.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | KubermaticConfigurationList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items KubermaticConfiguration array |
KubermaticConfigurationSpec is the spec for a Kubermatic installation.
Appears in:
| Field | Description |
|---|---|
caBundle TypedLocalObjectReference | CABundle references a ConfigMap in the same namespace as the KubermaticConfiguration. This ConfigMap must contain a ca-bundle.pem with PEM-encoded certificates. This bundle automatically synchronized into each seed and each usercluster. APIGroup and Kind are currently ignored. |
imagePullSecret string | ImagePullSecret is used to authenticate against Docker registries. |
auth KubermaticAuthConfiguration | Auth defines keys and URLs for Dex. |
featureGates object (keys:string, values:boolean) | FeatureGates are used to optionally enable certain features. |
ui KubermaticUIConfiguration | UI configures the dashboard. |
api KubermaticAPIConfiguration | API configures the frontend REST API used by the dashboard. |
seedController KubermaticSeedControllerConfiguration | SeedController configures the seed-controller-manager. |
masterController KubermaticMasterControllerConfiguration | MasterController configures the master-controller-manager. |
userCluster KubermaticUserClusterConfiguration | UserCluster configures various aspects of the user-created clusters. |
exposeStrategy ExposeStrategy | ExposeStrategy is the strategy to expose the cluster with. Note: The seed_dns_overwrite setting of a Seed’s datacenter doesn’t have any effect if this is set to LoadBalancerStrategy. |
ingress KubermaticIngressConfiguration | Ingress contains settings for making the API and UI accessible remotely. |
versions KubermaticVersioningConfiguration | Versions configures the available and default Kubernetes versions and updates. |
verticalPodAutoscaler KubermaticVPAConfiguration | VerticalPodAutoscaler configures the Kubernetes VPA integration. |
proxy KubermaticProxyConfiguration | Proxy allows to configure Kubermatic to use proxies to talk to the world outside of its cluster. |
Appears in:
| Field | Description |
|---|---|
domain string | Domain is the base domain where the dashboard shall be available. Even with a disabled Ingress, this must always be a valid hostname. |
className string | ClassName is the Ingress resource’s class name, used for selecting the appropriate ingress controller. |
disable boolean | Disable will prevent an Ingress from being created at all. This is mostly useful during testing. If the Ingress is disabled, the CertificateIssuer setting can also be left empty, as no Certificate resource will be created. |
certificateIssuer TypedLocalObjectReference | CertificateIssuer is the name of a cert-manager Issuer or ClusterIssuer (default) that will be used to acquire the certificate for the configured domain. To use a namespaced Issuer, set the Kind to “Issuer” and manually create the matching Issuer in Kubermatic’s namespace. Setting an empty name disables the automatic creation of certificates and disables the TLS settings on the Kubermatic Ingress. |
KubermaticMasterControllerConfiguration configures the Kubermatic master controller-manager.
Appears in:
| Field | Description |
|---|---|
dockerRepository string | DockerRepository is the repository containing the Kubermatic master-controller-manager image. |
projectsMigrator KubermaticProjectsMigratorConfiguration | ProjectsMigrator configures the migrator for user projects. |
pprofEndpoint string | PProfEndpoint controls the port the master-controller-manager should listen on to provide pprof data. This port is never exposed from the container and only available via port-forwardings. |
resources ResourceRequirements | Resources describes the requested and maximum allowed CPU/memory usage. |
debugLog boolean | DebugLog enables more verbose logging. |
replicas integer | Replicas sets the number of pod replicas for the master-controller-manager. |
KubermaticProjectsMigratorConfiguration configures the Kubermatic master controller-manager.
Appears in:
| Field | Description |
|---|---|
dryRun boolean | DryRun makes the migrator only log the actions it would take. |
KubermaticProxyConfiguration can be used to control how the various Kubermatic components reach external services / the Internet. These settings are reflected as environment variables for the Kubermatic pods.
Appears in:
| Field | Description |
|---|---|
http string | HTTP is the full URL to the proxy to use for plaintext HTTP connections, e.g. “http://internalproxy.example.com:8080”. |
https string | HTTPS is the full URL to the proxy to use for encrypted HTTPS connections, e.g. “http://secureinternalproxy.example.com:8080”. |
noProxy string | NoProxy is a comma-separated list of hostnames / network masks for which no proxy shall be used. If you make use of proxies, this list should contain all local and cluster-internal domains and networks, e.g. “10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,mydomain”. The operator will always prepend the following elements to this list if proxying is configured (i.e. HTTP/HTTPS are not empty): “127.0.0.1/8”, “localhost”, “.local”, “.local.”, “kubernetes”, “.default”, “.svc” |
KubermaticSeedControllerConfiguration configures the Kubermatic seed controller-manager.
Appears in:
| Field | Description |
|---|---|
dockerRepository string | DockerRepository is the repository containing the Kubermatic seed-controller-manager image. |
backupStoreContainer string | BackupStoreContainer is the container used for shipping etcd snapshots to a backup location. |
backupDeleteContainer string | BackupDeleteContainer is the container used for deleting etcd snapshots from a backup location. This container is only relevant when the new backup/restore controllers are enabled. |
backupCleanupContainer string | BackupCleanupContainer is the container used for removing expired backups from the storage location. This container is only relevant when the old, deprecated backup controllers are enabled. |
maximumParallelReconciles integer | MaximumParallelReconciles limits the number of cluster reconciliations that are active at any given time. |
pprofEndpoint string | PProfEndpoint controls the port the seed-controller-manager should listen on to provide pprof data. This port is never exposed from the container and only available via port-forwardings. |
resources ResourceRequirements | Resources describes the requested and maximum allowed CPU/memory usage. |
debugLog boolean | DebugLog enables more verbose logging. |
replicas integer | Replicas sets the number of pod replicas for the seed-controller-manager. |
KubermaticSetting is the type representing a KubermaticSetting.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | KubermaticSetting |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec SettingSpec |
KubermaticSettingList is a list of settings.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | KubermaticSettingList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items KubermaticSetting array |
KubermaticUIConfiguration configures the dashboard.
Appears in:
| Field | Description |
|---|---|
dockerRepository string | DockerRepository is the repository containing the Kubermatic dashboard image. |
dockerTag string | DockerTag is used to overwrite the dashboard Docker image tag and is only for development purposes. This field must not be set in production environments. — |
config string | Config sets flags for various dashboard features. |
resources ResourceRequirements | Resources describes the requested and maximum allowed CPU/memory usage. |
replicas integer | Replicas sets the number of pod replicas for the UI deployment. |
KubermaticUserClusterConfiguration controls various aspects of the user-created clusters.
Appears in:
| Field | Description |
|---|---|
kubermaticDockerRepository string | KubermaticDockerRepository is the repository containing the Kubermatic user-cluster-controller-manager image. |
dnatControllerDockerRepository string | DNATControllerDockerRepository is the repository containing the dnat-controller image. |
etcdLauncherDockerRepository string | EtcdLauncherDockerRepository is the repository containing the Kubermatic etcd-launcher image. |
overwriteRegistry string | OverwriteRegistry specifies a custom Docker registry which will be used for all images used for user clusters (user cluster control plane + addons). This also applies to the KubermaticDockerRepository and DNATControllerDockerRepository fields. |
addons KubermaticAddonsConfiguration | Addons controls the optional additions installed into each user cluster. |
nodePortRange string | NodePortRange is the port range for customer clusters - this must match the NodePort range of the seed cluster. |
monitoring KubermaticUserClusterMonitoringConfiguration | Monitoring can be used to fine-tune to in-cluster Prometheus. |
disableApiserverEndpointReconciling boolean | DisableAPIServerEndpointReconciling can be used to toggle the --endpoint-reconciler-type flag for the Kubernetes API server. |
etcdVolumeSize string | EtcdVolumeSize configures the volume size to use for each etcd pod inside user clusters. |
apiserverReplicas integer | APIServerReplicas configures the replica count for the API-Server deployment inside user clusters. |
machineController MachineControllerConfiguration | MachineController configures the Machine Controller |
operatingSystemManager OperatingSystemManager | OperatingSystemManager configures the image repo and the tag version for osm deployment. |
KubermaticUserClusterMonitoringConfiguration can be used to fine-tune to in-cluster Prometheus.
Appears in:
| Field | Description |
|---|---|
disableDefaultRules boolean | DisableDefaultRules disables the recording and alerting rules. |
disableDefaultScrapingConfigs boolean | DisableDefaultScrapingConfigs disables the default scraping targets. |
customRules string | CustomRules can be used to inject custom recording and alerting rules. This field must be a YAML-formatted string with a group element at its root, as documented on https://prometheus.io/docs/prometheus/2.14/configuration/alerting_rules/. |
customScrapingConfigs string | CustomScrapingConfigs can be used to inject custom scraping rules. This must be a YAML-formatted string containing an array of scrape configurations as documented on https://prometheus.io/docs/prometheus/2.14/configuration/configuration/#scrape_config. |
scrapeAnnotationPrefix string | ScrapeAnnotationPrefix (if set) is used to make the in-cluster Prometheus scrape pods inside the user clusters. |
Appears in:
| Field | Description |
|---|---|
dockerRepository string | DockerRepository is the repository containing the component’s image. |
resources ResourceRequirements | Resources describes the requested and maximum allowed CPU/memory usage. |
KubermaticVPAConfiguration configures the Kubernetes VPA.
Appears in:
| Field | Description |
|---|---|
recommender KubermaticVPAComponent | |
updater KubermaticVPAComponent | |
admissionController KubermaticVPAComponent |
KubermaticVersioningConfiguration configures the available and default Kubernetes versions.
Appears in:
| Field | Description |
|---|---|
versions Semver array | Versions lists the available versions. |
default Semver | Default is the default version to offer users. |
updates Update array | Updates is a list of available and automatic upgrades. All ’to’ versions must be configured in the version list for this orchestrator. Each update may optionally be configured to be ‘automatic: true’, in which case the controlplane of all clusters whose version matches the ‘from’ directive will get updated to the ’to’ version. If automatic is enabled, the ’to’ version must be a version and not a version range. Also, updates may set ‘automaticNodeUpdate: true’, in which case Nodes will get updates as well. ‘automaticNodeUpdate: true’ implies ‘automatic: true’ as well, because Nodes may not have a newer version than the controlplane. |
providerIncompatibilities Incompatibility array | ProviderIncompatibilities lists all the Kubernetes version incompatibilities |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
kubeconfig string |
KubevirtCloudSpec specifies the access data to Kubevirt.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
kubeconfig string | The cluster’s kubeconfig file, encoded with base64. |
csiKubeconfig string |
Appears in:
| Field | Description |
|---|---|
leaseDurationSeconds integer | LeaseDurationSeconds is the duration in seconds that non-leader candidates will wait to force acquire leadership. This is measured against time of last observed ack. |
renewDeadlineSeconds integer | RenewDeadlineSeconds is the duration in seconds that the acting controlplane will retry refreshing leadership before giving up. |
retryPeriodSeconds integer | RetryPeriodSeconds is the duration in seconds the LeaderElector clients should wait between tries of actions. |
LoggingRateLimitSettings contains rate-limiting configuration for logging in the user cluster.
Appears in:
| Field | Description |
|---|---|
ingestionRate integer | IngestionRate represents ingestion rate limit in requests per second (nginx rate in r/s). |
ingestionBurstSize integer | IngestionBurstSize represents ingestion burst size in number of requests (nginx burst). |
queryRate integer | QueryRate represents query request rate limit per second (nginx rate in r/s). |
queryBurstSize integer | QueryBurstSize represents query burst size in number of requests (nginx burst). |
MLAAdminSetting is the object representing cluster-specific administrator settings for KKP user cluster MLA (monitoring, logging & alerting) stack.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | MLAAdminSetting |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec MLAAdminSettingSpec |
MLAAdminSettingList specifies a list of administrtor settings for KKP user cluster MLA (monitoring, logging & alerting) stack.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | MLAAdminSettingList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items MLAAdminSetting array |
MLAAdminSettingSpec specifies the cluster-specific administrator settings for KKP user cluster MLA (monitoring, logging & alerting) stack.
Appears in:
| Field | Description |
|---|---|
clusterName string | ClusterName is the name of the user cluster whose MLA settings are defined in this object. |
monitoringRateLimits MonitoringRateLimitSettings | MonitoringRateLimits contains rate-limiting configuration for monitoring in the user cluster. |
loggingRateLimits LoggingRateLimitSettings | LoggingRateLimits contains rate-limiting configuration logging in the user cluster. |
Appears in:
| Field | Description |
|---|---|
monitoringEnabled boolean | MonitoringEnabled is the flag for enabling monitoring in user cluster. |
loggingEnabled boolean | LoggingEnabled is the flag for enabling logging in user cluster. |
monitoringResources ResourceRequirements | MonitoringResources is the resource requirements for user cluster prometheus. |
loggingResources ResourceRequirements | LoggingResources is the resource requirements for user cluster promtail. |
monitoringReplicas integer | MonitoringReplicas is the number of desired pods of user cluster prometheus deployment. |
MachineControllerConfiguration configures Machine Controller.
Appears in:
| Field | Description |
|---|---|
imageRepository string | ImageRepository is used to override the Machine Controller image repository. It is only for development, tests and PoC purposes. This field must not be set in production environments. |
imageTag string | ImageTag is used to override the Machine Controller image. It is only for development, tests and PoC purposes. This field must not be set in production environments. |
Appears in:
| Field | Description |
|---|---|
minCPU integer | Minimal number of vCPU |
maxCPU integer | Maximal number of vCPU |
minRAM integer | Minimal RAM size in GB |
maxRAM integer | Maximum RAM size in GB |
enableGPU boolean |
MachineNetworkingConfig specifies the networking parameters used for IPAM.
Appears in:
| Field | Description |
|---|---|
cidr string | |
gateway string | |
dnsServers string array |
Match contains the constraint to resource matching data.
Appears in:
| Field | Description |
|---|---|
kinds Kind array | Kinds accepts a list of objects with apiGroups and kinds fields that list the groups/kinds of objects to which the constraint will apply. If multiple groups/kinds objects are specified, only one match is needed for the resource to be in scope |
scope string | Scope accepts *, Cluster, or Namespaced which determines if cluster-scoped and/or namesapced-scoped resources are selected. (defaults to *) |
namespaces string array | Namespaces is a list of namespace names. If defined, a constraint will only apply to resources in a listed namespace. |
excludedNamespaces string array | ExcludedNamespaces is a list of namespace names. If defined, a constraint will only apply to resources not in a listed namespace. |
labelSelector LabelSelector | LabelSelector is a standard Kubernetes label selector. |
namespaceSelector LabelSelector | NamespaceSelector is a standard Kubernetes namespace selector. If defined, make sure to add Namespaces to your configs.config.gatekeeper.sh object to ensure namespaces are synced into OPA |
MeteringConfiguration contains all the configuration for the metering tool.
Appears in:
| Field | Description |
|---|---|
enabled boolean | |
storageClassName string | StorageClassName is the name of the storage class that the metering tool uses to save processed files before exporting it to s3 bucket. Default value is kubermatic-fast. |
storageSize string | StorageSize is the size of the storage class. Default value is 100Gi. |
Appears in:
| Field | Description |
|---|---|
loggingEnabled boolean | |
loggingEnforced boolean | |
monitoringEnabled boolean | |
monitoringEnforced boolean |
MonitoringRateLimitSettings contains rate-limiting configuration for monitoring in the user cluster.
Appears in:
| Field | Description |
|---|---|
ingestionRate integer | IngestionRate represents the ingestion rate limit in samples per second (Cortex ingestion_rate). |
ingestionBurstSize integer | IngestionBurstSize represents ingestion burst size in samples per second (Cortex ingestion_burst_size). |
maxSeriesPerMetric integer | MaxSeriesPerMetric represents maximum number of series per metric (Cortex max_series_per_metric). |
maxSeriesTotal integer | MaxSeriesTotal represents maximum number of series per this user cluster (Cortex max_series_per_user). |
queryRate integer | QueryRate represents query request rate limit per second (nginx rate in r/s). |
queryBurstSize integer | QueryBurstSize represents query burst size in number of requests (nginx burst). |
maxSamplesPerQuery integer | MaxSamplesPerQuery represents maximum number of samples during a query (Cortex max_samples_per_query). |
maxSeriesPerQuery integer | MaxSeriesPerQuery represents maximum number of timeseries during a query (Cortex max_series_per_query). |
NetworkRanges represents ranges of network addresses.
Appears in:
| Field | Description |
|---|---|
cidrBlocks string array |
Appears in:
| Field | Description |
|---|---|
NodeportProxyComponent NodeportProxyComponent | |
loadBalancerService EnvoyLoadBalancerService |
NodeSettings are node specific flags which can be configured on datacenter level.
Appears in:
| Field | Description |
|---|---|
ProxySettings ProxySettings | Optional: Proxy settings for the Nodes in this datacenter. Defaults to the Proxy settings of the seed. |
insecureRegistries string array | Optional: These image registries will be configured as insecure on the container runtime. |
registryMirrors string array | Optional: These image registries will be configured as registry mirrors on the container runtime. |
pauseImage string | Optional: Translates to –pod-infra-container-image on the kubelet. If not set, the kubelet will default it. |
containerdRegistryMirrors ContainerRuntimeContainerd | Optional: ContainerdRegistryMirrors configure registry mirrors endpoints. Can be used multiple times to specify multiple mirrors. |
Appears in:
| Field | Description |
|---|---|
dockerRepository string | DockerRepository is the repository containing the component’s image. |
resources ResourceRequirements | Resources describes the requested and maximum allowed CPU/memory usage. |
Appears in:
| Field | Description |
|---|---|
disable boolean | Disable will prevent the Kubermatic Operator from creating a nodeport-proxy setup on the seed cluster. This should only be used if a suitable replacement is installed (like the nodeport-proxy Helm chart). |
annotations object (keys:string, values:string) | Annotations are used to further tweak the LoadBalancer integration with the cloud provider where the seed cluster is running. Deprecated: Use .envoy.loadBalancerService.annotations instead. |
envoy NodePortProxyComponentEnvoy | Envoy configures the Envoy application itself. |
envoyManager NodeportProxyComponent | EnvoyManager configures the Kubermatic-internal Envoy manager. |
updater NodeportProxyComponent | Updater configures the component responsible for updating the LoadBalancer service. |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
proxyURL string | ProxyURL is used to optionally configure a HTTP proxy to access Nutanix Prism Central. |
username string | Username is the username to access the Nutanix Prism Central API. |
password string | Password is the password corresponding to the provided user. |
clusterName string | ClusterName is the Nutanix cluster to deploy resources and nodes to. |
projectName string | ProjectName is the optional Nutanix project to use. If none is given, no project will be used. |
csiUsername string | Prism Element Username for csi driver |
csiPassword string | Prism Element Password for csi driver |
csiEndpoint string | CSIEndpoint to access Nutanix Prism Element for csi driver |
csiPort integer | CSIPort to use when connecting to the Nutanix Prism Element endpoint (defaults to 9440) |
NutanixCSIConfig contains credentials and the endpoint for the Nutanix Prism Element to which the CSI driver connects.
Appears in:
| Field | Description |
|---|---|
username string | Prism Element Username for csi driver |
password string | Prism Element Password for csi driver |
endpoint string | Prism Element Endpoint to access Nutanix Prism Element for csi driver |
port integer | Optional: Port to use when connecting to the Nutanix Prism Element endpoint (defaults to 9440) |
storageContainer string | Optional: defaults to “SelfServiceContainer” |
fstype string | Optional: defaults to “xfs” |
ssSegmentedIscsiNetwork boolean | Optional: defaults to “false” |
NutanixCloudSpec specifies the access data to Nutanix.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
clusterName string | ClusterName is the Nutanix cluster that this user cluster will be deployed to. |
projectName string | ProjectName is the project that this cluster is deployed into. If none is given, no project will be used. |
proxyURL string | |
username string | |
password string | |
csi NutanixCSIConfig | NutanixCSIConfig for csi driver that connects to a prism element |
Appears in:
| Field | Description |
|---|---|
issuerURL string | |
clientID string | |
clientSecret string | |
usernameClaim string | |
groupsClaim string | |
requiredClaim string | |
extraScopes string |
Appears in:
| Field | Description |
|---|---|
enabled boolean | Enabled is the flag for enabling OPA integration |
webhookTimeoutSeconds integer | WebhookTimeout is the timeout that is set for the gatekeeper validating webhook admission review calls. By default 10 seconds. |
experimentalEnableMutation boolean | Enable mutation |
controllerResources ResourceRequirements | ControllerResources is the resource requirements for user cluster gatekeeper controller. |
auditResources ResourceRequirements | AuditResources is the resource requirements for user cluster gatekeeper audit. |
Appears in:
| Field | Description |
|---|---|
enabled boolean | |
enforced boolean |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
useToken boolean | |
applicationCredentialID string | |
applicationCredentialSecret string | |
username string | |
password string | |
project string | |
projectID string | |
domain string | |
network string | |
securityGroups string | |
floatingIPPool string | |
routerID string | |
subnetID string |
OpenstackCloudSpec specifies access data to an OpenStack cloud.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
username string | |
password string | |
project string | project, formally known as tenant. |
projectID string | project id, formally known as tenantID. |
domain string | |
applicationCredentialID string | |
applicationCredentialSecret string | |
useToken boolean | |
token string | Used internally during cluster creation |
network string | Network holds the name of the internal network When specified, all worker nodes will be attached to this network. If not specified, a network, subnet & router will be created |
| Note that the network is internal if the “External” field is set to false | |
securityGroups string | |
nodePortsAllowedIPRange string | |
floatingIPPool string | FloatingIPPool holds the name of the public network The public network is reachable from the outside world and should provide the pool of IP addresses to choose from. |
| When specified, all worker nodes will receive a public ip from this floating ip pool | |
| Note that the network is external if the “External” field is set to true | |
routerID string | |
subnetID string | |
useOctavia boolean | Whether or not to use Octavia for LoadBalancer type of Service implementation instead of using Neutron-LBaaS. Attention:Openstack CCM use Octavia as default load balancer implementation since v1.17.0 |
| Takes precedence over the ‘use_octavia’ flag provided at datacenter level if both are specified. |
Appears in:
| Field | Description |
|---|---|
minimumVCPUs integer | VCPUs is the minimum required amount of (virtual) CPUs |
minimumMemory integer | MinimumMemory is the minimum required amount of memory, measured in MB |
OperatingSystemManager configures the image repo and the tag version for osm deployment.
Appears in:
| Field | Description |
|---|---|
imageRepository string | ImageRepository is used to override the OperatingSystemManager image repository. It is recommended to use this field only for development, tests and PoC purposes. For production environments. it is not recommended, to use this field due to compatibility with the overall KKP stack. |
imageTag string | ImageTag is used to override the OperatingSystemManager image. It is recommended to use this field only for development, tests and PoC purposes. For production environments. it is not recommended, to use this field due to compatibility with the overall KKP stack. |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
apiKey string | |
projectID string | |
billingCycle string |
PacketCloudSpec specifies access data to a Packet cloud.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
apiKey string | |
projectID string | |
billingCycle string |
Preset is the type representing a Preset.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | Preset |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec PresetSpec |
PresetList is the type representing a PresetList.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | PresetList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Preset array | List of presets |
Presets specifies default presets for supported providers.
Appears in:
| Field | Description |
|---|---|
digitalocean Digitalocean | |
hetzner Hetzner | |
azure Azure | |
vsphere VSphere | |
aws AWS | |
openstack Openstack | |
packet Packet | |
gcp GCP | |
kubevirt Kubevirt | |
alibaba Alibaba | |
anexia Anexia | |
nutanix Nutanix | |
gke GKE | |
eks EKS | |
aks AKS | |
requiredEmails string array | |
enabled boolean |
Project is the type describing a project.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | Project |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec ProjectSpec | |
status ProjectStatus |
ProjectList is a collection of projects.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | ProjectList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Project array |
ProjectSpec is a specification of a project.
Appears in:
| Field | Description |
|---|---|
name string |
ProjectStatus represents the current status of a project.
Appears in:
| Field | Description |
|---|---|
phase ProjectPhase |
Appears in:
| Field | Description |
|---|---|
enabled boolean | |
datacenter string |
Underlying type: string
Appears in:
ProxySettings allow configuring a HTTP proxy for the controlplanes and nodes.
Appears in:
| Field | Description |
|---|---|
httpProxy ProxyValue | Optional: If set, this proxy will be configured for both HTTP and HTTPS. |
noProxy ProxyValue | Optional: If set this will be set as NO_PROXY environment variable on the node; The value must be a comma-separated list of domains for which no proxy should be used, e.g. “*.example.com,internal.dev”. Note that the in-cluster apiserver URL will be automatically prepended to this value. |
Underlying type: string
Appears in:
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | RuleGroup |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec RuleGroupSpec |
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | RuleGroupList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items RuleGroup array |
Appears in:
| Field | Description |
|---|---|
ruleGroupType RuleGroupType | RuleGroupType is the type of this ruleGroup applies to. It can be Metrics or Logs. |
cluster ObjectReference | Cluster is the reference to the cluster the ruleGroup should be created in. |
data integer array | Data contains the RuleGroup data. Ref: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group |
Underlying type: string
Appears in:
Appears in:
| Field | Description |
|---|---|
owner string | |
name string | |
fingerprint string | |
publicKey string | |
clusters string array |
Seed is the type representing a SeedDatacenter.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | Seed |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec SeedSpec |
SeedDatacenterList is the type representing a SeedDatacenterList.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | SeedList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Seed array | List of seeds |
SeedMLASettings allow configuring seed level MLA (Monitoring, Logging & Alerting) stack settings.
Appears in:
| Field | Description |
|---|---|
userClusterMLAEnabled boolean | Optional: UserClusterMLAEnabled controls whether the user cluster MLA (Monitoring, Logging & Alerting) stack is enabled in the seed. |
The spec for a seed data.
Appears in:
| Field | Description |
|---|---|
country string | Optional: Country of the seed as ISO-3166 two-letter code, e.g. DE or UK. For informational purposes in the Kubermatic dashboard only. |
location string | Optional: Detailed location of the cluster, like “Hamburg” or “Datacenter 7”. For informational purposes in the Kubermatic dashboard only. |
kubeconfig ObjectReference | A reference to the Kubeconfig of this cluster. The Kubeconfig must have cluster-admin privileges. This field is mandatory for every seed, even if there are no datacenters defined yet. |
datacenters object (keys:string, values:Datacenter) | Datacenters contains a map of the possible datacenters (DCs) in this seed. Each DC must have a globally unique identifier (i.e. names must be unique across all seeds). |
seedDNSOverwrite string | Optional: This can be used to override the DNS name used for this seed. By default the seed name is used. |
nodeportProxy NodeportProxyConfig | NodeportProxy can be used to configure the NodePort proxy service that is responsible for making user-cluster control planes accessible from the outside. |
proxySettings ProxySettings | Optional: ProxySettings can be used to configure HTTP proxy settings on the worker nodes in user clusters. However, proxy settings on nodes take precedence. |
exposeStrategy ExposeStrategy | Optional: ExposeStrategy explicitly sets the expose strategy for this seed cluster, if not set, the default provided by the master is used. |
mla SeedMLASettings | Optional: MLA allows configuring seed level MLA (Monitoring, Logging & Alerting) stack settings. |
defaultComponentSettings ComponentSettings | DefaultComponentSettings are default values to set for newly created clusters. Deprecated: Use DefaultClusterTemplate instead. |
defaultClusterTemplate string | DefaultClusterTemplate is the name of a cluster template of scope “seed” that is used to default all new created clusters |
metering MeteringConfiguration | Metering configures the metering tool on user clusters across the seed. |
etcdBackupRestore EtcdBackupRestore | EtcdBackupRestore holds the configuration of the automatic etcd backup restores for the Seed; if this is set, the new backup/restore controllers are enabled for this Seed. |
Appears in:
| Field | Description |
|---|---|
tokenVolumeProjectionEnabled boolean | |
issuer string | Issuer is the identifier of the service account token issuer If this is not specified, it will be set to the URL of apiserver by default |
apiAudiences string array | APIAudiences are the Identifiers of the API If this is not specified, it will be set to a single element list containing the issuer URL |
Appears in:
| Field | Description |
|---|---|
customLinks CustomLink array | |
defaultNodeCount integer | |
displayDemoInfo boolean | |
displayAPIDocs boolean | |
displayTermsOfService boolean | |
enableDashboard boolean | |
enableOIDCKubeconfig boolean | |
userProjectsLimit integer | |
restrictProjectCreation boolean | |
enableExternalClusterImport boolean | |
cleanupOptions CleanupOptions | |
opaOptions OpaOptions | |
mlaOptions MlaOptions | |
mlaAlertmanagerPrefix string | |
mlaGrafanaPrefix string | |
machineDeploymentVMResourceQuota MachineDeploymentVMResourceQuota |
Appears in:
| Field | Description |
|---|---|
resources ResourceRequirements |
Update represents an update option for a user cluster.
Appears in:
| Field | Description |
|---|---|
from string | From is the version from which an update is allowed. Wildcards are allowed, e.g. “1.18.*”. |
to string | To is the version to which an update is allowed. Must be a valid version if automatic is set to true, e.g. “1.20.13”. Can be a wildcard otherwise, e.g. “1.20.*”. |
automatic boolean | Automatic controls whether this update is executed automatically for the control plane of all matching user clusters. — |
automaticNodeUpdate boolean | Automatic controls whether this update is executed automatically for the worker nodes of all matching user clusters. — |
Appears in:
| Field | Description |
|---|---|
start string | |
length string |
User specifies a user.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | User |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec UserSpec | |
status UserStatus |
UserList is a list of users.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | UserList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items User array |
UserProjectBinding specifies a binding between a user and a project This resource is used by the user management to manipulate members of the given project.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | UserProjectBinding |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec UserProjectBindingSpec |
UserProjectBindingList is a list of users.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | UserProjectBindingList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items UserProjectBinding array |
UserProjectBindingSpec specifies a user.
Appears in:
| Field | Description |
|---|---|
userEmail string | |
projectID string | |
group string |
UserSSHKey specifies a users UserSSHKey.
Appears in:
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | UserSSHKey |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec SSHKeySpec |
UserSSHKeyList specifies a users UserSSHKey.
| Field | Description |
|---|---|
apiVersion string | kubermatic.k8c.io/v1 |
kind string | UserSSHKeyList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items UserSSHKey array |
UserSettings represent an user settings.
Appears in:
| Field | Description |
|---|---|
selectedTheme string | |
itemsPerPage integer | |
selectedProjectID string | |
selectProjectTableView boolean | |
collapseSidenav boolean | |
displayAllProjectsForAdmin boolean | |
lastSeenChangelogVersion string |
UserSpec specifies a user.
Appears in:
| Field | Description |
|---|---|
id string | |
name string | |
email string | |
admin boolean | |
settings UserSettings | |
invalidTokensReference GlobalSecretKeySelector |
UserStatus stores status information about a user.
Appears in:
| Field | Description |
|---|---|
lastSeen Time |
Appears in:
| Field | Description |
|---|---|
ProviderPreset ProviderPreset | |
username string | |
password string | |
vmNetName string | |
datastore string | |
datastoreCluster string | |
resourcePool string |
VSphereCloudSpec specifies access data to VSphere cloud.
Appears in:
| Field | Description |
|---|---|
credentialsReference GlobalSecretKeySelector | |
username string | Username is the vSphere user name. |
password string | Password is the vSphere user password. |
vmNetName string | VMNetName is the name of the vSphere network. |
folder string | Folder is the folder to be used to group the provisioned virtual machines. |
datastore string | Datastore to be used for storing virtual machines and as a default for dynamic volume provisioning, it is mutually exclusive with DatastoreCluster. |
datastoreCluster string | DatastoreCluster to be used for storing virtual machines, it is mutually exclusive with Datastore. |
storagePolicy string | StoragePolicy to be used for storage provisioning |
resourcePool string | ResourcePool is used to manage resources such as cpu and memory for vSphere virtual machines. The resource pool should be defined on vSphere cluster level. |
infraManagementUser VSphereCredentials | This user will be used for everything except cloud provider functionality |
VSphereCredentials credentials represents a credential for accessing vSphere.
Appears in:
| Field | Description |
|---|---|
username string | |
password string |