openstack

package
v1.30.2 Latest Latest
Warning

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

 Go to latest Published: Nov 23, 2024 License: Apache-2.0 Imports: 27 Imported by: 4

Documentation

Overview

Package openstack backups provides an implementation of Cinder Backup features cinder functions using Gophercloud.

Package openstack snapshots provides an implementation of Cinder Snapshot features cinder functions using Gophercloud.

Index

Constants

View Source 
const (
	BackupMaxDurationSecondsPerGBDefault = 20
	BackupMaxDurationPerGB               = "backup-max-duration-seconds-per-gb"
)
View Source 
const (
	SnapshotForceCreate      = "force-create"
	SnapshotType             = "type"
	SnapshotAvailabilityZone = "availability"
)
View Source 
const (
	VolumeAvailableStatus = "available"
	VolumeInUseStatus     = "in-use"
)

Variables

This section is empty.

Functions

func AddExtraFlags added in v1.16.0 

func AddExtraFlags(fs *pflag.FlagSet)

AddExtraFlags is called by the main package to add component specific command line flags

func InitOpenStackProvider 

func InitOpenStackProvider(cfgFiles []string, httpEndpoint string)

Types

type BlockStorageOpts added in v1.15.0 

type BlockStorageOpts struct {
	NodeVolumeAttachLimit    int64 `gcfg:"node-volume-attach-limit"`
	RescanOnResize           bool  `gcfg:"rescan-on-resize"`
	IgnoreVolumeAZ           bool  `gcfg:"ignore-volume-az"`
	IgnoreVolumeMicroversion bool  `gcfg:"ignore-volume-microversion"`
}

type Config 

type Config struct {
	Global       client.AuthOpts
	Metadata     metadata.Opts
	BlockStorage BlockStorageOpts
}

func GetConfigFromFiles added in v1.22.0 

func GetConfigFromFiles(configFilePaths []string) (Config, error)

GetConfigFromFiles retrieves config options from file

type IOpenStack 

type IOpenStack interface {
	CreateVolume(name string, size int, vtype, availability string, snapshotID string, sourceVolID string, sourceBackupID string, tags map[string]string) (*volumes.Volume, error)
	DeleteVolume(volumeID string) error
	AttachVolume(instanceID, volumeID string) (string, error)
	ListVolumes(limit int, startingToken string) ([]volumes.Volume, string, error)
	WaitDiskAttached(instanceID string, volumeID string) error
	DetachVolume(instanceID, volumeID string) error
	WaitDiskDetached(instanceID string, volumeID string) error
	WaitVolumeTargetStatus(volumeID string, tStatus []string) error
	GetAttachmentDiskPath(instanceID, volumeID string) (string, error)
	GetVolume(volumeID string) (*volumes.Volume, error)
	GetVolumesByName(name string) ([]volumes.Volume, error)
	CreateSnapshot(name, volID string, tags map[string]string) (*snapshots.Snapshot, error)
	ListSnapshots(filters map[string]string) ([]snapshots.Snapshot, string, error)
	DeleteSnapshot(snapID string) error
	GetSnapshotByID(snapshotID string) (*snapshots.Snapshot, error)
	WaitSnapshotReady(snapshotID string) (string, error)
	CreateBackup(name, volID, snapshotID, availabilityZone string, tags map[string]string) (*backups.Backup, error)
	ListBackups(filters map[string]string) ([]backups.Backup, error)
	DeleteBackup(backupID string) error
	GetBackupByID(backupID string) (*backups.Backup, error)
	BackupsAreEnabled() (bool, error)
	WaitBackupReady(backupID string, snapshotSize int, backupMaxDurationSecondsPerGB int) (string, error)
	GetInstanceByID(instanceID string) (*servers.Server, error)
	ExpandVolume(volumeID string, status string, size int) error
	GetMaxVolLimit() int64
	GetMetadataOpts() metadata.Opts
	GetBlockStorageOpts() BlockStorageOpts
}
var NoopInstance IOpenStack
var OsInstance IOpenStack

func CreateOpenStackProvider added in v1.14.0 

func CreateOpenStackProvider(noClient bool) (IOpenStack, error)

CreateOpenStackProvider creates Openstack Instance

func GetOpenStackProvider 

func GetOpenStackProvider(noClient bool) (IOpenStack, error)

GetOpenStackProvider returns Openstack Instance

