Commit Graph

133 Commits

Author SHA1 Message Date
Sebastiaan van Stijn 10973d6ddf
builder: rephrase ENV section, remove examples for ENV key value without '='
The `ENV key value` form can be ambiguous, for example, the following defines
a single env-variable (`ONE`) with value `"TWO= THREE=world"`:

    ENV ONE TWO= THREE=world

While we cannot deprecate/remove that syntax (as it would break existing
Dockerfiles), we should reduce exposure of the format in our examples.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 0a0037c6fd)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-09-28 14:15:48 +02:00
eyherabh 5c5486d910
Replaces ADD with COPY in the COPY section
Possibly a typo from reusing text from the ADD section.

Signed-off-by: Hugo Gabriel Eyherabide <hugogabriel.eyherabide@gmail.com>
(cherry picked from commit 86cbe28510)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-05 09:25:00 +02:00
Tonis Tiigi 9152bf265e
docs: remove docs for —-from=index
Naming stages is the preferred method for using
multi-stage builds.

Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
(cherry picked from commit 5dd9bd4c2c)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-03 12:15:32 +02:00
Sebastiaan van Stijn 7498d9cc49
docs/builder: add note about handling of leading whitespace
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 6776f7cdcd)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-07-06 13:37:08 +02:00
dito 4e7c875e3b
Fix broken link
Signed-off-by: Daisuke Ito <itodaisuke00@gmail.com>
(cherry picked from commit 0f7260d1c7)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-06-17 16:50:24 +02:00
Maciej Kalisz e06fc01c1b
Update dead link and add missing info on COPY
1. Fix dead URL to [Dockerfile best practices](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#leverage-build-cache).
2. Add missing information about cache invalidation by `COPY`. It works in the same way as in the case of `ADD`. Informing only about the `ADD`s behavior is misleading as one can infer that these two directives differ in this regard.
3. Add missing info on RUN cache invalidation by COPY

Signed-off-by: Maciej Kalisz <maciej.d.kalisz@gmail.com>
(cherry picked from commit ef414633d6)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-05-09 12:51:09 +02:00
Sebastiaan van Stijn c150ba2b85
builder: fix broken link
This link was broken when generating the documentation (due to
a bug in Jekyll not converting wrapped internal links)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit bc58d655c0)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-30 21:48:14 +02:00
Sebastiaan van Stijn 81909d70f0
docs: fix links, and minor markdown touch-ups
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 116c9a1f59)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-30 00:19:48 +02:00
Sebastiaan van Stijn 733ae82dae
docs/builder: touch up markdown, and some minor rephrasing
- add code-fences with code-hints so that the right hightlighting is applied
- replace `*` for `-` in bullet-lists for consistency with other parts of the
  documentation.
- reduced number of "notes", either by combining some, or by changing some
  to regular text.
- removed "line numbers" from some examples, because there's only four lines,
  which should not need really need line numbers.
- reformat some notes to our new format

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 16730a2ab6)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 19:42:38 +02:00
Hector S 2676c603fb
Adding missing title in builder.md
addresses https://github.com/docker/docker.github.io/issues/9691

Signed-off-by: hsam <hfsam88@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 7557c138d7)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 19:41:48 +02:00
Michael Irwin 365bae4f89
Add clarification when using USER UID:GI
Signed-off-by: Michael Irwin <mikesir87@gmail.com>
(cherry picked from commit b3a1681fd8)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 19:41:45 +02:00
Sebastiaan van Stijn 6a02465f4c
docs: update code-hints for compatibility with "rouge"
Unlike GitHub's web-UI, the "rouge" hightlighter used in our
online documentation is case-sensitive. As a result, code-blocks
having the Dockerfile (uppercase) code-hint were not highlighted.

This changes those to use lowercase, which is supported by both.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 824a9ce64b)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-03-17 15:04:51 +01:00
Adrian Plata e22f088abb
Fixing some links and deleting an older page reference
Signed-off-by: Adrian Plata <adrian.plata@docker.com>
(cherry picked from commit 8195512206)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-17 13:57:47 +01:00
Tonis Tiigi b5e0dca08d
docs: document from platform
Co-Authored-By: Tibor Vass <tiborvass@users.noreply.github.com>
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit ce42168940)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-01-06 15:23:32 +01:00
Brandon Mitchell c050ae7fb1
Adjusting glossary reference and clarrifying the start of a Dockerfile
Signed-off-by: Brandon Mitchell <git@bmitch.net>
(cherry picked from commit 937ce69b42)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-10-29 15:27:42 +01:00
Daniel Cassidy 66f8d279c1
builder.md: Correct copy/paste error
Signed-off-by: Daniel Cassidy <mail@danielcassidy.me.uk>
(cherry picked from commit e9ada56a88)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-10-29 15:26:09 +01:00
Tonis Tiigi 83aeb219f0
buildkit reference docs
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: Tibor Vass <tibor@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-21 16:41:33 +01:00
Brandon Mitchell cc316fde55 Documenting ENTRYPOINT can empty value of CMD
Signed-off-by: Brandon Mitchell <git@bmitch.net>
2018-11-17 10:10:15 -05:00
Alex Mayer 2b0fdd0f17 Docs: Add Spaces Around Parenthesis Where Needed
Signed-off-by: Alex Mayer <amayer5125@gmail.com>
2018-09-28 17:40:22 -04:00
Misty Stanley-Jones a2bb62683d Fix doubled word in note
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2018-01-31 13:05:58 -08:00
Daniel Nephin 01b521c002 Update buidler ENV docs
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2018-01-17 16:55:07 -05:00
Sebastiaan van Stijn 90cfa01889
Fix stray quote in builder.md
Signed-off-by: Taylor Brown <taylorb@microsoft.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-01-16 22:51:57 +01:00
Sebastiaan van Stijn 7e465d1b09
Fix repeated "for" in docs/reference/builder.md
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-01-08 12:33:06 +01:00
Misty Stanley-Jones db572ec4ab Document EXPOSE UDP syntax
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2018-01-04 16:16:06 -08:00
Sebastiaan van Stijn 12765c318f
Merge pull request #467 from estesp/chown-flag-docs
Add docs for Dockerfile ADD/COPY --chown flag
2017-11-29 09:28:30 -08:00
squeegels 032f676717 Fixed typo under User section
Signed-off-by: root <root@clientele.co.za>
Signed-off-by: Squeegels <lmscrewy@gmail.com>
Signed-off-by: Squeegels <1674195+squeegels@users.noreply.github.com>
2017-11-17 09:47:41 +02:00
Patrick Lang cc35724c17 Adding note about creating Windows users
Signed-off-by: Patrick Lang <plang@microsoft.com>
2017-11-13 11:43:38 -08:00
Mikhail Vasin bdd1b1e279 Fix grammar
Signed-off-by: Mikhail Vasin <michaelvasin@gmail.com>
2017-11-11 16:15:15 +03:00
Abdur Rehman c3fe9d85ef fix a number of minor typos
Fix 19 typos, grammatical errors and duplicated words.

