Containers

>>>

GET /docker/api/v2/containers
List all containers

GET /docker/api/v2/compute_resources/:compute_resource_id/containers
List all containers on a compute resource

Params

Param name Description
compute_resource_id
optional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
search
optional

filtra els resultats

Validations:

  • Must be a String
order
optional

ordena els resultats

Validations:

  • Must be a String
page
optional

pagina els resultats

Validations:

  • Must be a String
per_page
optional

Nombre d'entrades per petició

Validations:

  • Must be a String
>>>

GET /docker/api/v2/containers/:id
Show a container

GET /docker/api/v2/compute_resources/:compute_resource_id/containers/:id
Show container on a compute resource

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
compute_resource_id
optional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /docker/api/v2/containers
Create a container

POST /docker/api/v2/compute_resources/:compute_resource_id/containers
Create container on a compute resource

Params

Param name Description
container
required

Validations:

  • Must be a Hash
container[name]
optional , nil allowed

Validations:

  • Must be a String
container[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els id. donats

Validations:

  • Must be an array of any type
container[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els id. donats.

Validations:

  • Must be an array of any type
container[compute_resource_id]
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
container[registry_id]
optional , nil allowed

Registry this container will have to use to get the image

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
container[repository_name]
required

Name of the repository to use to create the container. e.g. centos

Validations:

  • Must be a String
container[tag]
required

Tag to use to create the container. e.g. latest

Validations:

  • Must be a String
container[tty]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0
container[entrypoint]
optional , nil allowed

Validations:

  • Must be a String
container[command]
required

Validations:

  • Must be a String
container[memory]
optional , nil allowed

Validations:

  • Must be a String
container[cpu_shares]
optional , nil allowed

Validations:

  • Must be a number.
container[cpu_set]
optional , nil allowed

Validations:

  • Must be a String
container[environment_variables]
optional , nil allowed

Optional array of environment variables hashes. e.g. 'environment_variables': [{'name' => 'example', 'value' => '123'}]

Validations:

  • Must be an array of any type
container[attach_stdout]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0
container[attach_stdin]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0
container[attach_stderr]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0
container[capsule_id]
optional , nil allowed

The capsule this container will have to use to get the image. Relevant for images retrieved from katello registry.

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

DELETE /docker/api/v2/containers/:id
Delete a container

DELETE /docker/api/v2/compute_resources/:compute_resource_id/containers/:id
Delete container on a compute resource

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
compute_resource_id
optional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /docker/api/v2/containers/:id/logs
Show container logs

GET /docker/api/v2/compute_resources/:compute_resource_id/containers/:id/logs
Show logs from a container on a compute resource

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
compute_resource_id
optional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
stdout
optional

Validations:

  • Must be one of: true, false, 1, 0
stderr
optional

Validations:

  • Must be one of: true, false, 1, 0
tail
optional

Number of lines to tail. Default: 100

Validations:

  • Must be a Integer
>>>

PUT /docker/api/v2/containers/:id/power
Run power operation on a container

PUT /docker/api/v2/compute_resources/:compute_resource_id/containers/:id/power
Run power operation on a container on a compute resource

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
compute_resource_id
optional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
power_action
required

power action, valid actions are (start), (stop), (status)

Validations:

  • Must be a String