Merge pull request #15048 from Huawei-PaaS/fixed_typos_for_cloudprovider

Fixed some typos and improved comments for cloudprovider
This commit is contained in:
Marcin Wielgus 2015-10-05 17:49:15 +02:00
commit 5adeb00583

View File

@ -43,7 +43,7 @@ type Interface interface {
// Clusters is an abstract, pluggable interface for clusters of containers. // Clusters is an abstract, pluggable interface for clusters of containers.
type Clusters interface { type Clusters interface {
// List lists the names of the available clusters. // ListClusters lists the names of the available clusters.
ListClusters() ([]string, error) ListClusters() ([]string, error)
// Master gets back the address (either DNS name or IP address) of the master node for the cluster. // Master gets back the address (either DNS name or IP address) of the master node for the cluster.
Master(clusterName string) (string, error) Master(clusterName string) (string, error)
@ -110,7 +110,7 @@ type Instances interface {
// AddSSHKeyToAllInstances adds an SSH public key as a legal identity for all instances // 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> // expected format for the key is standard ssh-keygen format: <protocol> <blob>
AddSSHKeyToAllInstances(user string, keyData []byte) error AddSSHKeyToAllInstances(user string, keyData []byte) error
// Returns the name of the node we are currently running on // CurrentNodeName 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 // On most clouds (e.g. GCE) this is the hostname, so we provide the hostname
CurrentNodeName(hostname string) (string, error) CurrentNodeName(hostname string) (string, error)
} }
@ -123,20 +123,20 @@ type Route struct {
// TargetInstance is the name of the instance as specified in routing rules // TargetInstance is the name of the instance as specified in routing rules
// for the cloud-provider (in gce: the Instance Name). // for the cloud-provider (in gce: the Instance Name).
TargetInstance string TargetInstance string
// Destination CIDR is the CIDR format IP range that this routing rule // DestinationCIDR is the CIDR format IP range that this routing rule
// applies to. // applies to.
DestinationCIDR string DestinationCIDR string
} }
// Routes is an abstract, pluggable interface for advanced routing rules. // Routes is an abstract, pluggable interface for advanced routing rules.
type Routes interface { type Routes interface {
// List all managed routes that belong to the specified clusterName // ListRoutes lists all managed routes that belong to the specified clusterName
ListRoutes(clusterName string) ([]*Route, error) ListRoutes(clusterName string) ([]*Route, error)
// Create the described managed route // CreateRoute creates the described managed route
// route.Name will be ignored, although the cloud-provider may use nameHint // route.Name will be ignored, although the cloud-provider may use nameHint
// to create a more user-meaningful name. // to create a more user-meaningful name.
CreateRoute(clusterName string, nameHint string, route *Route) error CreateRoute(clusterName string, nameHint string, route *Route) error
// Delete the specified managed route // DeleteRoute deletes the specified managed route
// Route should be as returned by ListRoutes // Route should be as returned by ListRoutes
DeleteRoute(clusterName string, route *Route) error DeleteRoute(clusterName string, route *Route) error
} }