Starting a Job Run

Use Data Science job runs to apply various use cases to created jobs.

Job creation sets the infrastructure and the actual use case artifact, but the job run actually runs the job with the specified parameters. Job runs provision the specified infrastructure, run the job artifact, and then deprovision and destroy the used resources when the job run ends.

1. From the jobs list page, select the name of the job to work with. If you need help finding the list of jobs, see Listing Jobs.
2. Select Start a job run.
3. (Optional) Select a different compartment for the job.
4. (Optional) Enter a unique name for the job run (limit of 255 characters). If you don't provide a name, a name is automatically generated.
  
  For example, jobrun20210808222435.
5. (Optional) To use logging, select Select, and then ensure that Enable logging is selected.
  
  Select a log group from the list. You can change to a different compartment to specify a log group in a different compartment from the job.
  
  Select one of the following to store all stdout and stderr messages:
  
  Enable automatic log creation
  
  Data Science automatically creates a log when the job starts.
  
  Select a log
  
  Select a log to use.
  
  Select Select to return to the job run creation page.
6. (Optional) Override the Bring Your Own Container configuration, that was defined when the job was created, by using these options:
  
  In Environment configuration. select Select. The Set your BYOC environment panel is displayed.
  
  In Repository select a repository from the list. If the repository is in a different compartment, select Change compartment.
  
  In Image select an image from the list.
  
  (Optional) In Entrypoint enter an entry point. To add another, select +Add parameter.
  
  (Optional) In CMD enter a CMD. To add another, select +Add parameter.
  Note
  
  Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT.
  
  (Optional) In Image digest enter an image digest.
  
  (Optional) In Signature ID, if using signature verification, enter the OCID of the image signature. For example, ocid1.containerimagesignature.oc1.iad.aaaaaaaaab....
  
  Select Select.
7. (Optional) Override the default job configuration that was defined when the job was created by using these options:
  Enter or select any of the following values:
  
  Custom environment variable key
  
  The environment variables that control the job.
  
  Value
  
  The value for the custom environment variable key.
  
  You can select Additional custom environment key to specify more variables.
  
  Command line arguments
  
  The command line arguments that you want to use for running the job.
  
  Maximum runtime (in minutes)
  
  The maximum number of minutes that the job can run. The service cancels the job run if its runtime exceeds the specified value. The maximum runtime is 30 days (43,200 minutes). We recommend that you configure a maximum runtime on all job runs to prevent runaway job runs.
8. (Optional) Select Show advanced options to add tags to the job run.
9. (Optional) In the Tags section, add one or more tags to the <resourceType>. If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
10. Select Start.

These environment variables control the job.

Use the Data Science CLI to start job runs as in this example:

Start a job run with:

oci data-science job-run create \
--display-name <job_run_name> \
--compartment-id <compartment_ocid> \
--project-id <project_ocid> \
--job-id <job_ocid> \
--configuration-override-details file://<optional_job_run_configuration_override_json_file> \
--log-configuration-override-details file://<optional_job_run_logging_configuration_override_json_file>

(Optional) Use this job run configuration override JSON file to override the configurations defined on the parent job:

jobEnvironmentConfigurationDetails: {
  jobEnvironmentType: "OCIR_CONTAINER",
    image: "iad.ocir.io/axoxdievda5j/odsc-byod-hello-wrld:0.1.3",
    imageDigest: "sha256",
  cmd: ["ls", "-h"],
  entrypoint: ["-l"],
    imageSignatureId: "ocid1.containerimagesignature.oc1.iad.0.ociodscdev.aaaaaaaaccutw5qdz6twjzkpgmbojdck3qotqqsbn7ph6xcumu4s32o6v5gq",
},
    jobConfigurationDetails: {
        jobType: "DEFAULT",
        environmentVariables: <envar-list-object>},
    ...
}

(Optional) Use this job run logging configuration override JSON file to override the logging configuration defined on the parent job:
```
{
  "enableLogging": true,
  "enableAutoLogCreation": true,
  "logGroupId": "<log_group_ocid>"
}
```

The ADS SDK is also a publicly available Python library that you can install with this command:
```
pip install oracle-ads
```
It provides the wrapper that makes starting job runs from notebooks or on your client machine easy.

Use the ADS SDK to start job runs.

Oracle Cloud Infrastructure Documentation

Starting a Job Run