cloudinit

package
v0.7.2 Latest Latest
Warning

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

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

Documentation

Overview

Package cloudinit implements kubeadm cloudinit functionality.

Index

Constants

View Source
const (

	// EmptyNetworkV1 is an empty network-config for version 1.
	EmptyNetworkV1 = `version: 1
config: []`
)
View Source
const (
	// FormatCloudConfig is the format for cloud-config.
	FormatCloudConfig = "cloud-config"
)

Variables

View Source
var (
	// ErrMissingHostname returns an error if required hostname is empty.
	ErrMissingHostname = errors.New("hostname is not set")

	// ErrMissingInstanceID returns an error if required hostname is empty.
	ErrMissingInstanceID = errors.New("instance-id is not set")

	// ErrMissingIPAddress returns an error if required ip address is empty.
	ErrMissingIPAddress = errors.New("ip address is not set")

	// ErrMalformedIPAddress returns an error if ip address is malformed.
	ErrMalformedIPAddress = errors.New("malformed ip address")

	// ErrMissingGateway returns an error if required gateway is empty.
	ErrMissingGateway = errors.New("gateway is not set")

	// ErrConflictingMetrics returns an error if a metric for a route already exists.
	ErrConflictingMetrics = errors.New("metric already exists for default gateway")

	// ErrMissingMacAddress returns an error if required mac address is empty.
	ErrMissingMacAddress = errors.New("mac address is not set")

	// ErrMissingNetworkConfigData returns an error if required network config data is empty.
	ErrMissingNetworkConfigData = errors.New("network config data is not set")

	// ErrMissingIPAddresses returns an error if required ip addresses is empty.
	ErrMissingIPAddresses = errors.New("ip addresses is not set")

	// ErrMalformedRoute is returned if a route can not be assembled by netplan.
	ErrMalformedRoute = errors.New("route is malformed")

	// ErrMalformedFIBRule is returned if a FIB rule can not be assembled by netplan.
	ErrMalformedFIBRule = errors.New("routing policy is malformed")
)

Functions

This section is empty.

Types

type BaseCloudInitData

type BaseCloudInitData struct {
	Hostname            string
	InstanceID          string
	KubernetesVersion   string
	ProviderIDInjection bool
	NetworkConfigData   []types.NetworkConfigData
}

BaseCloudInitData is shared across all the various types of files written to disk. used to render cloudinit.

type Metadata

type Metadata struct {
	// contains filtered or unexported fields
}

Metadata provides functionality to render machine metadata.

func NewMetadata

func NewMetadata(instanceID, hostname string, kubernetesVersion string, injectProviderID bool) *Metadata

NewMetadata returns a new Metadata object.

func (*Metadata) Render

func (r *Metadata) Render() (metadata []byte, err error)

Render returns rendered metadata.

type NetworkConfig

type NetworkConfig struct {
	// contains filtered or unexported fields
}

NetworkConfig provides functionality to render machine network-config.

func NewNetworkConfig

func NewNetworkConfig(configs []types.NetworkConfigData) *NetworkConfig

NewNetworkConfig returns a new NetworkConfig object.

func (*NetworkConfig) Render

func (r *NetworkConfig) Render() ([]byte, error)

Render returns rendered network-config.

type Renderer

type Renderer interface {
	Render() ([]byte, error)
}

Renderer renders cloud-init data.

Jump to

Keyboard shortcuts

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