Container Code Package Properties

  • Article

Describes a container and its runtime properties.

Properties

Name Type Required
name string Yes
image string Yes
imageRegistryCredential ImageRegistryCredential No
entryPoint string No
commands array of string No
environmentVariables array of EnvironmentVariable No
settings array of Setting No
labels array of ContainerLabel No
endpoints array of EndpointProperties No
resources ResourceRequirements Yes
volumeRefs array of VolumeReference No
volumes array of ApplicationScopedVolume No
diagnostics DiagnosticsRef No
reliableCollectionsRefs array of ReliableCollectionsRef No
instanceView ContainerInstanceView No
livenessProbe array of Probe No
readinessProbe array of Probe No

name

Type: string
Required: Yes

The name of the code package.

image

Type: string
Required: Yes

The Container image to use.

imageRegistryCredential

Type: ImageRegistryCredential
Required: No

Image registry credential.

entryPoint

Type: string
Required: No

Override for the default entry point in the container.

commands

Type: array of string
Required: No

Command array to execute within the container in exec form.

environmentVariables

Type: array of EnvironmentVariable
Required: No

The environment variables to set in this container

settings

Type: array of Setting
Required: No

The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".

labels

Type: array of ContainerLabel
Required: No

The labels to set in this container.

endpoints

Type: array of EndpointProperties
Required: No

The endpoints exposed by this container.

resources

Type: ResourceRequirements
Required: Yes

The resources required by this container.

volumeRefs

Type: array of VolumeReference
Required: No

Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.

volumes

Type: array of ApplicationScopedVolume
Required: No

Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.

diagnostics

Type: DiagnosticsRef
Required: No

Reference to sinks in DiagnosticsDescription.

reliableCollectionsRefs

Type: array of ReliableCollectionsRef
Required: No

A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.

instanceView

Type: ContainerInstanceView
Required: No

Runtime information of a container instance.

livenessProbe

Type: array of Probe
Required: No

An array of liveness probes for a code package. It determines when to restart a code package.

readinessProbe

Type: array of Probe
Required: No

An array of readiness probes for a code package. It determines when to unpublish an endpoint.