scaleway.k8s.v1.ACLRule
idID of the ACL rule. (UUID format)
ipIP subnet to allow. (IP network)
scaleway_rangesAllow 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.
descriptionDescription of the ACL.
scaleway.k8s.v1.ACLRuleRequest
ipIP subnet to allow. (IP network)
scaleway_rangesAllow 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.
descriptionDescription of the ACL.
scaleway.k8s.v1.CNI
scaleway.k8s.v1.Cluster
idCluster ID.
typeCluster type.
nameCluster name.
statusStatus of the cluster.
versionKubernetes version of the cluster.
regionRegion in which the cluster is deployed.
organization_idID of the Organization owning the cluster.
project_idID of the Project owning the cluster.
tagsTags associated with the cluster.
cniContainer Network Interface (CNI) plugin running in the cluster.
descriptionCluster description.
cluster_urlKubernetes API server URL of the cluster.
dns_wildcardWildcard DNS resolving all the ready cluster nodes.
created_atDate on which the cluster was created. (RFC 3339 format)
updated_atDate 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.
upgrade_availableDefines whether a new Kubernetes version is available.
feature_gatesList of enabled feature gates.
admission_pluginsList of enabled admission plugins.
This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.
apiserver_cert_sansAdditional Subject Alternative Names for the Kubernetes API server certificate.
private_network_idPrivate network ID for internal cluster communication.
commitment_ends_atDate on which it will be possible to switch to a smaller offer. (RFC 3339 format)
iam_nodes_group_idIAM group that nodes are members of (this field might be empty during early stage of cluster creation).
pod_cidrSubnet used for the Pod CIDR. (IP network)
service_cidrSubnet used for the Service CIDR. (IP network)
service_dns_ipIP used for the DNS Service. (IPv4 address)
acl_availableDefines whether ACL is available on the cluster.
scaleway.k8s.v1.ClusterType
nameCluster type name.
availabilityCluster type availability.
max_nodesMaximum number of nodes supported by the offer.
commitment_delayTime period during which you can no longer switch to a lower offer. (in seconds)
slaValue of the Service Level Agreement of the offer.
resiliencyResiliency offered by the offer.
memoryMax RAM allowed for the control plane. (in bytes)
dedicatedReturns information if this offer uses dedicated resources.
audit_logs_supportedTrue if the offer allows activation of the audit log functionality. Please note that audit logs are sent to Cockpit.
scaleway.k8s.v1.CoreV1Taint
keyThe taint key to be applied to a node.
valueThe taint value corresponding to the taint key.
effectEffect defines the effects of Taint.
scaleway.k8s.v1.CreateClusterRequest.PoolConfig
nameName of the pool.
node_typeNode 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.
sizeSize (number of nodes) of the pool.
placement_group_idPlacement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances.
autoscalingDefines whether the autoscaling feature is enabled for the pool.
min_sizeDefines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
max_sizeDefines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
container_runtimeCustomization of the container runtime is available for each pool.
autohealingDefines whether the autohealing feature is enabled for the pool.
tagsTags associated with the pool, see managing tagsOpen in new context.
Kubelet arguments to be used by this pool. Note that this feature is experimental.
Pool upgrade policy.
zoneZone in which the pool's nodes will be spawned.
root_volume_typeDefines the system volume disk type. Several types of volume (volume_type) are provided:.
l_ssdis a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node typessbs_5kis a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limitssbs_15kis a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limitsb_ssdis the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, usesbs_5korsbs_15kinstead.
root_volume_sizeSystem volume disk size. (in bytes)
public_ip_disabledDefines 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_idSecurity 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.
scaleway.k8s.v1.ExternalNode
idnamecluster_urlpool_versioncluster_cakube_tokenkubelet_configexternal_ipcontainerd_versionrunc_versioncni_plugins_versioniam_tokenscaleway.k8s.v1.ListClusterACLRulesResponse
total_countTotal number of ACLs that exist for the cluster.
Paginated returned ACLs.
scaleway.k8s.v1.ListClusterAvailableTypesResponse
Available cluster types for the cluster.
total_countTotal number of types.
scaleway.k8s.v1.ListClusterTypesResponse
total_countTotal number of cluster-types.
Paginated returned cluster-types.
scaleway.k8s.v1.ListClustersResponse
total_countTotal number of clusters.
Paginated returned clusters.
scaleway.k8s.v1.ListNodesResponse
total_countTotal number of nodes.
Paginated returned nodes.
scaleway.k8s.v1.ListPoolsResponse
total_countTotal number of pools that exists for the cluster.
Paginated returned pools.
scaleway.k8s.v1.Node
idNode ID.
pool_idPool ID of the node.
cluster_idCluster ID of the node.
provider_idUnderlying 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).
regionCluster region of the node.
nameName of the node.
statusStatus of the node.
error_messageDetails of the error, if any occurred when managing the node.
created_atDate on which the node was created. (RFC 3339 format)
updated_atDate on which the node was last updated. (RFC 3339 format)
scaleway.k8s.v1.Pool
node_typeNode 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.
sizeSize (number of nodes) of the pool.
idPool ID.
cluster_idCluster ID of the pool.
created_atDate on which the pool was created. (RFC 3339 format)
updated_atDate on which the pool was last updated. (RFC 3339 format)
namePool name.
statusPool status.
versionPool version.
autoscalingDefines whether the autoscaling feature is enabled for the pool.
min_sizeDefines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
max_sizeDefines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool.
container_runtimeCustomization of the container runtime is available for each pool.
autohealingDefines whether the autohealing feature is enabled for the pool.
tagsTags associated with the pool, see managing tagsOpen in new context.
placement_group_idPlacement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances.
Kubelet arguments to be used by this pool. Note that this feature is experimental.
Pool upgrade policy.
zoneZone in which the pool's nodes will be spawned.
root_volume_typeDefines the system volume disk type. Several types of volume (volume_type) are provided:.
l_ssdis a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node typessbs_5kis a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limitssbs_15kis a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limitsb_ssdis the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Not available for new pools, usesbs_5korsbs_15kinstead.
root_volume_sizeSystem volume disk size. (in bytes)
public_ip_disabledDefines 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_idSecurity 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.
regionCluster region of the pool.
scaleway.k8s.v1.Runtime
scaleway.k8s.v1.Version
nameName of the Kubernetes version.
labelLabel of the Kubernetes version.
regionRegion in which this version is available.
available_cnisSupported Container Network Interface (CNI) plugins for this version.
available_container_runtimesSupported container runtimes for this version.
available_feature_gatesSupported feature gates for this version.
available_admission_pluginsSupported admission plugins for this version.
Supported kubelet arguments for this version.
deprecated_atDate from which this version will no longer be available for provisioning. (RFC 3339 format)
end_of_life_atDate from which any remaining clusters on this version will begin to be forcibly upgraded to the next minor version. (RFC 3339 format)
released_atDate at which this version was made available by Kapsule product. (RFC 3339 format)