Commit da2f003c authored by Tomasz Maczukin's avatar Tomasz Maczukin Committed by Achilleas Pipinellis

Update syntax description to new syntax introduced in !12536.

parent 512254ef
...@@ -131,13 +131,13 @@ configuration options for image and services: ...@@ -131,13 +131,13 @@ configuration options for image and services:
```yaml ```yaml
image: image:
name: ruby:2.2 name: ruby:2.2
entrypoint: /bin/bash entrypoint: ["/bin/bash"]
services: services:
- name: my-postgres:9.4 - name: my-postgres:9.4
alias: db-postgres alias: db-postgres
entrypoint: /usr/local/bin/db-postgres entrypoint: ["/usr/local/bin/db-postgres"]
command: start command: ["start"]
before_script: before_script:
- bundle install - bundle install
...@@ -182,15 +182,15 @@ services: ...@@ -182,15 +182,15 @@ services:
| Setting | Required | Description | | Setting | Required | Description |
|------------|----------|-------------| |------------|----------|-------------|
| name | yes | Full name of the image that should be used. It should contain the registry part if needed. | | name | yes | Full name of the image that should be used. It should contain the registry part if needed. |
| entrypoint | no | Command or script that should be executed as container's entrypoint. It will be translated to Docker's `--entrypoint` option while creating container. | | entrypoint | no | Command or script that should be executed as container's entrypoint. It will be translated to Docker's `--entrypoint` option while creating container. The syntax is similar to `Dockerfile`'s `ENTRYPOINT` directive, where each shell token is a separate string in the array. |
### Available settings for `services` entry ### Available settings for `services` entry
| Setting | Required | Description | | Setting | Required | Description |
|------------|----------|-------------| |------------|----------|-------------|
| name | yes | Full name of the image that should be used. It should contain the registry part if needed. | | name | yes | Full name of the image that should be used. It should contain the registry part if needed. |
| entrypoint | no | Command or script that should be used as container's entrypoint. It will be translated to Docker's `--entrypoint` option while creating container. | | entrypoint | no | Command or script that should be used as container's entrypoint. It will be translated to Docker's `--entrypoint` option while creating container. The syntax is similar to `Dockerfile`'s `ENTRYPOINT` directive, where each shell token is a separate string in the array. |
| command | no | Command or script and eventual arguments that should be used as container's command. It will be translated to arguments passed to Docker after image's name. | | command | no | Command or script and eventual arguments that should be used as container's command. It will be translated to arguments passed to Docker after image's name. The syntax is similar to `Dockerfile`'s `CMD` directive, where each shell token is a separate string in the array. |
| alias | no | Additional alias, that can be used to access service from job's container. Read [Accessing the services](#accessing-the-services) for more information. | | alias | no | Additional alias, that can be used to access service from job's container. Read [Accessing the services](#accessing-the-services) for more information. |
### Example usages ### Example usages
...@@ -250,7 +250,7 @@ services: ...@@ -250,7 +250,7 @@ services:
- my-super-sql:latest - my-super-sql:latest
``` ```
With docker extended docker configuration we can now do this simple, setting With extended docker configuration we can now do this simple, setting
only proper configuration in `.gitlab-ci.yml`, e.g: only proper configuration in `.gitlab-ci.yml`, e.g:
```yaml ```yaml
...@@ -258,13 +258,15 @@ only proper configuration in `.gitlab-ci.yml`, e.g: ...@@ -258,13 +258,15 @@ only proper configuration in `.gitlab-ci.yml`, e.g:
services: services:
- name: super/sql:latest - name: super/sql:latest
command: /usr/bin/super-sql run command: ["/usr/bin/super-sql", "run"]
``` ```
As you can see the syntax of `command` entry is similar to Dockerfile's `CMD`.
#### Overriding entrypoint of job's image #### Overriding entrypoint of job's image
Let's assume we have a `super/sql:experimental` image with some SQL database Let's assume we have a `super/sql:experimental` image with some SQL database
inside. We would like to use it as base for our job, because we wan't to inside. We would like to use it as base for our job, because we want to
execute some tests with this database binary. The problem is that this image execute some tests with this database binary. The problem is that this image
is configured with `/usr/bin/super-sql run` as entrypoint. That means, that is configured with `/usr/bin/super-sql run` as entrypoint. That means, that
when starting container without additional options it will run database's when starting container without additional options it will run database's
...@@ -295,7 +297,10 @@ only proper configuration in `.gitlab-ci.yml`, e.g: ...@@ -295,7 +297,10 @@ only proper configuration in `.gitlab-ci.yml`, e.g:
image: image:
name: super/sql:experimental name: super/sql:experimental
entrypoint: /bin/sh entrypoint: ["/bin/sh"]
```
As you can see the syntax of `entrypoint` entry is similar to Dockerfile's `ENTRYPOINT`.
## Define image and services in `config.toml` ## Define image and services in `config.toml`
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment