0a8bb6e5b4
chore: regenerate docs
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit dc22572e3e35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:48 +02:00
eea26c50dd
docs: update links to docker cli reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit 3d4c12af7335727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:42 +02:00
1cf2c4efb3
docs: regenerate base command
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit bf33c8f10a35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:39 +02:00
c2b9c1474a
docs: align heading structure for base command
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit b0650f281e35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:35 +02:00
598442d37d
docs: remove frontmatter for base command
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit cfea2353b335727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:32 +02:00
c964b80e53
docs: rename cli.md to docker.md (base command)
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit 03961449aa35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:27 +02:00
0ca7be015e
docs: remove empty docker base command reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit a68382338335727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:22 +02:00
27bf78d335
docs: make buildx build the canonical reference doc
...
Move common flag descriptions to the buildx build reference, and make
that page the canonical page in docs. Also rewrite some content in
image_build to make clear that this page is only for the legacy builder.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit e91f0ded9c35727626+dvdksn@users.noreply.github.com >
2024-07-04 09:19:10 +02:00
c8c13bdcac
docs/deprecated: update status for graphdriver-plugins
...
Add a mention of the feature being disabled by default, and
the DOCKERD_DEPRECATED_GRAPHDRIVER_PLUGINS env-var.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-06-21 15:03:53 +02:00
64c20f3013
Additional typo corrections
...
Signed-off-by: Iain MacDonald <ijmacd@gmail.com >
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com >
2024-06-20 12:18:43 +02:00
a84536eb4a
Fix RFC3339 typo in docs
...
Signed-off-by: Iain MacDonald <ijmacd@gmail.com >
2024-06-20 12:18:28 +02:00
0bc092496f
deprecate experimental graphdriver plugins
...
[Graphdriver plugins] are an experimental feature that allow extending the
Docker Engine with custom storage drivers for storing images and containers.
This feature was not maintained since its inception, and will no longer be
supported in upcoming releases.
Users of this feature are recommended to instead configure the Docker Engine
to use the [containerd image store], and a custom [snapshotter].
[Graphdriver plugins]: https://github.com/docker/cli/blob/v26.1.4/docs/extend/plugins_graphdriver.md
[containerd image store]: https://github.com/docker/docs/blob/31a16f1da2f4a4c94b5a82713aa012f052fb7e6d/content/storage/containerd.md
[snapshotter]: https://github.com/containerd/containerd/tree/v1.7.18/docs/snapshotters
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-06-18 16:47:00 +02:00
1f1b70dfdf
docs: add deprecation warning to experimental grapdriver plugins
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-06-18 16:18:07 +02:00
540b28e7bb
Merge pull request #5150 from thaJeztah/extend_non_tls_api_deprecation
...
docs: extend deprecation target for non-TLS API
2024-06-12 13:58:10 +02:00
1671ee8b49
Merge pull request #5142 from thaJeztah/deprecate_image_config_fields
...
Deprecate non-standard (config) fields in image inspect output
2024-06-12 13:53:39 +02:00
e9c0fc330c
docs: extend deprecation target for non-TLS API
...
No work has started yet on the deprecation, so extending the time-
window.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-06-12 13:40:43 +02:00
ed2d365653
Merge pull request #5141 from thaJeztah/carry_5040
...
Removed all mentions of "please" from docs and messages
2024-06-11 22:01:50 +02:00
b79d684653
Deprecate non-standard (config) fields in image inspect output
...
The `Config` field returned by this endpoint (used for "image inspect") returns
additional fields that are not part of the image's configuration and not part of
the [Docker Image Spec] and the [OCI Image Spec].
These additional fields are included in the response, due to an
implementation detail, where the [api/types.ImageInspec] type used
for the response is using the [container.Config] type.
The [container.Config] type is a superset of the image config, and while the
image's Config is used as a _template_ for containers created from the image,
the additional fields are set at runtime (from options passed when creating
the container) and not taken from the image Config.
These fields are never set (and always return the default value for the type),
but are not omitted in the response when left empty. As these fields were not
intended to be part of the image configuration response, they are deprecated,
and will be removed from the API.
The following fields are currently included in the API response, but
are not part of the underlying image's Config, and deprecated:
- `Hostname`
- `Domainname`
- `AttachStdin`
- `AttachStdout`
- `AttachStderr`
- `Tty`
- `OpenStdin`
- `StdinOnce`
- `Image`
- `NetworkDisabled` (already omitted unless set)
- `MacAddress` (already omitted unless set)
- `StopTimeout` (already omitted unless set)
[Docker image spec]: https://github.com/moby/docker-image-spec/blob/v1.3.1/specs-go/v1/image.go#L19-L32
[OCI Image Spec]: https://github.com/opencontainers/image-spec/blob/v1.1.0/specs-go/v1/config.go#L24-L62
[api/types.ImageInspec]: https://github.com/moby/moby/blob/v26.1.4/api/types/types.go#L87-L104
[container.Config]: https://github.com/moby/moby/blob/v26.1.4/api/types/container/config.go#L47-L82
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-06-11 17:08:20 +02:00
e06ef800fc
Removed all mentions of "please" from docs and messages
...
Signed-off-by: Grace Choi <gracechoi@utexas.edu >
Signed-off-by: Pranjal Rai <pranjalrai@utexas.edu >
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-06-11 16:53:40 +02:00
966fa7c475
cli/push: Add platform switch
...
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com >
2024-06-11 16:39:48 +02:00
db2672e685
network create: make --ipv6 optional
...
The API field `EnableIPv6` was marked as optional in our Swagger docs,
and its default value in the Go client came from that field being a
bool, thus defaulting to its zero value. That's not the case anymore.
This field is now a `*bool` as to let daemon's config define the default
value. IPv6 can still be enabled / disabled by explicitly specifying the
`--ipv6` flag when doing `docker network create`.
Signed-off-by: Albin Kerouanton <albinker@gmail.com >
2024-06-07 03:17:46 +02:00
9acfbbd74f
Correct typos in docs/ and man/
...
Signed-off-by: Casey Korver <casey@korver.dev >
2024-06-06 02:15:23 +00:00
8ed44f916f
Merge pull request #4994 from robmry/47639_per-interface-sysctls
...
Document CLI support for per interface sysctls
2024-05-29 11:03:28 +02:00
4d28ae98f4
Merge pull request #5085 from akerouanton/deprecate-api-cors-header
...
docs: deprecate daemon's api-cors-header flag
2024-05-28 23:45:54 +02:00
9d9bb19f01
docs: deprecate daemon's api-cors-header flag
...
Signed-off-by: Albin Kerouanton <albinker@gmail.com >
2024-05-28 12:10:00 +02:00
d5d94e46fc
Explain how to use "network connect --driver-opt" to set sysctls
...
Signed-off-by: Rob Murray <rob.murray@docker.com >
2024-05-26 13:19:51 +01:00
b7583a2c28
Explain how to use "--network driver-opt" to set sysctls
...
Signed-off-by: Rob Murray <rob.murray@docker.com >
2024-05-26 13:17:22 +01:00
82ed39e319
docs: use --quiet in example to simplify output
...
The output showed the Alpine version that was used for the example,
which can get outdated and distracts from the example steps.
Use --quiet to reduce the output, and to reduce maintenance (i.e.,
no need to keep the output updated with current versions).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-05-26 11:43:08 +02:00
6d21372dbb
run, create: update "--rm" flag description to mention anonymous volumes
...
The "--rm" flag deletes both the container and any anonymous volumes
associated with the container when the container exits.
This patch updates the flag description to also mention volumes.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-05-21 13:52:56 +02:00
c5dd1d0951
Merge pull request #5079 from cncal/patch-1
...
docs: fix json syntax error
2024-05-17 15:22:49 +02:00
cbe9469364
Merge pull request #5021 from neersighted/cdi_typos
...
docs: tidy up CDI docs
2024-05-17 15:06:44 +02:00
6a4d38c7f2
docs: fix json syntax error
...
Signed-off-by: cncal <flycalvin@qq.com >
2024-05-17 17:47:44 +08:00
0ad1d55b02
Merge pull request #4997 from dvdksn/doc-vxlan-listen-addr
...
docs: clarify that --data-path-addr doesn't restrict access
2024-05-13 18:54:43 +02:00
4758ed0b0d
Document the extended '--network' syntax
...
Support for connecting more than one network using the container run
command was added in v25.0 for API > 1.44 - describe that in the docs.
Signed-off-by: Rob Murray <rob.murray@docker.com >
2024-05-08 14:13:59 +01:00
86162f7816
feat: use main func ctx for cobra and use ctx in tests
...
Explicitly create the context and set it on the CLI, instead of depending on
NewDockerCli() to instance a default context.
Co-authored-by: Sebastiaan van Stijn <github@gone.nl >
Co-authored-by: Alano Terblanche <18033717+Benehiko@users.noreply.github.com >
Signed-off-by: Alano Terblanche <18033717+Benehiko@users.noreply.github.com >
2024-04-25 12:00:31 +02:00
1cc2e445af
Merge pull request #4967 from robmry/windows-no-dns-proxy
...
Feature option 'windows-dns-proxy'
2024-04-19 13:42:15 +02:00
762a85a103
Warn about deprecation of windows-dns-proxy flag
...
Signed-off-by: Albin Kerouanton <albinker@gmail.com >
2024-04-19 13:32:32 +02:00
287f482e31
Feature option 'windows-dns-proxy'
...
Document feature option 'windows-dns-proxy', which can be used to
enable or disable forwarding of DNS requests from the daemon's
internal resolver to external servers.
Signed-off-by: Rob Murray <rob.murray@docker.com >
2024-04-16 11:27:23 +01:00
116db4fc82
docs: tidy up CDI docs
...
Signed-off-by: Bjorn Neergaard <bjorn.neergaard@docker.com >
2024-04-15 15:05:53 -07:00
4585809848
docs: add systempaths=unconfined security-opt
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-04-10 15:16:30 +02:00
faf096b25c
docs: clarify that --data-path-addr doesn't restrict access
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-04-09 13:08:21 +02:00
2ae903e86c
Merge pull request #4929 from dvdksn/privileged-flag
...
build / prepare (push) Has been cancelled
build / build (push) Has been cancelled
build / bin-image (push) Has been cancelled
build / prepare-plugins (push) Has been cancelled
build / plugins (push) Has been cancelled
codeql / codeql (push) Has been cancelled
e2e / e2e (alpine, 23, connhelper-ssh) (push) Has been cancelled
e2e / e2e (alpine, 23, experimental) (push) Has been cancelled
e2e / e2e (alpine, 23, non-experimental) (push) Has been cancelled
e2e / e2e (alpine, 24, connhelper-ssh) (push) Has been cancelled
e2e / e2e (alpine, 24, experimental) (push) Has been cancelled
e2e / e2e (alpine, 24, non-experimental) (push) Has been cancelled
e2e / e2e (alpine, 25, connhelper-ssh) (push) Has been cancelled
e2e / e2e (alpine, 25, experimental) (push) Has been cancelled
e2e / e2e (alpine, 25, non-experimental) (push) Has been cancelled
e2e / e2e (debian, 23, connhelper-ssh) (push) Has been cancelled
e2e / e2e (debian, 23, experimental) (push) Has been cancelled
e2e / e2e (debian, 23, non-experimental) (push) Has been cancelled
e2e / e2e (debian, 24, connhelper-ssh) (push) Has been cancelled
e2e / e2e (debian, 24, experimental) (push) Has been cancelled
e2e / e2e (debian, 24, non-experimental) (push) Has been cancelled
e2e / e2e (debian, 25, connhelper-ssh) (push) Has been cancelled
e2e / e2e (debian, 25, experimental) (push) Has been cancelled
e2e / e2e (debian, 25, non-experimental) (push) Has been cancelled
test / ctn (push) Has been cancelled
test / host (macos-12) (push) Has been cancelled
validate / validate (lint) (push) Has been cancelled
validate / validate (shellcheck) (push) Has been cancelled
validate / validate (update-authors) (push) Has been cancelled
validate / validate (validate-vendor) (push) Has been cancelled
validate / validate-md (push) Has been cancelled
validate / validate-make (manpages) (push) Has been cancelled
validate / validate-make (yamldocs) (push) Has been cancelled
docs: clarify what the --privileged flag does
2024-03-20 09:10:03 -06:00
ed9dd75575
Merge pull request #4949 from akerouanton/remove-short-cid-alias
...
docs/deprecated: update status of short cid alias deprecation
2024-03-20 16:05:01 +01:00
4eef4afbf4
Merge pull request #4893 from vvoland/deprecate-container
...
docs/deprecated: Deprecate Container fields in image inspect
2024-03-18 12:14:10 +01:00
f96d8e78c4
docs/deprecated: update status of short cid alias deprecation
...
Starting with API v1.45, the container short ID is removed from the
container Aliases.
Signed-off-by: Albin Kerouanton <albinker@gmail.com >
2024-03-18 10:39:14 +01:00
4e9abfecf5
Merge pull request #4916 from dvdksn/docs-typos-corrections
...
docs: typo fixes and other corrections
2024-03-14 13:20:39 +01:00
dc4163fb1a
docs/deprecated: Deprecate Container fields in image inspect
...
See moby#46939
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com >
2024-03-14 12:42:31 +01:00
8adf1ddb86
Merge pull request #4928 from dvdksn/deprecate-nontls-tcp
...
docs: deprecate TCP connection without TLS
2024-03-14 12:29:42 +01:00
3da26a5e79
docs: add description and link for --userns flag
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-03-14 10:10:49 +01:00
4bb2abaa54
docs: typo fixes and other corrections
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-03-14 10:10:49 +01:00
David Karlsson
Sebastiaan van Stijn
Iain MacDonald
Sebastiaan van Stijn
Grace Choi
Paweł Gronowski
Albin Kerouanton
Casey Korver
Albin Kerouanton
Rob Murray
cncal
Bjorn Neergaard