Run Steps in Containers
Short overview:
To run a step in a container, use the
containerblock:job("Example"){ // displayName is optional // it will be shown in the job run results container(displayName = "Say Hello", image = "alpine") { shellScript { content = "echo Hello" } } }You can use container images either from Docker Hub or from your own Space Packages registries.
Depending on your task, in a container, you can run a shell script, arbitrary Kotlin code, or a container image command.
All these three options are mutually exclusive.
During the run, the container has access to the project repository.
You can adjust container resources for resource-consuming steps.
A job can contain up to 50 steps (containers).
The default and maximum allowed job timeout is 2 hours.
Selecting a container image
You can use two sources of container images:
To use an image from Docker Hub, specify the image name:
container(image = "hello-world")Note that Space caches the images downloaded from Docker Hub. The cache lifetime is no longer than three hours. The disk space required for storing cached images is provided free of charge.
Your Space Packages registry.
To use an image from Space Packages, specify the full image URL:
container(image = "mycompany.registry.jetbrains.space/p/projectkey/mydocker/hello-world")
What can you run in a container
Shell scripts:
job("Run shell script") { container(displayName = "Show dir contents", image = "ubuntu") { shellScript { interpreter = "/bin/bash" content = """ echo Working dir contents ls /mnt/space/work """ } } }Learn moreArbitrary Kotlin code:
job("Run Kotlin code") { container(displayName = "Say Hello", image = "openjdk:latest") { kotlinScript { api -> println("Hello world!") } } }Learn moreContainer image commands:
job("Run container command") { container(displayName = "Say Hello", image = "alpine") { args("echo", "Hello World!") } }Learn more
Is it possible to run kotlinScript, shellScript, and entrypoint in the same container?
No, it's not possible. The kotlinScript, shellScript, and args | entrypoint items are mutually exclusive. If you specify more than one inside a container, the job will fail.
| Correct | Wrong |
|---|---|
job("Example") {
container(image = "openjdk") {
kotlinScript { api ->
// Do smth.
}
}
container(image = "alpine") {
shellScript {
content = """
echo Do smth.
"""
}
}
}
|
job("Example") {
container(image = "openjdk") {
kotlinScript { api ->
// Do smth.
}
shellScript {
content = """
echo Do smth.
"""
}
}
}
|
Container resources
A job can contain not more than 50 containers (steps). Each container has the following resources constraints:
| Default | Max | Min | |
|---|---|---|---|
| CPU | 2 virtual CPUs | 4 virtual CPUs | 0.2 virtual CPU |
| Memory | 7800 MiB (approx. 8 GB) | 16 GiB | – |
Note that all containers within a job use the same disk volume (it contains the project repository). The default volume size is 5 GB and the maximum allowed size is 30 GB. To specify resources and volume size, you should use resources and volumeSize correspondingly. Note that all items support units:
cpu: You can set a value in.cpuor.mcpu(millicpu), for example,cpu = 250.mcpuis the same ascpu = 0.25.cpu.memoryandvolumeSize: You can set their values in.mb(MB) and.gb(GB), for example,volumeSize = 10.gb.