oracle.oci.oci_container_instances_container_instance – Manage a ContainerInstance 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_container_instances_container_instance.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a ContainerInstance resource in Oracle Cloud Infrastructure

  • For state=present, creates a container instance and deploys the containers on it.

  • This resource has the following action operations in the oracle.oci.oci_container_instances_container_instance_actions module: change_compartment, restart, start, stop.

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
availability_domain
string
The availability domain where the container instance runs.
Required for create using state=present.
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 compartment OCID.
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.
container_instance_id
string
The OCID of the container instance.
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
container_restart_policy
string
Container restart policy
containers
list / elements=dictionary
The containers to create on this container instance.
Required for create using state=present.
arguments
list / elements=string
A list of string arguments for a container's ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
command
list / elements=string
An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.

aliases: name
environment_variables
dictionary
A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
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"}`
health_checks
list / elements=dictionary
list of container health checks to check container status and take appropriate action if container status is failed. There are three types of health checks that we currently support HTTP, TCP, and Command.
command
list / elements=string
The list of strings that will be simplified to a single command for checking the status of the container.
Required when health_check_type is 'COMMAND'
failure_action
string
    Choices:
  • KILL
  • NONE
The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
failure_threshold
integer
Number of consecutive failures at which we consider the check failed.
headers
list / elements=dictionary
Container health check HTTP headers.
Applicable when health_check_type is 'HTTP'
name
string / required
Container HTTP header Key.
Required when health_check_type is 'HTTP'
value
string / required
Container HTTP header value.
Required when health_check_type is 'HTTP'
health_check_type
string / required
    Choices:
  • TCP
  • HTTP
  • COMMAND
Container health check type.
initial_delay_in_seconds
integer
The initial delay in seconds before start checking container health status.
interval_in_seconds
integer
Number of seconds between two consecutive runs for checking container health.
name
string
Health check name.
path
string
Container health check HTTP path.
Required when health_check_type is 'HTTP'
port
integer
Container health check port.
Required when health_check_type is one of ['TCP', 'HTTP']
success_threshold
integer
Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
timeout_in_seconds
integer
Length of waiting time in seconds before marking health check failed.
image_url
string / required
A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub `docker.io/library`.
The registry used for container image must be reachable over the Container Instance's VNIC.
is_resource_principal_disabled
boolean
    Choices:
  • no
  • yes
Determines if the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
resource_config
dictionary
memory_limit_in_gbs
float
The maximum amount of memory that can be consumed by the container's process.
If you do not set a value, then the process may use all available memory on the instance.
vcpus_limit
float
The maximum amount of CPUs that can be consumed by the container's process.
If you do not set a value, then the process can use all available CPU resources on the instance.
CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
security_context
dictionary
is_non_root_user_check_enabled
boolean
    Choices:
  • no
  • yes
Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
is_root_file_system_readonly
boolean
    Choices:
  • no
  • yes
Determines if the container will have a read-only root file system. Default value is false.
run_as_group
integer
The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
run_as_user
integer
The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
security_context_type
string
    Choices:
  • LINUX ←
The type of security context
volume_mounts
list / elements=dictionary
List of the volume mounts.
is_read_only
boolean
    Choices:
  • no
  • yes
Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
mount_path
string / required
The volume access path.
partition
integer
If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
sub_path
string
A subpath inside the referenced volume.
volume_name
string / required
The name of the volume. Avoid entering confidential information.
working_directory
string
The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.
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.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
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
dns_config
dictionary
nameservers
list / elements=string
IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
options
list / elements=string
Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
searches
list / elements=string
Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
fault_domain
string
The fault domain where the container instance runs.
force_create
boolean
    Choices:
  • no ←
  • yes
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.
graceful_shutdown_timeout_in_seconds
integer
The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
image_pull_secrets
list / elements=dictionary
The image pulls secrets so you can access private registry to pull container images.
password
string
The password which should be used with the registry for authentication. The value is expected in base64 format.
Required when secret_type is 'BASIC'
registry_endpoint
string / required
The registry endpoint of the container image.
secret_id
string
The OCID of the secret for registry credentials.
Required when secret_type is 'VAULT'
secret_type
string / required
    Choices:
  • VAULT
  • BASIC
