kubernetes.v0: gopkg.in/kubernetes/kubernetes.v0/pkg/cloudprovider Index | Files | Directories

package cloudprovider

import "gopkg.in/kubernetes/kubernetes.v0/pkg/cloudprovider"

Package cloudprovider supplies interfaces and implementations for cloud service providers.


Package Files

cloud.go doc.go plugins.go


var InstanceNotFound = errors.New("instance not found")

func GetInstanceProviderID Uses

func GetInstanceProviderID(cloud Interface, nodeName string) (string, error)

func GetLoadBalancerName Uses

func GetLoadBalancerName(service *api.Service) string

TODO(#6812): Use a shorter name that's less likely to be longer than cloud providers' name length limits.

func RegisterCloudProvider Uses

func RegisterCloudProvider(name string, cloud Factory)

RegisterCloudProvider registers a cloudprovider.Factory by name. This is expected to happen during app startup.

type Clusters Uses

type Clusters interface {
    // List lists the names of the available clusters.
    ListClusters() ([]string, error)
    // Master gets back the address (either DNS name or IP address) of the master node for the cluster.
    Master(clusterName string) (string, error)

Clusters is an abstract, pluggable interface for clusters of containers.

type Factory Uses

type Factory func(config io.Reader) (Interface, error)

Factory is a function that returns a cloudprovider.Interface. The config parameter provides an io.Reader handler to the factory in order to load specific configurations. If no configuration is provided the parameter is nil.

type Instances Uses

type Instances interface {
    // NodeAddresses returns the addresses of the specified instance.
    // TODO(roberthbailey): This currently is only used in such a way that it
    // returns the address of the calling instance. We should do a rename to
    // make this clearer.
    NodeAddresses(name string) ([]api.NodeAddress, error)
    // ExternalID returns the cloud provider ID of the specified instance (deprecated).
    ExternalID(name string) (string, error)
    // InstanceID returns the cloud provider ID of the specified instance.
    // Note that if the instance does not exist or is no longer running, we must return ("", cloudprovider.InstanceNotFound)
    InstanceID(name string) (string, error)
    // List lists instances that match 'filter' which is a regular expression which must match the entire instance name (fqdn)
    List(filter string) ([]string, error)
    // GetNodeResources gets the resources for a particular node
    GetNodeResources(name string) (*api.NodeResources, error)
    // AddSSHKeyToAllInstances adds an SSH public key as a legal identity for all instances
    // expected format for the key is standard ssh-keygen format: <protocol> <blob>
    AddSSHKeyToAllInstances(user string, keyData []byte) error
    // Returns the name of the node we are currently running on
    // On most clouds (e.g. GCE) this is the hostname, so we provide the hostname
    CurrentNodeName(hostname string) (string, error)

Instances is an abstract, pluggable interface for sets of instances.

type Interface Uses

type Interface interface {
    // TCPLoadBalancer returns a balancer interface. Also returns true if the interface is supported, false otherwise.
    TCPLoadBalancer() (TCPLoadBalancer, bool)
    // Instances returns an instances interface. Also returns true if the interface is supported, false otherwise.
    Instances() (Instances, bool)
    // Zones returns a zones interface. Also returns true if the interface is supported, false otherwise.
    Zones() (Zones, bool)
    // Clusters returns a clusters interface.  Also returns true if the interface is supported, false otherwise.
    Clusters() (Clusters, bool)
    // Routes returns a routes interface along with whether the interface is supported.
    Routes() (Routes, bool)
    // ProviderName returns the cloud provider ID.
    ProviderName() string

Interface is an abstract, pluggable interface for cloud providers.

func GetCloudProvider Uses

func GetCloudProvider(name string, config io.Reader) (Interface, error)

GetCloudProvider creates an instance of the named cloud provider, or nil if the name is not known. The error return is only used if the named provider was known but failed to initialize. The config parameter specifies the io.Reader handler of the configuration file for the cloud provider, or nil for no configuation.

func InitCloudProvider Uses

func InitCloudProvider(name string, configFilePath string) Interface

InitCloudProvider creates an instance of the named cloud provider.

type Route Uses

type Route struct {
    // Name is the name of the routing rule in the cloud-provider.
    // It will be ignored in a Create (although nameHint may influence it)
    Name string
    // TargetInstance is the name of the instance as specified in routing rules
    // for the cloud-provider (in gce: the Instance Name).
    TargetInstance string
    // Destination CIDR is the CIDR format IP range that this routing rule
    // applies to.
    DestinationCIDR string

Route is a representation of an advanced routing rule.

type Routes Uses

type Routes interface {
    // List all managed routes that belong to the specified clusterName
    ListRoutes(clusterName string) ([]*Route, error)
    // Create the described managed route
    // route.Name will be ignored, although the cloud-provider may use nameHint
    // to create a more user-meaningful name.
    CreateRoute(clusterName string, nameHint string, route *Route) error
    // Delete the specified managed route
    // Route should be as returned by ListRoutes
    DeleteRoute(clusterName string, route *Route) error

Routes is an abstract, pluggable interface for advanced routing rules.

type TCPLoadBalancer Uses

type TCPLoadBalancer interface {
    // TODO: Break this up into different interfaces (LB, etc) when we have more than one type of service
    // GetTCPLoadBalancer returns whether the specified load balancer exists, and
    // if so, what its status is.
    GetTCPLoadBalancer(name, region string) (status *api.LoadBalancerStatus, exists bool, err error)
    // CreateTCPLoadBalancer creates a new tcp load balancer. Returns the status of the balancer
    CreateTCPLoadBalancer(name, region string, externalIP net.IP, ports []*api.ServicePort, hosts []string, affinityType api.ServiceAffinity) (*api.LoadBalancerStatus, error)
    // UpdateTCPLoadBalancer updates hosts under the specified load balancer.
    UpdateTCPLoadBalancer(name, region string, hosts []string) error
    // EnsureTCPLoadBalancerDeleted deletes the specified load balancer if it
    // exists, returning nil if the load balancer specified either didn't exist or
    // was successfully deleted.
    // This construction is useful because many cloud providers' load balancers
    // have multiple underlying components, meaning a Get could say that the LB
    // doesn't exist even if some part of it is still laying around.
    EnsureTCPLoadBalancerDeleted(name, region string) error

TCPLoadBalancer is an abstract, pluggable interface for TCP load balancers.

type Zone Uses

type Zone struct {
    FailureDomain string
    Region        string

Zone represents the location of a particular machine.

type Zones Uses

type Zones interface {
    // GetZone returns the Zone containing the current failure zone and locality region that the program is running in
    GetZone() (Zone, error)

Zones is an abstract, pluggable interface for zone enumeration.


fakePackage fake_cloud is a test-double implementation of cloudprovider Interface, TCPLoadBalancer and Instances.
gcePackage gce_cloud is an implementation of Interface, TCPLoadBalancer and Instances for Google Compute Engine.
nodecontrollerPackage nodecontroller contains code for syncing cloud instances with minion registry
routecontrollerPackage routecontroller contains code for syncing cloud routing rules with the list of registered nodes.
servicecontrollerPackage servicecontroller contains code for syncing cloud load balancers with the service registry.
vagrantPackage vagrant_cloud is an implementation of Interface, TCPLoadBalancer and Instances for developer managed Vagrant cluster.

Package cloudprovider imports 9 packages (graph). Updated 2018-03-04. Refresh now. Tools for package owners.