oracle.oci.oci_service_mesh_ingress_gateway_route_table – Manage an IngressGatewayRouteTable 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_ingress_gateway_route_table
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete an IngressGatewayRouteTable resource in Oracle Cloud Infrastructure
For state=present, creates a new IngressGatewayRouteTable.
This resource has the following action operations in the oracle.oci.oci_service_mesh_ingress_gateway_route_table_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 | ||
---|---|---|---|---|
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.
|
|||
ingress_gateway_id
string
|
The OCID of the service mesh in which this access policy is created.
Required for create using state=present.
|
|||
ingress_gateway_route_table_id
string
|
Unique IngressGatewayRouteTable 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 |
|||
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.
|
|||
name
string
|
A user-friendly name. The name must be unique within the same ingress gateway 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. |
|||
priority
integer
|
The priority of the route table. Lower value means higher priority. The routes are declared based on the priority.
This parameter is updatable.
|
|||
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. |
|||
route_rules
list
/ elements=dictionary
|
The route rules for the ingress gateway.
Required for create using state=present.
This parameter is updatable.
|
|||
destinations
list
/ elements=dictionary / required
|
The destination of the request.
|
|||
port
integer
|
The port on the virtual service to target. Mandatory if the virtual deployments are listening on multiple ports.
Applicable when type is 'TLS_PASSTHROUGH'
|
|||
type
string
/ required
|
|
Type of the traffic target.
Required when type is 'TLS_PASSTHROUGH'
|
||
virtual_service_id
string
/ required
|
The OCID of the virtual service where the request will be routed.
Required when type is 'TLS_PASSTHROUGH'
|
|||
weight
integer
|
Weight of traffic target.
Applicable when type is 'TLS_PASSTHROUGH'
|
|||
ingress_gateway_host
dictionary
|
||||
name
string
/ required
|
Name of the ingress gateway host that this route should apply to.
Required when type is 'TLS_PASSTHROUGH'
|
|||
port
integer
|
The port of the ingress gateway host listener. Leave empty to match all ports for the host.
Applicable when type is 'TLS_PASSTHROUGH'
|
|||
is_grpc
boolean
|
|
If true, the rule will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
Applicable when type is 'HTTP'
|
||
is_host_rewrite_enabled
boolean
|
|
If true, the hostname will be rewritten to the target virtual deployment's DNS hostname.
Applicable when type is 'HTTP'
|
||
is_path_rewrite_enabled
boolean
|
|
If true, the matched path prefix will be rewritten to '/' before being directed to the target virtual deployment.
Applicable when type is 'HTTP'
|
||
path
string
|
Route to match
Applicable when type is 'HTTP'
|
|||
path_type
string
|
|
Match type for the route
Applicable when type is 'HTTP'
|
||
request_timeout_in_ms
integer
|
The maximum duration in milliseconds for the upstream service to respond to a request. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP based route rules, and disabled (no timeout) when 'isGrpc' is true. The value 0 (zero) indicates that the timeout is disabled. For streaming responses from the upstream service, consider either keeping the timeout disabled or set a sufficiently high value.
Applicable when type is 'HTTP'
|
|||
type
string
/ required
|
|
Type of protocol.
|
||
state
string
|
|
The state of the IngressGatewayRouteTable.
Use state=present to create or update an IngressGatewayRouteTable.
Use state=absent to delete an IngressGatewayRouteTable.
|
||
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 ingress_gateway_route_table
oci_service_mesh_ingress_gateway_route_table:
# required
ingress_gateway_id: "ocid1.ingressgateway.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
route_rules:
- # required
type: TLS_PASSTHROUGH
destinations:
- # required
type: VIRTUAL_DEPLOYMENT
virtual_service_id: "ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx"
# optional
port: 56
weight: 56
# optional
ingress_gateway_host:
# required
name: name_example
# optional
port: 56
# optional
description: description_example
priority: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update ingress_gateway_route_table
oci_service_mesh_ingress_gateway_route_table:
# required
ingress_gateway_route_table_id: "ocid1.ingressgatewayroutetable.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
priority: 56
route_rules:
- # required
type: TLS_PASSTHROUGH
destinations:
- # required
type: VIRTUAL_DEPLOYMENT
virtual_service_id: "ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx"
# optional
port: 56
weight: 56
# optional
ingress_gateway_host:
# required
name: name_example
# optional
port: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update ingress_gateway_route_table using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_service_mesh_ingress_gateway_route_table:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
description: description_example
priority: 56
route_rules:
- # required
type: TLS_PASSTHROUGH
destinations:
- # required
type: VIRTUAL_DEPLOYMENT
virtual_service_id: "ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx"
# optional
port: 56
weight: 56
# optional
ingress_gateway_host:
# required
name: name_example
# optional
port: 56
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete ingress_gateway_route_table
oci_service_mesh_ingress_gateway_route_table:
# required
ingress_gateway_route_table_id: "ocid1.ingressgatewayroutetable.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete ingress_gateway_route_table using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_service_mesh_ingress_gateway_route_table:
# 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 | |||
---|---|---|---|---|---|
ingress_gateway_route_table
complex
|
on success |
Details of the IngressGatewayRouteTable resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ingress_gateway_id': 'ocid1.ingressgateway.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'priority': 56, 'route_rules': [{'destinations': [{'port': 56, 'type': 'VIRTUAL_DEPLOYMENT', 'virtual_service_id': 'ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx', 'weight': 56}], 'ingress_gateway_host': {'name': 'name_example', 'port': 56}, 'is_grpc': True, 'is_host_rewrite_enabled': True, 'is_path_rewrite_enabled': True, 'path': 'path_example', 'path_type': 'PREFIX', 'request_timeout_in_ms': 56, 'type': 'HTTP'}], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
|||
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
|
|||
ingress_gateway_id
string
|
on success |
The OCID of the ingress gateway.
Sample:
ocid1.ingressgateway.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
|
|||
name
string
|
on success |
A user-friendly name. The name must be unique within the same ingress gateway and cannot be changed after creation. Avoid entering confidential information.
Example: `My unique resource name`
Sample:
name_example
|
|||
priority
integer
|
on success |
The priority of the route table. A lower value means a higher priority. The routes are declared based on the priority.
Sample:
56
|
|||
route_rules
complex
|
on success |
The route rules for the ingress gateway.
|
|||
destinations
complex
|
on success |
The destination of the request.
|
|||
port
integer
|
on success |
The port on the virtual service to target. Mandatory if the virtual deployments are listening on multiple ports.
Sample:
56
|
|||
type
string
|
on success |
Type of the traffic target.
Sample:
VIRTUAL_DEPLOYMENT
|
|||
virtual_service_id
string
|
on success |
The OCID of the virtual service where the request will be routed.
Sample:
ocid1.virtualservice.oc1..xxxxxxEXAMPLExxxxxx
|
|||
weight
integer
|
on success |
Weight of traffic target.
Sample:
56
|
|||
ingress_gateway_host
complex
|
on success |
|
|||
name
string
|
on success |
Name of the ingress gateway host that this route should apply to.
Sample:
name_example
|
|||
port
integer
|
on success |
The port of the ingress gateway host listener. Leave empty to match all ports for the host.
Sample:
56
|
|||
is_grpc
boolean
|
on success |
If true, the rule will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
Sample:
True
|
|||
is_host_rewrite_enabled
boolean
|
on success |
If true, the hostname will be rewritten to the target virtual deployment's DNS hostname.
Sample:
True
|
|||
is_path_rewrite_enabled
boolean
|
on success |
If true, the matched path prefix will be rewritten to '/' before being directed to the target virtual deployment.
Sample:
True
|
|||
path
string
|
on success |
Route to match
Sample:
path_example
|
|||
path_type
string
|
on success |
Match type for the route
Sample:
PREFIX
|
|||
request_timeout_in_ms
integer
|
on success |
The maximum duration in milliseconds for the upstream service to respond to a request. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP based route rules, and disabled (no timeout) when 'isGrpc' is true. The value 0 (zero) indicates that the timeout is disabled. For streaming responses from the upstream service, consider either keeping the timeout disabled or set a sufficiently high value.
Sample:
56
|
|||
type
string
|
on success |
Type of protocol.
Sample:
HTTP
|
|||
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
|
Authors¶
Oracle (@oracle)