Merge pull request #264 from dataiku/feature/dss110-sc-85515-dcs-fm-all-add-information-related-to-the

Feature/dss110 sc 85515 dcs fm all add information related to the

Author: ericcournarie

Diff for: dataikuapi/fm/future.py

@@ -17,7 +17,11 @@ def __init__(
 
     @staticmethod
     def from_resp(client, resp, result_wrapper=lambda result: result):
-        """Creates a DSSFuture from a parsed JSON response"""
+        """
+        Creates a DSSFuture from a parsed JSON response
+
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
+        """
         return FMFuture(
             client, resp.get("jobId", None), state=resp, result_wrapper=result_wrapper
         )

Diff for: dataikuapi/fm/instances.py

@@ -17,7 +17,8 @@ def __init__(
         """
         Helper to create a DSS Instance
 
-        :param object client: :class:`dataikuapi.fm.fmclient`
+        :param client: The FM client
+        :type client: :class:`dataikuapi.fm.fmclient`
         :param str label: The label of the instance
         :param str instance_settings_template: The instance settings template id this instance should be based on
         :param str virtual_network: The virtual network where the instance should be spawned
@@ -37,7 +38,7 @@ def with_dss_node_type(self, dss_node_type):
         """
         Set the DSS Node type of the instance to create
 
-        :param str dss_node_type: Optional , the type of the dss node to create. Supports "design", "automation ordeployer". Defaults to "design"
+        :param str dss_node_type: Optional , the type of the dss node to create. Supports "design", "automation" or "deployer". Defaults to "design"
         :rtype: :class:`dataikuapi.fm.instances.FMInstanceCreator`
         """
         if dss_node_type not in ["design", "automation", "deployer"]:
@@ -51,7 +52,7 @@ def with_cloud_instance_type(self, cloud_instance_type):
         """
         Set the machine type for the DSS Instance
 
-        :param str cloud_instance_type
+        :param str cloud_instance_type: the machine type to be used for the instance
         :rtype: :class:`dataikuapi.fm.instances.FMInstanceCreator`
         """
         self.data["cloudInstanceType"] = cloud_instance_type
@@ -69,11 +70,12 @@ def with_data_volume_options(
         """
         Set the options of the data volume to use with the DSS Instance
 
-        :param str data_volume_type: Optional, Data volume type
-        :param int data_volume_size: Optional, Data volume initial size
-        :param int data_volume_size_max: Optional, Data volume maximum size
-        :param int data_volume_IOPS: Optional, Data volume IOPS
-        :param object data_volume_encryption: Optional, a :class:`dataikuapi.fm.instances.FMInstanceEncryptionMode` setting the encryption mode of the data volume
+        :param str data_volume_type: Optional, data volume type
+        :param int data_volume_size: Optional, data volume initial size
+        :param int data_volume_size_max: Optional, data volume maximum size
+        :param int data_volume_IOPS: Optional, data volume IOPS
+        :param  data_volume_encryption: Optional, encryption mode of the data volume
+        :type data_volume_encryption: :class:`dataikuapi.fm.instances.FMInstanceEncryptionMode`
         :param str data_volume_encryption_key: Optional, the encryption key to use when data_volume_encryption_key is FMInstanceEncryptionMode.CUSTOM
         :rtype: :class:`dataikuapi.fm.instances.FMInstanceCreator`
         """
@@ -135,7 +137,7 @@ def create(self):
         """
         Create the DSS instance
 
-        :return: Created DSS Instance
+        :return: a newly created DSS instance
         :rtype: :class:`dataikuapi.fm.instances.FMAWSInstance`
         """
         instance = self.client._perform_tenant_json(
@@ -149,7 +151,7 @@ def create(self):
         """
         Create the DSS instance
 
-        :return: Created DSS Instance
+        :return: a newly created DSS instance
         :rtype: :class:`dataikuapi.fm.instances.FMAzureInstance`
         """
         instance = self.client._perform_tenant_json(
@@ -163,7 +165,7 @@ def create(self):
         """
         Create the DSS instance
 
-        :return: Created DSS Instance
+        :return: a newly created DSS instance
         :rtype: :class:`dataikuapi.fm.instances.FMGCPInstance`
         """
         instance = self.client._perform_tenant_json(
@@ -175,7 +177,12 @@ def create(self):
 class FMInstance(object):
     """
     A handle to interact with a DSS instance.
-    Do not create this directly, use :meth:`FMClient.get_instance` or :meth: `FMClient.new_instance_creator`
+    Do not create this directly, use :meth:`dataikuapi.fmclient.FMClient.get_instance` or
+
+    * :meth:`dataikuapi.fmclient.FMClientAWS.new_instance_creator`
+    * :meth:`dataikuapi.fmclient.FMClientAzure.new_instance_creator`
+    * :meth:`dataikuapi.fmclient.FMClientGCP.new_instance_creator`
+
     """
 
     def __init__(self, client, instance_data):
@@ -187,8 +194,8 @@ def reprovision(self):
         """
         Reprovision the physical DSS instance
 
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the reprovision process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the reprovision process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future = self.client._perform_tenant_json(
             "GET", "/instances/%s/actions/reprovision" % self.id
@@ -199,8 +206,8 @@ def deprovision(self):
         """
         Deprovision the physical DSS instance
 
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the deprovision process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the deprovision process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future = self.client._perform_tenant_json(
             "GET", "/instances/%s/actions/deprovision" % self.id
@@ -211,8 +218,8 @@ def restart_dss(self):
         """
         Restart the DSS running on the physical instance
 
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the restart process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the restart process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future = self.client._perform_tenant_json(
             "GET", "/instances/%s/actions/restart-dss" % self.id
@@ -221,7 +228,7 @@ def restart_dss(self):
 
     def save(self):
         """
-        Update the Instance.
+        Update the instance
         """
         self.client._perform_tenant_empty(
             "PUT", "/instances/%s" % self.id, body=self.instance_data
@@ -233,6 +240,9 @@ def save(self):
     def get_status(self):
         """
         Get the physical DSS instance's status
+
+        :return: the instance status
+        :rtype: :class:`dataikuapi.fm.instances.FMInstanceStatus`
         """
         status = self.client._perform_tenant_json(
             "GET", "/instances/%s/status" % self.id
@@ -243,8 +253,8 @@ def delete(self):
         """
         Delete the DSS instance
 
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the deletion process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the deletion process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future = self.client._perform_tenant_json(
             "GET", "/instances/%s/actions/delete" % self.id
@@ -269,8 +279,8 @@ def reset_user_password(self, username, password):
 
         :param string username: login
         :param string password: new password
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the password reset process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the password reset process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future =  self.client._perform_tenant_json(
             "GET", "/instances/%s/actions/reset-user-password" % self.id, params={ 'userName':username, 'password':password }
@@ -281,8 +291,8 @@ def replay_setup_actions(self):
         """
         Replay the setup actions on the DSS instance
 
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the replay process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the replay process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future =  self.client._perform_tenant_json(
             "GET", "/instances/%s/actions/replay-setup-actions" % self.id
@@ -291,7 +301,7 @@ def replay_setup_actions(self):
 
     def set_automated_snapshots(self, enable, period, keep=0):
         """
-        Set the automated snapshots policy for this instance
+        Set the automated snapshot policy for this instance
 
         :param boolean enable: Enable the automated snapshots
         :param int period: The time period between 2 snapshot in hours
@@ -308,7 +318,7 @@ def set_custom_certificate(self, pem_data):
 
         Only needed when Virtual Network HTTPS Strategy is set to Custom Certificate
 
-        param: str pem_data: The SSL certificate
+        :param str pem_data: The SSL certificate
         """
         self.instance_data["sslCertificatePEM"] = pem_data
         return self
@@ -320,7 +330,7 @@ def set_custom_certificate(self, pem_data):
 
     def list_snapshots(self):
         """
-        List all snapshots of this instance
+        List all the snapshots of this instance
 
         :return: list of snapshots
         :rtype: list of :class:`dataikuapi.fm.instances.FMSnapshot`
@@ -341,7 +351,7 @@ def get_snapshot(self, snapshot_id):
 
     def snapshot(self, reason_for_snapshot=None):
         """
-        Create a snapshot of the DSS instance
+        Create a snapshot of the instance
  
         :return: Snapshot
         :rtype: :class:`dataikuapi.fm.instances.FMSnapshot`
@@ -357,7 +367,7 @@ def set_elastic_ip(self, enable, elasticip_allocation_id):
         Set a public elastic ip for this instance
 
         :param boolan enable: Enable the elastic ip allocation
-        :param str elaticip_allocation_id: AWS ElasticIP allocation ID
+        :param str elasticip_allocation_id: AWS ElasticIP allocation ID
         """
         self.instance_data["awsAssignElasticIP"] = enable
         self.instance_data["awsElasticIPAllocationId"] = elasticip_allocation_id
@@ -399,7 +409,7 @@ class FMInstanceEncryptionMode(Enum):
 
 class FMInstanceStatus(dict):
     """A class holding read-only information about an Instance.
-    This class should not be created directly. Instead, use :meth:`FMInstance.get_info`
+    This class should not be created directly. Instead, use :meth:`FMInstance.get_status`
     """
 
     def __init__(self, data):
@@ -435,8 +445,8 @@ def reprovision(self):
         """
         Reprovision the physical DSS instance from this snapshot
 
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the reprovision process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the reprovision process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future = self.client._perform_tenant_json(
             "POST", "/instances/%s/snapshots/%s/reprovision" % (self.instance_id, self.snapshot_id)
@@ -447,8 +457,8 @@ def delete(self):
         """
         Delete the snapshot
 
-        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the deletion process
-        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
+        :return: the `Future` object representing the deletion process
+        :rtype: :class:`dataikuapi.fm.future.FMFuture`
         """
         future = self.client._perform_tenant_json(
             "DELETE", "/instances/%s/snapshots/%s" % (self.instance_id, self.snapshot_id)