Skip to content

Set up a cluster

A cluster is a Kubernetes cluster LakeSail provisions inside your network. It is where jobs, sessions, and notebooks run. This page covers how to create, size, reconfigure, and destroy a cluster.

For a full first-time walkthrough (cloud account → network → cluster), start with the Quickstart. This page is the standalone reference.

Prerequisites

  • A connected cloud account with Active status.
  • A network with Deployed status, in the region you want the cluster.

Create a cluster

  1. Open Compute → Clusters and click Create Cluster.
  2. Fill in:
    • Network: the network the cluster lives in. The cluster inherits its cloud account and region from the network.
    • Cluster Name: a human-readable identifier. Cannot be changed after creation.
    • Cluster tier: choose a tier based on the guidance in the picker. Its details show the management instance, node range, disk, and estimated baseline AWS cost.
    • Allowed IPs List (optional): see Change who can reach the cluster below. Leave empty for private-only access.
    • Collect container metrics (optional): adds per-pod and per-container metrics in AWS. It is off by default and adds AWS charges that rise with load. Container logs are always collected.
  3. Click Create Cluster.

The cluster moves through Pending → Provisioning → Deployed. Provisioning typically takes 15 to 25 minutes while Karpenter, networking, the Sail control plane, and add-ons bootstrap, and the status may remain on Provisioning for an extended period before completing.

Compute vs. management nodes

The tier sizes management nodes (system) only. They run cluster system services. Compute nodes for jobs, sessions, and notebooks are picked per workload, so a larger workload does not require a larger cluster tier. See How compute runs and scales.

Use advanced configuration

The tiers are already sized for their stated use. Turn on Advanced configuration only when you need to set these management-node values yourself:

  • Management Node Size
  • Min / Desired / Max Management Nodes
  • Disk Size (GB)

The form warns you when the selected instance cannot fit the system pods, capacity is too low, or the node counts are out of order. See Troubleshooting for the full list.

Resize an existing cluster

Most properties can be changed in place. The cluster moves to Updating and stays available for existing workloads where possible.

You can edit:

  • Management node size (instance type)
  • Min / Desired / Max management nodes
  • Disk size (GB)
  • Allowed IPs list
  • Container metrics collection

You cannot change (these require creating a new cluster):

  • The network the cluster lives in
  • The cluster name
  • The region (set by the network)

To resize:

  1. Open Compute → Clusters and click into the one you want to change.
  2. Click Edit.
  3. Adjust any of the editable fields. The same validation warnings as create apply.
  4. Click Update Cluster.

The cluster moves Deployed → Updating → Deployed. Changing the management instance family replaces the management node group; the form warns you before you save.

Change who can reach the cluster

The Allowed IPs list controls who can reach the cluster endpoint from outside the VPC.

  • Empty (default): private-only. Only traffic from inside the VPC can reach the endpoint.
  • Comma-separated CIDRs, e.g. 203.0.113.0/24, 10.0.0.0/8: the public endpoint is restricted to listed IPs. VPC-internal traffic always uses the private endpoint.

This setting can be toggled on existing clusters without recreating them. It is a property of the access policy rather than the underlying compute.

When to create a new cluster instead

If the editor will not accept the change (region, network, or name) or the new configuration differs significantly from the current one, create a new cluster alongside the old one. Move workloads over by re-creating sessions and re-targeting jobs, then destroy the original.

Destroy a cluster

Close sessions, stop notebooks, and let job runs finish before destroying a cluster. LakeSail blocks a user-requested destroy while compute is active.

  1. Open the cluster detail page.
  2. Click Destroy (or Delete infrastructure).
  3. Confirm. The cluster moves Destroying → Destroyed, releasing the underlying AWS resources.

Destroying is irreversible

Job run history, catalog registrations, and team assignments stay in the organization, but the compute is released. Budget a few minutes for teardown to complete.

Reading a cluster's state

The console reports three things about a cluster, in the list and again on its detail page. They answer different questions:

SignalQuestion it answers
StatusWhat did the last infrastructure operation do?
ReadinessCan work run here right now?
PodsWhat did the last health check count?

Status shows whether the latest provision or update was successful.

Readiness is usually the one you want. It reads Ready when the cloud account, the network, and the cluster are all usable and there is an endpoint to schedule onto, and Not ready otherwise, naming what blocks it. Unknown means the check has not run or could not finish.

Pods is the evidence behind readiness: how many pods the last health check found running, and how many it could not schedule. A dash means no count was taken. Hover either for the check's own message.

An Update action appears on a cluster whose infrastructure template is out of date, and runs the same update as the row menu.

Lifecycle reference

StatusMeaning
PendingCreation accepted, queued
ProvisioningAWS resources being created
DeployedThe last provision or update completed successfully; check Readiness before scheduling work
UpdatingA configuration change is rolling out
FailedProvisioning or update failed. See the progress panel for the failed stage
DestroyingTeardown in progress
DestroyedCluster resources released; record retained for audit
DeletedRecord removed from the organization

API reference

  • Clusters: CreateExternalCluster, UpdateExternalCluster, DeleteExternalCluster, and the full lifecycle.
  • Networks: required prerequisite.
  • Cloud accounts: required prerequisite.

Can't find the answer here? Email us: support@lakesail.com