Support for Data Science - Model Deployment

Author: govindrao55

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Support for updating instance type in `oci_oce_oce_instance`
 - Support for private native vcn clusters to `container_engine`
 - Support for HTTP2 and Advance Rules Sets added to `load_balancer`
+- Support for Data Science - Model Deployment
 
 ## 4.17.0 (March 10, 2021)
 

examples/datascience/artifact.zip

@@ -0,0 +1,204 @@
+
+// Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
+// Licensed under the Mozilla Public License v2.0
+
+// These variables would commonly be defined as environment variables or sourced in a .env file
+
+variable "tenancy_ocid" {
+}
+
+variable "user_ocid" {
+}
+
+variable "fingerprint" {
+}
+
+variable "private_key_path" {
+}
+
+variable "region" {
+}
+
+provider "oci" {
+  region           = var.region
+  tenancy_ocid     = var.tenancy_ocid
+  user_ocid        = var.user_ocid
+  fingerprint      = var.fingerprint
+  private_key_path = var.private_key_path
+}
+
+variable "compartment_ocid" {
+}
+
+variable "project_ocid" {
+}
+
+variable "model_display_name" {
+  default = "terraform-testing-model"
+}
+
+variable "model_description" {
+  default = "Model for terraform testing"
+}
+
+variable "artifact_content_length" {
+}
+
+variable "model_artifact" {
+}
+
+variable "content_disposition" {
+}
+
+variable "shape" {
+}
+
+variable "model_defined_tags" {
+}
+
+variable "model_freeform_tag" {
+}
+
+variable "model_state" {
+}
+
+
+# A model resource configurations for creating a new model
+resource "oci_datascience_model" "tf_model" {
+  # Required
+  artifact_content_length = var.artifact_content_length
+  model_artifact          = var.model_artifact
+  compartment_id          = var.compartment_ocid
+  project_id              = var.project_ocid
+  # Optional
+  artifact_content_disposition = var.content_disposition
+  defined_tags  = var.model_defined_tags
+  description   = var.model_description
+  display_name  = var.model_display_name
+  freeform_tags = var.model_freeform_tag
+}
+
+# A data resource for the list of models in a specified compartment
+data "oci_datascience_models" "tf_models" {
+  # Required
+  compartment_id = var.compartment_ocid
+  # Optional
+  created_by   = var.user_ocid
+  display_name = oci_datascience_model.tf_model.display_name
+  id           = oci_datascience_model.tf_model.id
+  project_id   = var.project_ocid
+  state        = var.model_state
+}
+
+# The data source for a list of model deployment shapes
+data "oci_datascience_model_deployment_shapes" "tf_model_deployment_shapes" {
+  # Required
+  compartment_id = var.compartment_ocid
+}
+
+variable "model_deployment_display_name" {
+  default = "terraform-testing-model-deployment"
+}
+
+variable "model_deployment_description" {
+  default = "Model Deployment for terraform testing"
+}
+
+variable "shape" {
+}
+
+variable "log_group_id" {
+}
+
+variable "model_deployment_defined_tags" {
+}
+
+variable "model_deployment_freeform_tag" {
+}
+
+variable "access_log_id" {
+}
+
+variable "predict_log_id" {
+}
+
+variable "model_deployment_model_deployment_configuration_details_deployment_type" {
+  default = "SINGLE_MODEL"
+}
+
+variable "model_deployment_model_deployment_configuration_details_model_configuration_details_bandwidth_mbps" {
+  default = 10
+}
+
+variable "model_deployment_model_deployment_configuration_details_model_configuration_details_scaling_policy_instance_count" {
+  default = 1
+}
+
+variable "model_deployment_model_deployment_configuration_details_model_configuration_details_scaling_policy_policy_type" {
+  default = "FIXED_SIZE"
+}
+
+variable "model_deployment_state" {
+}
+
+# A model deployment resource configurations for creating a new model deployment
+resource "oci_datascience_model_deployment" "tf_model_deployment" {
+  # Required
+  compartment_id = var.compartment_ocid
+  model_deployment_configuration_details {
+    # Required
+    deployment_type = var.model_deployment_model_deployment_configuration_details_deployment_type
+    model_configuration_details {
+      # Required
+      instance_configuration {
+        # Required
+        instance_shape_name = var.shape
+      }
+      model_id = oci_datascience_model.tf_model.id
+
+      # Optional
+      bandwidth_mbps = var.model_deployment_model_deployment_configuration_details_model_configuration_details_bandwidth_mbps
+      scaling_policy {
+        # Required
+        instance_count = var.model_deployment_model_deployment_configuration_details_model_configuration_details_scaling_policy_instance_count
+        policy_type    = var.model_deployment_model_deployment_configuration_details_model_configuration_details_scaling_policy_policy_type
+      }
+    }
+  }
+  project_id = var.project_ocid
+
+  # Optional
+  category_log_details {
+
+    # Optional
+    access {
+      # Required
+      log_group_id = var.log_group_id
+      log_id       = var.access_log_id
+    }
+    predict {
+      # Required
+      log_group_id = var.log_group_id
+      log_id       = var.predict_log_id
+    }
+  }
+  # Optional
+  defined_tags  = var.model_deployment_defined_tags
+  description   = var.model_deployment_description
+  display_name  = var.model_deployment_display_name
+  freeform_tags = var.model_deployment_freeform_tag
+}
+
+# The data resource for a list of model deployments in a specified compartment
+data "oci_datascience_model_deployments" "tf_model_deployments" {
+  # Required
+  compartment_id = var.compartment_ocid
+
+  # Optional
+  created_by   = var.user_ocid
+  display_name = oci_datascience_model_deployment.tf_model_deployment.display_name
+  id           = oci_datascience_model_deployment.tf_model_deployment.id
+  project_id   = var.project_ocid
+  state        = var.model_deployment_state
+}
+

