Commit cf75c498 authored by Josh Horwitz's avatar Josh Horwitz

change godoc based on feedback from luxas

parent 82a69b28
...@@ -141,7 +141,7 @@ type Instances interface { ...@@ -141,7 +141,7 @@ type Instances interface {
// 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) (types.NodeName, error) CurrentNodeName(hostname string) (types.NodeName, error)
// InstanceExistsByProviderID returns true if the instance for the given provider id still is running. // InstanceExistsByProviderID returns true if the instance for the given provider id still is running.
// If false is returned with no error, the instance will be immediately deleted. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
InstanceExistsByProviderID(providerID string) (bool, error) InstanceExistsByProviderID(providerID string) (bool, error)
} }
......
...@@ -1102,7 +1102,7 @@ func (c *Cloud) ExternalID(nodeName types.NodeName) (string, error) { ...@@ -1102,7 +1102,7 @@ func (c *Cloud) ExternalID(nodeName types.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (c *Cloud) InstanceExistsByProviderID(providerID string) (bool, error) { func (c *Cloud) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
...@@ -88,7 +88,7 @@ func (az *Cloud) ExternalID(name types.NodeName) (string, error) { ...@@ -88,7 +88,7 @@ func (az *Cloud) ExternalID(name types.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (az *Cloud) InstanceExistsByProviderID(providerID string) (bool, error) { func (az *Cloud) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
...@@ -239,7 +239,7 @@ func (f *FakeCloud) InstanceTypeByProviderID(providerID string) (string, error) ...@@ -239,7 +239,7 @@ func (f *FakeCloud) InstanceTypeByProviderID(providerID string) (string, error)
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (f *FakeCloud) InstanceExistsByProviderID(providerID string) (bool, error) { func (f *FakeCloud) InstanceExistsByProviderID(providerID string) (bool, error) {
f.addCall("instance-exists-by-provider-id") f.addCall("instance-exists-by-provider-id")
return f.ExistsByProviderID, f.ErrByProviderID return f.ExistsByProviderID, f.ErrByProviderID
......
...@@ -153,7 +153,7 @@ func (gce *GCECloud) ExternalID(nodeName types.NodeName) (string, error) { ...@@ -153,7 +153,7 @@ func (gce *GCECloud) ExternalID(nodeName types.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (gce *GCECloud) InstanceExistsByProviderID(providerID string) (bool, error) { func (gce *GCECloud) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
...@@ -111,7 +111,7 @@ func (i *Instances) ExternalID(name types.NodeName) (string, error) { ...@@ -111,7 +111,7 @@ func (i *Instances) ExternalID(name types.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (i *Instances) InstanceExistsByProviderID(providerID string) (bool, error) { func (i *Instances) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
...@@ -212,7 +212,7 @@ func (v *OVirtCloud) ExternalID(nodeName types.NodeName) (string, error) { ...@@ -212,7 +212,7 @@ func (v *OVirtCloud) ExternalID(nodeName types.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (v *OVirtCloud) InstanceExistsByProviderID(providerID string) (bool, error) { func (v *OVirtCloud) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
...@@ -471,7 +471,7 @@ func (pc *PCCloud) ExternalID(nodeName k8stypes.NodeName) (string, error) { ...@@ -471,7 +471,7 @@ func (pc *PCCloud) ExternalID(nodeName k8stypes.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (pc *PCCloud) InstanceExistsByProviderID(providerID string) (bool, error) { func (pc *PCCloud) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
...@@ -437,7 +437,7 @@ func (i *Instances) ExternalID(nodeName types.NodeName) (string, error) { ...@@ -437,7 +437,7 @@ func (i *Instances) ExternalID(nodeName types.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (i *Instances) InstanceExistsByProviderID(providerID string) (bool, error) { func (i *Instances) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
...@@ -377,7 +377,7 @@ func (vs *VSphere) ExternalID(nodeName k8stypes.NodeName) (string, error) { ...@@ -377,7 +377,7 @@ func (vs *VSphere) ExternalID(nodeName k8stypes.NodeName) (string, error) {
} }
// InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. // 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. // If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (vs *VSphere) InstanceExistsByProviderID(providerID string) (bool, error) { func (vs *VSphere) InstanceExistsByProviderID(providerID string) (bool, error) {
return false, errors.New("unimplemented") return false, errors.New("unimplemented")
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment