Directories
¶
| Path | Synopsis |
|---|---|
|
Package apis provides API type definitions for KSail resources.
|
Package apis provides API type definitions for KSail resources. |
|
cluster
Package cluster provides cluster configuration API types.
|
Package cluster provides cluster configuration API types. |
|
cluster/v1alpha1
Package v1alpha1 provides model definitions for a KSail cluster.
|
Package v1alpha1 provides model definitions for a KSail cluster. |
|
Package cli provides reusable helpers for command wiring and execution.
|
Package cli provides reusable helpers for command wiring and execution. |
|
annotations
Package annotations provides constants for annotating Cobra commands to control AI tool generation, permission requirements, and command consolidation.
|
Package annotations provides constants for annotating Cobra commands to control AI tool generation, permission requirements, and command consolidation. |
|
cmd
Package cmd provides the command-line interface for KSail.
|
Package cmd provides the command-line interface for KSail. |
|
cmd/chat
Package chat implements the AI-assisted chat command.
|
Package chat implements the AI-assisted chat command. |
|
cmd/cipher
Package cipher provides the cipher command for integrating with SOPS.
|
Package cipher provides the cipher command for integrating with SOPS. |
|
cmd/cluster
Package cluster groups all KSail cluster lifecycle Cobra commands under a single namespace.
|
Package cluster groups all KSail cluster lifecycle Cobra commands under a single namespace. |
|
cmd/mcp
Package mcp implements the MCP server command.
|
Package mcp implements the MCP server command. |
|
cmd/workload
Package workload provides the workload command namespace.
|
Package workload provides the workload command namespace. |
|
cmd/workload/gen
Package gen provides the gen command namespace for generating Kubernetes resources.
|
Package gen provides the gen command namespace for generating Kubernetes resources. |
|
dockerutil
Package dockerutil provides Docker client lifecycle management utilities.
|
Package dockerutil provides Docker client lifecycle management utilities. |
|
editor
Package editor provides editor configuration resolution with proper precedence.
|
Package editor provides editor configuration resolution with proper precedence. |
|
flags
Package flags provides CLI flag handling utilities including benchmark timing.
|
Package flags provides CLI flag handling utilities including benchmark timing. |
|
kubeconfig
Package kubeconfig provides helpers for resolving kubeconfig file paths.
|
Package kubeconfig provides helpers for resolving kubeconfig file paths. |
|
lifecycle
Package lifecycle provides cluster lifecycle command helpers.
|
Package lifecycle provides cluster lifecycle command helpers. |
|
setup
Package setup provides helpers for cluster creation and setup workflows.
|
Package setup provides helpers for cluster creation and setup workflows. |
|
setup/localregistry
Package localregistry provides local registry lifecycle operations for cluster commands.
|
Package localregistry provides local registry lifecycle operations for cluster commands. |
|
setup/mirrorregistry
Package mirrorregistry provides mirror registry setup and connection stages for cluster creation.
|
Package mirrorregistry provides mirror registry setup and connection stages for cluster creation. |
|
ui
Package ui provides user interface components for KSail CLI.
|
Package ui provides user interface components for KSail CLI. |
|
ui/asciiart
Package asciiart provides ASCII art printing functionality for KSail.
|
Package asciiart provides ASCII art printing functionality for KSail. |
|
ui/chat
Package chat provides an interactive Bubbletea TUI for conversing with GitHub Copilot.
|
Package chat provides an interactive Bubbletea TUI for conversing with GitHub Copilot. |
|
ui/confirm
Package confirm provides confirmation prompt utilities for destructive operations.
|
Package confirm provides confirmation prompt utilities for destructive operations. |
|
ui/errorhandler
Package errorhandler centralizes Cobra command execution with KSail's error formatting rules.
|
Package errorhandler centralizes Cobra command execution with KSail's error formatting rules. |
|
Package client provides embedded Kubernetes and container tool clients.
|
Package client provides embedded Kubernetes and container tool clients. |
|
argocd
Package argocd provides Argo CD GitOps integration for KSail-Go.
|
Package argocd provides Argo CD GitOps integration for KSail-Go. |
|
docker
Package docker provides client wrappers for Docker Engine API operations.
|
Package docker provides client wrappers for Docker Engine API operations. |
|
flux
Package flux provides a Flux client implementation using Flux Kubernetes APIs.
|
Package flux provides a Flux client implementation using Flux Kubernetes APIs. |
|
helm
Package helm provides client helpers for interacting with Helm in KSail.
|
Package helm provides client helpers for interacting with Helm in KSail. |
|
k9s
Package k9s provides a K9s client implementation.
|
Package k9s provides a K9s client implementation. |
|
kubeconform
Package kubeconform provides a client for validating Kubernetes manifests using kubeconform.
|
Package kubeconform provides a client for validating Kubernetes manifests using kubeconform. |
|
kubectl
Package kubectl provides a kubectl client implementation.
|
Package kubectl provides a kubectl client implementation. |
|
kustomize
Package kustomize provides a client for building Kubernetes manifests using kustomize.
|
Package kustomize provides a client for building Kubernetes manifests using kustomize. |
|
netretry
Package netretry provides shared retry utilities for transient network errors across Kubernetes client packages (Docker, Helm, etc.).
|
Package netretry provides shared retry utilities for transient network errors across Kubernetes client packages (Docker, Helm, etc.). |
|
oci
Package oci provides OCI artifact management for Kubernetes workloads.
|
Package oci provides OCI artifact management for Kubernetes workloads. |
|
reconciler
Package reconciler provides a common base for GitOps reconciliation clients.
|
Package reconciler provides a common base for GitOps reconciliation clients. |
|
Package di exposes shared dependency injection helpers for KSail commands.
|
Package di exposes shared dependency injection helpers for KSail commands. |
|
Package envvar provides utilities for working with environment variables.
|
Package envvar provides utilities for working with environment variables. |
|
Package fsutil provides utilities for filesystem operations.
|
Package fsutil provides utilities for filesystem operations. |
|
configmanager
Package configmanager provides centralized configuration management for KSail.
|
Package configmanager provides centralized configuration management for KSail. |
|
configmanager/k3d
Package k3d provides configuration management for K3d clusters.
|
Package k3d provides configuration management for K3d clusters. |
|
configmanager/kind
Package kind provides configuration management for Kind clusters.
|
Package kind provides configuration management for Kind clusters. |
|
configmanager/ksail
Package configmanager provides configuration management for KSail v1alpha1.Cluster configurations.
|
Package configmanager provides configuration management for KSail v1alpha1.Cluster configurations. |
|
configmanager/loader
Package loader provides common functionality for config managers to eliminate duplication.
|
Package loader provides common functionality for config managers to eliminate duplication. |
|
configmanager/talos
Package talos provides configuration management for Talos cluster patches.
|
Package talos provides configuration management for Talos cluster patches. |
|
generator
Package generator provides an interface for generating files from code.
|
Package generator provides an interface for generating files from code. |
|
generator/argocd
Package argocd provides generators for ArgoCD GitOps resources.
|
Package argocd provides generators for ArgoCD GitOps resources. |
|
generator/flux
Package flux provides generators for Flux GitOps resources.
|
Package flux provides generators for Flux GitOps resources. |
|
generator/k3d
Package k3dgenerator provides utilities for generating K3d cluster configurations.
|
Package k3dgenerator provides utilities for generating K3d cluster configurations. |
|
generator/kind
Package kindgenerator provides utilities for generating Kind cluster configurations.
|
Package kindgenerator provides utilities for generating Kind cluster configurations. |
|
generator/kustomization
Package kustomizationgenerator provides utilities for generating kustomization.yaml files.
|
Package kustomizationgenerator provides utilities for generating kustomization.yaml files. |
|
generator/talos
Package talosgenerator provides a generator for Talos project scaffolding.
|
Package talosgenerator provides a generator for Talos project scaffolding. |
|
generator/yaml
Package yamlgenerator provides YAML generation functionality for arbitrary models.
|
Package yamlgenerator provides YAML generation functionality for arbitrary models. |
|
marshaller
Package marshaller provides functionality for marshaling and unmarshaling resources.
|
Package marshaller provides functionality for marshaling and unmarshaling resources. |
|
scaffolder
Package scaffolder provides utilities for scaffolding KSail project files and configuration.
|
Package scaffolder provides utilities for scaffolding KSail project files and configuration. |
|
validator
Package validator provides interfaces for configuration file validation.
|
Package validator provides interfaces for configuration file validation. |
|
validator/k3d
Package k3d provides K3d configuration validation functionality.
|
Package k3d provides K3d configuration validation functionality. |
|
validator/kind
Package kind provides Kind configuration validation functionality.
|
Package kind provides Kind configuration validation functionality. |
|
validator/ksail
Package ksail provides validation for KSail cluster configurations.
|
Package ksail provides validation for KSail cluster configurations. |
|
Package k8s provides Kubernetes client configuration and general-purpose utilities.
|
Package k8s provides Kubernetes client configuration and general-purpose utilities. |
|
readiness
Package readiness provides Kubernetes resource readiness polling utilities.
|
Package readiness provides Kubernetes resource readiness polling utilities. |
|
Package notify provides utilities for sending formatted notifications to CLI users.
|
Package notify provides utilities for sending formatted notifications to CLI users. |
|
Package runner provides helpers for executing Cobra commands while capturing output.
|
Package runner provides helpers for executing Cobra commands while capturing output. |
|
Package svc provides service layer components for KSail.
|
Package svc provides service layer components for KSail. |
|
chat
Package chat provides services for the AI chat assistant feature.
|
Package chat provides services for the AI chat assistant feature. |
|
detector
Package detector detects installed Kubernetes components by querying the cluster via Helm release history and Kubernetes API.
|
Package detector detects installed Kubernetes components by querying the cluster via Helm release history and Kubernetes API. |
|
detector/cluster
Package cluster detects Kubernetes cluster distribution, provider, and other attributes by analyzing kubeconfig contexts and server endpoints.
|
Package cluster detects Kubernetes cluster distribution, provider, and other attributes by analyzing kubeconfig contexts and server endpoints. |
|
detector/gitops
Package gitops provides utilities for detecting existing Kubernetes resources in the source directory, such as GitOps Custom Resources managed by KSail.
|
Package gitops provides utilities for detecting existing Kubernetes resources in the source directory, such as GitOps Custom Resources managed by KSail. |
|
diff
Package diff provides a DiffEngine that computes configuration differences between old and new ClusterSpec values and classifies their update impact into in-place, reboot-required, and recreate-required categories.
|
Package diff provides a DiffEngine that computes configuration differences between old and new ClusterSpec values and classifies their update impact into in-place, reboot-required, and recreate-required categories. |
|
image
Package image provides services for exporting and importing container images to and from Kubernetes cluster containerd runtimes.
|
Package image provides services for exporting and importing container images to and from Kubernetes cluster containerd runtimes. |
|
image/parser
Package parser provides utilities for parsing container image references from Dockerfiles.
|
Package parser provides utilities for parsing container image references from Dockerfiles. |
|
installer
Package installer provides functionality for installing and uninstalling components.
|
Package installer provides functionality for installing and uninstalling components. |
|
installer/argocd
Package argocdinstaller installs Argo CD via Helm.
|
Package argocdinstaller installs Argo CD via Helm. |
|
installer/certmanager
Package certmanagerinstaller installs cert-manager via Helm.
|
Package certmanagerinstaller installs cert-manager via Helm. |
|
installer/cloudproviderkind
Package cloudproviderkindinstaller provides a Helm-based installer for Cloud Provider KIND.
|
Package cloudproviderkindinstaller provides a Helm-based installer for Cloud Provider KIND. |
|
installer/cni
Package cni provides unified CNI installer implementations and shared utilities for managing CNI providers on Kubernetes clusters.
|
Package cni provides unified CNI installer implementations and shared utilities for managing CNI providers on Kubernetes clusters. |
|
installer/cni/calico
Package calicoinstaller provides an installer for installing Calico CNI on a Kubernetes cluster.
|
Package calicoinstaller provides an installer for installing Calico CNI on a Kubernetes cluster. |
|
installer/cni/cilium
Package ciliuminstaller provides an installer for installing Cilium CNI on a Kubernetes cluster.
|
Package ciliuminstaller provides an installer for installing Cilium CNI on a Kubernetes cluster. |
|
installer/flux
Package fluxinstaller provides an installer for installing Flux on a Kubernetes cluster.
|
Package fluxinstaller provides an installer for installing Flux on a Kubernetes cluster. |
|
installer/gatekeeper
Package gatekeeperinstaller installs Gatekeeper via Helm.
|
Package gatekeeperinstaller installs Gatekeeper via Helm. |
|
installer/hetznercsi
Package hetznercsiinstaller installs the Hetzner Cloud CSI driver via Helm.
|
Package hetznercsiinstaller installs the Hetzner Cloud CSI driver via Helm. |
|
installer/internal/helmutil
Package helmutil provides shared helpers for Helm-based installer packages.
|
Package helmutil provides shared helpers for Helm-based installer packages. |
|
installer/kubeletcsrapprover
Package kubeletcsrapproverinstaller provides an installer for kubelet-csr-approver on a Kubernetes cluster.
|
Package kubeletcsrapproverinstaller provides an installer for kubelet-csr-approver on a Kubernetes cluster. |
|
installer/kyverno
Package kyvernoinstaller installs Kyverno via Helm.
|
Package kyvernoinstaller installs Kyverno via Helm. |
|
installer/localpathstorage
Package localpathstorageinstaller provides installation of Rancher Local Path Provisioner for Kind clusters.
|
Package localpathstorageinstaller provides installation of Rancher Local Path Provisioner for Kind clusters. |
|
installer/metallb
Package metallbinstaller installs MetalLB via Helm.
|
Package metallbinstaller installs MetalLB via Helm. |
|
installer/metricsserver
Package metricsserverinstaller provides an installer for installing metrics-server on a Kubernetes cluster.
|
Package metricsserverinstaller provides an installer for installing metrics-server on a Kubernetes cluster. |
|
mcp
Package mcp provides an MCP server for exposing KSail commands as tools.
|
Package mcp provides an MCP server for exposing KSail commands as tools. |
|
provider
Package provider defines infrastructure providers for running Kubernetes cluster nodes.
|
Package provider defines infrastructure providers for running Kubernetes cluster nodes. |
|
provider/docker
Package docker provides a Docker-based infrastructure provider.
|
Package docker provides a Docker-based infrastructure provider. |
|
provider/hetzner
Package hetzner implements provider.Provider for Hetzner Cloud servers.
|
Package hetzner implements provider.Provider for Hetzner Cloud servers. |
|
provisioner
Package provisioner provides cluster and registry provisioning services.
|
Package provisioner provides cluster and registry provisioning services. |
|
provisioner/cluster
Package clusterprovisioner provides cluster provisioning for KSail distributions.
|
Package clusterprovisioner provides cluster provisioning for KSail distributions. |
|
provisioner/cluster/clustererr
Package clustererr provides common error types for cluster provisioners.
|
Package clustererr provides common error types for cluster provisioners. |
|
provisioner/cluster/clusterupdate
Package clusterupdate provides shared types for cluster update operations.
|
Package clusterupdate provides shared types for cluster update operations. |
|
provisioner/cluster/k3d
Package k3dprovisioner contains the K3d cluster provisioner and its client provider interfaces.
|
Package k3dprovisioner contains the K3d cluster provisioner and its client provider interfaces. |
|
provisioner/cluster/kind
Package kindprovisioner provides implementations of the ClusterProvisioner interface for provisioning Kind clusters.
|
Package kindprovisioner provides implementations of the ClusterProvisioner interface for provisioning Kind clusters. |
|
provisioner/cluster/talos
Package talosprovisioner provides implementations of the ClusterProvisioner interface for provisioning Talos-in-Docker clusters.
|
Package talosprovisioner provides implementations of the ClusterProvisioner interface for provisioning Talos-in-Docker clusters. |
|
provisioner/registry
Package registry centralizes all registry lifecycle helpers that KSail-Go needs for local development clusters.
|
Package registry centralizes all registry lifecycle helpers that KSail-Go needs for local development clusters. |
|
registryresolver
Package registryresolver provides OCI registry detection, resolution, and artifact push utilities.
|
Package registryresolver provides OCI registry detection, resolution, and artifact push utilities. |
|
state
Package state provides cluster state persistence for distributions that cannot introspect their running configuration (Kind, K3d).
|
Package state provides cluster state persistence for distributions that cannot introspect their running configuration (Kind, K3d). |
|
Package timer provides timing functionality for tracking command execution duration.
|
Package timer provides timing functionality for tracking command execution duration. |
|
Package toolgen provides automatic tool generation from Cobra commands for AI interfaces.
|
Package toolgen provides automatic tool generation from Cobra commands for AI interfaces. |
Click to show internal directories.
Click to hide internal directories.