Skip to content

Commit 5f5a5e1

Browse files
authored
Merge pull request #6290 from thaJeztah/deprecate_quoted_values
Deprecate special handling for quoted values for TLS flags
2 parents 5f6dfb0 + ee05a71 commit 5f5a5e1

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/deprecated.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ The following table provides an overview of the current status of deprecated fea
5353

5454
| Status | Feature | Deprecated | Remove |
5555
|------------|------------------------------------------------------------------------------------------------------------------------------------|------------|--------|
56+
| Deprecated | [Special handling for quoted values for TLS flags](#special-handling-for-quoted-values-for-tls-flags) | v28.4 | v29.0 |
5657
| Deprecated | [Empty/nil fields in image Config from inspect API](#emptynil-fields-in-image-config-from-inspect-api) | v28.3 | v29.0 |
5758
| Deprecated | [Configuration for pushing non-distributable artifacts](#configuration-for-pushing-non-distributable-artifacts) | v28.0 | v29.0 |
5859
| Deprecated | [`--time` option on `docker stop` and `docker restart`](#--time-option-on-docker-stop-and-docker-restart) | v28.0 | - |
@@ -122,6 +123,39 @@ The following table provides an overview of the current status of deprecated fea
122123
| Removed | [`--run` flag on `docker commit`](#--run-flag-on-docker-commit) | v0.10 | v1.13 |
123124
| Removed | [Three arguments form in `docker import`](#three-arguments-form-in-docker-import) | v0.6.7 | v1.12 |
124125

126+
127+
### Special handling for quoted values for TLS flags
128+
129+
**Deprecated in Release: v28.4**
130+
**Target For Removal In Release: v29.0**
131+
132+
The `--tlscacert`, `--tlscert`, and `--tlskey` command-line flags had
133+
non-standard behavior for handling values contained in quotes (`"` or `'`).
134+
Normally, quotes are handled by the shell, for example, in the following
135+
example, the shell takes care of handling quotes before passing the values
136+
to the `docker` CLI:
137+
138+
```console
139+
docker --some-option "some-value-in-quotes" ...
140+
```
141+
142+
However, when passing values using an equal sign (`=`), this may not happen
143+
and values may be handled including quotes;
144+
145+
```console
146+
docker --some-option="some-value-in-quotes" ...
147+
```
148+
149+
This caused issues with "Docker Machine", which used this format as part
150+
of its `docker-machine config` output, and the CLI carried special, non-standard
151+
handling for these flags.
152+
153+
Docker Machine reached EOL, and this special handling made the processing
154+
of flag values inconsistent with other flags used, so this behavior is
155+
deprecated. Users depending on this behavior are recommended to specify
156+
the quoted values using a space between the flag and its value, as illustrated
157+
above.
158+
125159
### Empty/nil fields in image Config from inspect API
126160

127161
**Deprecated in Release: v28.3**

0 commit comments

Comments
 (0)