Explain index¶
cloudseed explain knows 309 pages. Each one is available the same way everywhere: cloudseed explain <query> in the terminal (--json for data), the ? buttons and the Explain panel in the web console, and cloudseed_explain / cloudseed://explain/<query> over MCP. See the explain guide.
Generated from the code
This page is generated by scripts/gen-docs.py from the explain index (cloudseed/explain.py), so it always matches the CLI you install (this build: cloudseed 0.2.3).
| Kind | Pages |
|---|---|
| Features | 27 |
| Targets | 4 |
| Commands | 46 |
| Topics | 17 |
| Platform groups | 10 |
| Platform items | 73 |
| Setup variables | 132 |
Features¶
| Name | What it explains | Command |
|---|---|---|
operations | Shared health, deployment, policy, upgrade and recovery workflows with explicit evidence and approval gates. | cloudseed explain operations |
overview | How cloudseed is built: a stdlib Python CLI, Terraform stacks per target, Ansible for hosts, a Helm catalog and agent skills. | cloudseed explain overview |
network | One non-overlapping address space per environment: public and private subnets, NAT egress, flow logs, deny-by-default firewalls. | cloudseed explain network |
bastion | A single hardened SSH jump host, reachable only from your IP, with key-only auth, an encrypted disk and Ansible hardening. | cloudseed explain bastion |
security-baseline | Account- and project-wide guard rails, each managed by one environment: CloudTrail, GuardDuty, audit logs, Defender, encryption defaults. | cloudseed explain security-baseline |
state | Terraform state per environment: a versioned, encrypted bucket or storage account bootstrapped first, or local files. | cloudseed explain state |
kubernetes | Managed clusters (EKS / GKE / AKS, private endpoint by default) or RKE2 / kubeadm on VMware, one kubeconfig per environment. | cloudseed explain kubernetes |
platform | A curated Helm / kustomize catalog in groups, installed in dependency order with values per target and private load balancers. | cloudseed explain platform |
vpn | An OpenVPN server with per-user profiles, or a Tailscale subnet router, giving your machine a route into the private network. | cloudseed explain vpn |
vmware | Local VMs on VMware Fusion Pro 13+ / Workstation Pro 17+ through cloudseed's own Terraform provider, on a host-only network. | cloudseed explain vmware |
provisioning | After apply, the repository is copied to the hosts over SSH and Ansible hardens them and installs the tools. | cloudseed explain provisioning |
finops | Cost estimates from the inventory, actual cloud bills and Kubernetes cost allocation with OpenCost, saved as reports. | cloudseed explain finops |
managed-data | Databricks and Snowflake through their official CLIs, with a private connection profile per environment. | cloudseed explain managed-data |
agentic | An optional agent (built-in, Claude Code, Codex, Gemini or Grok) that drives cloudseed while credentials are kept away from it. | cloudseed explain agentic |
reconcile | Terraform runs survive 'already exists': only objects provably this environment's are imported, and the new plan is approved again. | cloudseed explain reconcile |
mcp | cloudseed as an MCP server: one tool per feature plus resources and prompts, over stdio or local HTTP with a token. | cloudseed explain mcp |
prereqs | Cloud resources platform items need (Velero buckets, Karpenter roles, identities) come from the environment's own Terraform stack. | cloudseed explain prereqs |
fips | fips_mode=true builds the whole environment for FIPS 140: endpoints, images, hosts, algorithms and a gated platform catalog. | cloudseed explain fips |
chaos | Chaos Mesh experiments against a canary or your Deployment, with an availability hypothesis and a PASS / FAIL report. | cloudseed explain chaos |
dr | Velero backups to storage the stack creates, restores, schedules, and automated drills that measure the recovery time. | cloudseed explain dr |
usage | Private usage metadata for Cloudseed-launched agent runs and this server's MCP tool activity. | cloudseed explain usage |
scan | Security scanners and a separate local Well-Architected assessment, with saved reports and explicit verdicts. | cloudseed explain scan |
architecture | Assess saved configuration and evidence against provider guidance; missing evidence remains unknown and no cloud resources are changed. | cloudseed explain architecture |
undo | A journal of the last fifteen actions per environment (and fifteen global ones, at most five of one kind) with their inverse: cs undo reverts the newest. | cloudseed explain undo |
ui | A local, token-protected web console where every cloudseed capability is a form and a button, and a "?" explains each one. | cloudseed explain ui |
audit | Every command writes an audit line and a redacted log; inventory.json tracks resources and changes; troubleshoot reads them. | cloudseed explain audit |
dependencies | Tools installed locally (Homebrew or verified releases), in a container image, or as one self-contained bundle. | cloudseed explain dependencies |
Targets¶
| Name | What it explains | Command |
|---|---|---|
aws | What cs setup aws builds on AWS: a VPC, a hardened bastion and the account baseline, optional EKS, VPN and FIPS, with every variable and output. | cloudseed explain aws |
gcp | What cs setup gcp builds on Google Cloud: a VPC, a hardened bastion and the logging baseline, optional GKE, VPN and FIPS, with every variable and output. | cloudseed explain gcp |
azure | What cs setup azure builds on Azure: a VNet with NSGs and a NAT gateway, a hardened bastion, Log Analytics, optional AKS, VPN, FIPS and Defender. | cloudseed explain azure |
vmware | What cs setup vmware builds on your machine: VMs on a host-only network, host and architecture detection, guest OS choices, every variable and output. | cloudseed explain target vmware |
Commands¶
| Name | What it explains | Command |
|---|---|---|
setup | Create or update an environment: network, subnets, NAT, bastion, security baseline. | cloudseed explain setup |
provision | Copy this repo to the bastion / VPN host and harden them with Ansible (auto after setup). | cloudseed explain provision |
k8s | The environment's cluster (EKS / GKE / AKS, RKE2 / kubeadm on vmware): info, kubeconfig, tunnel, untunnel. | cloudseed explain k8s |
vpn | VPN host: status, add-user, users, revoke, connect, disconnect, provision. | cloudseed explain command vpn |
plan | Show what apply would change. | cloudseed explain plan |
apply | Re-apply the saved configuration. | cloudseed explain apply |
destroy | Tear down everything, or pick parts with --select / --target. | cloudseed explain destroy |
env | The environment cluster commands act on (else: the only cluster, or you are asked). | cloudseed explain env |
node | Grow or shrink the cluster - managed pools in the cloud (scale sets the size and the autoscaler limits), VM + auto-join (RKE2 / kubeadm) on vmware. | cloudseed explain node |
platform | The Helm/kustomize catalog in groups (basek8s scaling data ai agentic finops devsecops security resilience chaos) or single items. | cloudseed explain command platform |
kubectl | Run kubectl against the current cluster: the environment's kubeconfig, a bastion tunnel when needed, installed after asking when missing. | cloudseed explain kubectl |
finops | Cost estimates, actual cloud bills and Kubernetes cost allocation (OpenCost), saved as reports. | cloudseed explain command finops |
managed | Managed data platforms next to your clusters: Databricks and Snowflake through their official CLIs, one connection profile per environment. | cloudseed explain managed |
troubleshoot | Deterministic diagnosis of an environment: audit log, the failed change, inventory, reachability. | cloudseed explain troubleshoot |
inventory | What exists in the environment (from state) and its change history. | cloudseed explain inventory |
status | Prints the saved configuration, tags, resource count in state, outputs and the SSH command. | cloudseed explain status |
output | Stack outputs (bastion IP, subnet IDs, ...). | cloudseed explain output |
ssh | SSH into the bastion with the generated key. | cloudseed explain ssh |
update-ip | Your public IP changed: re-detect it and re-apply the firewall. | cloudseed explain update-ip |
list | Every environment with its cloud, region, state location, bastion IP and last update. | cloudseed explain list |
doctor | Checks Terraform, ssh-keygen and the cloud CLIs, their versions, the runtime, container engines and whether credentials were found. | cloudseed explain doctor |
deps | Install single tools locally, run in Docker/Podman, or build a single binary. | cloudseed explain deps |
enable | Turn on agentic mode, the context brief (headliner), the MCP server or the local web console. | cloudseed explain enable |
mcp | cloudseed as an MCP server: every feature is a tool for Claude Code, Claude Desktop, Codex, Cursor, Windsurf, Gemini CLI or VS Code. | cloudseed explain command mcp |
ui | The local web console: every cloudseed capability as a form and a button (cs ui opens it). | cloudseed explain command ui |
undo | Undo the newest action (setup changes, installs, node changes, backups), fifteen deep per environment; --global for settings, agents, MCP and UI. | cloudseed explain command undo |
creds | The local credential vault (cloud keys, API keys, tokens) used by every command and the UI. | cloudseed explain creds |
chaos | Chaos Mesh experiments with a PASS/FAIL report. | cloudseed explain command chaos |
dr | Disaster recovery with Velero (bucket + identity created for you); test is an automated drill. | cloudseed explain command dr |
usage | Cloudseed agent tokens, MCP activity and optional ccusage cost estimates. | cloudseed explain command usage |
evidence | Saved reports and logs, redacted and paginated without running new scans. | cloudseed explain evidence |
scan | Security scans and local Well-Architected assessments with saved reports. | cloudseed explain command scan |
disable | Turn off agentic mode, the context brief (headliner), the MCP server or the local web console. | cloudseed explain disable |
use | Select the agent cs agentic runs, and install its CLI and the cloudseed skills for it. | cloudseed explain use |
agents | What each agent is, whether it is installed and logged in. | cloudseed explain agents |
model | Show or pick the model for the selected agent. | cloudseed explain model |
agentic | Run a natural-language task through the agent (alias: do). | cloudseed explain command agentic |
skill | The agent skills bundled with cloudseed: list them, show one, or install them for an agent. | cloudseed explain skill |
install | One front door for everything installable. | cloudseed explain install |
explain | How anything in cloudseed works: features, targets, commands, topics, platform groups and items, setup variables. | cloudseed explain explain |
ops | Inspect operational readiness, preview configuration and run explicitly approved lifecycle changes. | cloudseed explain ops |
do | Hands a natural-language task to the selected agent, which then drives cloudseed for you using the bundled skills. | cloudseed explain do |
databricks | Databricks: connect (profile per environment), test, or pass any CLI command through. | cloudseed explain databricks |
snowflake | Snowflake: the same, with the Snowflake CLI. | cloudseed explain snowflake |
helm | Run helm against the current cluster: the environment's kubeconfig, a bastion tunnel when needed, installed after asking when missing. | cloudseed explain helm |
k9s | Run k9s against the current cluster: the environment's kubeconfig, a bastion tunnel when needed, installed after asking when missing. | cloudseed explain k9s |
Topics¶
| Name | What it explains | Command |
|---|---|---|
fips | FIPS 140 mode: one switch that makes everything in the environment FIPS-capable, or refuses what cannot be. | cloudseed explain topic fips |
quickstart | The shortest path from nothing to a working environment: doctor, log in, setup, ssh, status, destroy. | cloudseed explain quickstart |
security | The security model: network exposure, host hardening, identity, encryption, logging and how secrets are kept. | cloudseed explain topic security |
state | Where Terraform state lives (a hardened remote bucket or local files) and how to switch between them. | cloudseed explain topic state |
envs | Environments and their working directories: answers, SSH keys, logs, state, outputs, naming and tags. | cloudseed explain envs |
vmware | Local virtual machines on VMware Fusion Pro / Workstation Pro: the same shape as a cloud environment, on your machine. | cloudseed explain topic vmware |
services | Optional services per environment (Kubernetes, VPN) switched on with --var or the setup prompts. | cloudseed explain services |
troubleshooting | Common failures and their fixes: missing tools, credentials, 'already exists', SSH timeouts, permissions. | cloudseed explain troubleshooting |
examples | Worked examples of common tasks on every target, from the first environment to teardown. | cloudseed explain examples |
variables aws | Every Terraform variable of the aws stack with its default, the setup inputs, and what cloudseed sets itself. | cloudseed explain variables aws |
outputs aws | Every output of the aws stack (cs output aws --env <env>). | cloudseed explain outputs aws |
variables gcp | Every Terraform variable of the gcp stack with its default, the setup inputs, and what cloudseed sets itself. | cloudseed explain variables gcp |
outputs gcp | Every output of the gcp stack (cs output gcp --env <env>). | cloudseed explain outputs gcp |
variables azure | Every Terraform variable of the azure stack with its default, the setup inputs, and what cloudseed sets itself. | cloudseed explain variables azure |
outputs azure | Every output of the azure stack (cs output azure --env <env>). | cloudseed explain outputs azure |
variables vmware | Every Terraform variable of the vmware stack with its default, the setup inputs, and what cloudseed sets itself. | cloudseed explain variables vmware |
outputs vmware | Every output of the vmware stack (cs output vmware --env <env>). | cloudseed explain outputs vmware |
Platform groups¶
| Name | What it explains | Command |
|---|---|---|
basek8s | Cluster management: metrics, certs, Gateway API + Envoy Gateway (private LB), GitOps, observability (Prometheus, Loki), OTel, secrets. | cloudseed explain basek8s |
scaling | Autoscaling: KEDA, VPA + Goldilocks (+ metrics-server), cluster-autoscaler / Karpenter (cloud). | cloudseed explain scaling |
data | Data platform: MinIO, Postgres operator, Kafka, Spark, Trino, StarRocks, Polaris, Airflow, ClickHouse. | cloudseed explain data |
ai | AI/ML: Ray, Kubeflow trainer/pipelines, KServe, JupyterHub, MLflow, vLLM, GPU operator, Ollama. | cloudseed explain ai |
agentic | Agentic: kagent, kmcp, agentgateway, Qdrant, Langfuse, LiteLLM, Open WebUI. | cloudseed explain group agentic |
finops | FinOps: OpenCost (+ Prometheus), kube-green, Kubecost; pairs with cs finops for cloud bills and estimates. | cloudseed explain group finops |
devsecops | DevSecOps: GitLab + runner and a CI template, NeuVector, Trivy operator, ArgoCD; registries Harbor, Artifactory and Nexus; SonarQube. | cloudseed explain devsecops |
security | Security / zero trust: Istio (ambient or sidecar, strict mTLS), Falco, Kyverno policies, cert-manager with a cluster CA issuer, External Secrets. | cloudseed explain security |
resilience | Resilience / DR: Velero backups (cloud bucket + identity created on demand), kured reboots, descheduler; cs dr runs backups, restores and drills. | cloudseed explain resilience |
chaos | Chaos engineering: Chaos Mesh (+ LitmusChaos extra); cs chaos run executes automated experiments with a PASS/FAIL report. | cloudseed explain group chaos |
Platform items¶
| Name | What it explains | Command |
|---|---|---|
metrics-server | Resource metrics API (kubectl top, HPA). | cloudseed explain metrics-server |
cert-manager | X.509 certificates for in-cluster services (Gateway API aware). | cloudseed explain cert-manager |
gateway-api | Kubernetes Gateway API CRDs (experimental channel v1.6.1, matches envoy-gateway). | cloudseed explain gateway-api |
envoy-gateway | Envoy Gateway: the cluster's Gateway API implementation (private LB, TLS via cert-manager). | cloudseed explain envoy-gateway |
ingress-nginx | LEGACY Ingress controller (upstream retired 2026; use Gateway API / envoy-gateway). | cloudseed explain ingress-nginx |
metallb | LoadBalancer IPs on the private network (local clusters). | cloudseed explain metallb |
aws-load-balancer-controller | ALB/NLB provisioning for EKS (needs IRSA role). | cloudseed explain aws-load-balancer-controller |
argocd | GitOps continuous delivery. | cloudseed explain argocd |
kube-prometheus-stack | Prometheus, Alertmanager, Grafana, node/kube exporters. | cloudseed explain kube-prometheus-stack |
loki | Log aggregation (Loki 3, single binary, persistent) + Alloy log collection. | cloudseed explain loki |
alloy | Grafana Alloy: collects every pod's logs into Loki. | cloudseed explain alloy |
opentelemetry-operator | OpenTelemetry operator (collectors, auto-instrumentation). | cloudseed explain opentelemetry-operator |
external-secrets | Sync secrets from AWS/GCP/Azure secret managers, Vault, ... | cloudseed explain external-secrets |
sealed-secrets | Encrypt secrets so they can live in git. | cloudseed explain sealed-secrets |
reloader | Restart workloads when ConfigMaps/Secrets change. | cloudseed explain reloader |
kyverno | Policy engine (admission control, mutation, generation). | cloudseed explain kyverno |
keda | Event-driven autoscaling (queues, metrics, cron, ...). | cloudseed explain keda |
vpa | Vertical Pod Autoscaler. | cloudseed explain vpa |
goldilocks | Right-sizing recommendations dashboard (uses VPA). | cloudseed explain goldilocks |
cluster-autoscaler | Scale node pools on demand within kubernetes_node_min/_max (EKS chart; GKE/AKS: built-in autoscaler, GKE never below kubernetes_node_count). | cloudseed explain cluster-autoscaler |
karpenter | Just-in-time nodes for EKS (controller + a default NodePool/EC2NodeClass). | cloudseed explain karpenter |
minio | S3-compatible object storage (lakehouse storage for local clusters). | cloudseed explain minio |
cloudnative-pg | PostgreSQL operator (CloudNativePG): Postgres clusters as CRDs (backs the Polaris catalog). | cloudseed explain cloudnative-pg |
strimzi | Apache Kafka operator (Strimzi) + a dev Kafka cluster (KRaft, 1 broker). | cloudseed explain strimzi |
spark-operator | Kubeflow Spark operator (SparkApplication CRD). | cloudseed explain spark-operator |
trino | Distributed SQL query engine. | cloudseed explain trino |
starrocks | StarRocks analytical database (operator + cluster CRD). | cloudseed explain starrocks |
polaris | Apache Polaris - Iceberg REST catalog (Postgres-backed via CloudNativePG). | cloudseed explain polaris |
spark-history-server | Spark History Server (event logs in MinIO s3a://spark-logs). | cloudseed explain spark-history-server |
airflow | Apache Airflow (official chart). | cloudseed explain airflow |
clickhouse-operator | Altinity ClickHouse operator. | cloudseed explain clickhouse-operator |
kuberay | Ray operator (distributed Python, RayJob/RayService/RayCluster). | cloudseed explain kuberay |
kubeflow-trainer | Kubeflow training operator (PyTorchJob, TFJob, ...). | cloudseed explain kubeflow-trainer |
kubeflow-pipelines | Kubeflow Pipelines (standalone, platform-agnostic). | cloudseed explain kubeflow-pipelines |
kserve | Model serving (KServe, standard (raw) deployment mode - no Knative needed). | cloudseed explain kserve |
jupyterhub | Multi-user notebooks. | cloudseed explain jupyterhub |
mlflow | Experiment tracking and model registry. | cloudseed explain mlflow |
vllm-stack | vLLM production stack (router + model servers). | cloudseed explain vllm-stack |
gpu-operator | NVIDIA GPU operator (drivers, device plugin, DCGM). | cloudseed explain gpu-operator |
ollama | Local LLM runtime (CPU-friendly for dev). | cloudseed explain ollama |
agentgateway | agentgateway: gateway for agents, MCP and LLM traffic (GatewayClass agentgateway). | cloudseed explain agentgateway |
kagent | kagent: agentic AI framework for Kubernetes (agents as CRDs). | cloudseed explain kagent |
kmcp | kmcp: build and run MCP servers on Kubernetes. | cloudseed explain kmcp |
qdrant | Vector database. | cloudseed explain qdrant |
langfuse | LLM observability, tracing and evals. | cloudseed explain langfuse |
litellm | LLM proxy / model router (OpenAI-compatible). | cloudseed explain litellm |
open-webui | Chat UI for local/remote models. | cloudseed explain open-webui |
opencost | OpenCost: real-time Kubernetes cost allocation (namespace, workload, label). | cloudseed explain opencost |
kube-green | Sleep dev workloads on a schedule (kube-green). | cloudseed explain kube-green |
kubecost-cost-analyzer | Kubecost (free tier; richer UI on top of OpenCost). | cloudseed explain kubecost-cost-analyzer |
gitlab | GitLab (git, CI, registry) - dev-sized, self-signed ingress. | cloudseed explain gitlab |
gitlab-runner | GitLab CI runner (Kubernetes executor). | cloudseed explain gitlab-runner |
neuvector | NeuVector container security platform (runtime, scanning, WAF). | cloudseed explain neuvector |
trivy-operator | Continuous vulnerability/misconfiguration scanning of workloads. | cloudseed explain trivy-operator |
artifactory | JFrog Artifactory OSS - universal artifact repository (Maven, npm, PyPI, generic). | cloudseed explain artifactory |
nexus | Sonatype Nexus Repository 3 - artifact + container registry. | cloudseed explain nexus |
harbor | Container registry with scanning and signing. | cloudseed explain harbor |
sonarqube | Code quality and SAST. | cloudseed explain sonarqube |
istio | Istio service mesh (mode: ambient [default] or sidecar) with strict mTLS. | cloudseed explain istio |
istio-gateway | Istio ingress gateway (private LB address: VPN/bastion on clouds, host-only network on vmware). | cloudseed explain istio-gateway |
kiali | Mesh observability console. | cloudseed explain kiali |
falco | Runtime threat detection (syscalls) + Falcosidekick UI. | cloudseed explain falco |
kyverno-policies | Kyverno pod-security baseline policies (audit mode). | cloudseed explain kyverno-policies |
cert-manager-issuer | Cluster CA issuer (cert-manager) for TLS on every UI. | cloudseed explain cert-manager-issuer |
vault | HashiCorp Vault (dev mode - not for production secrets). | cloudseed explain vault |
local-path-provisioner | Default StorageClass for local clusters (Rancher local-path, node disks). | cloudseed explain local-path-provisioner |
velero | Backup and restore of cluster state and volumes (Velero + node agent, cloud bucket or MinIO). | cloudseed explain velero |
kured | Safe rolling node reboots when the OS asks for one (kured). | cloudseed explain kured |
descheduler | Rebalance pods across nodes (duplicates, node utilisation, affinity violations). | cloudseed explain descheduler |
chaos-mesh | Chaos Mesh: pod, network, DNS, stress, time and IO faults with a dashboard (cs chaos run drives it). | cloudseed explain chaos-mesh |
litmus | LitmusChaos ChaosCenter (portal + experiments hub). | cloudseed explain litmus |
kubescape-operator | Continuous configuration, vulnerability and node scanning (NSA / MITRE / CIS reports as CRDs). | cloudseed explain kubescape-operator |
external-dns | Publish Services/Ingresses/HTTPRoutes in Route53 / Cloud DNS / Azure DNS (cloud identity wired in). | cloudseed explain external-dns |
Setup variables¶
Every stack variable and setup input has its own page: cloudseed explain variable <cloud> <name> (or cloudseed explain <cloud> <name>). The full tables live on the target pages:
| Target | Variables | Reference |
|---|---|---|
| AWS | 39 | aws |
| Google Cloud | 36 | gcp |
| Azure | 29 | azure |
| VMware (local) | 28 | vmware |