Added comments in Examples

Author: mbcse

examples/compute/do-droplet.js

@@ -33,6 +33,7 @@ function launchInstance() {
     });
 }
 
+//list Instances
 function listInstances() {
   droplet
     .list()
@@ -44,6 +45,7 @@ function listInstances() {
     });
 }
 
+//destroy an Instance
 function destroyInstance() {
   let instanceId = "3164444";
   droplet

examples/compute/do-ks.js

@@ -5,6 +5,7 @@ const optionsProvider = {
 const ncProviders = nodeCloud.getProviders(optionsProvider);
 const kubernetes = ncProviders.do.kubernetes();
 
+//Create Kubernetes cluster
 function createCluster() {
   let clusterDetails = {
     name: "Nodecloud",
@@ -29,6 +30,7 @@ function createCluster() {
   );
 }
 
+//Get Cluster details
 function getClusterDetails() {
   let clusterID = "bd5f5959-5e1e-4205-a714-a914373942af";
   kubernetes.describeCluster(clusterID).then(
@@ -41,6 +43,7 @@ function getClusterDetails() {
   );
 }
 
+// Get all clusters
 function getAllClusters() {
   /* The nextToken value returned from a previous ListClusters request where maxResults was used and the results
      exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the 
@@ -63,6 +66,7 @@ function getAllClusters() {
   );
 }
 
+//Delete cluster
 function deleteCluster() {
   let clusterID = "bd5f5959-5e1e-4205-a714-a914373942af";
   kubernetes.deleteCluster(clusterID).then(
@@ -75,6 +79,7 @@ function deleteCluster() {
   );
 }
 
+//Create a Node Group
 function createNodeGroup() {
   let groupDetails = {
     size: "s-1vcpu-2gb",
@@ -96,6 +101,7 @@ function createNodeGroup() {
   );
 }
 
+//Delete a node group
 function deleteNodeGroup() {
   let nodePoolID = "bd5f5959-5e1e-4205-a714-a914373942af";
   let clusterID = "bd5f5959-5e1e-4205-a714-a914373942af";
@@ -109,6 +115,7 @@ function deleteNodeGroup() {
   );
 }
 
+//Get details of Node Group
 function describeNodeGroup() {
   let nodePoolID = "bd5f5959-5e1e-4205-a714-a914373942af";
   let clusterID = "bd5f5959-5e1e-4205-a714-a914373942af";
@@ -122,6 +129,7 @@ function describeNodeGroup() {
   );
 }
 
+//Get all Nodegroups
 function listNodeGroups() {
   let clusterID = "bd5f5959-5e1e-4205-a714-a914373942af";
   kubernetes.listNodegroups(clusterID).then(

examples/management/do-keyManagement.js

@@ -5,6 +5,7 @@ const optionsProvider = {
 const ncProviders = nodeCloud.getProviders(optionsProvider);
 const keyManagement = ncProviders.do.keyManagement();
 
+//Craete a Key
 function createKey() {
   let options = {
     public_key:
@@ -20,7 +21,7 @@ function createKey() {
       console.log(`Oops something happened ${err}`);
     });
 }
-
+//Delete a Key
 function deleteKey() {
   let keyIdentifier = "512189";
   keyManagement
@@ -33,6 +34,7 @@ function deleteKey() {
     });
 }
 
+//Get details of a key
 function getKey() {
   let keyIdentifier = "512189";
   keyManagement
@@ -45,6 +47,7 @@ function getKey() {
     });
 }
 
+//Get all keys
 function getAllKeys() {
   keyManagement
     .list()

examples/network/do-dns.js

@@ -6,21 +6,23 @@ const ncProviders = nodeCloud.getProviders(optionsProvider);
 
 const dns = ncProviders.do.dns();
 
-const domainCreateOptions = {
-  type: "A",
-  name: "www",
-  data: "162.10.66.0",
-  priority: null,
-  port: null,
-  ttl: 1800,
-  weight: null,
-  flags: null,
-  tag: null
-};
-
 const domainName = "example.com";
 
+
+// Create a DNS Record
 function createRecord() {
+  let domainCreateOptions = {
+    type: "A",
+    name: "www",
+    data: "162.10.66.0",
+    priority: null,
+    port: null,
+    ttl: 1800,
+    weight: null,
+    flags: null,
+    tag: null
+  };
+
   dns
     .createRecord(domainName, domainCreateOptions)
     .then(result => {
@@ -31,6 +33,7 @@ function createRecord() {
     });
 }
 
+//Get all DNS records
 function getAllRecords() {
   dns
     .getRecords(domainName)
@@ -42,6 +45,7 @@ function getAllRecords() {
     });
 }
 
+//Get a DNS record
 function getRecord() {
   let recordID = "3352896";
   dns
@@ -54,6 +58,7 @@ function getRecord() {
     });
 }
 
+//Delete a DNS record
 function deleteRecord() {
   let recordID = "3352896";
   dns
@@ -66,6 +71,7 @@ function deleteRecord() {
     });
 }
 
+//Change a DNS record
 function changeRecord() {
   let recordID = "3352896";
   let options = {

examples/network/do-lb.js

@@ -5,6 +5,7 @@ const optionsProvider = {
 const ncProviders = nodeCloud.getProviders(optionsProvider);
 const lb = ncProviders.do.loadbalancer();
 
+//Create a LoadBalancer
 function create() {
   let options = {
     name: "example-lb-01",
@@ -36,6 +37,7 @@ function create() {
     });
 }
 
+//List all loadbalancers
 function listAllLoadBalancers() {
   lb.list()
     .then(result => {
@@ -46,6 +48,7 @@ function listAllLoadBalancers() {
     });
 }
 
+//Delete a loadbalancer
 function deleteLoadBalancer() {
   let lbId = "4de7ac8b-495b-4884-9a69-1050c6793cd6";
   lb.delete(lbId)
@@ -57,6 +60,7 @@ function deleteLoadBalancer() {
     });
 }
 
+//Update a loadbalancer
 function updateLoadBalancer() {
   let lbId = "4de7ac8b-495b-4884-9a69-1050c6793cd6";
   let options = {

examples/storage/do-blockStorage.js

@@ -6,6 +6,7 @@ const ncProviders = nodeCloud.getProviders(optionsProvider);
 
 const volume = ncProviders.do.blockStorage();
 
+//List all volumes
 function listVolumes() {
   let region = "nyc1";
   volume
@@ -18,6 +19,7 @@ function listVolumes() {
     });
 }
 
+//Create a volume 
 function createVolume() {
   let option = {
     size_gigabytes: 10,
@@ -37,6 +39,7 @@ function createVolume() {
     });
 }
 
+//Get details of a Volume
 function describeVolume() {
   let volumeId = "506f78a4-e098-11e5-ad9f-000f53306ae1";
   volume
@@ -49,6 +52,7 @@ function describeVolume() {
     });
 }
 
+//Delete a volume
 function deleteVolume() {
   let volumeId = "506f78a4-e098-11e5-ad9f-000f53306ae1";
   volume