Get Started
Connect a cluster
Get access to Admiral, install the CLI, and run a Kubernetes agent in a kind cluster on your own machine.
In this step you connect a Kubernetes cluster to Admiral by running a Kubernetes agent inside it. The cluster is a kind cluster on your own machine, so everything in this walkthrough runs locally.
1. Get access
Admiral is open by invitation. Accept the invitation a colleague sent you, or join the waitlist.
2. Install the CLI
brew install admiral-io/tap/admiralBinaries for Linux, macOS, and Windows, and .deb, .rpm, and Arch Linux packages, are on the admiral-cli releases page. Check the install with admiral version.
3. Sign in
admiral auth loginThe CLI opens a browser to sign in and keeps the session. Over SSH, add --no-browser to print the sign-in URL instead.
4. Create a local cluster
kind create cluster --name admiral-demo
kubectl cluster-info --context kind-admiral-demo5. Register and run the agent
Register the agent with Admiral
Registering yields a token the agent uses to authenticate when it pulls work.
admiral agent register --kind kubernetes --name admiral-demoInstall the agent into the cluster
By default the agent's role can read and change every resource in every namespace. That is fine for this throwaway kind cluster. Before you install it on a cluster you care about, read what the Kubernetes agent may do in your cluster and narrow its role.
# TODO: one-command, token-in agent install into the current kube-context
admiral agent install --token <TOKEN>6. Verify it connected
admiral agent listA healthy agent reports a recent heartbeat.
Overview
A local walkthrough that connects a kind cluster, deploys a workload, wires an infrastructure component to it, and promotes it to production.
Applications & environments
Create the resources Admiral deploys into: a source to fetch code from, an application to own it, and the dev and prod environments you promote between.