Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Container

A single container on a container instance.

If you delete a container, the record remains visible for a short period of time before being permanently removed.

Properties

Optional arguments

arguments: Array<string>

A list of string arguments for the ENTRYPOINT process of the container.

Many containers use an ENTRYPOINT process pointing to a shell {@code /bin/bash}. For those containers, you can use the argument list to specify the main command in the container process.

availabilityDomain

availabilityDomain: string

The availability domain where the container instance that hosts the container runs.

Optional command

command: Array<string>

This command overrides ENTRYPOINT process of the container. If you do not specify this command, the existing ENTRYPOINT process defined in the image is the default.

compartmentId

compartmentId: string

The OCID of the compartment that contains the container.

containerInstanceId

containerInstanceId: string

The OCID of the container instance that the container is running on.

Optional containerRestartAttemptCount

containerRestartAttemptCount: undefined | number

The number of container restart attempts. Depending on the restart policy, a restart might be attempted after a health check failure or a container exit. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

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"}}}.

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional environmentVariables

environmentVariables: undefined | object

A map of additional environment variables to set in the environment of the ENTRYPOINT process of the container. These variables are in addition to any variables already defined in the container's image.

Optional exitCode

exitCode: undefined | number

The exit code of the container process when it stopped running. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional faultDomain

faultDomain: undefined | string

The fault domain of the container instance that hosts the container runs.

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

id

id: string

The OCID of the container.

imageUrl

imageUrl: string

The container image information. Currently only supports public Docker registry.

You can provide either the image name (containerImage), image name with version (containerImagev1), or complete Docker image URL {@code docker.io/library/containerImage:latest}.

If you do not provide a registry, the registry defaults to public Docker hub {@code docker.io/library}. The registry used for the container image must be reachable over the VNIC of the container instance.

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 more 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 lifecycleDetails

lifecycleDetails: undefined | string

A message that describes the current state of the container in more detail. Can be used to provide actionable information.

lifecycleState

lifecycleState: LifecycleState

The current state of the container.

Optional resourceConfig

resourceConfig: model.ContainerResourceConfig

Optional securityContext

securityContext: model.LinuxSecurityContext

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}.

timeCreated

timeCreated: Date

The time the container was created, in the format defined by RFC 3339.

Optional timeTerminated

timeTerminated: Date

The time when the container last deleted (terminated), in the format defined by RFC 3339.

Optional timeUpdated

timeUpdated: Date

The time the container was updated, in the format defined by RFC 3339.

Optional volumeMounts

volumeMounts: Array<VolumeMount>

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

  • getDeserializedJsonObj(obj: Container): object

getJsonObj