Commit Graph

219 Commits

Author SHA1 Message Date
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
Sebastiaan van Stijn 33ad3d9bbf
Merge pull request #11042 from AkihiroSuda/prep-20-03
v20.10 docs for cgroup v2 and rootless
2020-12-09 01:05:54 +01:00
Akihiro Suda 1976c2178c
v20.10 docs for cgroup v2 and rootless
* Docker now supports cgroup v2 (both rootful and rootless)
* Rootless mode graduated from experimental
* New storage driver: fuse-overlayfs

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-11-12 12:47:16 +09:00
aliray 9a416422b5
command error
"volume-opt=o=10.0.0.10,rw,nfsvers=4,async" should be  "volume-opt=o=addr=10.0.0.10,rw,nfsvers=4,async"
2020-11-06 18:51:23 +08:00
Daido Shota 2cb92e074f
Fix broken links in storage/volumes.md 2020-10-31 22:39:52 +09:00
Sebastiaan van Stijn 2ce808edc0
Remove references to obsolete engine versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-26 15:45:07 +01:00
Sebastiaan van Stijn 82b0e8cb84
Merge pull request #11577 from mrl5/GH-11576
docker/docker.github.io#11576 fixed keywords for storage/storagedriver
2020-10-20 19:08:42 +02:00
Sebastiaan van Stijn 92e2068c38
[Desktop] remove content refering to removed "osxfs" topic
This topic was removed in 9bebb666d9

We may want to add back the part describing sharing sshagent somewhere,
which is not really a feature related to osxfs. Also, some generic
description about file sharing (permissions, syncing) should probably
be added back.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-20 14:08:46 +02:00
Usha Mandya 0e8c1b63ff
Minor style updates 2020-10-20 11:18:18 +01:00
mrl5 9242ec4525
docker/docker.github.io#11576 fixed keywords for storage/storagedriver 2020-10-19 21:17:30 +02:00
David Scott 1cfabd89e4 storage: mention volumes in compose and link to compose docs
Signed-off-by: David Scott <dave.scott@docker.com>
2020-10-19 11:43:55 +01:00
David Scott 4f181a683f volumes: mention Desktop-specific benefits
Signed-off-by: David Scott <dave.scott@docker.com>
2020-10-19 11:20:20 +01:00
David Scott 83f6cc1b3f Add Desktop examples to "Good use cases for volumes"
Signed-off-by: David Scott <dave.scott@docker.com>
2020-10-19 11:13:57 +01:00
Sebastiaan van Stijn 393d3f6566
Add rel="noopener" to external links
See https://web.dev/external-anchors-use-rel-noopener/

Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-12 13:09:30 +02:00
Sebastiaan van Stijn 0bbe9c32fb
Fix various broken links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-07 12:49:22 +02:00
jeffw387 f68b5bef8c
Update zfs-driver.md
Typo/misspelling
2020-09-22 20:48:12 -07:00
Jeremy Lin 24e175f880
bind-mounts.md: source/host path must be absolute 2020-09-19 02:19:25 -07:00
Tega Agbanagba 673872887a
Update index.md 2020-09-14 21:13:36 +01:00
Tega Agbanagba 5bf5f94c32
Container base layer in jpg is 15.04
Update the release version of base layer of container image to match what's in the jpg image files.
2020-09-14 21:05:09 +01:00
Kenyon Ralph fc40ccf269
btrfs-driver.md: remove unneeded use of sudo and cat 2020-08-12 22:48:37 -07:00
Leandro Gomez 0d2d153f7e We should refer to the read-only layer. There's no thing as the write only layer 2020-06-29 11:06:46 -03:00
Usha Mandya df3bd29a3e Remove links to success articles 2020-06-05 17:14:49 +01:00
Sebastiaan van Stijn 637bf1e066
storage: use relative markdown links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:46 +02:00
Sebastiaan van Stijn d813acb6e1
Engine: reorganize install topic
- Move getting started overview to /get-started/overview/
- Move engine installation files under /engine/
- Redirect the top-level /install/ to /get-docker/
- Updated titles in left-hand navigation
- Added back some pages to the navigation that were
  currently not included.
