Getting Started

Prerequisites

Before you begin, make sure you have:

A Kubernetes cluster (AWS EKS, GCP GKE, Azure AKS, or self-hosted)
kubectl installed and configured
Admin access to your cluster
An Admiral account (Join Waitlist)

Development Status

Admiral is currently in development. This documentation represents planned functionality.

Installation

Install the Admiral CLI

Download and install the Admiral CLI for your operating system:

bash curl -fsSL https://get.admiral.io | sh

powershell irm https://get.admiral.io/install.ps1 | iex

Verify the installation:

admiral version

Connect to Admiral

Authenticate with your Admiral account:

admiral auth login

This will open your browser and prompt you to log in. After authentication, you'll be ready to start using Admiral.

Connect Your Cluster

admiral cluster connect \
  --name production \
  --context my-k8s-context

This installs the Admiral agent in your cluster, which enables:

Application deployments
Infrastructure provisioning
Configuration management
Observability and monitoring

Verify your cluster is connected:

admiral cluster list

Create Your First Application

Create a new application in Admiral:

admiral app create \
  --name myapp \
  --repo https://github.com/myorg/myapp

Configure your application's environments:

admiral env create \
  --app myapp \
  --name production \
  --cluster production

Deploy Your Application

Deploy your application to the production environment:

admiral deploy \
  --app myapp \
  --env production \
  --image myapp:v1.0.0

Admiral will:

Validate your deployment configuration
Apply any infrastructure provisioning
Deploy your application to Kubernetes
Monitor the rollout progress

What's Next?

Now that you have Admiral set up, explore these guides:

Provision Infrastructure - Add databases, caches, and storage
Configure Variables - Set up your configuration hierarchy
Manage Environments - Create and configure environments
Deploy Applications - Advanced deployment strategies

Need Help?

If you encounter any issues during setup, contact our support team.

Quick Reference

Common Commands

# List all applications
admiral app list

# View application details
admiral app info myapp

# List environments
admiral env list --app myapp

# View deployment history
admiral deploy history --app myapp --env production

# Rollback a deployment
admiral deploy rollback --app myapp --env production

# View logs
admiral logs --app myapp --env production

Next Steps

Infrastructure Provisioning

Learn how to provision databases, caches, and other infrastructure from approved Terraform modules.

Learn more →

Variable Management

Understand the three-tier variable hierarchy and how to configure your applications.

Learn more →