README
¶
pkg/scaffolder
This package provides scaffolding utilities for KSail projects.
Purpose
Contains utilities for generating KSail project files and configurations. The scaffold creator provides the necessary configuration files for a complete KSail project setup.
Features
- Multi-Distribution Support: Scaffolds configurations for different Kubernetes distributions (Kind, K3d, EKS)
- Complete Project Setup: Generates all required files including ksail.yaml, distribution configs, and kustomization files
- Force Overwrite: Option to overwrite existing files
- Directory Structure: Creates proper directory structure for source files
Usage
import "github.com/devantler-tech/ksail-go/pkg/scaffolder"
// Create a cluster configuration
cluster := v1alpha1.Cluster{
TypeMeta: metav1.TypeMeta{
APIVersion: v1alpha1.APIVersion,
Kind: v1alpha1.Kind,
},
Metadata: metav1.ObjectMeta{
Name: "my-cluster",
},
Spec: v1alpha1.Spec{
Distribution: v1alpha1.DistributionKind,
SourceDirectory: "k8s",
DistributionConfig: "kind.yaml",
},
}
// Create scaffold instance and generate files
scaffold := scaffolder.NewScaffolder(cluster, os.Stdout)
err := scaffold.Scaffold("/path/to/output/", false)
if err != nil {
log.Fatal(err)
}
Generated Files
The scaffold creator generates the following files based on the cluster configuration:
- ksail.yaml: Main KSail cluster configuration
- Distribution config: Kind, K3d, or EKS-specific configuration file
- kustomization.yaml: Kustomization file in the source directory
Distribution-Specific Files
- Kind: Generates
kind.yamlwith a basic cluster configuration - K3d: Generates
k3d.yamlwith a simple k3d cluster configuration - EKS: Generates
eks.yamlwith an EKS cluster configuration including node groups
Documentation
¶
Overview ¶
Package scaffolder provides utilities for scaffolding KSail project files and configuration.
Index ¶
Constants ¶
const ( KindConfigFile = "kind.yaml" K3dConfigFile = "k3d.yaml" )
Distribution config file constants.
Variables ¶
var ( ErrUnknownDistribution = errors.New("provided distribution is unknown") ErrKSailConfigGeneration = errors.New("failed to generate KSail configuration") ErrKindConfigGeneration = errors.New("failed to generate Kind configuration") ErrK3dConfigGeneration = errors.New("failed to generate K3d configuration") ErrKustomizationGeneration = errors.New("failed to generate kustomization configuration") )
Error definitions for distribution handling.
Functions ¶
This section is empty.
Types ¶
type GenerationParams ¶
type GenerationParams[T any] struct { Gen generator.Generator[T, yamlgenerator.Options] Model T Opts yamlgenerator.Options DisplayName string Force bool WrapErr func(error) error }
GenerationParams groups parameters for generateWithFileHandling.
type Scaffolder ¶
type Scaffolder struct {
KSailConfig v1alpha1.Cluster
KSailYAMLGenerator generator.Generator[v1alpha1.Cluster, yamlgenerator.Options]
KindGenerator generator.Generator[*v1alpha4.Cluster, yamlgenerator.Options]
K3dGenerator generator.Generator[*k3dv1alpha5.SimpleConfig, yamlgenerator.Options]
KustomizationGenerator generator.Generator[*ktypes.Kustomization, yamlgenerator.Options]
Writer io.Writer
}
Scaffolder is responsible for generating KSail project files and configurations.
func NewScaffolder ¶
func NewScaffolder(cfg v1alpha1.Cluster, writer io.Writer) *Scaffolder
NewScaffolder creates a new Scaffolder instance with the provided KSail cluster configuration.
Source Files