Schemas

ID of the ACL rule. (UUID format)

The SRN of the ACL rule.

IP subnet to allow. (IP network)

Allow access to cluster from all Scaleway ranges as defined in https://www.scaleway.com/en/docs/console/account/reference-content/scaleway-network-information/#ip-ranges-used-by-scalewayOpen in new context. Only one rule with this field set to true can be added.

Description of the ACL.

Region of the ACL rule.

IP subnet to allow. (IP network)

Allow access to cluster from all Scaleway ranges as defined in https://www.scaleway.com/en/docs/console/account/reference-content/scaleway-network-information/#ip-ranges-used-by-scalewayOpen in new context. Only one rule with this field set to true can be added.

Description of the ACL.

ACLs that were added.

Cluster ID.

The SRN of the cluster.

Cluster type.

Cluster name.

Status of the cluster.

Kubernetes version of the cluster.

Region in which the cluster is deployed.

ID of the Organization owning the cluster.

ID of the Project owning the cluster.

Tags associated with the cluster.

Container Network Interface (CNI) plugin running in the cluster.

Cluster description.

Kubernetes API server URL of the cluster.

Wildcard DNS resolving all the ready cluster nodes.

Date on which the cluster was created. (RFC 3339 format)

Date on which the cluster was last updated. (RFC 3339 format)

Autoscaler configuration for the cluster, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.mdOpen in new context for details.

Auto upgrade Kubernetes version of the cluster.

Defines whether a new Kubernetes version is available.

List of enabled feature gates.

List of enabled admission plugins.

This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

Additional Subject Alternative Names for the Kubernetes API server certificate.

Private network ID for internal cluster communication.

Date on which it will be possible to switch to a smaller offer. (RFC 3339 format)

IAM group that nodes are members of (this field might be empty during early stage of cluster creation).

IAM application ID for the control plane (this field might be empty during early stage of cluster creation).

Subnet used for the Pod CIDR. (IP network)

Subnet used for the Service CIDR. (IP network)

IP used for the DNS Service. (IPv4 address)

Defines whether auto upgrade is enabled for the cluster.

Maintenance window of the cluster auto upgrades.

Forbid cluster autoscaler to scale down the cluster, defaults to false.

How long after scale up the scale down evaluation resumes.

Type of resource estimator to be used in scale up.

Kubernetes autoscaler strategy to fit pods into nodes, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expandersOpen in new context for details.

Ignore DaemonSet pods when calculating resource utilization for scaling down, defaults to false.

Detect similar node groups and balance the number of nodes between them, defaults to false.

Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.

How long a node should be unneeded before it is eligible for scale down, defaults to 10 minutes.

Node utilization level, defined as a sum of requested resources divided by allocatable capacity, below which a node can be considered for scale down.

Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node, defaults to 600 (10 minutes).

Cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath, defaults to true.

Cluster autoscaler logging level expressed from 0 to 4 (4 being the more verbose), defaults to 2. see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-can-i-increase-the-information-that-the-ca-is-loggingOpen in new context for details.

URL of the provider which allows the API server to discover public signing keys. Only URLs using the https:// scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.comOpen in new context" or "https://login.salesforce.comOpen in new context".

A client ID that all tokens must be issued for.

JWT claim to use as the user name. The default is sub, which is expected to be the end user's unique identifier. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent name collision.

