oracle.oci.oci_data_science_model_deployment – Manage a ModelDeployment resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_data_science_model_deployment
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a ModelDeployment resource in Oracle Cloud Infrastructure
For state=present, creates a new model deployment.
This resource has the following action operations in the oracle.oci.oci_data_science_model_deployment_actions module: activate, change_compartment, deactivate.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | ||||
---|---|---|---|---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||||
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||||
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|||||
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|||||
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
||||
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
||||
category_log_details
dictionary
|
This parameter is updatable.
|
|||||
access
dictionary
|
||||||
log_group_id
string
/ required
|
The OCID of a log group to work with.
|
|||||
log_id
string
/ required
|
The OCID of a log to work with.
|
|||||
predict
dictionary
|
||||||
log_group_id
string
/ required
|
The OCID of a log group to work with.
|
|||||
log_id
string
/ required
|
The OCID of a log to work with.
|
|||||
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|||||
compartment_id
string
|
The OCID of the compartment where you want to create the model deployment.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|||||
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|||||
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|||||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|||||
description
string
|
A short description of the model deployment.
This parameter is updatable.
|
|||||
display_name
string
|
A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: `My ModelDeployment`
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|||||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||||
freeform_tags
dictionary
|
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: `{"Department": "Finance"}`
This parameter is updatable.
|
|||||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|||||
model_deployment_configuration_details
dictionary
|
Required for create using state=present.
This parameter is updatable.
|
|||||
deployment_type
string
/ required
|
|
The type of the model deployment.
This parameter is updatable.
Applicable when deployment_type is 'SINGLE_MODEL'
|
||||
model_configuration_details
dictionary
|
Applicable when deployment_type is 'SINGLE_MODEL'
|
|||||
bandwidth_mbps
integer
|
The network bandwidth for the model.
This parameter is updatable.
|
|||||
instance_configuration
dictionary
|
Applicable when deployment_type is 'SINGLE_MODEL'
|
|||||
instance_shape_name
string
/ required
|
The shape used to launch the model deployment instances.
|
|||||
model_deployment_instance_shape_config_details
dictionary
|
||||||
memory_in_gbs
float
|
A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB.
|
|||||
ocpus
float
|
A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu.
|
|||||
model_id
string
/ required
|
The OCID of the model you want to deploy.
This parameter is updatable.
|
|||||
scaling_policy
dictionary
|
||||||
instance_count
integer
/ required
|
The number of instances for the model deployment.
|
|||||
policy_type
string
/ required
|
|
The type of scaling policy.
|
||||
model_deployment_id
string
|
The OCID of the model deployment.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|||||
project_id
string
|
The OCID of the project to associate with the model deployment.
Required for create using state=present.
|
|||||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
||||
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|||||
state
string
|
|
The state of the ModelDeployment.
Use state=present to create or update a ModelDeployment.
Use state=absent to delete a ModelDeployment.
|
||||
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|||||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
||||
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create model_deployment
oci_data_science_model_deployment:
# required
project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
model_deployment_configuration_details:
# required
deployment_type: SINGLE_MODEL
model_configuration_details:
# required
model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"
# optional
instance_configuration:
# required
instance_shape_name: instance_shape_name_example
# optional
model_deployment_instance_shape_config_details:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
scaling_policy:
# required
policy_type: FIXED_SIZE
instance_count: 56
bandwidth_mbps: 56
# optional
display_name: display_name_example
description: description_example
category_log_details:
# optional
access:
# required
log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
predict:
# required
log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update model_deployment
oci_data_science_model_deployment:
# required
model_deployment_id: "ocid1.modeldeployment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
description: description_example
model_deployment_configuration_details:
# required
deployment_type: SINGLE_MODEL
model_configuration_details:
# required
model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"
# optional
instance_configuration:
# required
instance_shape_name: instance_shape_name_example
# optional
model_deployment_instance_shape_config_details:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
scaling_policy:
# required
policy_type: FIXED_SIZE
instance_count: 56
bandwidth_mbps: 56
category_log_details:
# optional
access:
# required
log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
predict:
# required
log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update model_deployment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_data_science_model_deployment:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
description: description_example
model_deployment_configuration_details:
# required
deployment_type: SINGLE_MODEL
model_configuration_details:
# required
model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"
# optional
instance_configuration:
# required
instance_shape_name: instance_shape_name_example
# optional
model_deployment_instance_shape_config_details:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
scaling_policy:
# required
policy_type: FIXED_SIZE
instance_count: 56
bandwidth_mbps: 56
category_log_details:
# optional
access:
# required
log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
predict:
# required
log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
log_group_id: "ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete model_deployment
oci_data_science_model_deployment:
# required
model_deployment_id: "ocid1.modeldeployment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete model_deployment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_data_science_model_deployment:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||||
---|---|---|---|---|---|---|---|
model_deployment
complex
|
on success |
Details of the ModelDeployment resource acted upon by the current operation
Sample:
{'category_log_details': {'access': {'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_id': 'ocid1.log.oc1..xxxxxxEXAMPLExxxxxx'}, 'predict': {'log_group_id': 'ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx', 'log_id': 'ocid1.log.oc1..xxxxxxEXAMPLExxxxxx'}}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'model_deployment_configuration_details': {'deployment_type': 'SINGLE_MODEL', 'model_configuration_details': {'bandwidth_mbps': 56, 'instance_configuration': {'instance_shape_name': 'instance_shape_name_example', 'model_deployment_instance_shape_config_details': {'memory_in_gbs': 3.4, 'ocpus': 3.4}}, 'model_id': 'ocid1.model.oc1..xxxxxxEXAMPLExxxxxx', 'scaling_policy': {'instance_count': 56, 'policy_type': 'FIXED_SIZE'}}}, 'model_deployment_url': 'model_deployment_url_example', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00'}
|
|||||
category_log_details
complex
|
on success |
|
|||||
access
complex
|
on success |
|
|||||
log_group_id
string
|
on success |
The OCID of a log group to work with.
Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
log_id
string
|
on success |
The OCID of a log to work with.
Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
predict
complex
|
on success |
|
|||||
log_group_id
string
|
on success |
The OCID of a log group to work with.
Sample:
ocid1.loggroup.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
log_id
string
|
on success |
The OCID of a log to work with.
Sample:
ocid1.log.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
compartment_id
string
|
on success |
The OCID of the model deployment's compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
created_by
string
|
on success |
The OCID of the user who created the model deployment.
Sample:
created_by_example
|
|||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||||
description
string
|
on success |
A short description of the model deployment.
Sample:
description_example
|
|||||
display_name
string
|
on success |
A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: `My ModelDeployment`
Sample:
display_name_example
|
|||||
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|||||
id
string
|
on success |
The OCID of the model deployment.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
lifecycle_details
string
|
on success |
Details about the state of the model deployment.
Sample:
lifecycle_details_example
|
|||||
lifecycle_state
string
|
on success |
The state of the model deployment.
Sample:
CREATING
|
|||||
model_deployment_configuration_details
complex
|
on success |
|
|||||
deployment_type
string
|
on success |
The type of the model deployment.
Sample:
SINGLE_MODEL
|
|||||
model_configuration_details
complex
|
on success |
|
|||||
bandwidth_mbps
integer
|
on success |
The network bandwidth for the model.
Sample:
56
|
|||||
instance_configuration
complex
|
on success |
|
|||||
instance_shape_name
string
|
on success |
The shape used to launch the model deployment instances.
Sample:
instance_shape_name_example
|
|||||
model_deployment_instance_shape_config_details
complex
|
on success |
|
|||||
memory_in_gbs
float
|
on success |
A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB.
Sample:
3.4
|
|||||
ocpus
float
|
on success |
A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu.
Sample:
3.4
|
|||||
model_id
string
|
on success |
The OCID of the model you want to deploy.
Sample:
ocid1.model.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
scaling_policy
complex
|
on success |
|
|||||
instance_count
integer
|
on success |
The number of instances for the model deployment.
Sample:
56
|
|||||
policy_type
string
|
on success |
The type of scaling policy.
Sample:
FIXED_SIZE
|
|||||
model_deployment_url
string
|
on success |
The URL to interact with the model deployment.
Sample:
model_deployment_url_example
|
|||||
project_id
string
|
on success |
The OCID of the project associated with the model deployment.
Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
time_created
string
|
on success |
The date and time the resource was created, in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)