Documentation ¶
Index ¶
- Constants
- Variables
- func NewRoutes(compute *gophercloud.ServiceClient, network *gophercloud.ServiceClient, ...) (cloudprovider.Routes, error)
- func RegisterMetrics()
- type APIVersionsByID
- type BlockStorageOpts
- type Caller
- type Config
- type Instances
- func (i *Instances) AddSSHKeyToAllInstances(user string, keyData []byte) error
- func (i *Instances) CurrentNodeName(hostname string) (types.NodeName, error)
- func (i *Instances) ExternalID(name types.NodeName) (string, error)
- func (i *Instances) InstanceExistsByProviderID(providerID string) (bool, error)
- func (i *Instances) InstanceID(name types.NodeName) (string, error)
- func (i *Instances) InstanceType(name types.NodeName) (string, error)
- func (i *Instances) InstanceTypeByProviderID(providerID string) (string, error)
- func (i *Instances) NodeAddresses(name types.NodeName) ([]v1.NodeAddress, error)
- func (i *Instances) NodeAddressesByProviderID(providerID string) ([]v1.NodeAddress, error)
- type LbaasV1
- func (lb *LbaasV1) EnsureLoadBalancer(clusterName string, apiService *v1.Service, nodes []*v1.Node) (*v1.LoadBalancerStatus, error)
- func (lb *LbaasV1) EnsureLoadBalancerDeleted(clusterName string, service *v1.Service) error
- func (lb *LbaasV1) GetLoadBalancer(clusterName string, service *v1.Service) (*v1.LoadBalancerStatus, bool, error)
- func (lb *LbaasV1) UpdateLoadBalancer(clusterName string, service *v1.Service, nodes []*v1.Node) error
- type LbaasV2
- func (lbaas *LbaasV2) EnsureLoadBalancer(clusterName string, apiService *v1.Service, nodes []*v1.Node) (*v1.LoadBalancerStatus, error)
- func (lbaas *LbaasV2) EnsureLoadBalancerDeleted(clusterName string, service *v1.Service) error
- func (lbaas *LbaasV2) GetLoadBalancer(clusterName string, service *v1.Service) (*v1.LoadBalancerStatus, bool, error)
- func (lbaas *LbaasV2) UpdateLoadBalancer(clusterName string, service *v1.Service, nodes []*v1.Node) error
- type LoadBalancer
- type LoadBalancerOpts
- type Metadata
- type MyDuration
- type OpenStack
- func (os *OpenStack) AttachDisk(instanceID, volumeID string) (string, error)
- func (os *OpenStack) Clusters() (cloudprovider.Clusters, bool)
- func (os *OpenStack) CreateVolume(name string, size int, vtype, availability string, tags *map[string]string) (string, string, error)
- func (os *OpenStack) DeleteVolume(volumeID string) error
- func (os *OpenStack) DetachDisk(instanceID, volumeID string) error
- func (os *OpenStack) DiskIsAttached(instanceID, volumeID string) (bool, error)
- func (os *OpenStack) DisksAreAttached(instanceID string, volumeIDs []string) (map[string]bool, error)
- func (os *OpenStack) GetAttachmentDiskPath(instanceID, volumeID string) (string, error)
- func (os *OpenStack) GetDevicePath(volumeID string) string
- func (os *OpenStack) GetZone() (cloudprovider.Zone, error)
- func (os *OpenStack) GetZoneByNodeName(nodeName types.NodeName) (cloudprovider.Zone, error)
- func (os *OpenStack) GetZoneByProviderID(providerID string) (cloudprovider.Zone, error)
- func (os *OpenStack) HasClusterID() bool
- func (os *OpenStack) Initialize(clientBuilder controller.ControllerClientBuilder)
- func (os *OpenStack) InstanceID() (string, error)
- func (os *OpenStack) Instances() (cloudprovider.Instances, bool)
- func (os *OpenStack) LoadBalancer() (cloudprovider.LoadBalancer, bool)
- func (os *OpenStack) NewBlockStorageV1() (*gophercloud.ServiceClient, error)
- func (os *OpenStack) NewBlockStorageV2() (*gophercloud.ServiceClient, error)
- func (os *OpenStack) NewComputeV2() (*gophercloud.ServiceClient, error)
- func (os *OpenStack) NewNetworkV2() (*gophercloud.ServiceClient, error)
- func (os *OpenStack) OperationPending(diskName string) (bool, string, error)
- func (os *OpenStack) ProviderName() string
- func (os *OpenStack) Routes() (cloudprovider.Routes, bool)
- func (os *OpenStack) ScrubDNS(nameServers, searches []string) ([]string, []string)
- func (os *OpenStack) ShouldTrustDevicePath() bool
- func (os *OpenStack) Zones() (cloudprovider.Zones, bool)
- type RouterOpts
- type Routes
- type Volume
- type VolumeCreateOpts
- type VolumesV1
- type VolumesV2
Constants ¶
const ( ProviderName = "openstack" AvailabilityZone = "availability_zone" )
const ( ServiceAnnotationLoadBalancerFloatingNetworkId = "loadbalancer.openstack.org/floating-network-id" // ServiceAnnotationLoadBalancerInternal is the annotation used on the service // to indicate that we want an internal loadbalancer service. // If the value of ServiceAnnotationLoadBalancerInternal is false, it indicates that we want an external loadbalancer service. Default to true. ServiceAnnotationLoadBalancerInternal = "service.beta.kubernetes.io/openstack-internal-load-balancer" )
Note: when creating a new Loadbalancer (VM), it can take some time before it is ready for use, this timeout is used for waiting until the Loadbalancer provisioning status goes to ACTIVE state.
const ( OpenstackSubsystem = "openstack" OpenstackOperationKey = "cloudprovider_openstack_api_request_duration_seconds" OpenstackOperationErrorKey = "cloudprovider_openstack_api_request_errors" )
const ( VolumeAvailableStatus = "available" VolumeInUseStatus = "in-use" VolumeDeletedStatus = "deleted" VolumeErrorStatus = "error" )
Variables ¶
var ( OpenstackOperationsLatency = prometheus.NewHistogramVec( prometheus.HistogramOpts{ Subsystem: OpenstackSubsystem, Name: OpenstackOperationKey, Help: "Latency of openstack api call", }, []string{"request"}, ) OpenstackApiRequestErrors = prometheus.NewCounterVec( prometheus.CounterOpts{ Subsystem: OpenstackSubsystem, Name: OpenstackOperationErrorKey, Help: "Cumulative number of openstack Api call errors", }, []string{"request"}, ) )
var ErrBadMetadata = errors.New("Invalid OpenStack metadata, got empty uuid")
var ErrMultipleResults = errors.New("Multiple results where only one expected")
var ErrNoAddressFound = errors.New("No address found for host")
var ErrNoRouterId = errors.New("router-id not set in cloud provider config")
var ErrNotFound = errors.New("Failed to find object")
Functions ¶
func NewRoutes ¶ added in v1.6.0
func NewRoutes(compute *gophercloud.ServiceClient, network *gophercloud.ServiceClient, opts RouterOpts) (cloudprovider.Routes, error)
func RegisterMetrics ¶ added in v1.7.0
func RegisterMetrics()
Types ¶
type APIVersionsByID ¶ added in v1.7.0
type APIVersionsByID []apiversions_v1.APIVersion
Implementation of sort interface for blockstorage version probing
func (APIVersionsByID) Len ¶ added in v1.7.0
func (apiVersions APIVersionsByID) Len() int
func (APIVersionsByID) Less ¶ added in v1.7.0
func (apiVersions APIVersionsByID) Less(i, j int) bool
func (APIVersionsByID) Swap ¶ added in v1.7.0
func (apiVersions APIVersionsByID) Swap(i, j int)
type BlockStorageOpts ¶ added in v1.5.0
type Config ¶
type Config struct { Global struct { AuthUrl string `gcfg:"auth-url"` Username string UserId string `gcfg:"user-id"` Password string TenantId string `gcfg:"tenant-id"` TenantName string `gcfg:"tenant-name"` TrustId string `gcfg:"trust-id"` DomainId string `gcfg:"domain-id"` DomainName string `gcfg:"domain-name"` Region string CAFile string `gcfg:"ca-file"` } LoadBalancer LoadBalancerOpts BlockStorage BlockStorageOpts Route RouterOpts }
type Instances ¶
type Instances struct {
// contains filtered or unexported fields
}
func (*Instances) AddSSHKeyToAllInstances ¶
func (*Instances) CurrentNodeName ¶
Implementation of Instances.CurrentNodeName Note this is *not* necessarily the same as hostname.
func (*Instances) ExternalID ¶
ExternalID returns the cloud provider ID of the specified instance (deprecated).
func (*Instances) InstanceExistsByProviderID ¶ added in v1.8.0
InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (*Instances) InstanceID ¶
InstanceID returns the cloud provider ID of the specified instance.
func (*Instances) InstanceType ¶ added in v1.2.0
InstanceType returns the type of the specified instance.
func (*Instances) InstanceTypeByProviderID ¶ added in v1.7.0
InstanceTypeByProviderID returns the cloudprovider instance type of the node with the specified unique providerID This method will not be called from the node that is requesting this ID. i.e. metadata service and other local methods cannot be used here
func (*Instances) NodeAddresses ¶
func (*Instances) NodeAddressesByProviderID ¶ added in v1.7.0
func (i *Instances) NodeAddressesByProviderID(providerID string) ([]v1.NodeAddress, error)
NodeAddressesByProviderID returns the node addresses of an instances with the specified unique providerID This method will not be called from the node that is requesting this ID. i.e. metadata service and other local methods cannot be used here
type LbaasV1 ¶ added in v1.3.0
type LbaasV1 struct {
LoadBalancer
}
LoadBalancer implementation for LBaaS v1
func (*LbaasV1) EnsureLoadBalancer ¶ added in v1.3.0
func (*LbaasV1) EnsureLoadBalancerDeleted ¶ added in v1.3.0
func (*LbaasV1) GetLoadBalancer ¶ added in v1.3.0
type LbaasV2 ¶ added in v1.3.0
type LbaasV2 struct {
LoadBalancer
}
LoadBalancer implementation for LBaaS v2
func (*LbaasV2) EnsureLoadBalancer ¶ added in v1.3.0
func (*LbaasV2) EnsureLoadBalancerDeleted ¶ added in v1.3.0
func (*LbaasV2) GetLoadBalancer ¶ added in v1.3.0
type LoadBalancer ¶
type LoadBalancer struct {
// contains filtered or unexported fields
}
type LoadBalancerOpts ¶
type LoadBalancerOpts struct { LBVersion string `gcfg:"lb-version"` // overrides autodetection. v1 or v2 SubnetId string `gcfg:"subnet-id"` // overrides autodetection. FloatingNetworkId string `gcfg:"floating-network-id"` // If specified, will create floating ip for loadbalancer, or do not create floating ip. LBMethod string `gcfg:"lb-method"` // default to ROUND_ROBIN. CreateMonitor bool `gcfg:"create-monitor"` MonitorDelay MyDuration `gcfg:"monitor-delay"` MonitorTimeout MyDuration `gcfg:"monitor-timeout"` MonitorMaxRetries uint `gcfg:"monitor-max-retries"` ManageSecurityGroups bool `gcfg:"manage-security-groups"` NodeSecurityGroupID string `gcfg:"node-security-group"` }
type Metadata ¶ added in v1.5.0
type Metadata struct { Uuid string `json:"uuid"` Name string `json:"name"` AvailabilityZone string `json:"availability_zone"` }
Assumes the "2012-08-10" meta_data.json format. See http://docs.openstack.org/user-guide/cli_config_drive.html
type MyDuration ¶
encoding.TextUnmarshaler interface for time.Duration
func (*MyDuration) UnmarshalText ¶
func (d *MyDuration) UnmarshalText(text []byte) error
type OpenStack ¶
type OpenStack struct {
// contains filtered or unexported fields
}
OpenStack is an implementation of cloud provider Interface for OpenStack.
func (*OpenStack) AttachDisk ¶
AttachDisk attaches given cinder volume to the compute running kubelet
func (*OpenStack) CreateVolume ¶ added in v1.2.0
func (os *OpenStack) CreateVolume(name string, size int, vtype, availability string, tags *map[string]string) (string, string, error)
CreateVolume creates a volume of given size (in GiB)
func (*OpenStack) DeleteVolume ¶ added in v1.2.0
func (*OpenStack) DetachDisk ¶
DetachDisk detaches given cinder volume from the compute running kubelet
func (*OpenStack) DiskIsAttached ¶ added in v1.3.0
DiskIsAttached queries if a volume is attached to a compute instance
func (*OpenStack) DisksAreAttached ¶ added in v1.4.6
func (os *OpenStack) DisksAreAttached(instanceID string, volumeIDs []string) (map[string]bool, error)
DisksAreAttached queries if a list of volumes are attached to a compute instance
func (*OpenStack) GetAttachmentDiskPath ¶ added in v1.3.0
GetAttachmentDiskPath gets device path of attached volume to the compute running kubelet, as known by cinder
func (*OpenStack) GetDevicePath ¶ added in v1.3.0
GetDevicePath returns the path of an attached block storage volume, specified by its id.
func (*OpenStack) GetZoneByNodeName ¶ added in v1.8.0
GetZoneByNodeName implements Zones.GetZoneByNodeName This is particularly useful in external cloud providers where the kubelet does not initialize node data.
func (*OpenStack) GetZoneByProviderID ¶ added in v1.8.0
func (os *OpenStack) GetZoneByProviderID(providerID string) (cloudprovider.Zone, error)
GetZoneByProviderID implements Zones.GetZoneByProviderID This is particularly useful in external cloud providers where the kubelet does not initialize node data.
func (*OpenStack) HasClusterID ¶ added in v1.8.0
HasClusterID returns true if the cluster has a clusterID
func (*OpenStack) Initialize ¶ added in v1.7.0
func (os *OpenStack) Initialize(clientBuilder controller.ControllerClientBuilder)
Initialize passes a Kubernetes clientBuilder interface to the cloud provider
func (*OpenStack) InstanceID ¶ added in v1.3.0
InstanceID returns the kubelet's cloud provider ID.
func (*OpenStack) Instances ¶
func (os *OpenStack) Instances() (cloudprovider.Instances, bool)
Instances returns an implementation of Instances for OpenStack.
func (*OpenStack) LoadBalancer ¶ added in v1.2.0
func (os *OpenStack) LoadBalancer() (cloudprovider.LoadBalancer, bool)
func (*OpenStack) NewBlockStorageV1 ¶ added in v1.7.0
func (os *OpenStack) NewBlockStorageV1() (*gophercloud.ServiceClient, error)
func (*OpenStack) NewBlockStorageV2 ¶ added in v1.7.0
func (os *OpenStack) NewBlockStorageV2() (*gophercloud.ServiceClient, error)
func (*OpenStack) NewComputeV2 ¶ added in v1.7.0
func (os *OpenStack) NewComputeV2() (*gophercloud.ServiceClient, error)
func (*OpenStack) NewNetworkV2 ¶ added in v1.7.0
func (os *OpenStack) NewNetworkV2() (*gophercloud.ServiceClient, error)
func (*OpenStack) OperationPending ¶ added in v1.7.0
func (*OpenStack) ProviderName ¶
ProviderName returns the cloud provider ID.
func (*OpenStack) ShouldTrustDevicePath ¶ added in v1.5.0
ShouldTrustDevicePath queries if we should trust the cinder provide deviceName, See issue #33128
type RouterOpts ¶ added in v1.6.0
type RouterOpts struct {
RouterId string `gcfg:"router-id"` // required
}
type Routes ¶ added in v1.6.0
type Routes struct {
// contains filtered or unexported fields
}
func (*Routes) CreateRoute ¶ added in v1.6.0
func (*Routes) DeleteRoute ¶ added in v1.6.0
func (r *Routes) DeleteRoute(clusterName string, route *cloudprovider.Route) error
func (*Routes) ListRoutes ¶ added in v1.6.0
func (r *Routes) ListRoutes(clusterName string) ([]*cloudprovider.Route, error)
type Volume ¶ added in v1.7.0
type Volume struct { // ID of the instance, to which this volume is attached. "" if not attached AttachedServerId string // Device file path AttachedDevice string // Unique identifier for the volume. ID string // Human-readable display name for the volume. Name string // Current status of the volume. Status string }