FM: FMInstanceCreator

Author: Thibaud Baas

dataikuapi/fm/instances.py

@@ -1,6 +1,104 @@
 from enum import Enum
 from .future import FMFuture
 
+class FMInstanceCreator(object):
+    def __init__(self, client, label, instance_settings_template_id, virtual_network_id, image_id):
+        """
+        Helper to create a DSS 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
+        :param str label: The label of the instance
+        :param str image_id: The ID of the DSS runtime image (ex: dss-9.0.3-default)
+        """
+        self.client = client
+        self.data = {}
+        self.data["label"] = label
+        self.data["instanceSettingsTemplateId"] = instance_settings_template_id
+        self.data["virtualNetworkId"] = virtual_network_id
+        self.data["imageId"] = image_id
+
+        # Set the default value for dssNodeType
+        self.data["dssNodeType"] = "design"
+
+    def create(self):
+        """
+        Create the DSS instance
+
+        :return: Instance
+        :rtype: :class:`dataikuapi.fm.instances.FMInstance`
+        """
+        instance = self.client._perform_tenant_json("POST", "/instances", body=self.data)
+        return FMInstance(self.client, instance)
+
+    def set_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"
+        """
+        if dss_node_type not in ["design", "automation", "deployer"]:
+            raise ValueError("Only \"design\", \"automation\" or \"deployer\" dss_node_type are supported")
+        self.data["dssNodeType"] = dss_node_type
+
+    def set_cloud_instance_type(self, cloud_instance_type):
+        """
+        Set the machine type for the DSS Instance
+        """
+        self.data["cloudInstanceType"] = cloud_instance_type
+
+    def set_data_volume_options(self, data_volume_type=None, data_volume_size=None, data_volume_size_max=None, data_volume_IOPS=None, data_volume_encryption=None, data_volume_encryption_key=None):
+        """
+        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_encryption_key: Optional, the encryption key to use when data_volume_encryption_key is FMInstanceEncryptionMode.CUSTOM
+        """
+        if type(data_volume_encryption) is not FMInstanceEncryptionMode:
+            raise TypeError("data_volume encryption needs to be of type FMInstanceEncryptionMode")
+
+        self.data["dataVolumeType"] = data_volume_type
+        self.data["dataVolumeSizeGB"] = data_volume_size
+        self.data["dataVolumeSizeMaxGB"] = data_volume_size_max
+        self.data["dataVolumeIOPS"] = data_volume_IOPS
+        self.data["dataVolumeEncryption"] = data_volume_encryption.value
+        self.data["dataVolumeEncryptionKey"] = data_volume_encryption_key
+
+    def set_aws_root_volume_options(self, aws_root_volume_size=None, aws_root_volume_type=None, aws_root_volume_IOPS=None):
+        """
+        AWS Only: Set the options of the root volume of the DSS Instance
+
+        :param int aws_root_volume_size: Optional, the root volume size
+        :param str aws_root_volume_type: Optional, the root volume type
+        :param int aws_root_volume_IOPS: Optional, the root volume IOPS
+        """
+        if self.client.cloud != "AWS":
+            raise BaseException("set_aws_root_volume_options is only usable on AWS tenants")
+        self.data["awsRootVolumeSizeGB"] = aws_root_volume_size
+        self.data["awsRootVolumeType"] = aws_root_volume_type
+        self.data["awsRootVolumeIOPS"] = aws_root_volume_IOPS
+
+    def set_cloud_tags(self, cloud_tags):
+        """
+        Set the tags to be applied to the cloud resources created for this DSS instance
+
+        :param dict cloud_tags: a key value dictionary of tags to be applied on the cloud resources
+        """
+        self.data["cloudTags"] = cloud_tags
+
+    def set_fm_tags(self, fm_tags):
+        """
+        A list of tags to add on the DSS Instance in Fleet Manager
+
+        :param list fm_tags: Optional, list of tags to be applied on the instance in the Fleet Manager
+        """
+        self.data["fmTags"] = fm_tags
+
+
 class FMInstance(object):
     """
     A handle to interact with a DSS instance.

dataikuapi/fmclient.py

@@ -2,8 +2,9 @@
 from requests import Session
 from requests import exceptions
 from requests.auth import HTTPBasicAuth
-
 import os.path as osp
+
+from enum import Enum
 from .utils import DataikuException
 
 from .fm.tenant import FMCloudCredentials
@@ -14,17 +15,23 @@
 class FMClient(object):
     """Entry point for the FM API client"""
 
-    def __init__(self, host, api_key_id, api_key_secret, tenant_id="main", extra_headers=None):
+    def __init__(self, host, api_key_id, api_key_secret, cloud, tenant_id="main", extra_headers=None):
         """
         Instantiate a new FM API client on the given host with the given API key.
 
         API keys can be managed in FM on the project page or in the global settings.
 
         The API key will define which operations are allowed for the client.
+
+        :param str host: Full url of the FM
+
         """
         self.api_key_id = api_key_id
         self.api_key_secret = api_key_secret
         self.host = host
+        if cloud not in ["AWS", "Azure"]:
+            raise ValueError("cloud should be either \"AWS\" or \"Azure\"")
+        self.cloud = cloud
         self.__tenant_id = tenant_id
         self._session = Session()