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 SetIsoCreationFunction(isoFunc IsoCreationFunc)
• func SetLocalDirectory(dir string) error
• type CloudInitData
  • func ReadCloudInitVolumeDataSource(vmi *v1.VirtualMachineInstance, secretSourceDir string) (cloudInitData *CloudInitData, err error)
• type ConfigDriveMetadata
• type DataSourceType
• type DeviceData
• type DeviceMetadataType
• type IsoCreationFunc
• type NoCloudMetadata
• type PublicSSHKey

Constants

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

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 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
	NoCloudMetaData     *NoCloudMetadata
	ConfigDriveMetaData *ConfigDriveMetadata
	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, secretSourceDir string) (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.

type ConfigDriveMetadata

type ConfigDriveMetadata 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"`
	PublicSSHKeys map[string]string `json:"public_keys,omitempty"`
}

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 NoCloudMetadata

type NoCloudMetadata struct {
	InstanceID    string `json:"instance-id"`
	LocalHostname string `json:"local-hostname,omitempty"`
}

type PublicSSHKey

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