diff --git a/public-site/docs/guides/jobs/job-manager-and-job-api.md b/public-site/docs/guides/jobs/job-manager-and-job-api.md index f4fdf3ac..e4db3e7f 100644 --- a/public-site/docs/guides/jobs/job-manager-and-job-api.md +++ b/public-site/docs/guides/jobs/job-manager-and-job-api.md @@ -61,6 +61,7 @@ The Job Manager exposes the following methods for managing jobs: ```json { + "batchId": "random-batch-id-123", "defaultRadixJobComponentConfig": { "imageTagName": "1.0.0", "timeLimitSeconds": 200, @@ -225,6 +226,10 @@ To start a new batch of jobs, send a `POST` request to `http://compute:8000/api/ } ``` +### Batch ID +Batch can have `batchId` - it is an optional string, where any value can be put. Radix does not process it. It can exist in a `batchScheduleDescription` (a request body json) for a batch. +If the `batchId` is specified, it will be returned in the batch status, and it will be shown in the Radix console in the batch list. + ### Job ID Jobs can have `jobId` - it is an optional string, where any value can be put. Radix does not process it. It can exist in a `jobScheduleDescription` for a single job or in batch jobs If the `jobId` is specified, it will be returned in the job's status, and it will be shown in the Radix console in the job list. diff --git a/public-site/docs/guides/jobs/notifications.md b/public-site/docs/guides/jobs/notifications.md index d2d9f5ca..fd3e6c1b 100644 --- a/public-site/docs/guides/jobs/notifications.md +++ b/public-site/docs/guides/jobs/notifications.md @@ -10,6 +10,7 @@ When job and batch status needs to be monitored, their statuses can be [pulled]( The URL to the Radix application component or job component endpoint can be specified in the `webhook` option in the `notifications` section in the [radixconfig.yaml](/radix-config/index.md). This is an endpoint where a Radix batch events will be posted when any of the running jobs or batches for this job component changes states. Notification about changes are sent by a `POST` method with an `application/json` `ContentType` with a [Radix batch event format](#radix-batch-event), which extends the [Radix batch status](./job-manager-and-job-api.md#get-a-state-of-a-batch) format with fields * `name` - internal name of the batch or a single job. In both cases the name begins with `batch-` +* `batchId` - optional string value to identify a batch. * `created`, `started`, `ended` - timestamp of corresponding batch live cycle event * `status` - status of a batch or a single job * `updated` - timestamp when a status was updated @@ -57,6 +58,7 @@ Fields in the `jobStatus` list items: ```json { "name": "batch-compute-20220302155333-hrwl53mw", + "batchId": "random-batch-id-123", "created": "2022-03-02T15:53:33+01:00", "started": "2022-03-02T15:53:33+01:00", "ended": "2022-03-02T15:54:00+01:00",