Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5437 from thaJeztah/remove_deprecated_cors_headers 

docs, man: dockerd: remove --api-cors-header (deprecated)
This commit is contained in:
Laura Brehm 2024-09-16 13:42:01 +01:00 committed by GitHub
parent ccc87eb6ab 1a0e32099a
commit 7b630458bd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/deprecated.md
View File

@ -54,7 +54,7 @@ The following table provides an overview of the current status of deprecated fea
| Status | Feature | Deprecated | Remove | | Status | Feature | Deprecated | Remove |
|------------|------------------------------------------------------------------------------------------------------------------------------------|------------|--------| |------------|------------------------------------------------------------------------------------------------------------------------------------|------------|--------|
| Deprecated | [Non-standard fields in image inspect](#non-standard-fields-in-image-inspect) | v27.0 | v28.0 | | Deprecated | [Non-standard fields in image inspect](#non-standard-fields-in-image-inspect) | v27.0 | v28.0 |
| Deprecated | [API CORS headers](#api-cors-headers) | v27.0 | v28.0 | | Removed | [API CORS headers](#api-cors-headers) | v27.0 | v28.0 |
| Deprecated | [Graphdriver plugins (experimental)](#graphdriver-plugins-experimental) | v27.0 | v28.0 | | Deprecated | [Graphdriver plugins (experimental)](#graphdriver-plugins-experimental) | v27.0 | v28.0 |
| Deprecated | [Unauthenticated TCP connections](#unauthenticated-tcp-connections) | v26.0 | v28.0 | | Deprecated | [Unauthenticated TCP connections](#unauthenticated-tcp-connections) | v26.0 | v28.0 |
| Deprecated | [`Container` and `ContainerConfig` fields in Image inspect](#container-and-containerconfig-fields-in-image-inspect) | v25.0 | v26.0 | | Deprecated | [`Container` and `ContainerConfig` fields in Image inspect](#container-and-containerconfig-fields-in-image-inspect) | v25.0 | v26.0 |
@ -177,18 +177,19 @@ and a custom [snapshotter](https://github.com/containerd/containerd/tree/v1.7.18
### API CORS headers ### API CORS headers
**Deprecated in Release: v27.0** **Deprecated in Release: v27.0**
**Target For Removal In Release: v28.0** **Disabled by default in Release: v27.0**
**Removed in release: v28.0**
The `api-cors-header` configuration option for the Docker daemon is insecure, The `api-cors-header` configuration option for the Docker daemon is insecure,
and is therefore deprecated and scheduled for removal. and is therefore deprecated and scheduled for removal.
Incorrectly setting this option could leave a window of opportunity Incorrectly setting this option could leave a window of opportunity
for unauthenticated cross-origin requests to be accepted by the daemon. for unauthenticated cross-origin requests to be accepted by the daemon.
Starting in Docker Engine v27.0, this flag can still be set, In Docker Engine v27.0, this flag can still be set,
but it has no effect unless the environment variable but it has no effect unless the environment variable
`DOCKERD_DEPRECATED_CORS_HEADER` is also set to a non-empty value. `DOCKERD_DEPRECATED_CORS_HEADER` is also set to a non-empty value.
This flag will be removed altogether in v28.0. This flag has been removed altogether in v28.0.
This is a breaking change for authorization plugins and other programs This is a breaking change for authorization plugins and other programs
that depend on this option for accessing the Docker API from a browser. that depend on this option for accessing the Docker API from a browser.

2
docs/reference/dockerd.md
View File

@ -25,7 +25,6 @@ A self-sufficient runtime for containers.
Options: Options:
--add-runtime runtime Register an additional OCI compatible runtime (default []) --add-runtime runtime Register an additional OCI compatible runtime (default [])
--allow-nondistributable-artifacts list Allow push of nondistributable artifacts to registry --allow-nondistributable-artifacts list Allow push of nondistributable artifacts to registry
--api-cors-header string Set CORS headers in the Engine API
--authorization-plugin list Authorization plugins to load --authorization-plugin list Authorization plugins to load
--bip string Specify network bridge IP --bip string Specify network bridge IP
-b, --bridge string Attach containers to a network bridge -b, --bridge string Attach containers to a network bridge
@ -1074,7 +1073,6 @@ The following is a full example of the allowed configuration options on Linux:
```json ```json
{ {
"allow-nondistributable-artifacts": [], "allow-nondistributable-artifacts": [],
"api-cors-header": "",
"authorization-plugins": [], "authorization-plugins": [],
"bip": "", "bip": "",
"bridge": "", "bridge": "",

5
man/dockerd.8.md
View File

@ -7,7 +7,6 @@ dockerd - Enable daemon mode
**dockerd** **dockerd**
[**--add-runtime**[=*[]*]] [**--add-runtime**[=*[]*]]
[**--allow-nondistributable-artifacts**[=*[]*]] [**--allow-nondistributable-artifacts**[=*[]*]]
[**--api-cors-header**=[=*API-CORS-HEADER*]]
[**--authorization-plugin**[=*[]*]] [**--authorization-plugin**[=*[]*]]
[**-b**|**--bridge**[=*BRIDGE*]] [**-b**|**--bridge**[=*BRIDGE*]]
[**--bip**[=*BIP*]] [**--bip**[=*BIP*]]
@ -138,10 +137,6 @@ $ sudo dockerd --add-runtime runc=runc --add-runtime custom=/usr/local/bin/my-ru
artifacts to private registries and ensure that you are in compliance with artifacts to private registries and ensure that you are in compliance with
any terms that cover redistributing nondistributable artifacts. any terms that cover redistributing nondistributable artifacts.
**--api-cors-header**=""
Set CORS headers in the Engine API. Default is cors disabled. Give urls like
"http://foo, http://bar, ...". Give "\*" to allow all.
**--authorization-plugin**="" **--authorization-plugin**=""
Set authorization plugins to load Set authorization plugins to load