rename Instance to VM

Author: stephenplusplus

docs/site/components/docs/docs-values.js

@@ -55,10 +55,6 @@ angular.module('gcloud.docs')
           title: 'Firewall',
           url: '/firewall'
         },
-        {
-          title: 'Instance',
-          url: '/instance'
-        },
         {
           title: 'Network',
           url: '/network'
@@ -75,6 +71,10 @@ angular.module('gcloud.docs')
           title: 'Snapshot',
           url: '/snapshot'
         },
+        {
+          title: 'VM',
+          url: '/vm'
+        },
         {
           title: 'Zone',
           url: '/zone'

lib/compute/index.js

@@ -65,6 +65,12 @@ var streamRouter = require('../common/stream-router.js');
  */
 var util = require('../common/util.js');
 
+/**
+ * @type {module:compute/vm}
+ * @private
+ */
+var VM = require('./vm.js');
+
 /**
  * @type {module:compute/zone}
  * @private
@@ -231,6 +237,90 @@ Compute.prototype.createNetwork = function(name, config, callback) {
   });
 };
 
+/**
+ * Create a virtual machine. This is a convenience method that wraps
+ * {module:compute/zone#createVM}. See that method for a full list of supported
+ * arguments.
+ *
+ * @param {string} name - Name of the instance.
+ * @param {object} config - See an
+ *     [Instance resource](https://goo.gl/fuLRMj) for more information.
+ * @param {string|module:compute/zone} config.zone - The zone to create the VM
+ *     in.
+ * @param {function} callback - The callback function.
+ *
+ * @example
+ * //-
+ * // Create a new instance using the latest Debian version as the source image
+ * // for a new boot disk.
+ * //-
+ * var config = {
+ *   os: 'debian',
+ *   http: true,
+ *   zone: 'us-central1-a'
+ * };
+ *
+ * //-
+ * // The above object will auto-expand behind the scenes to something like the
+ * // following. The Debian version may be different when you run the command.
+ * //-
+ * var config = {
+ *   machineType: 'n1-standard-1',
+ *   disks: [
+ *     {
+ *       boot: true,
+ *       initializeParams: {
+ *         sourceImage:
+ *           'https://www.googleapis.com/compute/v1/projects' +
+ *           '/debian-cloud/global/images/debian-7-wheezy-v20150710'
+ *       }
+ *     }
+ *   ],
+ *   networkInterfaces: [
+ *     {
+ *       network: 'global/networks/default'
+ *     }
+ *   ],
+ *   tags: [
+ *     {
+ *       items: [
+ *         'http-server'
+ *       ]
+ *     }
+ *   ],
+ *   zone: 'us-central1-a'
+ * };
+ *
+ * function callback(err, instance, operation, apiResponse) {
+ *   // `instance` is an Instance object.
+ *
+ *   // `operation` is an Operation object that can be used to check the status
+ *   // of the request.
+ * }
+ *
+ * compute.createVM('new-vm-name', config, callback);
+ */
+Compute.prototype.createVM = function(name, config, callback) {
+  config = config || {};
+
+  var zoneName = config.zone;
+  delete config.zone;
+
+  if (!zoneName) {
+    throw new Error('A zone is required to create a virtual machine.');
+  }
+
+  var zone;
+
+  if (zoneName instanceof Zone) {
+    zone = zoneName;
+  } else {
+    zone = this.zone(zoneName);
+  }
+
+  zone.createVM(name, config, callback);
+};
+
 /**
  * Get a reference to a Google Compute Engine firewall.
  *
@@ -574,47 +664,47 @@ Compute.prototype.getFirewalls = function(options, callback) {
  * @param {function} callback - The callback function.
  *
  * @example
- * compute.getInstances(function(err, instances) {
- *   // `instances` is an array of `Instance` objects.
+ * compute.getVMs(function(err, vms) {
+ *   // `vms` is an array of `VM` objects.
  * });
  *
  * //-
  * // To control how many API requests are made and page through the results
  * // manually, set `autoPaginate` to `false`.
  * //-
- * function callback(err, instances, nextQuery, apiResponse) {
+ * function callback(err, vms, nextQuery, apiResponse) {
  *   if (nextQuery) {
  *     // More results exist.
- *     compute.getInstances(nextQuery, callback);
+ *     compute.getVMs(nextQuery, callback);
  *   }
  * }
  *
- * compute.getInstances({
+ * compute.getVMs({
  *   autoPaginate: false
  * }, callback);
  *
  * //-
- * // Get the instances from your project as a readable object stream.
+ * // Get the VM instances from your project as a readable object stream.
  * //-
- * compute.getInstances()
+ * compute.getVMs()
  *   .on('error', console.error)
  *   .on('data', function(instance) {
- *     // `instance` is an `Instance` object.
+ *     // `vm` is a `VM` object.
  *   })
  *   .on('end', function() {
- *     // All instances retrieved.
+ *     // All vms retrieved.
  *   });
  *
  * //-
  * // If you anticipate many results, you can end a stream early to prevent
  * // unnecessary processing and API requests.
  * //-
- * compute.getInstances()
+ * compute.getVMs()
  *   .on('data', function(instance) {
  *     this.end();
  *   });
  */
-Compute.prototype.getInstances = function(options, callback) {
+Compute.prototype.getVMs = function(options, callback) {
   var self = this;
 
   if (is.fn(options)) {
@@ -642,20 +732,20 @@ Compute.prototype.getInstances = function(options, callback) {
 
     var zones = resp.items || {};
 
-    var instances = Object.keys(zones).reduce(function(acc, zoneName) {
+    var vms = Object.keys(zones).reduce(function(acc, zoneName) {
       var zone = self.zone(zoneName.replace('zones/', ''));
       var instances = zones[zoneName].instances || [];
 
       instances.forEach(function(instance) {
-        var instanceInstance = zone.instance(instance.name);
-        instanceInstance.metadata = instance;
-        acc.push(instanceInstance);
+        var vmInstance = zone.vm(instance.name);
+        vmInstance.metadata = instance;
+        acc.push(vmInstance);
       });
 
       return acc;
     }, []);
 
-    callback(null, instances, nextQuery, resp);
+    callback(null, vms, nextQuery, resp);
   });
 };
 
@@ -995,6 +1085,19 @@ Compute.prototype.snapshot = function(name) {
   return new Snapshot(this, name);
 };
 
+/**
+ * Get a reference to a Google Compute Engine virtual machine instance.
+ *
+ * @param {string} name - Name of the existing virtual machine.
+ * @return {module:compute/vm}
+ *
+ * @example
+ * var vm = compute.vm('vm-name');
+ */
+Compute.prototype.vm = function(name) {
+  return new VM(this, null, name);
+};
+
 /**
  * Get a reference to a Google Compute Engine zone.
  *
@@ -1044,10 +1147,10 @@ streamRouter.extend(Compute, [
   'getDisks',
   'getFirewalls',
   'getImages',
-  'getInstances',
   'getNetworks',
   'getOperations',
-  'getSnapshots'
+  'getSnapshots',
+  'getVMs'
 ]);
 
 module.exports = Compute;