These fixes have minimal impact on the code as these are either in the
doc files or in comments inside the code files.

Signed-off-by: Abdur Rehman <abdur_rehman@mentor.com>
2017-10-31 15:21:51 +05:00
Sebastiaan van Stijn 92afc3f474
Merge pull request #623 from johndmulhausen/master
Removing titles from md files
2017-10-30 14:01:58 +01:00
Misty Stanley-Jones e49e1ea739 Update info on labels
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-10-16 10:10:49 -07: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
Phil Estes a83b9f102b
Add docs for Dockerfile ADD/COPY --chown flag
Document the new `--chown` flag added to the ADD and COPY commands in
the Dockerfile format.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-10-05 12:35:01 -04:00
Frieder Bluemle 45c9b9b6c1
Fix GitHub spelling
Signed-off-by: Frieder Bluemle <frieder.bluemle@gmail.com>
2017-10-05 01:14:31 +08:00
Rubens Figueiredo dd95731a21 Added docker documentation for Expose
Signed-off-by: Rubens Figueiredo <r.figueiredo.52@gmail.com>
2017-08-23 16:12:46 -07: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
Daniel Nephin ad5d035988 More about ARG and build stages.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-07-14 16:59:21 -04:00
Daniel Nephin 2880030814 Clarify docs about ARG in FROM
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-07-14 16:55:42 -04:00
Valentin Lorentz 4f3a8aecad Fix typo (proceed -> precede)
Signed-off-by: Valentin Lorentz <progval+git@progval.net>
2017-07-07 13:17:15 +02:00
Sebastiaan van Stijn 29b419eed5
Some builder docs improvements
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-06-29 14:20:16 -07:00
Slava Semushin a84463d8d5 docs/reference/builder.md: mention that USER directive also allows to specify the user group.
Signed-off-by: Slava Semushin <semushin@redhat.com>
2017-06-14 15:49:37 +02:00
Sebastiaan van Stijn 5bf86c1984 Merge pull request #32735 from bhavin192/patch-1
Add note about host-dir in VOLUME
(cherry picked from commit f2fff9d913a8ab0436dd56033189a7c3713a59a2)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 8fd6547fc3eb67e7efa7efb007ae6a4494cd2bb3)
Signed-off-by: Tibor Vass <tibor@docker.com>
2017-06-14 02:48:46 +00:00
Tõnis Tiigi 7955683eb2 Merge pull request #32684 from scjane/patch-3
Update builder.md
(cherry picked from commit 831066337743fc29ff122fce51afe44b8b3b3ba9)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit bc66821abbcf50c721ce9b8f52b339fda102d389)
Signed-off-by: Tibor Vass <tibor@docker.com>
2017-06-14 02:48:46 +00:00
Daniel Nephin c6e78b9c5f Document arg before from
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-06-02 00:11:05 +00:00
Daniel Nephin 6e40868ade Add Dockerfile reference docs for using ARG in FROM
Also fixed some examples of using `docker build` to clarify that the
positional argument is a directory, not a file.

Also fixed some terminology. Dockerfiles contain instructions, not directives or
commands.

Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-06-02 00:11:03 +00:00
Tonis Tiigi 29dd51d2a8 Add docs for named build stages
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2017-06-02 00:11:02 +00:00
Elias Faxö c5071b94da Added start period option to health check.
Signed-off-by: Elias Faxö <elias.faxo@gmail.com>
2017-06-02 00:11:02 +00:00
Foysal Iqbal 35cc51b4f6 remove the duplicate line from doc and rebase with master for 'example of ADD and COPY with special characters file name'
Signed-off-by: Foysal Iqbal <foysal.iqbal.fb@gmail.com>
2017-06-02 00:10:59 +00:00
John Maguire b3da704154 Add note regarding Windows VOLUME limitations
Signed-off-by: John Maguire <jmaguire@duosecurity.com>
2017-06-02 00:10:59 +00:00
Dave Tucker 84e63b3abb Ignore built-in allowed build-args in image history
Removes the build-args from the image history if they are in the
BuiltinAllowedBuildArgs map unless they are explicitly defined in an ARG
instruction.

Signed-off-by: Dave Tucker <dt@docker.com>
2017-06-02 00:10:59 +00:00