Job Environment Variables
When you create a job or a job run, you can provide custom environment variables and command line arguments.
- Constraints
-
- Custom environment variables—The total character count across the key and value pairs for all custom environment variables. Can't exceed 20,000 characters.
- Command line arguments—Input for the command line arguments field can't exceed 4,000 characters.
With a job run, the following service provided environment variables are automatically made available:
Name |
Description |
---|---|
|
OCID of the tenancy the job belongs to. |
|
OCID of the project the job is associated with. |
|
OCID of the compartment of the project the job is associated with. |
|
OCID of the job is associated with. |
|
OCID of the compartment of the job is associated with. |
|
The file name of the job artifact that was uploaded. |
|
OCID of the job run. |
|
OCID of the compartment of the job run. |
FQDN |
The Fully Qualified Domain Name of the node that can be used for nodes to communicate to other nodes. |
In addition to the service job run environment variables, you can also use these environment variables:
Name |
Description |
---|---|
|
Conda environment type. Either |
|
Service conda environment slug. For example, |
|
Published conda environment region. |
|
Published conda environment object name. |
|
Published conda environment Object Storage namespace. |
|
Published conda environment Object Storage bucket. |
|
Required for zip or tar files. Specifies the entry point file in the job artifact to be run. |
Name | Description |
---|---|
NODE_RANK |
The system generated rank allocated to the NODE. Rank is a continuous, increasing integer between 0 and the number of nodes minus 1. |
NODE_GROUP_NAME |
The name of the node group provided by the user. |
|
The network interface name. For more information, see |
CLUSTER_NODES_METADATA_FILE |
The path to the file that contains the cluster nodes metadata. |
INITIAL_CLUSTER_SIZE |
The count of total cluster nodes across all Job Run node groups at time of start. Only the initial cluster size is provided. |
FQDN |
The Fully Qualified Domain Name of the node that can be used for nodes to communicate to other nodes. |
These variables are only for version 1 of Bring Your Own Container. See Creating a Job for the latest information on how to configure Bring Your Own Container using Environment Configurations.
Key | Value Type | Value Example | Description |
---|---|---|---|
|
String (Required) |
|
The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. For example:
Important: Bring your own container jobs don't support cross-region container image pulling. For example, when running a bring your own container job in an IAD (Ashburn) region, you can't pull container images from the OCIR (Oracle Cloud Container Registry) in the PHX (Phoenix) region. |
|
String[] |
`"ls", "-l"` |
The container image run Accept the |
|
String[] |
`"-a", "-h"` `"ls", "-l", "-a", "-h"` |
The container run Use |