Prefix prepended to username claims to prevent name collision (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag is not provided and username_claim is a value other than email, the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of issuer_url. The value - can be used to disable all prefixing.

JWT claim to use as the user's group.

Prefix prepended to group claims to prevent name collision (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra.

Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value.

Cluster type name.

The SRN of the cluster type.

Cluster type availability.

Maximum number of nodes supported by the offer.

Time period during which you can no longer switch to a lower offer. (in seconds)

Value of the Service Level Agreement of the offer.

Resiliency offered by the offer.

Max RAM allowed for the control plane. (in bytes)

Returns information if this offer uses dedicated resources.

True if the offer allows activation of the audit log functionality. Please note that audit logs are sent to Cockpit.

The region of the cluster type.

The taint key to be applied to a node.

The taint value corresponding to the taint key.

Effect defines the effects of Taint.

Defines whether auto upgrade is enabled for the cluster.

Maintenance window of the cluster auto upgrades.

Forbid cluster autoscaler to scale down the cluster, defaults to false.

How long after scale up the scale down evaluation resumes.

Type of resource estimator to be used in scale up.

Kubernetes autoscaler strategy to fit pods into nodes, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expandersOpen in new context for details.

Ignore DaemonSet pods when calculating resource utilization for scaling down, defaults to false.

Detect similar node groups and balance the number of nodes between them, defaults to false.

Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.

How long a node should be unneeded before it is eligible for scale down, defaults to 10 minutes.

Node utilization level, defined as a sum of requested resources divided by allocatable capacity, below which a node can be considered for scale down.

Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node, defaults to 600 (10 minutes).

Cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath, defaults to true.

Cluster autoscaler logging level expressed from 0 to 4 (4 being the more verbose), defaults to 2. see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-can-i-increase-the-information-that-the-ca-is-loggingOpen in new context for details.

URL of the provider which allows the API server to discover public signing keys. Only URLs using the https:// scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.comOpen in new context" or "https://login.salesforce.comOpen in new context".

A client ID that all tokens must be issued for.

JWT claim to use as the user name. The default is sub, which is expected to be the end user's unique identifier. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent name collision.

Prefix prepended to username claims to prevent name collision (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag is not provided and username_claim is a value other than email, the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of issuer_url. The value - can be used to disable all prefixing.

JWT claim to use as the user's group.

Prefix prepended to group claims to prevent name collision (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra.

Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value.

Name of the pool.

Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster.

Size (number of nodes) of the pool.

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances.

Defines whether the autoscaling feature is enabled for the pool.

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

Customization of the container runtime is available for each pool.

Defines whether the autohealing feature is enabled for the pool.

Tags associated with the pool, see managing tagsOpen in new context.

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

Zone in which the pool's nodes will be spawned.

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

• l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
• sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
• sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
• b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

System volume disk size. (in bytes)

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone.

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

Maximum amount of time before the API forces the drain and deletion of a deleting node. It overrides pods PodDisruptionBudget and terminationGracePeriodSeconds. Defaults to 15 minutes, up to 1 hour. (in seconds)

User data applied and reconciled with the pool.

The maximum number of nodes that can be upgrading at the same time.

The maximum number of nodes to be created during the upgrade, e.g. the pool will scale up to reach size+max_surge before downscaling to size after node upgrades.

The maximum number of nodes that can be upgrading at the same time.

The maximum number of nodes to be created during the upgrade, e.g. the pool will scale up to reach size+max_surge before downscaling to size after node upgrades.

Total number of ACLs that exist for the cluster.

Paginated returned ACLs.

Available cluster types for the cluster.

Total number of types.

Available Kubernetes versions for the cluster.

Total number of cluster-types.

Paginated returned cluster-types.

Total number of clusters.

Paginated returned clusters.

Total number of nodes.

Paginated returned nodes.

Total number of pools that exists for the cluster.

Paginated returned pools.

User data information.

Available Kubernetes versions.

Start time of the two-hour maintenance window.

Day of the week for the maintenance window.

Node ID.

The SRN of the node.

Pool ID of the node.

Cluster ID of the node.

Underlying instance ID. It is prefixed by instance type and location information (see https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderIDOpen in new context).

Cluster region of the node.

Name of the node.

Status of the node.

Details of the error, if any occurred when managing the node.

Date on which the node was created. (RFC 3339 format)

Date on which the node was last updated. (RFC 3339 format)

Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster.

Size (number of nodes) of the pool.

Pool ID. (UUID format)

Cluster ID of the pool. (UUID format)

Date on which the pool was created. (RFC 3339 format)

Date on which the pool was last updated. (RFC 3339 format)

Pool name.

Pool status.

Pool version.

Defines whether the autoscaling feature is enabled for the pool.

Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.

Customization of the container runtime is available for each pool.

Defines whether the autohealing feature is enabled for the pool.

Tags associated with the pool, see managing tagsOpen in new context.

Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. (UUID format)

Kubelet arguments to be used by this pool. Note that this feature is experimental.

Defines how node provisioning should behave during pool version upgrade.

Zone in which the pool's nodes will be spawned.

Defines the system volume disk type. Several types of volume (volume_type) are provided:.

• l_ssd is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types
• sbs_5k is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits
• sbs_15k is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits
• b_ssd is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, use sbs_5k or sbs_15k instead.

System volume disk size. (in bytes)

Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

Security group ID in which all the nodes of the pool will be created. If unset, the pool will use default Kapsule security group in current zone. (UUID format)

Kubernetes labels applied and reconciled on the nodes.

Kubernetes taints applied and reconciled on the nodes.

Kubernetes taints applied at node creation but not reconciled afterwards.

Details of the error, if any occurred when managing the pool.

Maximum amount of time before the API forces the drain and deletion of a deleting node. It overrides pods PodDisruptionBudget and terminationGracePeriodSeconds. Defaults to 15 minutes, up to 1 hour. (in seconds)

The SRN of the pool.

Cluster region of the pool.

The maximum number of nodes that can be upgrading at the same time.

The maximum number of nodes to be created during the upgrade, e.g. the pool will scale up to reach size+max_surge before downscaling to size after node upgrades.

ACLs that were set.

Defines whether auto upgrade is enabled for the cluster.

Maintenance window of the cluster auto upgrades.

Forbid cluster autoscaler to scale down the cluster, defaults to false.

How long after scale up the scale down evaluation resumes.

Type of resource estimator to be used in scale up.

Kubernetes autoscaler strategy to fit pods into nodes, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expandersOpen in new context for details.

Ignore DaemonSet pods when calculating resource utilization for scaling down, defaults to false.

Detect similar node groups and balance the number of nodes between them, defaults to false.

Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.

How long a node should be unneeded before it is eligible for scale down, defaults to 10 minutes.

Node utilization level, defined as a sum of requested resources divided by allocatable capacity, below which a node can be considered for scale down.

Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node, defaults to 600 (10 minutes).

Cluster autoscaler will never delete nodes with pods with local storage, e.g. EmptyDir or HostPath, defaults to true.

Cluster autoscaler logging level expressed from 0 to 4 (4 being the more verbose), defaults to 2. see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-can-i-increase-the-information-that-the-ca-is-loggingOpen in new context for details.

URL of the provider which allows the API server to discover public signing keys. Only URLs using the https:// scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.comOpen in new context" or "https://login.salesforce.comOpen in new context".

A client ID that all tokens must be issued for.

JWT claim to use as the user name. The default is sub, which is expected to be the end user's unique identifier. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent name collision.

Prefix prepended to username claims to prevent name collision (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag is not provided and username_claim is a value other than email, the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of issuer_url. The value - can be used to disable all prefixing.

JWT claim to use as the user's group.

Prefix prepended to group claims to prevent name collision (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra.

Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value.

New maximum number of nodes that can be upgrading at the same time.

New maximum number of nodes to be created during the upgrade.

Key name of a given user data.

Name of the Kubernetes version.

The SRN of the version.

Label of the Kubernetes version.

Region in which this version is available.

Supported Container Network Interface (CNI) plugins for this version.

Supported feature gates for this version.

Supported admission plugins for this version.

Supported kubelet arguments for this version.

Date from which this version will no longer be available for provisioning. (RFC 3339 format)

Date from which any remaining clusters on this version will begin to be forcibly upgraded to the next minor version. (RFC 3339 format)

Date at which this version was made available by Kapsule product. (RFC 3339 format)

Map containing every sub-component version shipped with this Kapsule version.