cloudinit

Documentation

Index

• Constants
• func GenerateLocalData(vmiName string, namespace string, data *CloudInitData) error
• func GetIsoFilePath(source DataSourceType, domain, namespace string) string
• func IsValidCloudInitData(cloudInitData *CloudInitData) bool
• func ResolveConfigDriveSecrets(vmi *v1.VirtualMachineInstance, secretSourceDir string) error
• func ResolveNoCloudSecrets(vmi *v1.VirtualMachineInstance, secretSourceDir string) error
• func SetIsoCreationFunction(isoFunc IsoCreationFunc)
• func SetLocalDirectory(dir string) error
• type CloudInitData
  • func ReadCloudInitVolumeDataSource(vmi *v1.VirtualMachineInstance) (cloudInitData *CloudInitData, err error)
• type DataSourceType
• type DeviceData
• type DeviceMetadataType
• type IsoCreationFunc
• type Metadata

Constants

const (
	DataSourceNoCloud     DataSourceType     = "noCloud"
	DataSourceConfigDrive DataSourceType     = "configDrive"
	NICMetadataType       DeviceMetadataType = "nic"
	DiskMetadataType      DeviceMetadataType = "disk"
)

Functions

func GenerateLocalData

func GenerateLocalData(vmiName string, namespace string, data *CloudInitData) error

func GetIsoFilePath

func GetIsoFilePath(source DataSourceType, domain, namespace string) string

func IsValidCloudInitData

func IsValidCloudInitData(cloudInitData *CloudInitData) bool

IsValidCloudInitData checks if the given CloudInitData object is valid in the sense that GenerateLocalData can be called with it.

func ResolveConfigDriveSecrets

func ResolveConfigDriveSecrets(vmi *v1.VirtualMachineInstance, secretSourceDir string) error

ResolveConfigDriveSecrets is looking for CloudInitConfigDriveSource volume source with UserDataSecretRef and NetworkDataSecretRef and resolves the secret from the corresponding VolumeMount.

Note: when using this function, make sure that your code can access the secret volumes.

func ResolveNoCloudSecrets

func ResolveNoCloudSecrets(vmi *v1.VirtualMachineInstance, secretSourceDir string) error

ResolveNoCloudSecrets is looking for CloudInitNoCloud volumes with UserDataSecretRef requests. It reads the `userdata` secret the corresponds to the given CloudInitNoCloud volume and sets the UserData field on that volume.

Note: when using this function, make sure that your code can access the secret volumes.

func SetIsoCreationFunction

func SetIsoCreationFunction(isoFunc IsoCreationFunc)

The unit test suite uses this function

func SetLocalDirectory

func SetLocalDirectory(dir string) error

Types

type CloudInitData

type CloudInitData struct {
	DataSource  DataSourceType
	MetaData    *Metadata
	UserData    string
	NetworkData string
	DevicesData *[]DeviceData
}

CloudInitData is a data source independent struct that holds cloud-init user and network data

func ReadCloudInitVolumeDataSource

func ReadCloudInitVolumeDataSource(vmi *v1.VirtualMachineInstance) (cloudInitData *CloudInitData, err error)

ReadCloudInitVolumeDataSource scans the given VMI for CloudInit volumes and reads their content into a CloudInitData struct. Does not resolve secret refs. To ensure that secrets are read correctly, call ResolveNoCloudSecrets beforehand.

type DataSourceType

type DataSourceType string

type DeviceData

type DeviceData struct {
	Type    DeviceMetadataType `json:"type"`
	Bus     string             `json:"bus"`
	Address string             `json:"address"`
	MAC     string             `json:"mac,omitempty"`
	Serial  string             `json:"serial,omitempty"`
	Tags    []string           `json:"tags"`
}

type DeviceMetadataType

type DeviceMetadataType string

type IsoCreationFunc

type IsoCreationFunc func(isoOutFile, volumeID string, inDir string) error

type Metadata

type Metadata struct {
	InstanceID    string        `json:"instance-id"`
	LocalHostname string        `json:"local-hostname,omitempty"`
	Hostname      string        `json:"hostname,omitempty"`
	UUID          string        `json:"uuid,omitempty"`
	Devices       *[]DeviceData `json:"devices,omitempty"`
}