client

Documentation

Index

• Constants
• func IsNotFoundError(err error) bool
• type Compute
• type ComputeClient
  • func (c *ComputeClient) CreateServerGroup(name, policy string) (*servergroups.ServerGroup, error)
  • func (c *ComputeClient) DeleteServerGroup(id string) error
  • func (c *ComputeClient) GetServerGroup(id string) (*servergroups.ServerGroup, error)
  • func (c *ComputeClient) ListServerGroups() ([]servergroups.ServerGroup, error)
• type DNS
• type DNSClient
  • func (c *DNSClient) CreateOrUpdateRecordSet(ctx context.Context, zoneID, name, recordType string, records []string, ...) error
  • func (c *DNSClient) DeleteRecordSet(ctx context.Context, zoneID, name, recordType string) error
  • func (c *DNSClient) GetZones(ctx context.Context) (map[string]string, error)
• type Factory
  • func NewOpenStackClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference, ...) (Factory, error)
  • func NewOpenstackClientFromCredentials(credentials *os.Credentials) (Factory, error)
• type FactoryFactory
• type FactoryFactoryFunc
  • func (f FactoryFactoryFunc) NewFactory(credentials *openstack.Credentials) (Factory, error)
• type Networking
• type NetworkingClient
  • func (c *NetworkingClient) GetExternalNetworkNames(_ context.Context) ([]string, error)
• type OpenstackClientFactory
  • func (oc *OpenstackClientFactory) Compute(options ...Option) (Compute, error)
  • func (oc *OpenstackClientFactory) DNS(options ...Option) (DNS, error)
  • func (oc *OpenstackClientFactory) Networking(options ...Option) (Networking, error)
  • func (oc *OpenstackClientFactory) Storage(options ...Option) (Storage, error)
• type Option
  • func WithRegion(region string) Option
• type Storage
  • func NewStorageClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference, ...) (Storage, error)
• type StorageClient
  • func (s *StorageClient) CreateContainerIfNotExists(ctx context.Context, container string) error
  • func (s *StorageClient) DeleteContainerIfExists(ctx context.Context, container string) error
  • func (s *StorageClient) DeleteObjectsWithPrefix(ctx context.Context, container, prefix string) error

Constants

const (
	// ServerGroupPolicyAntiAffinity is a constant for the anti-affinity server group policy.
	ServerGroupPolicyAntiAffinity = "anti-affinity"
	// ServerGroupPolicyAffinity is a constant for the affinity server group policy.
	ServerGroupPolicyAffinity = "affinity"
)

Functions

func IsNotFoundError

func IsNotFoundError(err error) bool

IsNotFoundError checks if an error returned by OpenStack is caused by HTTP 404 status code.

Types

type Compute

type Compute interface {
	CreateServerGroup(name, policy string) (*servergroups.ServerGroup, error)
	GetServerGroup(id string) (*servergroups.ServerGroup, error)
	DeleteServerGroup(id string) error
	ListServerGroups() ([]servergroups.ServerGroup, error)
}

Compute describes the operations of a client interacting with OpenStack's Compute service.

type ComputeClient

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

ComputeClient is a client for the Nova service.

func (*ComputeClient) CreateServerGroup

func (c *ComputeClient) CreateServerGroup(name, policy string) (*servergroups.ServerGroup, error)

CreateServerGroup creates a server group with the specified policy.

func (*ComputeClient) DeleteServerGroup

func (c *ComputeClient) DeleteServerGroup(id string) error

DeleteServerGroup deletes the server group with the specified id. It returns nil if the server group could not be found.

func (*ComputeClient) GetServerGroup

func (c *ComputeClient) GetServerGroup(id string) (*servergroups.ServerGroup, error)

GetServerGroup retrieves the server group with the specified id.

func (*ComputeClient) ListServerGroups

func (c *ComputeClient) ListServerGroups() ([]servergroups.ServerGroup, error)

ListServerGroups retrieves the list of server groups.

type DNS

type DNS interface {
	GetZones(ctx context.Context) (map[string]string, error)
	CreateOrUpdateRecordSet(ctx context.Context, zoneID, name, recordType string, records []string, ttl int) error
	DeleteRecordSet(ctx context.Context, zoneID, name, recordType string) error
}

DNS describes the operations of a client interacting with OpenStack's DNS service.

type DNSClient

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

DNSClient is a client for the Designate service.

func (*DNSClient) CreateOrUpdateRecordSet

func (c *DNSClient) CreateOrUpdateRecordSet(ctx context.Context, zoneID, name, recordType string, records []string, ttl int) error

CreateOrUpdateRecordSet creates or updates the recordset with the given name, record type, records, and ttl in the zone with the given zone ID.

func (*DNSClient) DeleteRecordSet

func (c *DNSClient) DeleteRecordSet(ctx context.Context, zoneID, name, recordType string) error

DeleteRecordSet deletes the recordset with the given name and record type in the zone with the given zone ID.