type NoopOpenStack added in v1.28.3 

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

func (*NoopOpenStack) AttachVolume added in v1.28.3 

func (os *NoopOpenStack) AttachVolume(instanceID, volumeID string) (string, error)

func (*NoopOpenStack) BackupsAreEnabled added in v1.28.3 

func (os *NoopOpenStack) BackupsAreEnabled() (bool, error)

func (*NoopOpenStack) CreateBackup added in v1.28.3 

func (os *NoopOpenStack) CreateBackup(name, volID, snapshotID, availabilityZone string, tags map[string]string) (*backups.Backup, error)

func (*NoopOpenStack) CreateSnapshot added in v1.28.3 

func (os *NoopOpenStack) CreateSnapshot(name, volID string, tags map[string]string) (*snapshots.Snapshot, error)

func (*NoopOpenStack) CreateVolume added in v1.28.3 

func (os *NoopOpenStack) CreateVolume(name string, size int, vtype, availability string, snapshotID string, sourceVolID string, sourceBackupID string, tags map[string]string) (*volumes.Volume, error)

func (*NoopOpenStack) DeleteBackup added in v1.28.3 

func (os *NoopOpenStack) DeleteBackup(backupID string) error

func (*NoopOpenStack) DeleteSnapshot added in v1.28.3 

func (os *NoopOpenStack) DeleteSnapshot(snapID string) error

func (*NoopOpenStack) DeleteVolume added in v1.28.3 

func (os *NoopOpenStack) DeleteVolume(volumeID string) error

func (*NoopOpenStack) DetachVolume added in v1.28.3 

func (os *NoopOpenStack) DetachVolume(instanceID, volumeID string) error

func (*NoopOpenStack) ExpandVolume added in v1.28.3 

func (os *NoopOpenStack) ExpandVolume(volumeID string, status string, newSize int) error

func (*NoopOpenStack) GetAttachmentDiskPath added in v1.28.3 

func (os *NoopOpenStack) GetAttachmentDiskPath(instanceID, volumeID string) (string, error)

func (*NoopOpenStack) GetBackupByID added in v1.28.3 

func (os *NoopOpenStack) GetBackupByID(backupID string) (*backups.Backup, error)

func (*NoopOpenStack) GetBlockStorageOpts added in v1.28.3 

func (os *NoopOpenStack) GetBlockStorageOpts() BlockStorageOpts

func (*NoopOpenStack) GetInstanceByID added in v1.28.3 

func (os *NoopOpenStack) GetInstanceByID(instanceID string) (*servers.Server, error)

func (*NoopOpenStack) GetMaxVolLimit added in v1.28.3 

func (os *NoopOpenStack) GetMaxVolLimit() int64

func (*NoopOpenStack) GetMetadataOpts added in v1.28.3 

func (os *NoopOpenStack) GetMetadataOpts() metadata.Opts

func (*NoopOpenStack) GetSnapshotByID added in v1.28.3 

func (os *NoopOpenStack) GetSnapshotByID(snapshotID string) (*snapshots.Snapshot, error)

func (*NoopOpenStack) GetVolume added in v1.28.3 

func (os *NoopOpenStack) GetVolume(volumeID string) (*volumes.Volume, error)

func (*NoopOpenStack) GetVolumesByName added in v1.28.3 

func (os *NoopOpenStack) GetVolumesByName(n string) ([]volumes.Volume, error)

func (*NoopOpenStack) ListBackups added in v1.28.3 

func (os *NoopOpenStack) ListBackups(filters map[string]string) ([]backups.Backup, error)

func (*NoopOpenStack) ListSnapshots added in v1.28.3 

func (os *NoopOpenStack) ListSnapshots(filters map[string]string) ([]snapshots.Snapshot, string, error)

func (*NoopOpenStack) ListVolumes added in v1.28.3 

func (os *NoopOpenStack) ListVolumes(limit int, startingToken string) ([]volumes.Volume, string, error)

func (*NoopOpenStack) WaitBackupReady added in v1.28.3 

func (os *NoopOpenStack) WaitBackupReady(backupID string, snapshotSize int, backupMaxDurationSecondsPerGB int) (string, error)

func (*NoopOpenStack) WaitDiskAttached added in v1.28.3 

func (os *NoopOpenStack) WaitDiskAttached(instanceID string, volumeID string) error

