Skip to main content

Register a cluster you already run

Bring a Kubernetes cluster you already run into AstroPulse: EKS, GKE, AKS, on-premises, edge or a local cluster such as kind. A small agent installs in the cluster with your own kubectl and connects out to AstroPulse, so nothing opens inbound. Once it connects, you deploy to the cluster and manage it like any other. The example registers edge-01.

Before you start​

  • kubectl pointed at the cluster, with rights to install into it.
  • astroctl installed and signed in. The agent installs from your terminal, not from the console.
  • An org admin role, and a plan that includes registered clusters.
  • Want AstroPulse to create the cluster in your cloud instead? Create a cluster.

In the console​

  1. Open Infrastructure › Kubernetes › New cluster and choose Bring your own Kubernetes. The step is named Register.

  2. Enter Cluster name edge-01. Under "With your kubectl pointed at the cluster" the console shows the two commands for that name:

    Open zoom view

    Register cluster, Bring your own Kubernetes: the cluster name edge-01 and the register and status commands

    Register cluster, Bring your own Kubernetes: the cluster name edge-01 and the register and status commandsRegister cluster, Bring your own Kubernetes: the cluster name edge-01 and the register and status commands
    Terminal
    astroctl infra k8s register --cluster-name edge-01
    astroctl infra k8s register status --cluster-name edge-01

  3. Copy them and run them in a terminal whose kubectl points at the cluster. The first installs the agent; the second shows the registration's state.

The link Registration guide: labels, a file, or no install opens How registration works.

You should see​

The cluster appears in the cluster list. Its page, edge-01, reads Registered, and the Agent line on its Overview reads Connected with the last check-in. Once it does, deploy to it: Deploy an application.

Open zoom view

A registered cluster's Overview with the Agent line reading Connected and its last check-in

A registered cluster's Overview with the Agent line reading Connected and its last check-inA registered cluster's Overview with the Agent line reading Connected and its last check-in

Register from a file, without installing, or with labels​

A registration manifest, labels, a split-team install where one team registers and another installs the agent, and every flag are in How registration works.

Other ways in​

  • Nova: ask, for example, "how do I register my current cluster as edge-01?". Nova returns the command for you to run, since the agent installs with your own kubectl.
  • SDK and API: the same operations, in the API reference.

With astroctl​

Terminal
astroctl infra k8s register --cluster-name edge-01
astroctl infra k8s register status --cluster-name edge-01

Every flag: astroctl infra k8s register.

If it's refused​

"Use lowercase letters, numbers and '-', starting and ending with a letter or number"
Cause
The cluster name has another character, or starts or ends with -.
Fix
Change the Cluster name, for example edge-01.
"Registration not available on your current plan"
Cause
Your plan does not include registered clusters.
Fix
Upgrade your plan, then run the command again.
"This cluster is already registered to another organization. An admin of that organization must unregister it first, then it can be registered here."
Cause
An agent from another organization already runs in this cluster.
Fix
Ask an admin of that organization to unregister it, then register it again here.

Next​