Skip to content

Commit 9ac3d02

Browse files
committed
Updating README.md
1 parent 85d9a94 commit 9ac3d02

1 file changed

Lines changed: 40 additions & 10 deletions

File tree

README.md

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ steps:
1515
- command: "go build -o dist/my-app ."
1616
artifact_paths: "./dist/my-app"
1717
plugins:
18-
- docker#v5.12.0:
18+
- docker#v5.13.0:
1919
image: "golang:1.11"
2020
```
2121
@@ -25,7 +25,7 @@ Windows images are also supported:
2525
steps:
2626
- command: "dotnet publish -c Release -o published"
2727
plugins:
28-
- docker#v5.12.0:
28+
- docker#v5.13.0:
2929
image: "microsoft/dotnet:latest"
3030
always-pull: true
3131
```
@@ -37,7 +37,7 @@ If you want to control how your command is passed to the docker container, you c
3737
```yml
3838
steps:
3939
- plugins:
40-
- docker#v5.12.0:
40+
- docker#v5.13.0:
4141
image: "mesosphere/aws-cli"
4242
always-pull: true
4343
command: ["s3", "sync", "s3://my-bucket/dist/", "/app/dist"]
@@ -52,7 +52,7 @@ Note: If you are utilizing Buildkite's [Elastic CI Stack S3 Secrets plugin](http
5252
steps:
5353
- command: "yarn install; yarn run test"
5454
plugins:
55-
- docker#v5.12.0:
55+
- docker#v5.13.0:
5656
image: "node:7"
5757
always-pull: true
5858
environment:
@@ -70,7 +70,7 @@ steps:
7070
env:
7171
MY_SPECIAL_BUT_PUBLIC_VALUE: kittens
7272
plugins:
73-
- docker#v5.12.0:
73+
- docker#v5.13.0:
7474
image: "node:7"
7575
always-pull: true
7676
propagate-environment: true
@@ -84,7 +84,7 @@ steps:
8484
env:
8585
MY_SPECIAL_BUT_PUBLIC_VALUE: kittens
8686
plugins:
87-
- docker#v5.12.0:
87+
- docker#v5.13.0:
8888
image: "node:7"
8989
always-pull: true
9090
propagate-aws-auth-tokens: true
@@ -96,7 +96,7 @@ You can pass in additional volumes to be mounted. This is useful for running Doc
9696
steps:
9797
- command: "docker build . -t image:tag; docker push image:tag"
9898
plugins:
99-
- docker#v5.12.0:
99+
- docker#v5.13.0:
100100
image: "docker:latest"
101101
always-pull: true
102102
volumes:
@@ -109,12 +109,28 @@ You can disable the default behaviour of mounting in the checkout to `workdir`:
109109
steps:
110110
- command: "npm start"
111111
plugins:
112-
- docker#v5.12.0:
112+
- docker#v5.13.0:
113113
image: "node:7"
114114
always-pull: true
115115
mount-checkout: false
116116
```
117117

118+
You can enable custom logging drivers and logging options with the use of `log-driver` and `log-opt`:
119+
120+
```yml
121+
steps:
122+
- command: "npm run start"
123+
plugins:
124+
- docker#v5.13.0:
125+
image: "node:7"
126+
log-driver: "awslogs"
127+
log-opt:
128+
- "awslogs-group=my-buildkite-logs"
129+
- "awslogs-region=us-east-1"
130+
- "awslogs-stream-prefix=buildkite"
131+
- "awslogs-create-group=true"
132+
```
133+
118134
Variable interpolation can be tricky due to the 3 layers involved (Buildkite, agent VM, and docker). For example, if you want to use [ECR Buildkite plugin](https://github.com/buildkite-plugins/ecr-buildkite-plugin), you will need to use the following syntax. Note the `$$` prefix for variables that would otherwise resolve at pipeline upload time, not runtime:
119135

120136
```yml
@@ -128,7 +144,7 @@ steps:
128144
- "p"
129145
region: us-west-2
130146
no-include-email: true
131-
- docker#v5.12.0:
147+
- docker#v5.13.0:
132148
image: "d.dkr.ecr.us-west-2.amazonaws.com/imagename"
133149
command: ["./run-integration-tests.sh"]
134150
expand-volume-vars: true
@@ -156,7 +172,7 @@ steps:
156172
plugins:
157173
- artifacts#v1.9.0:
158174
download: "node-7-image.tar.gz"
159-
- docker#v5.12.0:
175+
- docker#v5.13.0:
160176
load: "node-7-image.tar.gz"
161177
image: "node:7"
162178
```
@@ -307,6 +323,20 @@ Whether or not to leave the container after the run, or immediately remove it wi
307323

308324
Default: `false`
309325

326+
### `log-driver` (optional, string)
327+
328+
The logging driver for the container. This allows you to configure how Docker handles logs for the container.
329+
330+
Common drivers include: `json-file`, `syslog`, `journald`, `gelf`, `fluentd`, `awslogs`, `splunk`, `etwlogs`, `gcplogs`, `logentries`, `none`.
331+
332+
Default: `json-file`
333+
334+
See [Docker's logging documentation](https://docs.docker.com/config/containers/logging/) for complete details.
335+
336+
### `log-opt` (optional, array)
337+
338+
Options for the logging driver. These are key-value pairs that configure the behavior of the selected logging driver.
339+
310340
### `load` (optional, string)
311341

312342
Specify a file to load a docker image from. If omitted no load will be done.

0 commit comments

Comments
 (0)