Commit Graph

82 Commits

Author SHA1 Message Date
Sven Dowideit 5b8040c935 spelling fix from Marc MERLIN
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:55 +00:00
buddhamagnet 63193b17b1 add support for exclusion rules in dockerignore
Signed-off-by: Dave Goodchild <buddhamagnet@gmail.com>
2017-06-02 00:06:55 +00:00
Ed Costello fcf01194a9 Copy edits for typos
Signed-off-by: Ed Costello <epc@epcostello.com>
2017-06-02 00:06:55 +00:00
Tristan Carel 3f2bc86a4f Fix typo in builder reference
Signed-off-by: Tristan Carel <tristan.carel@gmail.com>
2017-06-02 00:06:54 +00:00
Rick Wieman acc0eac695 Makes headings in documentation consistent
Fixes #10673.

Signed-off-by: Rick Wieman <git@rickw.nl>
2017-06-02 00:06:54 +00:00
Jeff Nickoloff 8bf56348e9 Update builder.md
Single value labels do not work in 1.6 and multi-label instructions only work when separated by non-EOL whitespace.
I also added an example snip from the inspect output with the labels that are included in this guide.

Signed-off-by: Jeff Nickoloff <jeff@allingeek.com>
2017-06-02 00:06:54 +00:00
Doug Davis efc478e33c Add support for more advanced ${xxx:...} syntax
Just ${xxx:+...} and ${xxx:-...} for now

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:52 +00:00
Daniel, Dao Quang Minh 729035faff document dirperm1 fix for #783 in known issues
Since `dirperm1` requires a more recent aufs patch than many current OS release,
we cant remove #783 completely. This documents that docker will apply `dirperm1`
automatically for systems that support it

Signed-off-by: Daniel, Dao Quang Minh <dqminh89@gmail.com>
2017-06-02 00:06:52 +00:00
Mary Anthony fb7eb87b94 Removing sudo from command line examples
We now advise people to configure docker group and
add to sudo.  Mac shouldn't use sudo.  Removed sudo
from command examples.  Left in installation to be removed
in installation doc sweep -- removing requires finer
grain control.

Signed-off-by: Mary Anthony <mary@docker.com>
2017-06-02 00:06:52 +00:00
Doug Davis f32b6eb23c Fix some escaping around env var processing
Clarify in the docs that ENV is not recursive

Closes #10391

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:51 +00:00
Mary Anthony ade615a458 Updating with Sven's comments and other tweaks
Signed-off-by: Mary Anthony <mary@docker.com>
2017-06-02 00:06:50 +00:00
Andy Goldstein 2eaa831df5 Add ability to refer to image by name + digest
Add ability to refer to an image by repository name and digest using the
format repository@digest. Works for pull, push, run, build, and rmi.

Signed-off-by: Andy Goldstein <agoldste@redhat.com>
2017-06-02 00:06:50 +00:00
Darren Shepherd bfca1f4258 Documentation changes for labels
Signed-off-by: Darren Shepherd <darren@rancher.com>
2017-06-02 00:06:50 +00:00
Sebastiaan van Stijn b5c9f3f13a Add labels documentation
Adds more documentation for labels and adds the label instruction to the
man-pages.

Also included is a document called "Labels - custom meta-data in Docker"
in the user-guide, this is still a work-in-progress I started to describe
the "namespaces" conventions, an example on storing structured data.

I ran a bit "out of steam" (writers block?) on that document, but kept
it in (for now), in case it still ends up useful.

The Remote API documentation changes will need to be moved to the
docker_remote_api_v1.18.md document when rebasing the whole PR.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Darren Shepherd <darren@rancher.com>
2017-06-02 00:06:50 +00:00
Dan Walsh 72b8275268 Allow specification of Label Name/Value pairs in image json content
Save "LABEL" field in Dockerfile into image content.

This will allow a user to save user data into an image, which
can later be retrieved using:

docker inspect IMAGEID

