lifecycle

func CreateMinimalProvisioner ¶ added in v5.13.0

func CreateMinimalProvisioner(
	distribution v1alpha1.Distribution,
	clusterName string,
) (clusterprovisioner.ClusterProvisioner, error)

CreateMinimalProvisioner creates a minimal provisioner for lifecycle operations. These provisioners only need enough configuration to identify containers.

func DetectDistributionFromContext ¶ added in v5.13.0

func DetectDistributionFromContext(ctx string) (v1alpha1.Distribution, string, error)

DetectDistributionFromContext detects the distribution and cluster name from a context string. This auto-detects the distribution based on the context naming pattern:

• Kind: kind-<cluster-name>
• K3d: k3d-<cluster-name>
• Talos: admin@<cluster-name>

Returns the detected distribution, cluster name, and an error if the pattern is unrecognized.

func ExtractClusterNameFromContext ¶

func ExtractClusterNameFromContext(context string, distribution v1alpha1.Distribution) string

ExtractClusterNameFromContext extracts the cluster name from a context string. For kind clusters, contexts follow the pattern "kind-<cluster-name>". For k3d clusters, contexts follow the pattern "k3d-<cluster-name>". Returns empty string if the context doesn't match the expected pattern.

func GetClusterNameFromConfig ¶

func GetClusterNameFromConfig(
	clusterCfg *v1alpha1.Cluster,
	factory clusterprovisioner.Factory,
) (string, error)

GetClusterNameFromConfig extracts the cluster name from the KSail cluster configuration. When a context is explicitly set, it derives the cluster name from it. Otherwise, it loads the distribution config and extracts the name from there. This function is exported for use in command handlers that need the cluster name for operations beyond the standard lifecycle actions.

func HandleRunE ¶

func HandleRunE(
	cmd *cobra.Command,
	cfgManager *ksailconfigmanager.ConfigManager,
	deps Deps,
	config Config,
) error

HandleRunE orchestrates the standard lifecycle workflow. It performs the following steps in order:

1. Create a new timer stage (config was already loaded in WrapHandler)
2. Execute the lifecycle action via RunWithConfig

Note: The cluster configuration is already loaded by WrapHandler, so this function uses the cached config from cfgManager.Config.

func NewSimpleLifecycleCmd ¶ added in v5.13.0

func NewSimpleLifecycleCmd(config SimpleLifecycleConfig) *cobra.Command

NewSimpleLifecycleCmd creates a simple lifecycle command (start/stop) with context auto-detection. Unlike config-based lifecycle commands, these commands don't require a ksail.yaml file and instead detect the cluster from the kubeconfig context pattern.

func NewStandardRunE ¶

func NewStandardRunE(
	runtimeContainer *runtime.Runtime,
	cfgManager *ksailconfigmanager.ConfigManager,
	config Config,
) func(*cobra.Command, []string) error

NewStandardRunE creates a standard RunE handler for simple lifecycle commands. It handles dependency injection from the runtime container and delegates to HandleRunE with the provided lifecycle configuration.

This is the recommended way to create lifecycle command handlers for standard operations like start, stop, and delete. The returned function can be assigned directly to a cobra.Command's RunE field.

func RunWithConfig ¶

func RunWithConfig(
	cmd *cobra.Command,
	deps Deps,
	config Config,
	clusterCfg *v1alpha1.Cluster,
) error

RunWithConfig executes a lifecycle command using a pre-loaded cluster configuration. This function is useful when the cluster configuration has already been loaded, avoiding the need to reload it.

It performs the following steps:

1. Create the cluster provisioner using the factory
2. Extract the cluster name from the distribution config or context
3. Execute the lifecycle action
4. Display success message with timing information

Returns an error if provisioner creation, cluster name extraction, or the action itself fails.

func WrapHandler ¶

func WrapHandler(
	runtimeContainer *runtime.Runtime,
	cfgManager *ksailconfigmanager.ConfigManager,
	handler func(*cobra.Command, *ksailconfigmanager.ConfigManager, Deps) error,
) func(*cobra.Command, []string) error

WrapHandler resolves lifecycle dependencies from the runtime container and invokes the provided handler function with those dependencies.

This function loads the cluster configuration first, then creates a factory using the cached distribution config from the config manager. This ensures the factory has the proper distribution-specific configuration.

The output is wrapped with StageSeparatingWriter to automatically add blank lines between CLI stages for better readability.

This function is used internally by NewStandardRunE but can also be used directly for custom lifecycle handlers that need dependency injection but require custom logic beyond the standard HandleRunE flow.