Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateContainerDetails

Information to create a new container within a container instance.

The container created by this call contains both the tags specified in this object and any tags specified in the parent container instance.

The container is created in the same compartment, availability domain, and fault domain as its container instance.

Properties

Optional arguments

arguments: Array<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.

Optional command

command: Array<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.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}.

Optional displayName

displayName: undefined | 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.

Optional environmentVariables

environmentVariables: undefined | object

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.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional healthChecks

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.

imageUrl

imageUrl: string

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 {@code docker.io/library}.

The registry used for container image must be reachable over the Container Instance's VNIC.

Optional isResourcePrincipalDisabled

isResourcePrincipalDisabled: undefined | false | true

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.

Optional resourceConfig

resourceConfig: model.CreateContainerResourceConfigDetails

Optional securityContext

securityContext: model.CreateLinuxSecurityContextDetails

Optional volumeMounts

List of the volume mounts.

Optional workingDirectory

workingDirectory: undefined | 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.

Functions

getDeserializedJsonObj

getJsonObj