I have copied this from the "Comment" handling in docker images.

We want to be able to add Name/Value data to an image to describe the image,
and then be able to use other tools to look at this data, to be able to do
security checks based on this data.

We are thinking about adding version names,
Perhaps listing the content of the dockerfile.
Descriptions of where the code came from etc.

This LABEL field should also be allowed to be specified in the
docker import --change LABEL:Name=Value
docker commit --change LABEL:Name=Value

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
2017-06-02 00:06:50 +00:00
Doug Davis d69dea3c44 Tell users about how VOLUME initializes the new mount point/volume
Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:48 +00:00
Sven Dowideit 8ac0e4d95e Notes should be indented
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:48 +00:00
Sven Dowideit 10560b0a8f a little re-writing
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:47 +00:00
Michael A. Smith 95fe3a1a93 Distinguish ENV from setting environment inline
It's ambiguous to say that `ENV` is _functionally equivalent to prefixing the command with `<key>=<value>`_. `ENV` sets the environment for all future commands, but `RUN` can take chained commands like `RUN foo=bar bash -c 'echo $foo' && bash -c 'echo $foo $bar'`. Users with a solid understanding of `exec` may grok this without confusion, but less experienced users may need this distinction.

Signed-off-by: Michael A. Smith <msmith3@ebay.com>

Improve Environment Handling Descriptions

- Link `ENV` and `Environment Replacement`
- Improve side-effects of `ENV` text
- Rearrange avoiding side effects text

Signed-off-by: Michael A. Smith <msmith3@ebay.com>
2017-06-02 00:06:46 +00:00
Doug Davis 37fd964edb Fix docs so WORKDIR mentions it works for COPY and ADD too
The docs around COPY/ADD already mentioned that it will do a relative
copy/add based on WORKDIR, so that part is already ok.  Just needed to
tweak the WORKDIR section since w/o mentioning COPY/ADD it can be misleading.

Noticed by @phemmer

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:46 +00:00
Arnaud Porterie 776f4e478e Support whitespaces in ADD and COPY continued
Add tests and documentation for this new feature.

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2017-06-02 00:06:45 +00:00
Jan Koprowski fbe252581a Specify ENV variables are also used for CMD.
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-06-02 00:06:44 +00:00
Doug Davis c88762b38b Have .dockerignore support Dockerfile/.dockerignore
If .dockerignore mentions either then the client will send them to the
daemon but the daemon will erase them after the Dockerfile has been parsed
to simulate them never being sent in the first place.

an events test kept failing for me so I tried to fix that too

Closes #8330

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:44 +00:00
Doug Davis c5bc505744 Allow for relative paths on ADD/COPY
Moved Tianon's PR from: https://github.com/docker/docker/pull/7870
on top of the latest code

Closes: #3936

Signed-off-by: Andrew Page <admwiggin@gmail.com>
Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:43 +00:00
Sven Dowideit 1cc7a4eb81 add Scott's link checker script, and fix what it finds
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:43 +00:00
Sindhu S 5d4d002c23 Fix dead link build.md 2017-06-02 00:06:42 +00:00
Jacob Atzen d40014d096 Update documentation for EXPOSE
The documentation for EXPOSE seems to indicate, that EXPOSE is only relevant in
the context of links, which is not the case.

Signed-off-by: Jacob Atzen <jatzen@gmail.com>
2017-06-02 00:06:42 +00:00
Michael Steinert ab60926400 Fix a small typo
Signed-off-by: Michael Steinert <mike.steinert@gmail.com>
2017-06-02 00:06:42 +00:00
Sven Dowideit 440a18bb50 Add an example that shows starting apache in the foreground
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:41 +00:00
Doug Davis 489d01ee7d Add support for ENV of the form: ENV name=value ...
still supports the old form: ENV name value

Also, fixed an issue with the parser where it would ignore lines
at the end of the Dockerfile that ended with \

