QOqovery
Containers

Create a container

post/environment/{environmentId}/container

Request

Path parameters

environmentIdstring uuid required

Environment ID

Request body

namestring required

name is case insensitive

descriptionstring

give a description to this container

registry_idstring required

id of the linked registry

image_namestring required

The image name pattern differs according to chosen container registry provider:

  • ECR: repository
  • SCALEWAY_CR: namespace/image
  • DOCKER_HUB: image or repository/image
  • PUBLIC_ECR: registry_alias/repository
tagstring required

tag of the image container

argumentsstring[]
entrypointstring

optional entrypoint when launching container

cpuinteger

unit is millicores (m). 1000m = 1 cpu

memoryinteger

unit is MB. 1024 MB = 1GB

gpuinteger
min_running_instancesinteger

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running.

max_running_instancesinteger

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

auto_previewboolean

Indicates if the 'environment preview option' is enabled for this container.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.

auto_deployboolean nullable

Specify if the container will be automatically updated after receiving a new image tag. The new image tag shall be communicated via the "Auto Deploy container" endpoint https://api-doc.qovery.com/#tag/Containers/operation/autoDeployContainerEnvironments

icon_uristring uri

Icon URI representing the container.

Example request

{
  "storage": [
    {
      "size": 16,
      "mount_point": "/mnt/images"
    }
  ],
  "ports": [
    {
      "internal_port": 8080,
      "external_port": 8080
    }
  ],
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1
}

Response

Create container

idstring uuid required
created_atstring date-time required
updated_atstring date-time
image_namestring required

The image name pattern differs according to chosen container registry provider:

  • ECR: repository
  • SCALEWAY_CR: namespace/image
  • DOCKER_HUB: image or repository/image
  • PUBLIC_ECR: registry_alias/repository
tagstring required

tag of the image container

registry_idstring

tag of the image container

maximum_cpuinteger required

Maximum cpu that can be allocated to the container based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu

maximum_memoryinteger required

Maximum memory that can be allocated to the container based on organization cluster configuration. unit is MB. 1024 MB = 1GB

maximum_gpuinteger required

Maximum memory that can be allocated to the container based on organization cluster configuration. unit is MB. 1024 MB = 1GB

namestring required

name is case insensitive

descriptionstring

give a description to this container

argumentsstring[]
entrypointstring

optional entrypoint when launching container

cpuinteger required

unit is millicores (m). 1000m = 1 cpu

memoryinteger required

unit is MB. 1024 MB = 1GB

gpuinteger required
min_running_instancesinteger required

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running.

max_running_instancesinteger required

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

auto_previewboolean required

Indicates if the 'environment preview option' is enabled for this container.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.

auto_deployboolean

Specify if the container will be automatically updated after receiving a new image tag. The new image tag shall be communicated via the "Auto Deploy container" endpoint https://api-doc.qovery.com/#tag/Containers/operation/autoDeployContainerEnvironments

icon_uristring uri required

Icon URI representing the container.

service_type'APPLICATION' | 'DATABASE' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required

type of the service (application, database, job, ...)

Example response

{
  "storage": [
    {
      "size": 16,
      "mount_point": "/mnt/images"
    }
  ],
  "maximum_cpu": 16000,
  "maximum_memory": 16384,
  "maximum_gpu": 2,
  "cpu": 1250,
  "memory": 1024,
  "gpu": 1,
  "ports": [
    {
      "internal_port": 8080,
      "external_port": 8080
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.