func (*NoopOpenStack) WaitDiskDetached added in v1.28.3 

func (os *NoopOpenStack) WaitDiskDetached(instanceID string, volumeID string) error

func (*NoopOpenStack) WaitSnapshotReady added in v1.28.3 

func (os *NoopOpenStack) WaitSnapshotReady(snapshotID string) (string, error)

func (*NoopOpenStack) WaitVolumeTargetStatus added in v1.28.3 

func (os *NoopOpenStack) WaitVolumeTargetStatus(volumeID string, tStatus []string) error

type OpenStack 

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

func (*OpenStack) AttachVolume 

func (os *OpenStack) AttachVolume(instanceID, volumeID string) (string, error)

AttachVolume attaches given cinder volume to the compute

func (*OpenStack) BackupsAreEnabled added in v1.30.0 

func (os *OpenStack) BackupsAreEnabled() (bool, error)

func (*OpenStack) CreateBackup added in v1.30.0 

func (os *OpenStack) CreateBackup(name, volID, snapshotID, availabilityZone string, tags map[string]string) (*backups.Backup, error)

CreateBackup issues a request to create a Backup from the specified Snapshot with the corresponding ID and returns the resultant gophercloud Backup Item upon success.

func (*OpenStack) CreateSnapshot 

func (os *OpenStack) CreateSnapshot(name, volID string, tags map[string]string) (*snapshots.Snapshot, error)

CreateSnapshot issues a request to take a Snapshot of the specified Volume with the corresponding ID and returns the resultant gophercloud Snapshot Item upon success

func (*OpenStack) CreateVolume 

func (os *OpenStack) CreateVolume(name string, size int, vtype, availability string, snapshotID string, sourceVolID string, sourceBackupID string, tags map[string]string) (*volumes.Volume, error)

CreateVolume creates a volume of given size

func (*OpenStack) DeleteBackup added in v1.30.0 

func (os *OpenStack) DeleteBackup(backupID string) error

DeleteBackup issues a request to delete the Backup with the specified ID from the Cinder backend.

func (*OpenStack) DeleteSnapshot 

func (os *OpenStack) DeleteSnapshot(snapID string) error

DeleteSnapshot issues a request to delete the Snapshot with the specified ID from the Cinder backend

func (*OpenStack) DeleteVolume 

func (os *OpenStack) DeleteVolume(volumeID string) error

DeleteVolume delete a volume

func (*OpenStack) DetachVolume 

func (os *OpenStack) DetachVolume(instanceID, volumeID string) error

DetachVolume detaches given cinder volume from the compute

func (*OpenStack) ExpandVolume added in v1.16.0 

func (os *OpenStack) ExpandVolume(volumeID string, status string, newSize int) error

ExpandVolume expands the volume to new size

func (*OpenStack) GetAttachmentDiskPath 

func (os *OpenStack) GetAttachmentDiskPath(instanceID, volumeID string) (string, error)

GetAttachmentDiskPath gets device path of attached volume to the compute

func (*OpenStack) GetBackupByID added in v1.30.0 

func (os *OpenStack) GetBackupByID(backupID string) (*backups.Backup, error)

GetBackupByID returns backup details by id.

func (*OpenStack) GetBlockStorageOpts added in v1.18.0 

func (os *OpenStack) GetBlockStorageOpts() BlockStorageOpts

GetBlockStorageOpts returns OpenStack block storage options

func (*OpenStack) GetInstanceByID added in v1.16.0 

func (os *OpenStack) GetInstanceByID(instanceID string) (*servers.Server, error)

GetInstanceByID returns server with specified instanceID

func (*OpenStack) GetMaxVolLimit added in v1.16.0 

func (os *OpenStack) GetMaxVolLimit() int64

GetMaxVolLimit returns max vol limit

func (*OpenStack) GetMetadataOpts added in v1.18.0 

func (os *OpenStack) GetMetadataOpts() metadata.Opts

GetMetadataOpts returns metadataopts

func (*OpenStack) GetSnapshotByID added in v1.14.0 

func (os *OpenStack) GetSnapshotByID(snapshotID string) (*snapshots.Snapshot, error)

GetSnapshotByID returns snapshot details by id

func (*OpenStack) GetVolume 

func (os *OpenStack) GetVolume(volumeID string) (*volumes.Volume, error)

GetVolume retrieves Volume by its ID.

