Skip to content
Docs
Getting Started

Getting Started with Podplane

Podplane can deploy clusters on AWS, Google Cloud, or Proxmox environments.

Using the Podplane CLI, you can deploy a Podplane cluster in a few minutes.

Every cluster comes with CoreDNS and Cilium CNI built-in. You are also able to select addon components to install like Traefik ingress controller or CSI drivers, either during cluster creation or later using podplane install.

Deploying a cluster first generates versionable infrastructure-as-code artifacts such as OpenTofu/Terraform .tf files for AWS & Google Cloud, which then deploys a cluster into your public or private cloud of choice.

Step 1: Install the Podplane CLI

macOS via Homebrew:

brew install podplane/tap/podplane

or via Go:

go install github.com/podplane/podplane@latest

Step 2: Create Cluster 

podplane cluster create

Follow the prompts to specify:

  • Which cloud/provider to use.
  • Provider config such as account/project/profile and region.
  • Auth server URL, or opt to deploy a new Easy OIDC server.
  • Cluster layout e.g. single node, separate control plane/ingress layers, etc.
  • Networking configuration e.g. CIDR block for VPC and Subnet(s), provider zone(s).
  • Default CPU architecture.
  • Cluster name.
  • Which components to install (e.g. Traefik, CSI drivers, etc)

This will:

  1. Create a podplane.cluster.jsonc file in the current directory
  2. Generate the relevant infrastructure-as-code artifacts
  3. For AWS/Google Cloud:
    1. Confirm if you want to immediately deploy
    2. Deploy using the OpenTofu/Terraform apply command

Step 3: Login

The Podplane CLI can automatically configure your local kubeconfig via kubectl using the login command:

podplane login

This will open a browser window (or print a URL to the terminal) to login via your configured OAuth provider. Once successful, you can then use all your favourite tools e.g.

kubectl get nodes --context cluster-name

Step 4: Deploy Your App

You can use the Podplane CLI to deploy your apps:

podplane deploy web --name hello --image ghcr.io/podplane/hello:latest

This will print a URL you can use to view the hello app.

Note: The deploy template may require specific addon components to be installed in the cluster. If they aren’t installed, the CLI will prompt you to install them e.g. web apps require Traefik ingress controller.

Viewing Logs

Use the Podplane CLI to tail logs for your deployed apps:

podplane logs test
Architecture