Create a container job

post/container/job

Creates a container job to initiate the creation of a project container. The project container is created some time later.

Request Samples

Response Samples


1{
2  "id": "123456789",
3  "containerName": "The name of the project container.",
4  "createdBy": "Mohammed Lee",
5  "creationTimeStamp": "2024/04/23 16:55:50"
6}

Request Body

A description of a job that creates a project container.

Name	Type	Required	Description
projectName	string	false	The name of the project package to be put in the project container.
projectVersionAndPromotionLevel	object	false	The version and promotion level of the project package to be put in the project container.
containerName	string	false	The name to be given to the project container. Match pattern: ^[a-z0-9]+(?:(?:\.\|_{1,2}\|-+)[a-z0-9]+)*$
description	string	false	An optional description for the project container.
arch	string	false	The architecture that the project container runs on (for example, "x86_64").
gpu	array [string]	false	An optional list of the graphics processing units (GPUs) that the project uses (for example, "[nvidia, openvino]").
espVersion	string	false
tags	array [string]	false	Optional tags that are applied to the project container. If the first tag is not of the form <project.version>-<espServer.version>-<YYYYMMDD.HHmmss date-time>, then a tag of that form is added automatically. Each new container is also tagged as "latest".
targetRegistryName	string	false	The name of the target registry.
baseImageName	string	false	The full Docker image name of the base image.
baseImageTag	string	false	The target tag of the base image.
baseImageRegistry	string	false	The name of the optional source registry for the base image.
baseImageRegistryPath	string	false	The path to the base image within the optional source registry.
componentsImageName	string	false	The full Docker image name of the base image
componentsImageTag	string	false	The target tag of the base image
componentsImageRegistry	string	false	The name of the optional source registry for the components image
componentsImageRegistryPath	string	false	The path to the components image within the optional source registry
serverImageName	string	false	The full Docker image name of the ESP server image
serverImageTag	string	false	The target tag of the ESP server image
serverImageRegistry	string	false	The name of the optional source registry for the ESP server image
serverImageRegistryPath	string	false	The path to the ESP server image within the optional source registry
buildkitImageName	string	false	The full Docker image name of the BuildKit image
buildkitImageTag	string	false	The target tag of the BuildKit image
buildkitImageRegistry	string	false	The name of the optional source registry for the BuildKit image
buildkitImageRegistryPath	string	false	The path to the BuildKit image within the optional source registry
targetRegistryPath	string	false	A path within the target registry.
pathToProjectPackageDirectory	string	false	An optional path to a directory for a project package. If a path is specified, the project container gets the project from the specified location. If a path is not specified, the project container gets the project from a Git server.
includeTestFiles	boolean	false	This parameter specifies whether to include the "test_files" folder in the container image.

Responses

Status	Meaning	Description
201	Created	The creation of the project container was initialized.	Headers	Schema
400	Bad Request	The request was invalid. Additional information is available in the application logs if the environment variable `LOGGING_LEVEL_ORG_SPRINGFRAMEWORK` is set to `DEBUG`.		Schema
401	Unauthorized	The request is not authenticated.		Schema
403	Forbidden	The user did not have the necessary permissions.		Schema
502	Bad Gateway	SAS Event Stream Manager was unable to find a suitable secret for the default container registry, or the default SAS Event Stream Processing license.		Schema
503	Service Unavailable	Functionality for project containers is not enabled.		Schema