Skip to content

Commit ef4448d

Browse files
the commit.
2 parents 8ea375e + 8bfa1bd commit ef4448d

35 files changed

+241
-163
lines changed

apidocs/cloud-api-source/source/includes/node.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{% raw %}
2-
31
# Nodes
42

53
## Node
@@ -376,5 +374,3 @@ Available in Docker Cloud's **REST API**
376374
Parameter | Description
377375
--------- | -----------
378376
uuid | The UUID of the node to terminate
379-
380-
{% endraw %}

apidocs/cloud-api-source/source/includes/stack.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{% raw %}
2-
31
# Stacks
42

53
## Stack
@@ -568,5 +566,3 @@ Available in Docker Cloud's **REST API**
568566
Parameter | Description
569567
--------- | -----------
570568
uuid | The UUID of the stack to terminate
571-
572-
{% endraw %}

engine/admin/formatting.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ menu:
99
title: Format command and log output
1010
---
1111

12-
{% raw %}
13-
1412
# Formatting reference
1513

1614
Docker uses [Go templates](https://golang.org/pkg/text/template/) to allow users manipulate the output format
@@ -35,36 +33,46 @@ This is the complete list of the available functions with examples:
3533
Join concatenates a list of strings to create a single string.
3634
It puts a separator between each element in the list.
3735

36+
{% raw %}
3837
$ docker ps --format '{{join .Names " or "}}'
38+
{% endraw %}
3939

4040
### Json
4141

4242
Json encodes an element as a json string.
4343

44+
{% raw %}
4445
$ docker inspect --format '{{json .Mounts}}' container
46+
{% endraw %}
4547

4648
### Lower
4749

4850
Lower turns a string into its lower case representation.
4951

52+
{% raw %}
5053
$ docker inspect --format "{{lower .Name}}" container
54+
{% endraw %}
5155

5256
### Split
5357

5458
Split slices a string into a list of strings separated by a separator.
5559

60+
{% raw %}
5661
# docker inspect --format '{{split (join .Names "/") "/"}}' container
62+
{% endraw %}
5763

5864
### Title
5965

6066
Title capitalizes a string.
6167

68+
{% raw %}
6269
$ docker inspect --format "{{title .Name}}" container
70+
{% endraw %}
6371

6472
### Upper
6573

6674
Upper turns a string into its upper case representation.
6775

76+
{% raw %}
6877
$ docker inspect --format "{{upper .Name}}" container
69-
70-
{% endraw %}
78+
{% endraw %}

engine/admin/logging/fluentd.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ menu:
1010
title: Fluentd logging driver
1111
---
1212

13-
{% raw %}
14-
1513
# Fluentd logging driver
1614

1715
The `fluentd` logging driver sends container logs to the
@@ -35,8 +33,10 @@ The `docker logs` command is not available for this logging driver.
3533

3634
Some options are supported by specifying `--log-opt` as many times as needed:
3735

36+
{% raw %}
3837
- `fluentd-address`: specify `host:port` to connect `localhost:24224`
3938
- `tag`: specify tag for fluentd message, which interpret some markup, ex `{{.ID}}`, `{{.FullID}}` or `{{.Name}}` `docker.{{.ID}}`
39+
{% endraw %}
4040

4141

4242
Configure the default logging driver by passing the
@@ -115,5 +115,3 @@ aggregate store.
115115
3. Start one or more containers with the `fluentd` logging driver:
116116

117117
$ docker run --log-driver=fluentd your/application
118-
119-
{% endraw %}

engine/admin/logging/log_tags.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ menu:
1111
title: Log tags for logging driver
1212
---
1313

14-
{% raw %}
15-
1614
# Log Tags
1715

1816
The `tag` log option specifies how to format a tag that identifies the
@@ -25,6 +23,7 @@ docker run --log-driver=fluentd --log-opt fluentd-address=myhost.local:24224 --l
2523

2624
Docker supports some special template markup you can use when specifying a tag's value:
2725

26+
{% raw %}
2827
| Markup | Description |
2928
|--------------------|------------------------------------------------------|
3029
| `{{.ID}}` | The first 12 characters of the container id. |
@@ -36,30 +35,33 @@ Docker supports some special template markup you can use when specifying a tag's
3635
| `{{.DaemonName}}` | The name of the docker program (`docker`). |
3736

3837
For example, specifying a `--log-opt tag="{{.ImageName}}/{{.Name}}/{{.ID}}"` value yields `syslog` log lines like:
38+
{% endraw %}
3939

4040
```
4141
Aug 7 18:33:19 HOSTNAME docker/hello-world/foobar/5790672ab6a0[9103]: Hello from Docker.
4242
```
4343

44+
{% raw %}
4445
At startup time, the system sets the `container_name` field and `{{.Name}}` in
4546
the tags. If you use `docker rename` to rename a container, the new name is not
4647
reflected in the log messages. Instead, these messages continue to use the
4748
original container name.
49+
{% endraw %}
4850

4951
For advanced usage, the generated tag's use [go
5052
templates](http://golang.org/pkg/text/template/) and the container's [logging
5153
context](https://github.com/docker/docker/blob/master/daemon/logger/context.go).
5254

5355
As an example of what is possible with the syslog logger:
5456

55-
```
57+
```{% raw %}
5658
$ docker run -it --rm \
5759
--log-driver syslog \
5860
--log-opt tag="{{ (.ExtraAttributes nil).SOME_ENV_VAR }}" \
5961
--log-opt env=SOME_ENV_VAR \
6062
-e SOME_ENV_VAR=logtester.1234 \
6163
flyinprogrammer/logtester
62-
```
64+
{% endraw %}```
6365
6466
Results in logs like this:
6567
@@ -68,5 +70,3 @@ Apr 1 15:22:17 ip-10-27-39-73 docker/logtester.1234[45499]: + exec app
6870
Apr 1 15:22:17 ip-10-27-39-73 docker/logtester.1234[45499]: 2016-04-01 15:22:17.075416751 +0000 UTC stderr msg: 1
6971
```
7072
71-
72-
{% endraw %}

engine/admin/logging/overview.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ menu:
1111
title: Configuring Logging Drivers
1212
---
1313

14-
{% raw %}
15-
1614
# Configure logging drivers
1715

1816
The container can have a different logging driver than the Docker daemon. Use
@@ -245,13 +243,13 @@ logging driver options.
245243

246244
For example, to specify both additional options:
247245

248-
```bash
246+
```bash{% raw %}
249247
$ docker run -dit \
250248
--log-driver=fluentd \
251249
--log-opt fluentd-address=localhost:24224 \
252250
--log-opt tag="docker.{{.Name}}" \
253251
alpine sh
254-
```
252+
{% endraw %}```
255253
256254
If container cannot connect to the Fluentd daemon on the specified address and
257255
`fluentd-async-connect` is not enabled, the container stops immediately.
@@ -307,5 +305,3 @@ The Google Cloud Logging driver supports the following options:
307305

308306
For detailed information about working with this logging driver, see the
309307
[Google Cloud Logging driver](gcplogs.md). reference documentation.
310-
311-
{% endraw %}

engine/admin/logging/splunk.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ menu:
1010
title: Splunk logging driver
1111
---
1212

13-
{% raw %}
14-
1513
# Splunk logging driver
1614

1715
The `splunk` logging driver sends container logs to
@@ -35,6 +33,7 @@ You can set the logging driver for a specific container by using the
3533
You can use the `--log-opt NAME=VALUE` flag to specify these additional Splunk
3634
logging driver options:
3735

36+
{% raw %}
3837
| Option | Required | Description |
3938
|-----------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
4039
| `splunk-token` | required | Splunk HTTP Event Collector token. |
@@ -48,6 +47,7 @@ logging driver options:
4847
| `tag` | optional | Specify tag for message, which interpret some markup. Default value is `{{.ID}}` (12 characters of the container ID). Refer to the [log tag option documentation](log_tags.md) for customizing the log tag format. |
4948
| `labels` | optional | Comma-separated list of keys of labels, which should be included in message, if these labels are specified for container. |
5049
| `env` | optional | Comma-separated list of keys of environment variables, which should be included in message, if these variables are specified for container. |
50+
{% endraw %}
5151

5252
If there is collision between `label` and `env` keys, the value of the `env` takes precedence.
5353
Both options add additional fields to the attributes of a logging message.
@@ -58,6 +58,7 @@ Docker daemon is running. The path to the root certificate and Common Name is
5858
specified using an HTTPS scheme. This is used for verification.
5959
The `SplunkServerDefaultCert` is automatically generated by Splunk certificates.
6060

61+
{% raw %}
6162
docker run --log-driver=splunk \
6263
--log-opt splunk-token=176FCEBF-4CF5-4EDF-91BC-703796522D20 \
6364
--log-opt splunk-url=https://splunkhost:8088 \
@@ -69,5 +70,4 @@ The `SplunkServerDefaultCert` is automatically generated by Splunk certificates.
6970
--env "TEST=false"
7071
--label location=west
7172
your/application
72-
73-
{% endraw %}
73+
{% endraw %}

engine/deprecated.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ menu:
1111
title: Deprecated Engine Features
1212
---
1313

14-
{% raw %}
15-
1614
# Deprecated Engine Features
1715

1816
The following list of features are deprecated in Engine.
@@ -108,7 +106,9 @@ Log tags are now generated in a standard way across different logging drivers.
108106
Because of which, the driver specific log tag options `syslog-tag`, `gelf-tag` and
109107
`fluentd-tag` have been deprecated in favor of the generic `tag` option.
110108

109+
{% raw %}
111110
docker --log-driver=syslog --log-opt tag="{{.ImageName}}/{{.Name}}/{{.ID}}"
111+
{% endraw %}
112112

113113
### LXC built-in exec driver
114114
**Deprecated In Release: [v1.8.0](https://github.com/docker/docker/releases/tag/v1.8.0)**
@@ -189,5 +189,3 @@ Since 1.9, Docker Content Trust Offline key has been renamed to Root key and the
189189

190190
- DOCKER_CONTENT_TRUST_OFFLINE_PASSPHRASE is now named DOCKER_CONTENT_TRUST_ROOT_PASSPHRASE
191191
- DOCKER_CONTENT_TRUST_TAGGING_PASSPHRASE is now named DOCKER_CONTENT_TRUST_REPOSITORY_PASSPHRASE
192-
193-
{% endraw %}

engine/reference/api/docker_remote_api_v1.18.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ menu:
99
title: Remote API v1.18
1010
---
1111

12-
{% raw %}
13-
1412
# Docker Remote API v1.18
1513

1614
## 1. Brief introduction
@@ -525,7 +523,9 @@ Get `stdout` and `stderr` logs from the container ``id``
525523
Connection: Upgrade
526524
Upgrade: tcp
527525

526+
{% raw %}
528527
{{ STREAM }}
528+
{% endraw %}
529529

530530
**Query parameters**:
531531

@@ -600,7 +600,9 @@ Export the contents of container `id`
600600
HTTP/1.1 200 OK
601601
Content-Type: application/octet-stream
602602

603+
{% raw %}
603604
{{ TAR STREAM }}
605+
{% endraw %}
604606

605607
**Status codes**:
606608

@@ -904,7 +906,9 @@ Attach to the container `id`
904906
Connection: Upgrade
905907
Upgrade: tcp
906908

909+
{% raw %}
907910
{{ STREAM }}
911+
{% endraw %}
908912

909913
**Query parameters**:
910914

@@ -984,7 +988,9 @@ Implements websocket protocol handshake according to [RFC 6455](http://tools.iet
984988

985989
**Example response**
986990

991+
{% raw %}
987992
{{ STREAM }}
993+
{% endraw %}
988994

989995
**Query parameters**:
990996

@@ -1077,7 +1083,9 @@ Copy files or folders of container `id`
10771083
HTTP/1.1 200 OK
10781084
Content-Type: application/x-tar
10791085

1086+
{% raw %}
10801087
{{ TAR STREAM }}
1088+
{% endraw %}
10811089

10821090
**Status codes**:
10831091

@@ -1183,7 +1191,9 @@ Build an image from a Dockerfile
11831191

11841192
POST /build HTTP/1.1
11851193

1194+
{% raw %}
11861195
{{ TAR STREAM }}
1196+
{% endraw %}
11871197

11881198
**Example response**:
11891199

@@ -1944,7 +1954,9 @@ interactive session with the `exec` command.
19441954
HTTP/1.1 200 OK
19451955
Content-Type: application/vnd.docker.raw-stream
19461956

1957+
{% raw %}
19471958
{{ STREAM }}
1959+
{% endraw %}
19481960

19491961
**JSON parameters**:
19501962

@@ -2135,5 +2147,3 @@ To set cross origin requests to the remote api please give values to
21352147
default or blank means CORS disabled
21362148

21372149
$ docker -d -H="192.168.1.9:2375" --api-cors-header="http://foo.bar"
2138-
2139-
{% endraw %}

0 commit comments

Comments
 (0)