names

Documentation

Overview

Package names implements name generators for managed topology.

Index

• type NameGenerator
  • func ControlPlaneNameGenerator(templateString, clusterName string) NameGenerator
  • func MachineDeploymentNameGenerator(templateString, clusterName, topologyName string) NameGenerator
  • func MachinePoolNameGenerator(templateString, clusterName, topologyName string) NameGenerator
  • func SimpleNameGenerator(base string) NameGenerator

Types

type NameGenerator

type NameGenerator interface {
	// GenerateName generates a valid name. The generator is responsible for
	// knowing the maximum valid name length.
	GenerateName() (string, error)
}

NameGenerator generates names for objects.

func ControlPlaneNameGenerator

func ControlPlaneNameGenerator(templateString, clusterName string) NameGenerator

ControlPlaneNameGenerator returns a generator for creating a control plane name.

func MachineDeploymentNameGenerator

func MachineDeploymentNameGenerator(templateString, clusterName, topologyName string) NameGenerator

MachineDeploymentNameGenerator returns a generator for creating a machinedeployment name.

func MachinePoolNameGenerator

func MachinePoolNameGenerator(templateString, clusterName, topologyName string) NameGenerator

MachinePoolNameGenerator returns a generator for creating a machinepool name.

func SimpleNameGenerator

func SimpleNameGenerator(base string) NameGenerator

SimpleNameGenerator returns a NameGenerator which is based on k8s.io/apiserver/pkg/storage/names.SimpleNameGenerator.