Skip to content
k
kix
/docs
Search docs, packages, flags
Ctrl
K
Cancel
Select version
Latest
v0.1
Install the CLI
Start
Tutorials
How-to guides
Reference
Explanation
Start
Tutorials
How-to guides
Reference
Explanation
How-to guides
Start and inspect a Kix project
Deploy to kind
Install and run the Kix CLI
List clusters and packages
Render manifests
Select and configure a cluster flavor
Use mkFlake in a consuming repo
Operate a cluster
Check cluster health
Check live resources for drift
Check resource status
Configure Activation retention
Deploy with dry-run, timeouts, pruning, and log/TUI output modes
Export audit-preserving YAML
Export plain YAML
Garbage-collect stale resources
Inspect a deploy receipt
List images for air-gapped preloading
Preview changes with kix plan and kix diff
Reconcile drift
Roll back an activation
Use kix logs
Use kix pf
Use snapshots for offline or CI diffs
Promote images
Build, promote, and deploy an image in CI
Create a committed image pin file
Promote and verify an image pin
Debug dependency wiring
Debug a missing dependency
Inspect an instance's deps, parts, and out
Use aliases and default aliases
Use auto-instantiation with availablePackages, optional, and autoNamespace
Visualize the dependency graph with kix graph
Wire cross-namespace dependencies explicitly
Author packages and clusters
Add a post-deploy health check
Add env vars and mounts
Add typed package options
Compose multi-team clusters with mergeFragments
Configure namespace policy and global cluster settings
Create a local package
Declare package roles and metadata
Declare readiness for custom resources
Keep intentionally empty values
Map the availability level in a package
Reuse one package for multiple instances
Stamp multi-environment clusters with mkEnv
Adopt existing resources
Add explicit ordering with extraDeps
Cede fields to a controller
Handle server-side-apply conflicts safely
Handle stateful migration prompts safely
Import an existing service with kix.mkImport
Patch package output with overlays
Preserve existing selectors
Preserve Helm-compatible labels
Shadow a flavor-provided import with a managed package
Take ownership of Helm-managed resources
Take ownership of kubectl-managed resources
Use Helm charts through the Kix Helm bridge
Platform capabilities
Add TLS through a cluster issuer
Auto-monitor a service
Configure storage classes and PVCs
Declare platform intents for non-Kix-managed pods
Enable generated network policy
Expose a service through Cloudflare Tunnel
Expose a service with Gateway API
Expose a service with Ingress
Mount node-local storage with hostPath
Set the cluster availability level
Use externally managed secrets
Use Kix-managed secrets
Use SOPS-backed secrets
Policy, CI, and compliance
Add scorecard rules
Attest a deployment from its cluster receipt
Disable scorecard rules
Fail the build on scorecard findings
Generate a CycloneDX SBOM
Generate an audit bundle
Generate PR-review markdown from kix diff
Generate SLSA provenance
Override scorecard severity
Run kix check --sarif in CI
Save and diff snapshots for offline CI
Package task guides
Configure cert-manager issuers
Deploy StackGres
Deploy Valkey / Redis
Deploy Velero
Install Cilium / network policy support
Install Envoy Gateway
Install ingress-nginx
Install Mayastor
Install the monitoring stack
Install the VictoriaMetrics HA monitoring stack
Provision persistent storage
Publish DNS records with external-dns
Select version
Latest
v0.1
How-to guides
Task-oriented recipes for building, operating, and maintaining Kix clusters.