github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #29490 from justinsb/fix_cloudprovider_contract_comments

Browse Source 
Automatic merge from submit-queue

Correctly document cloudprovider Instances contract
This commit is contained in:
k8s-merge-robot
2016-07-23 11:10:54 -07:00
committed by GitHub
parent 0ad153c776 29e95431c5
commit cbe8cd58a9
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
pkg/cloudprovider/cloud.go
View File

@@ -106,12 +106,11 @@ type Instances interface {
// make this clearer. // make this clearer.
NodeAddresses(name string) ([]api.NodeAddress, error) NodeAddresses(name string) ([]api.NodeAddress, error)
// ExternalID returns the cloud provider ID of the specified instance (deprecated). // ExternalID returns the cloud provider ID of the specified instance (deprecated).
// Note that if the instance does not exist or is no longer running, we must return ("", cloudprovider.InstanceNotFound)
ExternalID(name string) (string, error) ExternalID(name string) (string, error)
// InstanceID returns the cloud provider ID of the specified instance. // 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) InstanceID(name string) (string, error)
// InstanceType returns the type of the specified instance. // InstanceType returns the type of the specified instance.
// Note that if the instance does not exist or is no longer running, we must return ("", cloudprovider.InstanceNotFound)
InstanceType(name string) (string, error) InstanceType(name string) (string, error)
// List lists instances that match 'filter' which is a regular expression which must match the entire instance name (fqdn) // List lists instances that match 'filter' which is a regular expression which must match the entire instance name (fqdn)
List(filter string) ([]string, error) List(filter string) ([]string, error)