func (*DNSClient) GetZones

func (c *DNSClient) GetZones(ctx context.Context) (map[string]string, error)

GetZones returns a map of all zone names mapped to their IDs.

type Factory

type Factory interface {
	Compute(options ...Option) (Compute, error)
	Storage(options ...Option) (Storage, error)
	DNS(options ...Option) (DNS, error)
	Networking(options ...Option) (Networking, error)
}

Factory is an interface for constructing OpenStack service clients.

func NewOpenStackClientFromSecretRef

func NewOpenStackClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference, keyStoneUrl *string) (Factory, error)

NewOpenStackClientFromSecretRef returns a Factory implementation that can be used to create clients for OpenStack services. The credentials are fetched from the Kubernetes secret referenced by <secretRef>.

func NewOpenstackClientFromCredentials

func NewOpenstackClientFromCredentials(credentials *os.Credentials) (Factory, error)

NewOpenstackClientFromCredentials returns a Factory implementation that can be used to create clients for OpenStack services. TODO: respect CloudProfile's requestTimeout for the OpenStack client. see https://github.com/kubernetes/cloud-provider-openstack/blob/c44d941cdb5c7fe651f5cb9191d0af23e266c7cb/pkg/openstack/openstack.go#L257

type FactoryFactory

type FactoryFactory interface {
	// NewFactory creates a new instance of Factory for the given Openstack credentials.
	NewFactory(credentials *openstack.Credentials) (Factory, error)
}

FactoryFactory creates instances of Factory.

type FactoryFactoryFunc

type FactoryFactoryFunc func(credentials *openstack.Credentials) (Factory, error)

FactoryFactoryFunc is a function that implements FactoryFactory.

func (FactoryFactoryFunc) NewFactory

func (f FactoryFactoryFunc) NewFactory(credentials *openstack.Credentials) (Factory, error)

NewFactory creates a new instance of Factory for the given Openstack credentials.

type Networking

type Networking interface {
	GetExternalNetworkNames(ctx context.Context) ([]string, error)
}

Networking describes the operations of a client interacting with OpenStack's Networking service.

type NetworkingClient

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

NetworkingClient is a client for the Neutron service.

func (*NetworkingClient) GetExternalNetworkNames

func (c *NetworkingClient) GetExternalNetworkNames(_ context.Context) ([]string, error)

GetExternalNetworkNames returns a list of all external network names.

type OpenstackClientFactory

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

OpenstackClientFactory implements a factory that can construct clients for Openstack services.

func (*OpenstackClientFactory) Compute

func (oc *OpenstackClientFactory) Compute(options ...Option) (Compute, error)

Compute returns a Compute client. The client uses Nova v2 API for issuing calls.

func (*OpenstackClientFactory) DNS

func (oc *OpenstackClientFactory) DNS(options ...Option) (DNS, error)

DNS returns a DNS client. The client uses Designate v2 API for issuing calls.

func (*OpenstackClientFactory) Networking

func (oc *OpenstackClientFactory) Networking(options ...Option) (Networking, error)

Networking returns a Networking client. The client uses Neutron v2 API for issuing calls.

func (*OpenstackClientFactory) Storage

func (oc *OpenstackClientFactory) Storage(options ...Option) (Storage, error)

Storage returns a Storage client. The client uses Swift v1 API for issuing calls.

type Option

type Option func(opts gophercloud.EndpointOpts) gophercloud.EndpointOpts

Option can be passed to Factory implementations to modify the produced clients.

func WithRegion

func WithRegion(region string) Option

WithRegion returns an Option that can modify the region a client targets.

type Storage

type Storage interface {
	DeleteObjectsWithPrefix(ctx context.Context, container, prefix string) error
	CreateContainerIfNotExists(ctx context.Context, container string) error
	DeleteContainerIfExists(ctx context.Context, container string) error
}

Storage describes the operations of a client interacting with OpenStack's ObjectStorage service.

func NewStorageClientFromSecretRef

func NewStorageClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference, region string) (Storage, error)

NewStorageClientFromSecretRef retrieves the openstack client from specified by the secret reference.

type StorageClient

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

StorageClient is a client for the Swift service.

func (*StorageClient) CreateContainerIfNotExists

func (s *StorageClient) CreateContainerIfNotExists(ctx context.Context, container string) error

CreateContainerIfNotExists creates the openstack blob container with name <container>. If it already exist, no error is returned.

func (*StorageClient) DeleteContainerIfExists

func (s *StorageClient) DeleteContainerIfExists(ctx context.Context, container string) error

DeleteContainerIfExists deletes the openstack blob container with name <container>. If it does not exist, no error is returned.

func (*StorageClient) DeleteObjectsWithPrefix

func (s *StorageClient) DeleteObjectsWithPrefix(ctx context.Context, container, prefix string) error

DeleteObjectsWithPrefix deletes the blob objects with the specific <prefix> from <container>. If it does not exist, no error is returned.