func (*OpenStack) GetVolumesByName 

func (os *OpenStack) GetVolumesByName(n string) ([]volumes.Volume, error)

GetVolumesByName is a wrapper around ListVolumes that creates a Name filter to act as a GetByName Returns a list of Volume references with the specified name

func (*OpenStack) ListBackups added in v1.30.0 

func (os *OpenStack) ListBackups(filters map[string]string) ([]backups.Backup, error)

ListBackups retrieves a list of active backups from Cinder for the corresponding Tenant. We also provide the ability to provide limit and offset to enable the consumer to provide accurate pagination. In addition the filters argument provides a mechanism for passing in valid filter strings to the list operation. Valid filter keys are: Name, Status, VolumeID, Limit, Marker (TenantID has no effect).

func (*OpenStack) ListSnapshots 

func (os *OpenStack) ListSnapshots(filters map[string]string) ([]snapshots.Snapshot, string, error)

ListSnapshots retrieves a list of active snapshots from Cinder for the corresponding Tenant. We also provide the ability to provide limit and offset to enable the consumer to provide accurate pagination. In addition the filters argument provides a mechanism for passing in valid filter strings to the list operation. Valid filter keys are: Name, Status, VolumeID, Limit, Marker (TenantID has no effect)

func (*OpenStack) ListVolumes added in v1.14.0 

func (os *OpenStack) ListVolumes(limit int, startingToken string) ([]volumes.Volume, string, error)

ListVolumes list all the volumes

func (*OpenStack) WaitBackupReady added in v1.30.0 

func (os *OpenStack) WaitBackupReady(backupID string, snapshotSize int, backupMaxDurationSecondsPerGB int) (string, error)

WaitBackupReady waits until backup is ready. It waits longer depending on the size of the corresponding snapshot.

func (*OpenStack) WaitDiskAttached 

func (os *OpenStack) WaitDiskAttached(instanceID string, volumeID string) error

WaitDiskAttached waits for attached

func (*OpenStack) WaitDiskDetached 

func (os *OpenStack) WaitDiskDetached(instanceID string, volumeID string) error

WaitDiskDetached waits for detached

func (*OpenStack) WaitSnapshotReady added in v1.14.0 

func (os *OpenStack) WaitSnapshotReady(snapshotID string) (string, error)

WaitSnapshotReady waits till snapshot is ready

func (*OpenStack) WaitVolumeTargetStatus added in v1.21.0 

func (os *OpenStack) WaitVolumeTargetStatus(volumeID string, tStatus []string) error

WaitVolumeTargetStatus waits for volume to be in target state

type OpenStackMock 

type OpenStackMock struct {
	mock.Mock
}

revive:disable:exported OpenStackMock is an autogenerated mock type for the IOpenStack type ORIGINALLY GENERATED BY mockery with hand edits

func (*OpenStackMock) AttachVolume 

func (_m *OpenStackMock) AttachVolume(instanceID string, volumeID string) (string, error)

AttachVolume provides a mock function with given fields: instanceID, volumeID

func (*OpenStackMock) BackupsAreEnabled added in v1.30.0 

func (_m *OpenStackMock) BackupsAreEnabled() (bool, error)

func (*OpenStackMock) CreateBackup added in v1.30.0 

func (_m *OpenStackMock) CreateBackup(name, volID, snapshotID, availabilityZone string, tags map[string]string) (*backups.Backup, error)

func (*OpenStackMock) CreateSnapshot 

func (_m *OpenStackMock) CreateSnapshot(name string, volID string, tags map[string]string) (*snapshots.Snapshot, error)

CreateSnapshot provides a mock function with given fields: name, volID, tags

func (*OpenStackMock) CreateVolume 

func (_m *OpenStackMock) CreateVolume(name string, size int, vtype string, availability string, snapshotID string, sourceVolID string, sourceBackupID string, tags map[string]string) (*volumes.Volume, error)

CreateVolume provides a mock function with given fields: name, size, vtype, availability, tags

func (*OpenStackMock) DeleteBackup added in v1.30.0 

func (_m *OpenStackMock) DeleteBackup(backupID string) error

func (*OpenStackMock) DeleteSnapshot 

func (_m *OpenStackMock) DeleteSnapshot(snapID string) error

DeleteSnapshot provides a mock function with given fields: snapID

func (*OpenStackMock) DeleteVolume 

