README
¶
Podplane: Kubernetes Distribution & PaaS
Podplane is an Open Source Kubernetes distribution & PaaS you can deploy in a few minutes to your AWS, Google Cloud, or Proxmox VE environment.
Want an easy-to-use container platform, without vendor lock-in? Use Podplane to:
-
Save Time: Deploy everything you need for a container platform in minutes.
-
Lower Costs: Use battle-tested infrastructure primitives like VMs, not overpriced managed services.
-
Be In Control: Podplane is Apache 2.0 licensed, and only uses components with OSI-approved licenses.
The goal is to combine infrastructure and security best practices with an intuitive developer experience, to enable a platform which scales from hobby projects to enterprise production systems.
How It Works
Using the Podplane CLI, you can deploy a Podplane cluster in a few minutes.
Every cluster includes CoreDNS and Cilium CNI out of the box, and you can install addon components like Traefik ingress controller or CSI drivers, either at cluster creation or later with podplane install.
Some CLI commands (like podplane deploy) require specific components and will guide you to install them if needed.
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.
Components
Podplane is easy to use and operate because of three sibling projects which form a new type of Kubernetes-based container platform:
- Cluster state is stored in object storage via Netsy, not etcd.
- Auto-scaling & provisioning is faster with Nstance.
- OIDC & RBAC is simplified with Easy OIDC.
Podplane, Netsy, Nstance, and Easy OIDC are Open Source projects created by Nadrama.
Learn More
Learn more about Podplane at the official project website: podplane.dev
License
Podplane is licensed under the Apache License, Version 2.0. Copyright The Podplane Authors.
See the LICENSE file for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
buildvars
Package buildvars exposes build info injected by build-time linker flags.
|
Package buildvars exposes build info injected by build-time linker flags. |
|
cloudinit
Package cloudinit generates NoCloud cidata ISO images for cloud-init.
|
Package cloudinit generates NoCloud cidata ISO images for cloud-init. |
|
clusterauth
Package clusterauth coordinates cluster OIDC login, refresh, and token persistence.
|
Package clusterauth coordinates cluster OIDC login, refresh, and token persistence. |
|
clusterconfig
Package clusterconfig parses and resolves Podplane cluster configuration files.
|
Package clusterconfig parses and resolves Podplane cluster configuration files. |
|
clusterdelete
Package clusterdelete orchestrates cluster destroy workflows across provider implementations.
|
Package clusterdelete orchestrates cluster destroy workflows across provider implementations. |
|
clusterdelete/aws
Package aws implements AWS-specific cluster destroy cleanup for the clusterdelete package.
|
Package aws implements AWS-specific cluster destroy cleanup for the clusterdelete package. |
|
clusterdelete/google
Package google will contain the Google Cloud cluster delete provider implementation.
|
Package google will contain the Google Cloud cluster delete provider implementation. |
|
cmd
Package cmd defines the Podplane CLI commands.
|
Package cmd defines the Podplane CLI commands. |
|
components
Package components reads and mutates the platform-components HelmRelease in a Podplane cluster, which is the single source of truth for which Podplane component charts are enabled/installed and which are core.
|
Package components reads and mutates the platform-components HelmRelease in a Podplane cluster, which is the single source of truth for which Podplane component charts are enabled/installed and which are core. |
|
config
Package config manages Podplane CLI runtime configuration and stored auth state.
|
Package config manages Podplane CLI runtime configuration and stored auth state. |
|
deploy
Package deploy installs a Podplane app template onto a Kubernetes cluster by rendering values and invoking Helm against a cached chart.
|
Package deploy installs a Podplane app template onto a Kubernetes cluster by rendering values and invoking Helm against a cached chart. |
|
deps
Package deps downloads, verifies, and reports status for local VM dependencies.
|
Package deps downloads, verifies, and reports status for local VM dependencies. |
|
execwrap
Package execwrap wraps external command execution and runtime dependency checks.
|
Package execwrap wraps external command execution and runtime dependency checks. |
|
filecache
Package filecache downloads and verifies cached files.
|
Package filecache downloads and verifies cached files. |
|
kubectl
Package kubectl configures kubectl for Podplane clusters.
|
Package kubectl configures kubectl for Podplane clusters. |
|
local
Package local manages local Podplane cluster VMs and their support server.
|
Package local manages local Podplane cluster VMs and their support server. |
|
oidc
Package oidc implements OIDC auth-code+PKCE login and refresh flows.
|
Package oidc implements OIDC auth-code+PKCE login and refresh flows. |
|
oidcconfig
Package oidcconfig parses and validates Podplane OIDC server configuration files.
|
Package oidcconfig parses and validates Podplane OIDC server configuration files. |
|
oidcserver
Package oidcserver implements the minimal local OIDC provider used by local clusters.
|
Package oidcserver implements the minimal local OIDC provider used by local clusters. |
|
osboot
Package osboot prepares direct kernel boot artifacts from cached OS images.
|
Package osboot prepares direct kernel boot artifacts from cached OS images. |
|
pid
Package pid manages PID files for Podplane background processes.
|
Package pid manages PID files for Podplane background processes. |
|
s3fake
Package s3fake exposes a local fake S3 service for local clusters.
|
Package s3fake exposes a local fake S3 service for local clusters. |
|
tfexec
Package tfexec runs OpenTofu/Terraform commands for Podplane-managed stacks.
|
Package tfexec runs OpenTofu/Terraform commands for Podplane-managed stacks. |
|
tfgen
Package tfgen renders deterministic Podplane-managed OpenTofu/Terraform files.
|
Package tfgen renders deterministic Podplane-managed OpenTofu/Terraform files. |
|
tui
Package tui contains terminal UI helpers.
|
Package tui contains terminal UI helpers. |
|
userdata
Package userdata renders cloud-init user-data scripts for Podplane VMs.
|
Package userdata renders cloud-init user-data scripts for Podplane VMs. |
|
vm
Package vm defines the interface for local virtual machine managers.
|
Package vm defines the interface for local virtual machine managers. |
|
vm/qemu
Package qemu implements the local VM manager using QEMU.
|
Package qemu implements the local VM manager using QEMU. |
|
pkg
|
|
|
netsyseed
Package netsyseed renders Podplane seed files into Netsy snapshot files.
|
Package netsyseed renders Podplane seed files into Netsy snapshot files. |
|
seeds
Package seeds downloads and caches published Podplane seed files.
|
Package seeds downloads and caches published Podplane seed files. |
|
Package schemas embeds Podplane JSON Schemas for offline CLI output.
|
Package schemas embeds Podplane JSON Schemas for offline CLI output. |