The type of ImagePullSecret.
username
string
The username which should be used with the registry for authentication. The value is expected in base64 format.
Required when secret_type is 'BASIC'
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.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
shape
string
The shape of the container instance. The shape determines the resources available to the container instance.
Required for create using state=present.
shape_config
dictionary
Required for create using state=present.
memory_in_gbs
float
The total amount of memory available to the container instance (GB).
ocpus
float / required
The total number of OCPUs available to the container instance.
state
string
    Choices:
  • present ←
  • absent
The state of the ContainerInstance.
Use state=present to create or update a ContainerInstance.
Use state=absent to delete a ContainerInstance.
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
vnics
list / elements=dictionary
The networks available to containers on this container instance.
Required for create using state=present.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`.
display_name
string
A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.

aliases: name
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"}`
hostname_label
string
The hostname for the VNIC's primary private IP. Used for DNS.
is_public_ip_assigned
boolean
    Choices:
  • no
  • yes
Whether the VNIC should be assigned a public IP address.
nsg_ids
list / elements=string
A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
private_ip
string
A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
skip_source_dest_check
boolean
    Choices:
  • no
  • yes
Whether the source/destination check is disabled on the VNIC.
subnet_id
string / required
The OCID of the subnet to create the VNIC in.
volumes
list / elements=dictionary
A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
backing_store
string
The volume type of the empty directory, can be either File Storage or Memory.
Applicable when volume_type is 'EMPTYDIR'
configs
list / elements=dictionary
Contains key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
Applicable when volume_type is 'CONFIGFILE'
data
string / required
The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
Required when volume_type is 'CONFIGFILE'
file_name
string / required
The name of the file. The fileName should be unique across the volume.
Required when volume_type is 'CONFIGFILE'
path
string
(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
Applicable when volume_type is 'CONFIGFILE'
name
string / required
The name of the volume. This must be unique within a single container instance.
volume_type
string / required
    Choices:
  • CONFIGFILE
  • EMPTYDIR
Default:
"null"
The type of volume.
wait
boolean
    Choices:
  • no
  • yes ←
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.

Examples

- name: Create container_instance
  oci_container_instances_container_instance:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    availability_domain: Uocm:PHX-AD-1
    shape: shape_example
    shape_config:
      # required
      ocpus: 3.4

      # optional
      memory_in_gbs: 3.4
    containers:
    - # required
      image_url: image_url_example

      # optional
      display_name: display_name_example
      command: [ "command_example" ]
      arguments: [ "arguments_example" ]
      working_directory: working_directory_example
      environment_variables: null
      volume_mounts:
      - # required
        mount_path: mount_path_example
        volume_name: volume_name_example

        # optional
        sub_path: sub_path_example
        is_read_only: true
        partition: 56
      is_resource_principal_disabled: true
      resource_config:
        # optional
        vcpus_limit: 3.4
        memory_limit_in_gbs: 3.4
      health_checks:
      - # required
        port: 56
        health_check_type: TCP

        # optional
        name: name_example
        initial_delay_in_seconds: 56
        interval_in_seconds: 56
        failure_threshold: 56
        success_threshold: 56
        timeout_in_seconds: 56
        failure_action: KILL
      security_context:
        # optional
        security_context_type: LINUX
        run_as_user: 56
        run_as_group: 56
        is_non_root_user_check_enabled: true
        is_root_file_system_readonly: true
      freeform_tags: {'Department': 'Finance'}
      defined_tags: {'Operations': {'CostCenter': 'US'}}
    vnics:
    - # required
      subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      display_name: display_name_example
      hostname_label: hostname_label_example
      is_public_ip_assigned: true
      skip_source_dest_check: true
      nsg_ids: [ "nsg_ids_example" ]
      private_ip: private_ip_example
      freeform_tags: {'Department': 'Finance'}
      defined_tags: {'Operations': {'CostCenter': 'US'}}

    # optional
    fault_domain: FAULT-DOMAIN-1
    volumes:
    - # required
      name: name_example
      volume_type: CONFIGFILE

      # optional
      configs:
      - # required
        file_name: file_name_example
        data: data_example

        # optional
        path: path_example
    dns_config:
      # optional
      nameservers: [ "nameservers_example" ]
      searches: [ "searches_example" ]
      options: [ "options_example" ]
    graceful_shutdown_timeout_in_seconds: 56
    image_pull_secrets:
    - # required
      secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
      secret_type: VAULT
      registry_endpoint: registry_endpoint_example
    container_restart_policy: container_restart_policy_example
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update container_instance
  oci_container_instances_container_instance:
    # required
    container_instance_id: "ocid1.containerinstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update container_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_container_instances_container_instance:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete container_instance
  oci_container_instances_container_instance:
    # required
    container_instance_id: "ocid1.containerinstance.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete container_instance using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_container_instances_container_instance:
    # 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
container_instance
complex
on success
Details of the ContainerInstance resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'container_count': 56, 'container_restart_policy': 'ALWAYS', 'containers': [{'container_id': 'ocid1.container.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example'}], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dns_config': {'nameservers': [], 'options': [], 'searches': []}, 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'graceful_shutdown_timeout_in_seconds': 56, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'image_pull_secrets': [{'registry_endpoint': 'registry_endpoint_example', 'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'secret_type': 'BASIC'}], 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'shape': 'shape_example', 'shape_config': {'memory_in_gbs': 3.4, 'networking_bandwidth_in_gbps': 3.4, 'ocpus': 3.4, 'processor_description': 'processor_description_example'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'vnics': [{'vnic_id': 'ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx'}], 'volume_count': 56, 'volumes': [{'backing_store': 'EPHEMERAL_STORAGE', 'configs': [{'data': None, 'file_name': 'file_name_example', 'path': 'path_example'}], 'name': 'name_example', 'volume_type': 'EMPTYDIR'}]}
 