Closes #2333

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:41 +00:00
Doug Davis da3b6648fd Be clearer in docs about COPY/ADD dirs
COPY/ADD just copies the contents of dirs, not dirs themselves.
This PR tries to clear that up in the docs.

Closes #8775

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:41 +00:00
decadent 2c1368cd2f Updated the COPY directive reference: Source can't be a URL for COPY (+ formatting error fixes)
Signed-off-by: Roman Dudin <katrmr@gmail.com>
2017-06-02 00:06:39 +00:00
Doug Davis 0d41e6a758 Use the HTTP Last-Modified http header as the mtime value for ADD cmd when present
Closes #8331

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:39 +00:00
Huu Nguyen 86e72c6e06 Fix apparent copy paste mistake
The note under the RUN header refers to the CMD instruction. It should refer to the RUN instruction instead.

Signed-off-by: Huu Nguyen <whoshuu@gmail.com>
2017-06-02 00:06:39 +00:00
Arnaud Porterie 7caa149d5f Clarify USER instruction documentation
Reuse WORKDIR wording to specify that the USER instructions affect the
following RUN, CMD, and ENTRYPOINT instructions.

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2017-06-02 00:06:39 +00:00
Fred Lifton a6ba3f585b Tweaks to Dockerfile tutorial
Made a few tweaks to Dockerfile tutorial links and removed some cruft from the tutorial itself.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
2017-06-02 00:06:37 +00:00
Erik Hollensbe 15192a0bc1 builder: Update documentation WRT environment replacement
Docker-DCO-1.1-Signed-off-by: Erik Hollensbe <github@hollensbe.org> (github: erikh)
2017-06-02 00:06:37 +00:00
Sven Dowideit 9efb51fbc1 Rewrite ENTRYPOINT documentation covering all the combinations with examples.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
2017-06-02 00:06:37 +00:00
Madhu Venugopal a6594e13ce Fixed a minor docs issue in a Dockerfile Example
The Dockerfile Instruction to create the .vnc directory results in a failure :
-storepasswd failed for file: /root/.vnc/passwd

Signed-off-by: Madhu Venugopal <madhu@socketplane.io>
2017-06-02 00:06:37 +00:00
Adrien Folie 410719e6df Add ENV variables support to WORKDIR build command
Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Docker-DCO-1.1-Signed-off-by: Adrien Folie <folie.adrien@gmail.com> (github: folieadrien)

Conflicts:
	builder/builder.go
		This file has been deleted.
2017-06-02 00:06:36 +00:00
Doug Davis 49323dfac9 Add note to docs about lack of shell processing in JSON form
Closes #5509

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:36 +00:00
Daniel Farrell 1d2bb271ac Doc update to clarify EXPOSE vs -p functionality.
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
2017-06-02 00:06:35 +00:00
Doug Davis 0e82ab713b Add more info about when build cache is invalidated/used - Issue #3636
Plus some edits as suggested by @jamtur01

Closes #3636

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:35 +00:00
Doug Davis 1a83c9f87e add wildcard support to copy/add
Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:35 +00:00
Erik Hollensbe 82ff6f0c9f builder: Fix handling of VOLUME command where multiple volumes are
specified in a space delimited list.

Docker-DCO-1.1-Signed-off-by: Erik Hollensbe <github@hollensbe.org> (github: erikh)
2017-06-02 00:06:35 +00:00
Fred Lifton 85808d776d Adding new Dockerfile Best Practices doc, and links thereto.
Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
2017-06-02 00:06:35 +00:00
Doug Davis 6ea2cc5e0e Add support for copy/add with multiple src files
Part one of solution for issue #6820

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:34 +00:00
Sven Dowideit 3ca630d381 Consistently use 'sudo docker' in examples
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
2017-06-02 00:06:34 +00:00
Doug Davis f0b5f2601f Add notes about single-quotes
Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:34 +00:00
Fred Lifton e06e910b87 Fixed a typo and added a bit based on Sven's feedback
Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
2017-06-02 00:06:33 +00:00