Commit Graph

209 Commits

Author SHA1 Message Date
Allie Sadler
855cda4011 Spec split (#16740)
* split spec

* spec split

* trial branch

* fix

* branch update

* landing page

* add description

* add description

* update file path

* tweak

* fix build

* split spec

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* spec split

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* trial branch

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* branch update

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* landing page

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* update file path

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* tweak

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix build

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* missing new line

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* first batch of fix links

* second batch of link fix

* update toc

---------

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2023-03-22 12:00:04 +00:00
Allie Sadler
8e16fb9373 keywords (#16691) 2023-02-08 14:42:21 +00:00
David Karlsson
5424418548 Merge pull request #16488 from dvdksn/storage/block-device-mounts
storage/block device mounts
2023-01-25 16:36:48 +01:00
David Karlsson
ad077fb8e9 storage: added block storage mount example
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2023-01-25 16:31:34 +01:00
Allie Sadler
f956ab6552 Improve alt text on images (#16484) 2023-01-10 16:28:46 +00:00
David Karlsson
0de7f57f79 chore: format document 2023-01-10 16:29:56 +01:00
David Karlsson
5135d40383 engine: restructure and consolidate
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2022-12-01 15:44:37 +01:00
Usha Mandya
620a834839 Merge pull request #15527 from carehart/patch-5
Clarify bind-mount obscuring of non-empty directories in container
2022-11-10 14:57:01 +00:00
Sebastiaan van Stijn
c4432a8df3 Merge pull request #15929 from usha-mandya/volumes-patch
Update Volumes, fix navigation
2022-10-27 18:43:06 -04:00
Daniel Schroeder
88fb637b8a Update tmpfs mounts example (#15817)
* Update "Mounts" example

In the original example, the "Mounts" field returned by `docker container inspect [CONTAINER]` was not shown. This may be too much data, but we should at least show the "Mounts" field so folks know what to look for.

* shortened the docker inspect example

Co-authored-by: David Karlsson <david.karlsson@docker.com>
2022-10-27 18:06:55 +02:00
Usha Mandya
d3314f86b1 Update Volumes, fix navigation
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2022-10-26 10:57:31 +01:00
CrazyMax
271f8c3de5 build: merge build enhancements page in build section
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-10-25 19:46:23 +02:00
kazumaru kurai
32f8a25904 fix: using bind-mounts with compose (#15851) 2022-10-18 11:46:11 +02:00
Mohan_J
bda82b6384 Fix typo in bind-mounts.md 2022-10-10 21:06:38 +05:30
Sebastiaan van Stijn
7b65eabc8e storage: remove mention of "named volumes" for mount propagation
Mount propagation is not supported for named volumes, as mentioned in
the paragraph before this one, so let's remove it here.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-09-23 11:37:30 +02:00
CrazyMax
d775c8a6bf build: multi-stage builds
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-15 13:37:37 +02:00
Charlie Arehart
bcddda7f13 Clarify bind-mount obscuring of non-empty directories in container
The current wording implies that ANY bind mount into a non-empty directory will obscure the files in that directory, but while that's true of bind mounting a directory, it's not true if bind-mounting a single file (from my testing, in a linux container running Docker Desktop for Windows).

I simply added that minor (but important) clarification of "a directory".
2022-08-30 22:50:06 -05:00
Efim
a1dfa5aa19 fix typo 2022-08-29 18:23:23 +03:00
Mehdi Mostafavi
eeb8a5397f Update storagedriver/index.md for spaces (#15335)
* Fix some spaces in storage index.md
2022-08-08 10:52:25 +02:00
Usha Mandya
a373a7bca6 Merge pull request #15191 from KhooHaoYit/patch-1
fix typo in overlayfs-driver
2022-08-05 13:57:23 +01:00
Justin Chadwell
fd9fe19061 lint: tidy up ordered list prefixes 2022-07-28 11:27:10 +01:00
Khoo Hao Yit
60ab407e12 fix typo in overlayfs-driver 2022-07-22 23:27:49 +08:00
Allie Sadler
e29b9691ae global troubleshoot section for DD (#15173)
* global troubleshoot section for DD

* tidy up

* fix links

* fix links

* tidy up

* tidy up
2022-07-20 14:48:46 +01:00
Atiab Bin Zakaria
d7b8ada736 Replace backtick with apostrophe in /storage/volumes.md (#14930) 2022-06-13 16:19:11 +01:00
Sebastiaan van Stijn
4570727495 engine: remove some mentions of old Ubuntu and Engine versions
These were notes about distro versions that have been EOL for a long
time, and an old version of docker engine that's EOL as well.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-05-26 00:28:30 +02:00
Mark H
51a49dc4bf Fix alerts on bind mounts page 2022-04-25 11:08:55 +01:00
Nikhil Sharma
ab445f493e Update bind-mounts.md (#14355)
* Update bind-mounts.md

* Apply suggestions from code review

* Update storage/bind-mounts.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2022-04-22 11:54:28 +01:00
prk0ghy
dee8939fee Add information on compose usage. (#14244)
* Add information on compose usage.

Add information on how to declare a bind mount in docke compose.

* Apply suggestions from code review

* Update storage/bind-mounts.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2022-02-25 11:14:54 +00:00
softwarepronto
f5676f4557 Update index.md (#14215)
There was no transition or clear delineation between persisted storage to in-memory storage.
2022-02-04 14:07:56 +00:00
Alejandro Sandoval Parra
36428d09e7 Reorder words in about section
Changes "... drivers that a use copy-on-write filesystem."  to "... drivers that use a copy-on-write filesystem."
2022-01-21 08:54:30 +01:00
lmshipp
1324c4f8b7 Updates Step 9 docker inspect commands
There is an error in the example commands of Step 9 in the copy on write strategy section of the [About storage drivers](https://docs.docker.com/storage/storagedriver/#the-copy-on-write-cow-strategy) page. The first command should reference the `acme/my-base-image:1.0` image and the second command should reference the `acme/my-final-image:1.0`.
2022-01-06 11:15:48 -08:00
freemankevin
eaab1382be Supplement the'$' identifier 2021-12-23 10:56:33 +08:00
Adisa Malik
309ebe05e8 Update inaccurate section headers for backing up/restoring volumes (#13860)
* Change section headers for backing up/restoring volumes to use "volume" instead of "container"

The section headers "Backup a container" and "Restore container from backup" are used as headers for sections that are actually about backing up and restoring volumes.

* Minor style update

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-11-19 14:37:46 +00:00
wood-push-melon
6c2a64086e Correct the typo 2021-10-10 20:15:54 +08:00
Nicolaj Græsholt
8b618a6795 Add anonymous volumes autoremove info (#13471)
* Add anonymous volumes autoremove info

Anonymous volumes aren't removed if another container adopts them with `--volumes-from`, see: https://github.com/docker/docker.github.io/issues/13435

* Format Note

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-10-08 12:07:29 +01:00
Typing Turtle
c1a35e1ba0 Minor read-only clarification (#13521)
* Minor `read-only` clarification

## Why

It was not obvious to me that `ro` is the shorthand form of `readonly`.

## Description

This adds a bit of text to explicitly state that `ro` is the shorthand form of `readonly` when using volumes

* Update storage/volumes.md

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
2021-10-04 10:50:21 +01:00
Sebastiaan van Stijn
173d3c65f8 fix broken (anchor) links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-09-13 15:07:49 +02:00
cam
4bf71bbdc5 Fix broken link to Windows path troubleshooting (#13495)
* Fix broken link to Windows path troubleshooting

* Update the cross-reference

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-09-10 17:40:11 +01:00
Sebastiaan van Stijn
fbf817d974 Merge pull request #13412 from thaJeztah/carry_13381_s390x_changes
[carry 13381] Updated docs for s390x for latest version
2021-08-27 10:10:56 +02:00
anujajakhade
b781519e18 Updated docs for s390x for latest version
Signed-off-by: Anuja Jakhade <anujajakhade@gmail.com>
2021-08-20 04:36:10 +00:00
Frédéric Dalleau
c1416c35ce Document path conversion on Windows (#13331)
* Document path conversion on Windows

* Minor formatting and style updates

* desktop/windows: minor fixes in troubleshoot

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-08-17 12:03:20 +01:00
Sebastiaan van Stijn
1583678203 Add missing code-hints, and minor markdown edits
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
  put in separate blocks. With the "console" code-hint, this
  is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
  numbered-list to be interrupted.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-16 12:59:23 +02:00
Sebastiaan van Stijn
4afcaf3b2d storage: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:19:20 +02:00
Sebastiaan van Stijn
f5e49b158b rewrite storage-driver section
- Reduce use of "Community Edition", and some sections that were written
  for Docker Enterprise.
- Add notes about deprecation of AuFS in the overview.
- Update the storage driver index page to use BuildKit, and rephrase some
  bits that made assumptions about each Dockerfile instruction producing
  a new layer.
- Updated some examples to be usable on Docker Desktop, which does not
  provide direct access to the daemon's storage directoreis.
- Add some notes linking to relevant sections about formatting output.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 15:45:39 +02:00
Nirman Narang
055e6fd68a DOCS: Added support for arch s390x for Ubuntu, RHEL and SLES
Added .md files for SLES and RHEL engine installation. Added indexing to _data/toc.yaml and engine/install/index.md. Modified engine/install/index.md, includes/install-script.md, engine/security/rootless.md, storage/storagedriver/device-mapper-driver.md, and storage/storagedriver/select-storage-driver.md to add info for added RHEL and SLES support. Modified engine/install/ubuntu.md to add s390x repos and other info. Added tab target for RHEL and SLES to engine/security/rootless.md along with other info.

Signed-off-by: Nirman Narang <narang@us.ibm.com>
2021-08-05 19:48:09 +02:00
Sebastiaan van Stijn
e22984f7d4 use Dockerfile "syntax" directive in examples
BuildKit allows using alternative Dockerfile syntaxes to introduce new features
without having to update Docker itself. The general recommendation is to always
specify a "syntax" directive in a Dockerfile, so that (if needed) older versions
of Docker can download the correct syntax to build the Dockerfile.

This updates our examples to include a syntax directive, to make users more familiar
with these directives, and to illustrate best-pracitces in our documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-20 10:19:12 +02:00
Sebastiaan van Stijn
d95a4266ff replace "output truncated" with special <...> (supported by "rouge")
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-02 15:02:21 +01:00
Lee Dale
96a4e1a430 Remove broken version based link to source. (#12328)
* Remove broken version based link to source.

Link to source container version based link that was broken. Propose to use non version based link.

Co-authored-by: Sebastiaan van Stijn <thaJeztah@users.noreply.github.com>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2021-02-19 15:03:02 +01:00
bizmate
80974031b6 Adding usage of CIFS mounts so it is clear how to connect to a Samba share also by using hostnames. 2021-02-10 09:00:29 +00:00
Sebastiaan van Stijn
3a794b3197 (temporarily) replace compose-file deep links to v3 docs
The documentation curently doesn't contain reference docs for the
unified (version-less) compose-file syntax, so for now replacing
all links to point to the v3 compose-file reference, which is still
present.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-07 14:21:37 +01:00