oracle.oci.oci_service_mesh_virtual_deployment – Manage a VirtualDeployment resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_service_mesh_virtual_deployment
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a VirtualDeployment resource in Oracle Cloud Infrastructure
For state=present, creates a new VirtualDeployment.
This resource has the following action operations in the oracle.oci.oci_service_mesh_virtual_deployment_actions module: change_compartment.
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 | |
---|---|---|---|
access_logging
dictionary
|
This parameter is updatable.
|
||
is_enabled
boolean
|
|
Determines if the logging configuration is enabled.
|
|
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. |
|
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.
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. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||
description
string
|
Description of the resource. It can be changed after creation. Avoid entering confidential information.
Example: `This is my new resource`
This parameter is updatable.
|
||
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
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
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.
|
||
listeners
list
/ elements=dictionary
|
The listeners for the virtual deployment.
This parameter is updatable.
|
||
idle_timeout_in_ms
integer
|
The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
|
||
port
integer
/ required
|
Port in which virtual deployment is running.
|
||
protocol
string
/ required
|
|
Type of protocol used in virtual deployment.
|
|
request_timeout_in_ms
integer
|
The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
|
||
name
string
|
A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information.
Example: `My unique resource name`
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
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. |
||
service_discovery
dictionary
|
This parameter is updatable.
|
||
hostname
string
|
The hostname of the virtual deployments.
Required when type is 'DNS'
|
||
type
string
/ required
|
|
Type of service discovery.
|
|
state
string
|
|
The state of the VirtualDeployment.
Use state=present to create or update a VirtualDeployment.
Use state=absent to delete a VirtualDeployment.
|
|
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 |
||
virtual_deployment_id
string
|
Unique VirtualDeployment identifier.
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 |
||
virtual_service_id
string
|
The OCID of the service mesh in which this access policy is created.
Required for create using state=present.
|
||
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 virtual_deployment
oci_service_mesh_virtual_deployment:
# required
virtual_service_id: "ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
service_discovery:
# required
hostname: hostname_example
type: DNS
listeners:
- # required
protocol: HTTP
port: 56
# optional
request_timeout_in_ms: 56
idle_timeout_in_ms: 56
access_logging:
# optional
is_enabled: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update virtual_deployment
oci_service_mesh_virtual_deployment:
# required
virtual_deployment_id: "ocid1.virtualdeployment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
service_discovery:
# required
hostname: hostname_example
type: DNS
listeners:
- # required
protocol: HTTP
port: 56
# optional
request_timeout_in_ms: 56
idle_timeout_in_ms: 56
access_logging:
# optional
is_enabled: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update virtual_deployment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_service_mesh_virtual_deployment:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
service_discovery:
# required
hostname: hostname_example
type: DNS
listeners:
- # required
protocol: HTTP
port: 56
# optional
request_timeout_in_ms: 56
idle_timeout_in_ms: 56
access_logging:
# optional
is_enabled: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete virtual_deployment
oci_service_mesh_virtual_deployment:
# required
virtual_deployment_id: "ocid1.virtualdeployment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete virtual_deployment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_service_mesh_virtual_deployment:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
virtual_deployment
complex
|
on success |
Details of the VirtualDeployment resource acted upon by the current operation
Sample:
{'access_logging': {'is_enabled': True}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'listeners': [{'idle_timeout_in_ms': 56, 'port': 56, 'protocol': 'HTTP', 'request_timeout_in_ms': 56}], 'name': 'name_example', 'service_discovery': {'hostname': 'hostname_example', 'type': 'DNS'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'virtual_service_id': 'ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx'}
|
||
access_logging
complex
|
on success |
|
||
is_enabled
boolean
|
on success |
Determines if the logging configuration is enabled.
Sample:
True
|
||
compartment_id
string
|
on success |
The OCID of the compartment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
description
string
|
on success |
Description of the resource. It can be changed after creation. Avoid entering confidential information.
Example: `This is my new resource`
Sample:
description_example
|
||
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
Unique identifier that is immutable on creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
The current state of the Resource.
Sample:
CREATING
|
||
listeners
complex
|
on success |
The listeners for the virtual deployment
|
||
idle_timeout_in_ms
integer
|
on success |
The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.
Sample:
56
|
||
port
integer
|
on success |
Port in which virtual deployment is running.
Sample:
56
|
||
protocol
string
|
on success |
Type of protocol used in virtual deployment.
Sample:
HTTP
|
||
request_timeout_in_ms
integer
|
on success |
The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.
Sample:
56
|
||
name
string
|
on success |
A user-friendly name. The name must be unique within the same virtual service and cannot be changed after creation. Avoid entering confidential information.
Example: `My unique resource name`
Sample:
name_example
|
||
service_discovery
complex
|
on success |
|
||
hostname
string
|
on success |
The hostname of the virtual deployments.
Sample:
hostname_example
|
||
type
string
|
on success |
Type of service discovery.
Sample:
DNS
|
||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
||
time_created
string
|
on success |
The time when this resource was created in an RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time when this resource was updated in an RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
virtual_service_id
string
|
on success |
The OCID of the virtual service in which this virtual deployment is created.
Sample:
ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)