metadata

Documentation

Overview

Package metadata is a generated GoMock package.

Index

• Constants
• Variables
• func CheckMetadataSearchOrder(order string) error
• func Clear()
• func GetDevicePath(ctx context.Context, volumeID string) (string, error)
• func Set(value *Metadata)
• type DeviceMetadata
• type Duration
  • func (d *Duration) UnmarshalText(text []byte) error
• type IMetadata
  • func GetMetadataProvider(order string) IMetadata
• type Metadata
  • func Get(ctx context.Context, order string) (*Metadata, error)
• type MockIMetadata
  • func NewMockIMetadata(ctrl *gomock.Controller) *MockIMetadata
  • func (m *MockIMetadata) EXPECT() *MockIMetadataMockRecorder
  • func (m *MockIMetadata) GetAvailabilityZone(ctx context.Context) (string, error)
  • func (m *MockIMetadata) GetFlavor(ctx context.Context) (string, error)
  • func (m *MockIMetadata) GetInstanceID(ctx context.Context) (string, error)
• type MockIMetadataMockRecorder
  • func (mr *MockIMetadataMockRecorder) GetAvailabilityZone(ctx any) *gomock.Call
  • func (mr *MockIMetadataMockRecorder) GetFlavor(ctx any) *gomock.Call
  • func (mr *MockIMetadataMockRecorder) GetInstanceID(ctx any) *gomock.Call
• type Opts

Constants

const (
	InstanceTypeURLTemplate = "http://169.254.169.254/%s/meta-data/instance-type"

	// MetadataID is used as an identifier on the metadata search order configuration.
	MetadataID = "metadataService"

	// ConfigDriveID is used as an identifier on the metadata search order configuration.
	ConfigDriveID = "configDrive"
)

Variables

var ErrBadMetadata = errors.New("invalid OpenStack metadata, got empty uuid")

ErrBadMetadata is used to indicate a problem parsing data from metadata server

Functions

func CheckMetadataSearchOrder

func CheckMetadataSearchOrder(order string) error

func Clear

func Clear()

Clear clears the metadatacache

func GetDevicePath

func GetDevicePath(ctx context.Context, volumeID string) (string, error)

GetDevicePath retrieves device path from metadata service

func Set

func Set(value *Metadata)

Set sets the value of metadatacache

Types

type DeviceMetadata

type DeviceMetadata struct {
	Type    string `json:"type"`
	Bus     string `json:"bus,omitempty"`
	Serial  string `json:"serial,omitempty"`
	Address string `json:"address,omitempty"`
}

DeviceMetadata is a single/simplified data structure for all kinds of device metadata types.

type Duration

type Duration struct {
	time.Duration
}

Duration is the encoding.TextUnmarshaler interface for time.Duration

func (*Duration) UnmarshalText

func (d *Duration) UnmarshalText(text []byte) error

UnmarshalText is used to convert from text to Duration

type IMetadata

type IMetadata interface {
	GetInstanceID(ctx context.Context) (string, error)
	GetAvailabilityZone(ctx context.Context) (string, error)
	GetFlavor(ctx context.Context) (string, error)
}

IMetadata implements GetInstanceID & GetAvailabilityZone

var MetadataService IMetadata

MetadataService instance of IMetadata

func GetMetadataProvider

func GetMetadataProvider(order string) IMetadata

GetMetadataProvider retrieves instance of IMetadata

type Metadata

type Metadata struct {
	UUID             string           `json:"uuid"`
	Name             string           `json:"name"`
	AvailabilityZone string           `json:"availability_zone"`
	Devices          []DeviceMetadata `json:"devices,omitempty"`
}

Metadata has the information fetched from OpenStack metadata service or config drives. Assumes the "latest" meta_data.json format.

func Get

func Get(ctx context.Context, order string) (*Metadata, error)

Get retrieves metadata from either config drive or metadata service. Search order depends on the order set in config file.

type MockIMetadata

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

MockIMetadata is a mock of IMetadata interface.

func NewMockIMetadata

func NewMockIMetadata(ctrl *gomock.Controller) *MockIMetadata

NewMockIMetadata creates a new mock instance.

func (*MockIMetadata) EXPECT

func (m *MockIMetadata) EXPECT() *MockIMetadataMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockIMetadata) GetAvailabilityZone

func (m *MockIMetadata) GetAvailabilityZone(ctx context.Context) (string, error)

GetAvailabilityZone mocks base method.

func (*MockIMetadata) GetFlavor

func (m *MockIMetadata) GetFlavor(ctx context.Context) (string, error)

GetFlavor mocks base method.

func (*MockIMetadata) GetInstanceID

func (m *MockIMetadata) GetInstanceID(ctx context.Context) (string, error)

GetInstanceID mocks base method.

type MockIMetadataMockRecorder

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

MockIMetadataMockRecorder is the mock recorder for MockIMetadata.

func (*MockIMetadataMockRecorder) GetAvailabilityZone

func (mr *MockIMetadataMockRecorder) GetAvailabilityZone(ctx any) *gomock.Call

GetAvailabilityZone indicates an expected call of GetAvailabilityZone.

func (*MockIMetadataMockRecorder) GetFlavor

func (mr *MockIMetadataMockRecorder) GetFlavor(ctx any) *gomock.Call

GetFlavor indicates an expected call of GetFlavor.

func (*MockIMetadataMockRecorder) GetInstanceID

func (mr *MockIMetadataMockRecorder) GetInstanceID(ctx any) *gomock.Call

GetInstanceID indicates an expected call of GetInstanceID.

type Opts

type Opts struct {
	SearchOrder    string   `yaml:"searchOrder"`
	RequestTimeout Duration `yaml:"requestTimeout"`
}

revive:enable:exported Opts is used for configuring how to talk to metadata service or config drive