Skip to main content

Set Up AstroPulse

Everything starts in the console. Sign in, and you can create a cluster and deploy an application with a few clicks. The command line is optional.

In the console​

  1. Open https://astropulse.io/console and sign in, or select Start free on astropulse.io to create an account.
  2. The Dashboard opens: your clusters, workloads, critical vulnerabilities and anything that needs attention. The organization picker at the top of the sidebar shows the organization you are working in, and switches between them.

You should see​

The Dashboard, with New cluster and New application at the top. A new account starts in its own default organization, ready for its first cluster: Deploy a Kubernetes Cluster.

Use the terminal too (optional)​

astroctl runs the same operations from a terminal, for scripts and CI/CD. On macOS or Linux:

Install astroctl​

macOS (Homebrew):

Terminal
brew tap astropulseinc/astroctl
brew trust astropulseinc/astroctl
brew install astroctl

Homebrew asks you to trust a tap that isn't part of Homebrew itself, once.

macOS / Linux (one-line installer):

Terminal
curl -fsSL https://astropulse.io/install.sh | bash

It installs astroctl into ~/.astropulse/bin and adds it to your PATH. Set ASTROCTL_INSTALL_DIR to install somewhere else, or ASTROCTL_NO_MODIFY_PATH=1 to leave your PATH alone.

Verify:

Terminal
astroctl version --client

It prints the installed version without contacting AstroPulse. astroctl version also prints the version of the AstroPulse API it talks to.

Update astroctl​

Update the same way you installed:

  • Homebrew: brew upgrade astroctl
  • One-line installer: astroctl update, or astroctl update --check to only check for a newer version.

Authenticate​

Terminal
astroctl auth login

This opens the browser login flow, creates a default organization if you don't have one, and stores credentials in ~/.config/astropulse/credentials.yml.

If you already belong to an organization, log in for the one you want:

Terminal
astroctl auth login --org-id <org-id>

Scripts and CI/CD: use an API key instead of the browser login: an organization service account key, or your own API key under API Keys in the sidebar. Then:

Terminal
export ASTROPULSE_API_KEY=<your-api-key>

With ASTROPULSE_API_KEY set, astroctl uses that key and skips the browser flow.

Verify​

Terminal
astroctl whoami

You should see your email, organization name, and active API key. If the organization is wrong, astroctl organization list marks the current one with *; switch it:

Terminal
astroctl organization use <org-name-or-id>

Output​

Commands print tables by default. -o json or -o yaml prints the data alone, with no headings or hints, for scripts. A command missing an argument it needs exits non-zero.

Next step​

Continue with Deploy a Kubernetes Cluster.