- Reduce some steps in the installation pages
- Move devicemapper prerequisites to the devicemapper
  storage driver page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-06 10:50:28 +02:00
Sebastiaan van Stijn 331554f4b3
Fix various links that were generating URLs with `.md` (#10548)
* Fix incorrect links in compose section

there's a bug causing wrapped links to not work, and replacing
some links to point to the .md file, so that IDE's can check
if the anchors are valid. Also replaced some links to point
to their new location.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* engine/swarm: update links

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

* Fix various broken links

There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work.
Also replacing some links to point to the .md file, so that IDE's can check if the anchors
are valid. Finally, replaced some links to point to their new locations, so that users don't
get redirected..

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-01 12:05:50 +01:00
jureaky cdee2dd67c
Fix wrong device path in NFSv4 volume example (#10429)
In section Create a service which creates an NFS volume,
NFSv3 command states right device path(:/var/docker-nfs),
but NFSv4 command is not configured to refer that path.
So updated the path.
2020-03-31 17:13:08 +01:00
Sebastiaan van Stijn 14bbe621e5
Update markdown language hints to work with "rouge"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 14:49:51 +01:00
谭九鼎 8bf6e38700
Chore: Fix indentation 2020-03-07 21:13:11 +08:00
Dawn-Docker 3c54d2ff9c
Update toc (#9819) 2019-11-08 08:13:40 -08:00
Sergey Kolesnikov 806ed5f4e8 add file name to step description (#9688)
* add file name to step description

add file name to step description

* Minor grammar fix
2019-10-21 08:58:08 -07:00
Sergey Kolesnikov 246499390d
Update tmpfs.md - fix incorrect tmpfs-type option
Incorrect "tmpfs-type" option changed to "tmpfs-size"
2019-10-19 21:44:43 +03:00
Adam Brodziak d5489b4462 Correct in-page link (#9542) 2019-10-02 16:18:30 -07:00
Nikita Potapenko 578cd24e37
Update devicemapper path 2019-09-16 15:18:26 +03:00
linchiwei123 7cb5de0743 make things clear (#9228) 2019-08-16 11:34:26 +01:00
Nathan Jones 798a7b1944 Added link to 3rd party volume driver plugins (#8932)
Added link to 3rd party volume driver plugins
2019-07-29 16:48:03 +01:00
Olli Janatuinen 500b9b166d Included npipe to documentation (#7427) 2019-07-23 08:58:41 -07:00
Dawn W Docker 9b6409c806 branding changes
Signed-off-by: Dawn W Docker <dawn.wood@users.noreply.github.com>
2019-06-11 14:42:10 -07:00
Dawn W Docker f4dde18e07 branding changes
Signed-off-by: Dawn W Docker <dawn.wood@users.noreply.github.com>
2019-06-11 14:37:45 -07:00
paigehargrave 6759a89704 Update index.md 2019-06-11 13:58:38 -07:00
Takuya N 9ecfaf9732 Update ubuntu version and common driver on storagedriver docs (#8746)
Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>
2019-05-29 22:02:00 -07:00
Hoang 0602e4c354 Update volumes.md (#8842) 2019-05-25 12:18:18 -07:00
Philipp f841aa6618 Update zfs-driver.md (#8735)
* Update zfs-driver.md

* Add suggested correction
2019-05-14 18:20:12 -07:00
Wang Jie e0df4c0934 Update tmpfs.md (#8711) 2019-05-07 18:14:05 -07:00
Wang Jie c90007a548 Update bind-mounts.md (#8696) 2019-04-23 17:25:26 -06:00
i-need-to-tell-you-something b7b1e03f04 Update index.md (#8690)
Fix typo - missing word.
2019-04-23 13:45:04 -06:00
Lars Gyrup Brink Nielsen bb659a656e docs: fix typo in removal of named volumes (#8686) 2019-04-22 18:52:20 -06:00
Sagar Velankar 8781ea5cbc
Remove extra which
Change below line

From

AUFS, which can suffer noticeable latencies when searching for files in images with many layers

To

AUFS can suffer noticeable latencies when searching for files in images with many layers
2019-04-14 21:33:44 +05:30
Sebastiaan van Stijn 21c45858b0
Fix some minor issues in vfs storage-driver section
- Fix mention of `storage-drivers` instead of `storage-opts`
- Repeat the selected driver in the second `daemon.json` example
- Remove mention of `CE` as this driver can be used
  on Docker EE (although it's mainly intending for
  debugging, so not a "supported" driver)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-27 14:52:18 +01:00
Maria Bermudez d3afe5ed0d
Merge pull request #7495 from omegamormegil/patch-8
NFS volume with service create
2019-03-15 15:17:13 -07:00
Maria Bermudez eb6aa08e8a
Fix service name 2019-03-15 15:16:59 -07:00
Maria Bermudez 66dda9ef20
Add NFS example 2019-03-15 15:15:37 -07:00
Sebastiaan van Stijn ec7e716c54
Clean up some old setup information for overlayFS
This removes the additional steps for old versions of Docker EE 17.06.
Current versions of Docker EE 17.06 no longer need these additional
steps.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-05 13:41:55 +01:00
L-Hudson 115ededf56
Merge pull request #8205 from dmandalidis/overlay-reword
Overlay driver note rewording (fixes #38695)
2019-02-20 10:35:52 -05:00
Dimitris Mandalidis bdc863005a Overlay driver note rewording (fixes #38695) 2019-02-09 11:45:59 +02:00
Sebastiaan van Stijn 03d5b3396d
Use consistent formatting for notes
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-02-09 00:49:57 +01:00
L-Hudson 6839b76f68
Merge pull request #6449 from DanHam/fix-device-mapper-doc
Fix device mapper doc
2019-01-23 15:28:43 -05:00
L-Hudson d8c1b5c452
Update device-mapper-driver.md
minor editorial crx
2019-01-23 15:20:53 -05:00
Anne Henmi dbe3c68ba5
Update device-mapper-driver.md
added comma
2019-01-22 16:14:09 -07:00
Sebastiaan van Stijn 7002b9c5c2
Merge pull request #8006 from thaJeztah/remove_edge_reference_docs
Remove edge documentation
2019-01-18 19:13:58 +01:00
Maria Bermudez 7a993f7b65
Merge pull request #6822 from lvthillo/patch-1
Update device-mapper-driver.md
2019-01-15 17:04:34 -08:00
Josh Sleeper 4c5b491d31
chore(typo): fix incorrect storage driver reference 2019-01-15 15:37:17 -05:00
Sebastiaan van Stijn aae9bfc276
Rename / remove edge-related variables
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-14 22:44:58 +01:00
paigehargrave 4bc888a9c2
Update bind-mounts.md 2019-01-11 15:59:42 -05:00
paigehargrave 77077e06a3
Update index.md 2019-01-11 15:10:34 -05:00
paigehargrave 3a97eec35a
Update select-storage-driver.md 2019-01-11 14:17:16 -05:00
ada mancini ce588a5df4
Update device-mapper-driver.md
callout json-file functionality when using devicemapper - json-file logs to docker dataroot not devicemapper volumes
2018-12-19 17:29:51 -05:00
Maria Bermudez 4bdcbf8ae9 Merge branch 'master' of github.com:docker/docker.github.io 2018-12-10 12:41:24 -08:00
Mark Janssen 8783864b54
Fix XFS 'ftype' option typo
The required XFS option is called ftype, not fstype:

```
xfs_info / | grep ftype
naming   =version 2              bsize=4096   ascii-ci=0 ftype=1
```
2018-12-08 17:41:58 +01:00
Anne Henmi 14f78649ab
Merge pull request #900 from docker/mountflags-zfs-899
Added a note on ZFS/MountFlags=slave
2018-12-07 10:05:21 -07:00
Anne Henmi 48ce1ddfd8
Update zfs-driver.md
Technical review complete by @andrewhsu.
2018-12-04 12:57:04 -07:00
Anne Henmi a5f1d88deb Initial draft. 2018-11-30 10:15:46 -07:00
Brandon Mitchell 906a91f5ea Data exists in stopped containers, but not removed containers
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2018-11-16 07:34:20 -05:00
Anne Henmi 3805b23d93
Update select-storage-driver.md
Fixed product naming
2018-11-13 13:20:33 -07:00
Anne Henmi e7cbb50923
Update select-storage-driver.md 2018-11-13 12:45:59 -07:00
Maria Bermudez 3d7a90acb1
Minor edits 2018-11-13 11:05:43 -08:00
Anne Henmi f0c93ff968
Update select-storage-driver.md 2018-11-13 11:45:01 -07:00
Anne Henmi 48f9a7e09d
Update select-storage-driver.md 2018-11-13 10:12:53 -07:00
Sebastiaan van Stijn 3b2495966a
Update "select a storage driver" with current status
The information on this page was a bit outdated, and
with "overlay" and "devicemapper" being phased-out, could
use some changes;

- de-emphasize "overlay", "devicemapper" and "aufs"
- split "recommended" and "alternative drivers" columns
  (vfs was listed as a "recommended" driver, but definitely
  is not recommended for production use).
- add notes about "overlay" and "devicemapper" being
  deprecated in Docker 18.09
- some other textual changes.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-13 18:04:10 +01:00
Nathan Jones 00e913e648
NFS volume with service create
Added example. There aren't many good examples using NFS with service create in the docs and this is a common customer question.
2018-10-11 16:04:08 -04:00
Maria Bermudez eb608ee28d
Merge branch 'master' into spelling 2018-10-04 12:18:34 -07:00
Sebastiaan van Stijn 9124018691
Merge pull request #7432 from BretFisher/patch-4
Correct container write layer persistence statement
2018-10-02 11:18:49 +02:00
Maria Bermudez bc9d3a4348
Merge pull request #7430 from BretFisher/patch-2
Fixing link from storage drivers page to volumes page
2018-10-01 13:37:15 -07:00
Bret Fisher 261bd20697
adding oxford comma 2018-09-27 04:50:59 -04:00
Bret Fisher 95d49df03d
Correct container write layer persistence statement
Make it more clear that container storage file changes are persistent until the container is deleted, rather than the container stopped. This now matches statements later in the document.
2018-09-27 04:11:53 -04:00
Bret Fisher 4b39f91fb0
remove aufs "default storage driver" statements
In many cases, aufs is no longer the default storage driver, so just change the example to not mention the default. If you'd like it to actually state overlay2 is the default in most/some cases I can change that.
2018-09-27 04:11:47 -04:00
Bret Fisher afaa1a174d
Fixing link to volumes
Link to specific volumes page rather than storage summary page.
2018-09-27 03:37:12 -04:00
Anne Henmi 3c01dfe6b2
Merge pull request #7333 from corburn/patch-1
Update zfs-driver.md
2018-09-26 08:45:05 -06:00
Maria Bermudez 4ede4f8558
Update overlayfs-driver.md
Update "referred to a" to "referred to as a"
2018-09-25 07:52:16 -07:00
Maria Bermudez 95fd472135
Update overlayfs-driver.md
Change "referred to a" to "referred to as a"
2018-09-25 07:40:43 -07:00
Maria Bermudez 12ece3c317
Update aufs-driver.md
Fix grammar
2018-09-25 07:22:19 -07:00
Maria Bermudez bedfc702a8
Update bind-mounts.md
Add a comma
2018-09-25 07:21:48 -07:00