kindgenerator

package
v1.11.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 8, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

README

pkg/io/generator/kind

This package provides Kind-specific resource generators for KSail.

Purpose

Generates Kubernetes resources and configuration files specifically tailored for Kind (Kubernetes in Docker) clusters. Kind is a tool for running local Kubernetes clusters using Docker container "nodes".

Features

  • Kind-Specific Resources: Generates resources optimized for Kind environments
  • Docker Integration: Handles Docker-specific configurations for Kind clusters
  • Local Development: Generates configurations suitable for local Kubernetes development
  • Multi-Node Support: Supports configurations for single and multi-node Kind clusters

Usage

import "github.com/devantler-tech/ksail-go/pkg/io/generator/kind"

// Generate Kind-specific resources
generator := kind.NewGenerator(/* configuration */)
resources, err := generator.Generate(/* parameters */)
if err != nil {
    log.Fatal("Failed to generate Kind resources:", err)
}

This generator is used when KSail needs to create resources specifically for Kind clusters, ensuring compatibility with Kind's Docker-based node architecture and local development workflows.


⬅️ Go Back

Documentation

Overview

Package kindgenerator provides utilities for generating kind cluster configurations.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type KindGenerator

type KindGenerator struct {
	Marshaller marshaller.Marshaller[*v1alpha4.Cluster]
}

KindGenerator generates a kind Cluster YAML.

func NewKindGenerator

func NewKindGenerator() *KindGenerator

NewKindGenerator creates and returns a new KindGenerator instance.

func (*KindGenerator) Generate

func (g *KindGenerator) Generate(
	cfg *v1alpha4.Cluster,
	opts yamlgenerator.Options,
) (string, error)

Generate creates a kind cluster YAML configuration and writes it to the specified output.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL