starred/cli
1
0
Fork 0
mirror of https://github.com/docker/cli.git synced 2026-08-24 10:05:37 -05:00
Code Issues Packages Projects Releases Wiki Activity
12,715 Commits 17 Branches 320 Tags
5201f5894e8aefbb09a67ba34895e59841e41b82
Commit Graph
35 Commits
Author SHA1 Message Date
Matteo Panzeri 6d38b7a71a docs: clarify 64 KiB response-body buffer in authz plugin docs 
Adds a "Response body size and partial buffering" subsection to
docs/extend/plugins_authorization.md documenting the 64 KiB
maxBufferSize constant in the daemon's internal responseModifier
(pkg/authorization/response.go in moby/moby) and the practical
implications for plugins that use ResponseBody inspection.

The existing docs (lines 81-87) say streaming endpoints such as
logs and events send only the HTTP request to plugins, but don't
explain the underlying mechanism. Plugin authors building
response-body redaction or content-filtering can be surprised when
the same effect happens on non-listed endpoints whose response is
produced through multiple writes exceeding the buffer or via an
io.WriteFlusher.

The 64 KiB buffer is observable from the public moby source, so
this PR is documentation catching up to existing behavior — not
a contract change.

Signed-off-by: Matteo Panzeri <matteo1782@gmail.com>
 2026-05-09 23:00:51 +02:00
David Karlsson 071f6f9391 docs: rename plugins index file and add linkTitle 
We publish this page on docs.docker.com, and hugo expects index pages
for sections to be named _index.md. We currently rename the page when we
mount it to the docs repo but might as well change the filename in the
source.

Also adds a linkTitle to the page, which is a shorter title that will be
used in the sidebar navigation and breadcrumbs.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-09-04 13:48:37 +02:00
David Karlsson f1befabe9f docs: use gh alert syntax for callouts 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-08-16 11:02:10 +02:00
David Karlsson caf72655fb docs: update url scheme for reference docs 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-02-20 21:38:50 +01:00
David Karlsson 3df149545e docs(plugins): fix typos and formatting 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
 2024-01-16 20:37:29 +01:00
Sebastiaan van Stijn 07338fe965 docs: update redirect metadata for hugo 
docs.docker.com switched from Jekyll to Hugo, which uses "aliases"
instead of "redirect_from".

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2023-11-06 18:25:49 +01:00
Sebastiaan van Stijn 2621af848a docs: fix some broken anchors 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-09-13 16:20:09 +02:00
Sebastiaan van Stijn 47ba76afb1 docs: use "console" code-hint for shell examples 
This replaces the use of bash where suitable, to allow easier copy/pasting
of shell examples without copying the prompt or process output.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2021-08-21 18:29:13 +02:00
Sebastiaan van Stijn e4fc8cfa23 docs/extend: reformat notes 
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 2020-04-19 17:53:06 +02:00
John Mulhausen 4a5db8d27e Removing titles from md files 
Signed-off-by: John Mulhausen <john@docker.com>
 2017-10-13 15:24:06 -07:00
Frieder Bluemle 45c9b9b6c1 Fix GitHub spelling 
Signed-off-by: Frieder Bluemle <frieder.bluemle@gmail.com>
 2017-10-05 01:14:31 +08:00
Kir Kolyshkin 6d85a4f5f8 Fix repo references in docs 
Since CLI was moved to a separate repo, these references are incorrect.
Fixed with the help of sed script, verified manually.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
 2017-07-28 10:32:42 -07:00
Misty Stanley-Jones ede69a38c2 Fix small typo 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-21 11:06:26 -07:00
Misty Stanley-JonesandTibor Vass d5b3df0c2f Fix some redirect loops and problems 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-02 00:10:42 +00:00
Ben FirshmanandTibor Vass 2cfcc8a8fa Rename Remote API to Engine API 
Implementation of https://github.com/docker/docker/issues/28319

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
 2017-06-02 00:10:40 +00:00
Victor VieuxandTibor Vass 410d4ce7ae move plugins out of experimental 
Signed-off-by: Victor Vieux <vieux@docker.com>
 2017-06-02 00:10:37 +00:00
Gaetan de VilleleandTibor Vass 4126b5526c fix frontmatter keywords value type (string, instead of []string) 
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
 2017-06-02 00:10:31 +00:00
lixiaobing10051267andTibor Vass 9b109cd9a7 fill all the rest invalid address because no related directory 
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
 2017-06-02 00:10:30 +00:00
Misty Stanley-JonesandTibor Vass 7f36c3a1a0 Sync docker/docker refs with files mistakenly edited in docker.github.io repo 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-02 00:10:26 +00:00
Misty Stanley-JonesandTibor Vass 2845676cc2 Convert Markdown frontmatter to YAML 
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-02 00:10:24 +00:00
Misty Stanley-JonesandTibor Vass 12a3920153 Add a link to the new build instructions 
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
 2017-06-02 00:10:24 +00:00
John MulhausenandTibor Vass 68d252bc19 Remove old documentation, add README.md with pointer 
Signed-off-by: John Mulhausen <john@docker.com>
 2017-06-02 00:10:22 +00:00
Charles SmithandTibor Vass 9c9cd1a439 some fixes to clean up new plugin system docs 
Signed-off-by: Charles Smith <charles.smith@docker.com>
 2017-06-02 00:10:07 +00:00
yuexiao-wangandTibor Vass ed38ec18bf Replace docker command from 'docker daemon' to 'dockerd' 
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
 2017-06-02 00:10:06 +00:00
Charles SmithandTibor Vass 16de3a25f4 edit plugin system doc, fix menu system 
Signed-off-by: Charles Smith <charles.smith@docker.com>
 2017-06-02 00:10:05 +00:00
Victor VieuxandTibor Vass 4755904cc3 adding some documentation about the new plugin system 
Signed-off-by: Victor Vieux <vieux@docker.com>
 2017-06-02 00:10:05 +00:00
Liron LevinandTibor Vass e428a09ae7 Enable to dynamically reload authorization plugins via daemon.config 
Following #22729, enable to dynamically reload/remove the daemon
authorization plugins (via standard reloading mechanism).
https://docs.docker.com/engine/reference/commandline/daemon/#daemon-
configuration-file

Daemon must store a reference to the authorization middleware to refresh
the plugin on configuration changes.

Signed-off-by: Liron Levin <liron@twistlock.com>
 2017-06-02 00:10:04 +00:00
Everett ToewsandTibor Vass d41421140c Fix AuthzPlugin URL fragment in docs 
These docs have AuthzPlugin with a lower case 'z'. What the plugin
api is actually looking for is AuthZPlugin with an upper case 'Z'.

See https://github.com/docker/docker/blob/46e3a249a1971f8697ca338c9b02e27d36ddab12/pkg/authorization/api.go#L5-L8

Signed-off-by: Everett Toews <everett.toews@rackspace.com>
 2017-06-02 00:10:02 +00:00
Sven DowideitandTibor Vass be6f353670 Removing some url links that can be resolved using src markdown links 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
 2017-06-02 00:07:46 +00:00
Yi EungJunandTibor Vass 0d227954c5 docs: Remove RequestStatusCode 
The requests doesn't include RequestStatusCode field.

Signed-off-by: Yi EungJun <eungjun.yi@navercorp.com>
 2017-06-02 00:07:38 +00:00
Liron LevinandTibor Vass 3e48f4b4ab Remove response modification sections from authorization design doc 
Signed-off-by: Liron Levin <liron@twistlock.com>
 2017-06-02 00:07:37 +00:00
Yi EungJunandTibor Vass cf2670b8ba Fix errata; s/RequestUri/ReqestURI/ 
Signed-off-by: Yi EungJun <eungjun.yi@navercorp.com>
 2017-06-02 00:07:35 +00:00
Yi EungJunandTibor Vass b394f05fee Use 'null' instead of 'nil' for json 
When describe json response, 'null' is better than 'nil' which is not in
json specification.

Signed-off-by: Yi EungJun <eungjun.yi@navercorp.com>
 2017-06-02 00:07:35 +00:00
Liron LevinandTibor Vass 1db38dfe21 Add short description about default authentication method in authorization docs 
Following the discussion in #21556, adding a short description of the
default user authentication mechanism (without requiring authentication
plugins)
Signed-off-by: Liron Levin <liron@twistlock.com>
 2017-06-02 00:07:35 +00:00
Antonio MurdacaandTibor Vass b20a425cd9 docs: extend: plugins: mention the sdk + systemd socket activation 
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
 2017-06-02 00:07:31 +00:00