We have moved away from the docker.github.io domain. If you're not automatically redirected, please visit us at docs.docker.com.
+ + + + \ No newline at end of file diff --git a/404.md b/404.md new file mode 100644 index 0000000..a668cc2 --- /dev/null +++ b/404.md @@ -0,0 +1,33 @@ +--- +title: "Sorry, we can't find that page" +permalink: /404.html +noratings: true +notoc: true +sitemap: false +skip_read_time: true +--- + +There might be a mistake in the URL or you might've clicked a link to content +that no longer exists. If you think it's the latter, please file an issue in +our [issue tracker on GitHub](https://github.com/docker/docker.github.io/issues/new) +and let us know what happened. Please also include a link to where the error +occurred, if applicable. + +[**Click here to create a new ticket**](https://github.com/docker/docker.github.io/issues/new){:.newissue.button.primary-btn} + + +[](https://docs.docker.com/ "Go to the homepage") + + diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b42f3ca --- /dev/null +++ b/Dockerfile @@ -0,0 +1,94 @@ +# This Dockerfile builds the docs for https://docs.docker.com/ +# from the master branch of https://github.com/docker/docker.github.io +# +# Here is the sequence: +# 1. Set up base stages for building and deploying +# 2. Collect and build the reference documentation (from upstream resources) +# 3. Build static HTML from the current branch +# 4. Build the final image, combining the reference docs and current version +# of the documentation +# +# When the image is run, it starts Nginx and serves the docs at port 4000 + +# Jekyll environment (development/production) +ARG JEKYLL_ENV=development + +# Engine +ARG ENGINE_BRANCH="19.03" + +# Distribution +ARG DISTRIBUTION_BRANCH="release/2.7" + +### +# Set up base stages for building and deploying +### +FROM starefossen/github-pages:198 AS builderbase +ENV TARGET=/usr/share/nginx/html +WORKDIR /usr/src/app/md_source/ + +# Set vars used by fetch-upstream-resources.sh script as an environment variable, +# so that they are persisted in the image for use in later stages. +ARG ENGINE_BRANCH +ENV ENGINE_BRANCH=${ENGINE_BRANCH} + +ARG DISTRIBUTION_BRANCH +ENV DISTRIBUTION_BRANCH=${DISTRIBUTION_BRANCH} + +# Fetch upstream resources (reference documentation) +# Only add the files that are needed to build these reference docs, so that these +# docs are only rebuilt if changes were made to ENGINE_BRANCH or DISTRIBUTION_BRANCH. +# Disable caching (docker build --no-cache) to force updating these docs. +FROM alpine AS upstream-resources +RUN apk add --no-cache subversion wget +WORKDIR /usr/src/app/md_source/ +COPY ./_scripts/fetch-upstream-resources.sh ./_scripts/ +ARG ENGINE_BRANCH +ARG DISTRIBUTION_BRANCH +RUN ./_scripts/fetch-upstream-resources.sh . + + +# Build the static HTML for the current docs. +# After building with jekyll, fix up some links +FROM builderbase AS current +COPY . . +COPY --from=upstream-resources /usr/src/app/md_source/. ./ +# substitute the "{site.latest_engine_api_version}" in the title for the latest +# API docs, based on the latest_engine_api_version parameter in _config.yml +RUN ./_scripts/update-api-toc.sh +ARG JEKYLL_ENV +RUN echo "Building docs for ${JEKYLL_ENV} environment" +RUN set -eu; \ + if [ "${JEKYLL_ENV}" = "production" ]; then \ + jekyll build --profile -d ${TARGET} --config _config.yml,_config_production.yml; \ + sed -i 's#| Option | +Required | +Description | +
|---|---|---|
| type | ++ |
+ The type of mount, can be either volume, bind, tmpfs, or npipe. Defaults to volume if no type is specified. +
|
+
| src or source | +for type=bind and type=npipe | +
+
|
+
dst or destination or target |
+ yes | +
+ Mount path inside the container, for example /some/path/in/container/. + If the path does not exist in the container's filesystem, the Engine creates + a directory at the specified location before mounting the volume or bind mount. + |
+
readonly or ro |
+ + |
+ The Engine mounts binds and volumes read-write unless readonly option + is given when mounting the bind or volume. Note that setting readonly for a + bind-mount does not make its submounts readonly on the current Linux implementation. See also bind-nonrecursive. +
|
+
| Option | +Description | +
|---|---|
| bind-propagation | +
+ See the bind propagation section. + |
+
| consistency | +
+ The consistency requirements for the mount; one of +
|
+
| bind-nonrecursive | +
+ By default, submounts are recursively bind-mounted as well. However, this behavior can be confusing when a
+ bind mount is configured with readonly option, because submounts are not mounted as read-only.
+ Set bind-nonrecursive to disable recursive bind-mount. + + A value is optional: + +
|
+
| Option | +Description | +
|---|---|
| volume-driver | +
+ Name of the volume-driver plugin to use for the volume. Defaults to + "local", to use the local volume driver to create the volume if the + volume does not exist. + |
+
| volume-label | ++ One or more custom metadata ("labels") to apply to the volume upon + creation. For example, + volume-label=mylabel=hello-world,my-other-label=hello-mars. For more + information about labels, refer to + apply custom metadata. + | +
| volume-nocopy | +
+ By default, if you attach an empty volume to a container, and files or
+ directories already existed at the mount-path in the container (dst),
+ the Engine copies those files and directories into the volume, allowing
+ the host to access them. Set volume-nocopy to disable copying files
+ from the container's filesystem to the volume and mount the empty volume. + + A value is optional: + +
|
+
| volume-opt | ++ Options specific to a given volume driver, which will be passed to the + driver when creating the volume. Options are provided as a comma-separated + list of key/value pairs, for example, + volume-opt=some-option=some-value,volume-opt=some-other-option=some-other-value. + For available options for a given driver, refer to that driver's + documentation. + | +
| Option | +Description | +
|---|---|
| tmpfs-size | +Size of the tmpfs mount in bytes. Unlimited by default in Linux. | +
| tmpfs-mode | +File mode of the tmpfs in octal. (e.g. "700" or "0700".) Defaults to "1777" in Linux. | +
| Option | +Short syntax | +Long syntax | +Description | +
|---|---|---|---|
| published and target port | +--publish 8080:80 | +--publish published=8080,target=80 | ++ The target port within the container and the port to map it to on the + nodes, using the routing mesh (ingress) or host-level networking. + More options are available, later in this table. The key-value syntax is + preferred, because it is somewhat self-documenting. + |
+
| mode | +Not possible to set using short syntax. | +--publish published=8080,target=80,mode=host | ++ The mode to use for binding the port, either ingress or host. + Defaults to ingress to use the routing mesh. + |
+
| protocol | +--publish 8080:80/tcp | +--publish published=8080,target=80,protocol=tcp | ++ The protocol to use, tcp , udp, or sctp. Defaults to + tcp. To bind a port for both protocols, specify the -p or + --publish flag twice. + |
+
| Placeholder | +Description | +
|---|---|
| .Service.ID | +Service ID | +
| .Service.Name | +Service name | +
| .Service.Labels | +Service labels | +
| .Node.ID | +Node ID | +
| .Node.Hostname | +Node Hostname | +
| .Task.ID | +Task ID | +
| .Task.Name | +Task name | +
| .Task.Slot | +Task slot | +