availability_domain
string
on success
The availability domain to place the container instance.

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
container_count
integer
on success
The number of containers on the container instance.

Sample:
56
 
container_restart_policy
string
on success
The container restart policy is applied for all containers in container instance.

Sample:
ALWAYS
 
containers
complex
on success
The containers on the container instance.
   
container_id
string
on success
The OCID of the container.

Sample:
ocid1.container.oc1..xxxxxxEXAMPLExxxxxx
   
display_name
string
on success
Display name for the Container.

Sample:
display_name_example
 
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'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
dns_config
complex
on success

   
nameservers
list / elements=string
on success
IP address of the name server..
   
options
list / elements=string
on success
Options allows certain internal resolver variables to be modified.
   
searches
list / elements=string
on success
Search list for hostname lookup.
 
fault_domain
string
on success
The fault domain to place the container instance.

Sample:
FAULT-DOMAIN-1
 
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'}
 
graceful_shutdown_timeout_in_seconds
integer
on success
The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.

Sample:
56
 
id
string
on success
An OCID that cannot be changed.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
image_pull_secrets
complex
on success
The image pulls secrets so you can access private registry to pull container images.
   
registry_endpoint
string
on success
The registry endpoint of the container image.

Sample:
registry_endpoint_example
   
secret_id
string
on success
The OCID of the secret for registry credentials.

Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
   
secret_type
string
on success
The type of ImagePullSecret.

Sample:
BASIC
 
lifecycle_details
string
on success
A message that describes the current state of the container in more detail. Can be used to provide actionable information.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the container instance.

Sample:
CREATING
 
shape
string
on success
The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.

Sample:
shape_example
 
shape_config
complex
on success

   
memory_in_gbs
float
on success
The total amount of memory available to the container instance, in gigabytes.

Sample:
3.4
   
networking_bandwidth_in_gbps
float
on success
The networking bandwidth available to the container instance, in gigabits per second.

Sample:
3.4
   
ocpus
float
on success
The total number of OCPUs available to the container instance.

Sample:
3.4
   
processor_description
string
on success
A short description of the container instance's processor (CPU).

Sample:
processor_description_example
 
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 the container instance was created, in the format defined by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the container instance was updated, in the format defined by RFC 3339.

Sample:
2013-10-20T19:20:30+01:00
 
vnics
complex
on success
The virtual networks available to the containers in the container instance.
   
vnic_id
string
on success
The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

Sample:
ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
 
volume_count
integer
on success
The number of volumes that are attached to the container instance.

Sample:
56
 
volumes
complex
on success
A volume is a directory with data that is accessible across multiple containers in a container instance.
   
backing_store
string
on success
The volume type of the empty directory, can be either File Storage or Memory.

Sample:
EPHEMERAL_STORAGE
   
configs
complex
on success
Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
     
data
string
on success
The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.

Sample:
null
     
file_name
string
on success
The name of the file. The fileName should be unique across the volume.

Sample:
file_name_example
     
path
string
on success
(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.

Sample:
path_example
   
name
string
on success
The name of the volume. This must be unique within a single container instance.

Sample:
name_example
   
volume_type
string
on success
The type of volume.

Sample:
EMPTYDIR


Authors

  • Oracle (@oracle)