Scaleway Kapsule
@sntxrr/scaleway-kapsulev2026.10.14.1
01README
Manage a Scaleway Kubernetes Kapsule cluster — sync state, create, update, upgrade, and delete clusters, discover clusters and node pools in a region, and fetch the kubeconfig, via the Kubernetes API with X-Auth-Token auth.
02Release Notes
Declare SPDX license (MIT) in manifest.
03Behaviors
@sntxrr/scaleway-kapsulev2026.07.19.1scaleway_kapsule.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| secretKey | string | Scaleway API secret key. Wire with ${{ vault.get(scaleway, SCW_SECRET_KEY) }}. |
| projectId | string | Scaleway Project ID that owns the Kapsule cluster. |
| region? | string | Region, e.g. fr-par, nl-ams, pl-waw. |
| clusterId? | string | ID of the Kapsule cluster this model manages. Optional — `create` |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the Kapsule cluster's current state (GetCluster).
fn create(name: string, version: string, cni?: string, type?: string, description?: string, tags?: array, pools?: array)
Provision a new Kapsule cluster (CreateCluster) and snapshot it.
| Argument | Type | Description |
|---|---|---|
| name | string | Name of the new Kapsule cluster. |
| version | string | Kubernetes version for the cluster, e.g. 1.30.2. |
| cni? | string | Container Network Interface plugin, e.g. cilium, calico, flannel. |
| type? | string | Cluster type (offer), e.g. kapsule, kapsule-dedicated-4. Optional. |
| description? | string | Optional human-readable description of the cluster. |
| tags? | array | Tags to attach to the new cluster. |
| pools? | array | Initial node pools to create with the cluster. |
fn update(name?: string, description?: string, tags?: array)
Mutate a cluster's mutable fields (UpdateCluster).
| Argument | Type | Description |
|---|---|---|
| name? | string | New name for the cluster. |
| description? | string | New human-readable description of the cluster. |
| tags? | array | Replacement set of tags for the cluster. |
fn upgrade(version: string, upgradePools?: boolean)
Upgrade the cluster to a target Kubernetes version (UpgradeCluster).
| Argument | Type | Description |
|---|---|---|
| version | string | Target Kubernetes version to upgrade the cluster to, e.g. 1.31.0. |
| upgradePools? | boolean | Whether to also upgrade the cluster's node pools to the target version. |
fn delete()
Deprovision the Kapsule cluster (DeleteCluster).
fn list()
Discover all Kapsule clusters in the region (factory).
fn list-pools()
Discover all node pools attached to this cluster (factory).
fn get-kubeconfig()
Fetch the cluster's kubeconfig (base64) and store it in a sensitive snapshot.
Resources
cluster(infinite)— Snapshot of the Kapsule cluster's state
pool(infinite)— Snapshot of a Kapsule node pool
kubeconfig(infinite)— Snapshot of a cluster kubeconfig (sensitive; cluster-admin credentials)
04Previous Versions
2026.07.19.1
2026.07.18.1
05Stats
A
100 / 100
Downloads
27
Archive size
11.4 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
Repository
https://github.com/sntxrr/swamp-scaleway06Platforms
07Labels