# Podplane: replicated key-value database backed by object storage.

> Podplane is an Open Source Kubernetes distribution & PaaS you can deploy in a few minutes to your AWS, Google Cloud, or Proxmox VE environment.

- Website: https://podplane.dev/
- GitHub: https://github.com/podplane/podplane
- LLMs.txt: https://podplane.dev/llms.txt

## Documentation

- [Getting Started](https://podplane.dev/docs/getting-started.md): Get started with Podplane quickly.
- [Architecture](https://podplane.dev/docs/architecture.md): Overview of the Podplane architecture and components
- [Infrastructure](https://podplane.dev/docs/infrastructure.md): How Podplane provisions and manages cloud infrastructure
- [Recommended Infrastructure Topologies](https://podplane.dev/docs/topologies.md): Reference infrastructure and network topologies for small startups
- [VM Configuration](https://podplane.dev/docs/vmconfig.md): How Podplane configures VMs using vmconfig
- [Components](https://podplane.dev/docs/components.md): How Podplane manages cluster components
- [Secrets](https://podplane.dev/docs/secrets.md): How Podplane manages application secrets
- [Seeds](https://podplane.dev/docs/seeds.md): How Podplane seed files initialize Netsy cluster state
- [Templates](https://podplane.dev/docs/templates.md): App deployment templates for web apps and background workers
- [CLI Overview](https://podplane.dev/docs/cli-overview.md): Podplane CLI design and command overview
- [CLI Storage](https://podplane.dev/docs/cli-storage.md): How Podplane classifies CLI-owned files
- [Config Reference](https://podplane.dev/docs/config-reference.md): Reference for Podplane configuration files
- [Contributing](https://podplane.dev/docs/contributing.md): How to contribute to Podplane.
- [Development](https://podplane.dev/docs/development.md): Local development workflow for Podplane itself.

### CLI Reference

> Podplane CLI reference

- [cluster create](https://podplane.dev/docs/cli-reference/cluster-create.md): Generate cluster configuration and deploy infrastructure
- [cluster delete](https://podplane.dev/docs/cli-reference/cluster-delete.md): Remove deployed cluster infrastructure
- [oidc create](https://podplane.dev/docs/cli-reference/oidc-create.md): Generate OIDC configuration and deploy infrastructure
- [oidc delete](https://podplane.dev/docs/cli-reference/oidc-delete.md): Remove deployed OIDC infrastructure
- [login](https://podplane.dev/docs/cli-reference/login.md): Authenticate to a cluster via kubectl
- [logout](https://podplane.dev/docs/cli-reference/logout.md): Remove cluster authentication from kubeconfig
- [hooks kubectl-auth](https://podplane.dev/docs/cli-reference/hooks-kubectl-auth.md): kubectl exec auth plugin
- [deploy](https://podplane.dev/docs/cli-reference/deploy.md): Deploy an app using a template
- [remove](https://podplane.dev/docs/cli-reference/remove.md): Remove a previously deployed app
- [logs](https://podplane.dev/docs/cli-reference/logs.md): Tail logs for a deployed app
- [secret](https://podplane.dev/docs/cli-reference/secret.md): Manage application secrets through the Podplane operator
- [install](https://podplane.dev/docs/cli-reference/install.md): Install an addon component into the cluster
- [uninstall](https://podplane.dev/docs/cli-reference/uninstall.md): Remove an addon component from the cluster
- [local start](https://podplane.dev/docs/cli-reference/local-start.md): Start a local cluster VM
- [local status](https://podplane.dev/docs/cli-reference/local-status.md): Report the status of a local cluster VM
- [local stop](https://podplane.dev/docs/cli-reference/local-stop.md): Stop a local cluster VM
- [local delete](https://podplane.dev/docs/cli-reference/local-delete.md): Delete a local cluster VM and its state files
- [local shell](https://podplane.dev/docs/cli-reference/local-shell.md): Open a shell into a local cluster VM
- [local console](https://podplane.dev/docs/cli-reference/local-console.md): Attach to a local cluster VM serial console
- [local sync](https://podplane.dev/docs/cli-reference/local-sync.md): Sync files into a local cluster VM
- [local server](https://podplane.dev/docs/cli-reference/local-server.md): Run a local background server for VMs
- [deps status](https://podplane.dev/docs/cli-reference/deps-status.md): Report dependency cache status
- [deps download](https://podplane.dev/docs/cli-reference/deps-download.md): Download latest dependency versions
- [version](https://podplane.dev/docs/cli-reference/version.md): Report the current CLI version

---

Tip: Append `.md` to any page URL to get the markdown version.
