Skip to content

Commit 87a2c54

Browse files
authored
docs(k8s): big revamp (#3124)
1 parent 55801ca commit 87a2c54

28 files changed

+443
-425
lines changed

cmd/scw/testdata/test-all-usage-k8s-cluster-create-usage.golden

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,71 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Create a new Kubernetes cluster on a Scaleway account.
3+
Create a new Kubernetes cluster in a Scaleway region.
44

55
USAGE:
66
scw k8s cluster create [arg=value ...]
77

88
EXAMPLES:
9-
Create a Kubernetes cluster named foo with cilium as CNI, in version 1.24.7 and with a pool named default composed of 3 DEV1-M
10-
scw k8s cluster create name=foo version=1.24.7 pools.0.size=3 pools.0.node-type=DEV1-M pools.0.name=default
9+
Create a Kubernetes cluster named foo with cilium as CNI, in version 1.27.0 and with a pool named default composed of 3 DEV1-M
10+
scw k8s cluster create name=foo version=1.27.0 pools.0.size=3 pools.0.node-type=DEV1-M pools.0.name=default
1111

12-
Create a Kubernetes cluster named bar, tagged, calico as CNI, in version 1.24.7 and with a tagged pool named default composed of 2 RENDER-S and autohealing and autoscaling enabled (between 1 and 10 nodes)
13-
scw k8s cluster create name=bar version=1.24.7 tags.0=tag1 tags.1=tag2 cni=calico pools.0.size=2 pools.0.node-type=RENDER-S pools.0.min-size=1 pools.0.max-size=10 pools.0.autohealing=true pools.0.autoscaling=true pools.0.tags.0=pooltag1 pools.0.tags.1=pooltag2 pools.0.name=default
12+
Create a Kubernetes cluster named bar, tagged, calico as CNI, in version 1.27.0 and with a tagged pool named default composed of 2 RENDER-S and autohealing and autoscaling enabled (between 1 and 10 nodes)
13+
scw k8s cluster create name=bar version=1.27.0 tags.0=tag1 tags.1=tag2 cni=calico pools.0.size=2 pools.0.node-type=RENDER-S pools.0.min-size=1 pools.0.max-size=10 pools.0.autohealing=true pools.0.autoscaling=true pools.0.tags.0=pooltag1 pools.0.tags.1=pooltag2 pools.0.name=default
1414

1515
ARGS:
1616
[project-id] Project ID to use. If none is passed the default project ID will be used
17-
[type] Type of the cluster (possible values are kapsule, multicloud).
18-
name=<generated> Name of the cluster
19-
[description] Description of the cluster
17+
[type] Type of the cluster (possible values are kapsule, multicloud, kapsule-dedicated-8, kapsule-dedicated-16)
18+
name=<generated> Cluster name
19+
[description] Cluster description
2020
[tags.{index}] Tags associated with the cluster
2121
version=latest Kubernetes version of the cluster
22-
cni=cilium Container Network Interface (CNI) plugin that will run in the cluster (unknown_cni | cilium | calico | weave | flannel | kilo)
22+
cni=cilium Container Network Interface (CNI) plugin running in the cluster (unknown_cni | cilium | calico | weave | flannel | kilo)
2323
pools.{index}.name Name of the pool
24-
pools.{index}.node-type Node type is the type of Scaleway Instance wanted for the pool
24+
pools.{index}.node-type 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
2525
[pools.{index}.placement-group-id] Placement group ID in which all the nodes of the pool will be created
2626
[pools.{index}.autoscaling] Defines whether the autoscaling feature is enabled for the pool
2727
pools.{index}.size Size (number of nodes) of the pool
28-
[pools.{index}.min-size] Minimum size of the pool
29-
[pools.{index}.max-size] Maximum size of the pool
30-
[pools.{index}.container-runtime] Container runtime for the nodes of the pool (unknown_runtime | docker | containerd | crio)
28+
[pools.{index}.min-size] Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool
29+
[pools.{index}.max-size] Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool
30+
[pools.{index}.container-runtime] Customization of the container runtime is available for each pool. Note that `docker` has been deprecated since version 1.20 and will be removed by version 1.24 (unknown_runtime | docker | containerd | crio)
3131
[pools.{index}.autohealing] Defines whether the autohealing feature is enabled for the pool
3232
[pools.{index}.tags.{index}] Tags associated with the pool
33-
[pools.{index}.kubelet-args.{key}] Kubelet arguments to be used by this pool. Note that this feature is to be considered as experimental
33+
[pools.{index}.kubelet-args.{key}] Kubelet arguments to be used by this pool. Note that this feature is experimental
3434
[pools.{index}.upgrade-policy.max-unavailable] The maximum number of nodes that can be not ready at the same time
3535
[pools.{index}.upgrade-policy.max-surge] The maximum number of nodes to be created during the upgrade
3636
[pools.{index}.zone] Zone in which the pool's nodes will be spawned
37-
[pools.{index}.root-volume-type] System volume disk type (default_volume_type | l_ssd | b_ssd)
37+
[pools.{index}.root-volume-type] Defines the system volume disk type. Two different 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. `b_ssd` is a remote block storage which means your system is stored on a centralized and resilient cluster (default_volume_type | l_ssd | b_ssd)
3838
[pools.{index}.root-volume-size] System volume disk size
3939
[autoscaler-config.scale-down-disabled] Disable the cluster autoscaler
4040
[autoscaler-config.scale-down-delay-after-add] How long after scale up that scale down evaluation resumes
4141
[autoscaler-config.estimator] Type of resource estimator to be used in scale up (unknown_estimator | binpacking)
4242
[autoscaler-config.expander] Type of node group expander to be used in scale up (unknown_expander | random | most_pods | least_waste | priority | price)
4343
[autoscaler-config.ignore-daemonsets-utilization] Ignore DaemonSet pods when calculating resource utilization for scaling down
4444
[autoscaler-config.balance-similar-node-groups] Detect similar node groups and balance the number of nodes between them
45-
[autoscaler-config.expendable-pods-priority-cutoff] Pods with priority below cutoff will be expendable
46-
[autoscaler-config.scale-down-unneeded-time] How long a node should be unneeded before it is eligible for scale down
47-
[autoscaler-config.scale-down-utilization-threshold] Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
45+
[autoscaler-config.expendable-pods-priority-cutoff] 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
46+
[autoscaler-config.scale-down-unneeded-time] How long a node should be unneeded before it is eligible to be scaled down
47+
[autoscaler-config.scale-down-utilization-threshold] Node utilization level, defined as a sum of requested resources divided by capacity, below which a node can be considered for scale down
4848
[autoscaler-config.max-graceful-termination-sec] Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
49-
[auto-upgrade.enable] Whether or not auto upgrade is enabled for the cluster
49+
[auto-upgrade.enable] Defines whether auto upgrade is enabled for the cluster
5050
[auto-upgrade.maintenance-window.start-hour] Start time of the two-hour maintenance window
5151
[auto-upgrade.maintenance-window.day] Day of the week for the maintenance window (any | monday | tuesday | wednesday | thursday | friday | saturday | sunday)
5252
[feature-gates.{index}] List of feature gates to enable
5353
[admission-plugins.{index}] List of admission plugins to enable
54-
[open-id-connect-config.issuer-url] URL of the provider which allows the API server to discover public signing keys
55-
[open-id-connect-config.client-id] A client id that all tokens must be issued for
56-
[open-id-connect-config.username-claim] JWT claim to use as the user name
57-
[open-id-connect-config.username-prefix] Prefix prepended to username
54+
[open-id-connect-config.issuer-url] 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.com" or "https://login.salesforce.com"
55+
[open-id-connect-config.client-id] A client ID that all tokens must be issued for
56+
[open-id-connect-config.username-claim] 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
57+
[open-id-connect-config.username-prefix] 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
5858
[open-id-connect-config.groups-claim.{index}] JWT claim to use as the user's group
59-
[open-id-connect-config.groups-prefix] Prefix prepended to group claims
60-
[open-id-connect-config.required-claim.{index}] Multiple key=value pairs that describes a required claim in the ID token
59+
[open-id-connect-config.groups-prefix] 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`
60+
[open-id-connect-config.required-claim.{index}] 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
6161
[apiserver-cert-sans.{index}] Additional Subject Alternative Names for the Kubernetes API server certificate
6262
[private-network-id] Private network ID for internal cluster communication (cannot be changed later)
6363
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
6464
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
6565

6666
DEPRECATED ARGS:
67-
[enable-dashboard] Defines if the Kubernetes Dashboard is enabled in the cluster
68-
[ingress] Ingress Controller that will run in the cluster (unknown_ingress | none | nginx | traefik | traefik2)
67+
[enable-dashboard] Defines whether the Kubernetes Dashboard is enabled in the cluster
68+
[ingress] Ingress Controller running in the cluster (deprecated feature) (unknown_ingress | none | nginx | traefik | traefik2)
6969

7070
FLAGS:
7171
-h, --help help for create

cmd/scw/testdata/test-all-usage-k8s-cluster-delete-usage.golden

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Delete a specific cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancers or Block Volumes that are associated with the cluster.
3+
Delete a specific Kubernetes cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancer or Block Volume that are associated with the cluster.
44

55
USAGE:
66
scw k8s cluster delete <cluster-id ...> [arg=value ...]
@@ -9,9 +9,12 @@ EXAMPLES:
99
Delete a cluster
1010
scw k8s cluster delete 11111111-1111-1111-111111111111
1111

12+
Delete a cluster with its Block volumes and Load Balancers
13+
scw k8s cluster delete 11111111-1111-1111-111111111111 with-additional-resources=true
14+
1215
ARGS:
1316
cluster-id ID of the cluster to delete
14-
[with-additional-resources] Set true if you want to delete all volumes (including retain volume type) and loadbalancers whose name start with cluster ID
17+
[with-additional-resources] Defines whether all volumes (including retain volume type) and Load Balancers with a name starting with the cluster ID will also be deleted
1518
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1619

1720
FLAGS:

cmd/scw/testdata/test-all-usage-k8s-cluster-get-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Get details about a specific Kubernetes cluster.
3+
Retrieve information about a specific Kubernetes cluster.
44

55
USAGE:
66
scw k8s cluster get <cluster-id ...> [arg=value ...]
@@ -10,7 +10,7 @@ EXAMPLES:
1010
scw k8s cluster get 11111111-1111-1111-111111111111
1111

1212
ARGS:
13-
cluster-id The ID of the requested cluster
13+
cluster-id ID of the requested cluster
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1515

1616
FLAGS:

cmd/scw/testdata/test-all-usage-k8s-cluster-list-available-versions-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List the versions that a specific Kubernetes cluster is allowed to upgrade to. Results will comprise every patch version greater than the current patch, as well as one minor version ahead of the current version. Any upgrade skipping a minor version will not work.
3+
List the versions that a specific Kubernetes cluster is allowed to upgrade to. Results will include every patch version greater than the current patch, as well as one minor version ahead of the current version. Any upgrade skipping a minor version will not work.
44

55
USAGE:
66
scw k8s cluster list-available-versions <cluster-id ...> [arg=value ...]
77

88
EXAMPLES:
9-
List all available versions for a cluster to upgrade to
9+
List all versions that a cluster can upgrade to
1010
scw k8s cluster list-available-versions 11111111-1111-1111-111111111111
1111

1212
ARGS:
13-
cluster-id ID of the cluster which the available Kuberentes versions will be listed from
13+
cluster-id Cluster ID for which the available Kubernetes versions will be listed
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1515

1616
FLAGS:

cmd/scw/testdata/test-all-usage-k8s-cluster-list-usage.golden

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
List all the existing Kubernetes clusters in a specific Region.
3+
List all existing Kubernetes clusters in a specific region.
44

55
USAGE:
66
scw k8s cluster list [arg=value ...]
@@ -17,10 +17,10 @@ EXAMPLES:
1717

1818
ARGS:
1919
[project-id] Project ID on which to filter the returned clusters
20-
[order-by] Sort order of the returned clusters (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc | status_asc | status_desc | version_asc | version_desc)
21-
[name] Name on which to filter the returned clusters
22-
[status] Status on which to filter the returned clusters (unknown | creating | ready | deleting | deleted | updating | locked | pool_required)
23-
[type] Type on which to filter the returned clusters
20+
[order-by] Sort order of returned clusters (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc | status_asc | status_desc | version_asc | version_desc)
21+
[name] Name to filter on, only clusters containing this substring in their name will be returned
22+
[status] Status to filter on, only clusters with this status will be returned (unknown | creating | ready | deleting | deleted | updating | locked | pool_required)
23+
[type] Type to filter on, only clusters with this type will be returned
2424
[organization-id] Organization ID on which to filter the returned clusters
2525
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
2626

cmd/scw/testdata/test-all-usage-k8s-cluster-reset-admin-token-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Reset the admin token for a specific Kubernetes cluster. This will invalidate the old admin token (which will not be usable afterwards) and create a new one. Note that you will need to redownload kubeconfig in order to keep interacting with the cluster.
3+
Reset the admin token for a specific Kubernetes cluster. This will revoke the old admin token (which will not be usable afterwards) and create a new one. Note that you will need to download kubeconfig again to keep interacting with the cluster.
44

55
USAGE:
66
scw k8s cluster reset-admin-token <cluster-id ...> [arg=value ...]
@@ -10,7 +10,7 @@ EXAMPLES:
1010
scw k8s cluster reset-admin-token 11111111-1111-1111-111111111111
1111

1212
ARGS:
13-
cluster-id ID of the cluster on which the admin token will be renewed
13+
cluster-id Cluster ID on which the admin token will be renewed
1414
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1515

1616
FLAGS:

cmd/scw/testdata/test-all-usage-k8s-cluster-set-type-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Change type of a specific Kubernetes cluster.
3+
Change the type of a specific Kubernetes cluster.
44

55
USAGE:
66
scw k8s cluster set-type <cluster-id ...> [arg=value ...]
@@ -11,7 +11,7 @@ EXAMPLES:
1111

1212
ARGS:
1313
cluster-id ID of the cluster to migrate from one type to another
14-
type Type of the cluster. Note that some migrations are not possible (please refer to product documentation).
14+
type Type of the cluster. Note that some migrations are not possible (please refer to product documentation)
1515
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1616

1717
FLAGS:

0 commit comments

Comments
 (0)