Skip to content

Commit 6adde56

Browse files
authored
Merge pull request #6291 from thaJeztah/28.x_backport_deprecate_quoted_values
[28.x backport] Deprecate special handling for quoted values for TLS flags
2 parents 14f2972 + d1617cb commit 6adde56

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 | - |
@@ -121,6 +122,39 @@ The following table provides an overview of the current status of deprecated fea
121122
| Removed | [`--run` flag on `docker commit`](#--run-flag-on-docker-commit) | v0.10 | v1.13 |
122123
| Removed | [Three arguments form in `docker import`](#three-arguments-form-in-docker-import) | v0.6.7 | v1.12 |
123124

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

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

0 commit comments

Comments
 (0)