func (_m *OpenStackMock) DeleteVolume(volumeID string) error

DeleteVolume provides a mock function with given fields: volumeID

func (*OpenStackMock) DetachVolume 

func (_m *OpenStackMock) DetachVolume(instanceID string, volumeID string) error

DetachVolume provides a mock function with given fields: instanceID, volumeID

func (*OpenStackMock) ExpandVolume added in v1.16.0 

func (_m *OpenStackMock) ExpandVolume(volumeID string, status string, size int) error

ExpandVolume provides a mock function with given fields: instanceID, volumeID

func (*OpenStackMock) GetAttachmentDiskPath 

func (_m *OpenStackMock) GetAttachmentDiskPath(instanceID string, volumeID string) (string, error)

GetAttachmentDiskPath provides a mock function with given fields: instanceID, volumeID

func (*OpenStackMock) GetAvailabilityZone added in v1.14.0 

func (_m *OpenStackMock) GetAvailabilityZone() (string, error)

func (*OpenStackMock) GetBackupByID added in v1.30.0 

func (_m *OpenStackMock) GetBackupByID(backupID string) (*backups.Backup, error)

func (*OpenStackMock) GetBlockStorageOpts added in v1.18.0 

func (_m *OpenStackMock) GetBlockStorageOpts() BlockStorageOpts

GetBlockStorageOpts provides a mock function to return BlockStorageOpts

func (*OpenStackMock) GetInstanceByID added in v1.16.0 

func (_m *OpenStackMock) GetInstanceByID(instanceID string) (*servers.Server, error)

func (*OpenStackMock) GetInstanceID added in v1.14.0 

func (_m *OpenStackMock) GetInstanceID() (string, error)

func (*OpenStackMock) GetMaxVolLimit added in v1.15.0 

func (_m *OpenStackMock) GetMaxVolLimit() int64

func (*OpenStackMock) GetMetadataOpts added in v1.18.0 

func (_m *OpenStackMock) GetMetadataOpts() metadata.Opts

func (*OpenStackMock) GetSnapshotByID added in v1.14.0 

func (_m *OpenStackMock) GetSnapshotByID(snapshotID string) (*snapshots.Snapshot, error)

func (*OpenStackMock) GetVolume added in v1.15.0 

func (_m *OpenStackMock) GetVolume(volumeID string) (*volumes.Volume, error)

GetVolume provides a mock function with given fields: volumeID

func (*OpenStackMock) GetVolumesByName 

func (_m *OpenStackMock) GetVolumesByName(name string) ([]volumes.Volume, error)

GetVolumesByName provides a mock function with given fields: name

func (*OpenStackMock) ListBackups added in v1.30.0 

func (_m *OpenStackMock) ListBackups(filters map[string]string) ([]backups.Backup, error)

func (*OpenStackMock) ListSnapshots 

func (_m *OpenStackMock) ListSnapshots(filters map[string]string) ([]snapshots.Snapshot, string, error)

ListSnapshots provides a mock function with given fields: limit, offset, filters

func (*OpenStackMock) ListVolumes added in v1.14.0 

func (_m *OpenStackMock) ListVolumes(limit int, marker string) ([]volumes.Volume, string, error)

ListVolumes provides a mock function without param

func (*OpenStackMock) WaitBackupReady added in v1.30.0 

func (_m *OpenStackMock) WaitBackupReady(backupID string, snapshotSize int, backupMaxDurationSecondsPerGB int) (string, error)

func (*OpenStackMock) WaitDiskAttached 

func (_m *OpenStackMock) WaitDiskAttached(instanceID string, volumeID string) error

WaitDiskAttached provides a mock function with given fields: instanceID, volumeID

func (*OpenStackMock) WaitDiskDetached 

func (_m *OpenStackMock) WaitDiskDetached(instanceID string, volumeID string) error

WaitDiskDetached provides a mock function with given fields: instanceID, volumeID

func (*OpenStackMock) WaitSnapshotReady added in v1.14.0 

func (_m *OpenStackMock) WaitSnapshotReady(snapshotID string) (string, error)

func (*OpenStackMock) WaitVolumeTargetStatus added in v1.21.0 

func (_m *OpenStackMock) WaitVolumeTargetStatus(volumeID string, tStatus []string) error

WaitVolumeTargetStatus provides a mock function with given fields: volumeID, tStatus

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.