14360: Comment stubServer.

[arvados.git] / lib / dispatchcloud / test / stub_driver.go

diff --git a/lib/dispatchcloud/test/stub_driver.go b/lib/dispatchcloud/test/stub_driver.go
index bfe0f8f266396f8bcfe19dae3c12e83a2845cacf..808d7bd3a7a4e495a4c5779685662e6b33ee4fe7 100644 (file)
--- a/lib/dispatchcloud/test/stub_driver.go
+++ b/lib/dispatchcloud/test/stub_driver.go
@@ -105,6 +105,14 @@ func (sis *StubInstanceSet) Stop() {
        sis.stopped = true
 }
 
+// stubServer is a fake server that runs an SSH service. It represents
+// a VM running in a fake cloud.
+//
+// Note this is distinct from a stubInstance, which is a snapshot of
+// the VM's metadata. As with a VM in a real cloud, the stubServer
+// keeps running (and might change IP addresses, shut down, etc.)
+// without updating any stubInstances that have been returned to
+// callers.
 type stubServer struct {
        sis          *StubInstanceSet
        id           cloud.InstanceID