examples/datascience/model_deployment.tf

@@ -0,0 +1,127 @@
+// Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
+// Licensed under the Mozilla Public License v2.0
+
+package oci
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	oci_datascience "github.com/oracle/oci-go-sdk/v36/datascience"
+)
+
+func init() {
+	RegisterDatasource("oci_datascience_model_deployment", DatascienceModelDeploymentDataSource())
+}
+
+func DatascienceModelDeploymentDataSource() *schema.Resource {
+	fieldMap := make(map[string]*schema.Schema)
+	fieldMap["model_deployment_id"] = &schema.Schema{
+		Type:     schema.TypeString,
+		Required: true,
+	}
+	return GetSingularDataSourceItemSchema(DatascienceModelDeploymentResource(), fieldMap, readSingularDatascienceModelDeployment)
+}
+
+func readSingularDatascienceModelDeployment(d *schema.ResourceData, m interface{}) error {
+	sync := &DatascienceModelDeploymentDataSourceCrud{}
+	sync.D = d
+	sync.Client = m.(*OracleClients).dataScienceClient()
+
+	return ReadResource(sync)
+}
+
+type DatascienceModelDeploymentDataSourceCrud struct {
+	D      *schema.ResourceData
+	Client *oci_datascience.DataScienceClient
+	Res    *oci_datascience.GetModelDeploymentResponse
+}
+
+func (s *DatascienceModelDeploymentDataSourceCrud) VoidState() {
+	s.D.SetId("")
+}
+
+func (s *DatascienceModelDeploymentDataSourceCrud) Get() error {
+	request := oci_datascience.GetModelDeploymentRequest{}
+
+	if modelDeploymentId, ok := s.D.GetOkExists("model_deployment_id"); ok {
+		tmp := modelDeploymentId.(string)
+		request.ModelDeploymentId = &tmp
+	}
+
+	request.RequestMetadata.RetryPolicy = getRetryPolicy(false, "datascience")
+
+	response, err := s.Client.GetModelDeployment(context.Background(), request)
+	if err != nil {
+		return err
+	}
+
+	s.Res = &response
+	return nil
+}
+
+func (s *DatascienceModelDeploymentDataSourceCrud) SetData() error {
+	if s.Res == nil {
+		return nil
+	}
+
+	s.D.SetId(*s.Res.Id)
+
+	if s.Res.CategoryLogDetails != nil {
+		s.D.Set("category_log_details", []interface{}{CategoryLogDetailsToMap(s.Res.CategoryLogDetails)})
+	} else {
+		s.D.Set("category_log_details", nil)
+	}
+
+	if s.Res.CompartmentId != nil {
+		s.D.Set("compartment_id", *s.Res.CompartmentId)
+	}
+
+	if s.Res.CreatedBy != nil {
+		s.D.Set("created_by", *s.Res.CreatedBy)
+	}
+
+	if s.Res.DefinedTags != nil {
+		s.D.Set("defined_tags", definedTagsToMap(s.Res.DefinedTags))
+	}
+
+	if s.Res.Description != nil {
+		s.D.Set("description", *s.Res.Description)
+	}
+
+	if s.Res.DisplayName != nil {
+		s.D.Set("display_name", *s.Res.DisplayName)
+	}
+
+	s.D.Set("freeform_tags", s.Res.FreeformTags)
+
+	if s.Res.LifecycleDetails != nil {
+		s.D.Set("lifecycle_details", *s.Res.LifecycleDetails)
+	}
+
+	if s.Res.ModelDeploymentConfigurationDetails != nil {
+		modelDeploymentConfigurationDetailsArray := []interface{}{}
+		if modelDeploymentConfigurationDetailsMap := ModelDeploymentConfigurationDetailsToMap(&s.Res.ModelDeploymentConfigurationDetails); modelDeploymentConfigurationDetailsMap != nil {
+			modelDeploymentConfigurationDetailsArray = append(modelDeploymentConfigurationDetailsArray, modelDeploymentConfigurationDetailsMap)
+		}
+		s.D.Set("model_deployment_configuration_details", modelDeploymentConfigurationDetailsArray)
+	} else {
+		s.D.Set("model_deployment_configuration_details", nil)
+	}
+
+	if s.Res.ModelDeploymentUrl != nil {
+		s.D.Set("model_deployment_url", *s.Res.ModelDeploymentUrl)
+	}
+
+	if s.Res.ProjectId != nil {
+		s.D.Set("project_id", *s.Res.ProjectId)
+	}
+
+	s.D.Set("state", s.Res.LifecycleState)
+
+	if s.Res.TimeCreated != nil {
+		s.D.Set("time_created", s.Res.TimeCreated.String())
+	}
+
+	return nil
+}