Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into distribution_docs…
Browse files Browse the repository at this point in the history
…_from_upstream
  • Loading branch information
Misty Stanley-Jones committed Nov 30, 2016
2 parents 554b2c9 + 7d77fa4 commit f285741
Show file tree
Hide file tree
Showing 46 changed files with 1,250 additions and 420 deletions.
5 changes: 5 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.dockerignore
.git
.gitignore
Dockerfile
docker-compose.yml
116 changes: 24 additions & 92 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,103 +1,35 @@
FROM starefossen/github-pages

# Basic Git set-up for throwaway commits
RUN git config --global user.email "gordon@docker.com"
RUN git config --global user.name "Gordon"

# Clone the docs repo
RUN git clone https://www.github.com/docker/docker.github.io allv
ENV VERSIONS="v1.4 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11"

# Create archive; check out each version, create HTML, tweak links
RUN git clone https://www.github.com/docker/docker.github.io temp; \
for VER in $VERSIONS; do \
git --git-dir=./temp/.git --work-tree=./temp checkout ${VER} \
&& mkdir -p allvbuild/${VER} \
&& jekyll build -s temp -d allvbuild/${VER} \
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/'"$VER"'/#g' \
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/'"$VER"'/#g' \
&& find allvbuild/${VER} -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/'"$VER"'/#g'; \
done; \
rm -rf temp

COPY . allv

## Branch to pull from, per ref doc
ENV ENGINE_BRANCH="1.12.x"
ENV DISTRIBUTION_BRANCH="release/2.5"

# Engine
# Get docker/docker ref docs from $ENGINE_BRANCH branch to be used in master builds
# Uses Github Subversion gateway to limit the checkout
RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/reference allv/engine/reference
RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/extend allv/engine/extend
# Can't use the svn trick to get a single file, use wget instead
RUN wget -O allv/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/deprecated.md
# Make a temporary commit for the files we added so we can check out other branches later
RUN git --git-dir=./allv/.git --work-tree=./allv add engine
RUN git --git-dir=./allv/.git --work-tree=./allv commit -m "Temporary commit"

# Distribution
# Get docker/distribution ref docs from $DISTRIBUTION_BRANCH tag to be used in master builds
# Uses Github Subversion gateway to limit the checkout
RUN svn co https://github.com/docker/distribution/branches/$DISTRIBUTION_BRANCH/docs/spec allv/registry/spec
# Can't use the svn trick to get a single file, use wget instead
RUN wget -O allv/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md
# Make a temporary commit for the files we added so we can check out other branches later
RUN git --git-dir=./allv/.git --work-tree=./allv add registry
RUN git --git-dir=./allv/.git --work-tree=./allv commit -m "Temporary commit"

# Create HTML for master
RUN jekyll build -s allv -d allvbuild

# Check out 1.4 branch, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.4
RUN mkdir allvbuild/v1.4
RUN jekyll build -s allv -d allvbuild/v1.4
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.4/#g'
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.4/#g'
RUN find allvbuild/v1.4 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.4/#g'

# Check out 1.5 branch, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.5
RUN mkdir allvbuild/v1.5
RUN jekyll build -s allv -d allvbuild/v1.5
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.5/#g'
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.5/#g'
RUN find allvbuild/v1.5 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.5/#g'

# Check out 1.6, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.6
RUN mkdir allvbuild/v1.6
RUN jekyll build -s allv -d allvbuild/v1.6
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.6/#g'
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.6/#g'
RUN find allvbuild/v1.6 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.6/#g'

# Check out 1.7, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.7
RUN mkdir allvbuild/v1.7
RUN jekyll build -s allv -d allvbuild/v1.7
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.7/#g'
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.7/#g'
RUN find allvbuild/v1.7 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.7/#g'

# Check out 1.8, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.8
RUN mkdir allvbuild/v1.8
RUN jekyll build -s allv -d allvbuild/v1.8
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.8/#g'
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.8/#g'
RUN find allvbuild/v1.8 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.8/#g'

# Check out 1.9, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.9
RUN mkdir allvbuild/v1.9
RUN jekyll build -s allv -d allvbuild/v1.9
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.9/#g'
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.9/#g'
RUN find allvbuild/v1.9 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.9/#g'

# Check out 1.10, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.10
RUN mkdir allvbuild/v1.10
RUN jekyll build -s allv -d allvbuild/v1.10
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.10/#g'
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.10/#g'
RUN find allvbuild/v1.10 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.10/#g'
# The statements below pull reference docs from upstream locations,
# then build the whole site to static HTML using Jekyll

# Check out 1.11, create HTML, tweak links
RUN git --git-dir=./allv/.git --work-tree=./allv checkout v1.11
RUN mkdir allvbuild/v1.11
RUN jekyll build -s allv -d allvbuild/v1.11
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="/#href="/v1.11/#g'
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#src="/#src="/v1.11/#g'
RUN find allvbuild/v1.11 -type f -name '*.html' -print0 | xargs -0 sed -i 's#href="https://docs.docker.com/#href="/v1.11/#g'
RUN svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/reference allv/engine/reference \
&& svn co https://github.com/docker/docker/branches/$ENGINE_BRANCH/docs/extend allv/engine/extend \
&& wget -O allv/engine/deprecated.md https://raw.githubusercontent.com/docker/docker/$ENGINE_BRANCH/docs/deprecated.md \
&& svn co https://github.com/docker/distribution/branches/$DISTRIBUTION_BRANCH/docs/spec allv/registry/spec \
&& wget -O allv/registry/configuration.md https://raw.githubusercontent.com/docker/distribution/$DISTRIBUTION_BRANCH/docs/configuration.md \
&& jekyll build -s allv -d allvbuild \
&& rm -rf allv

# Serve the site, which is now all static HTML
CMD jekyll serve -s /usr/src/app/allvbuild -d /_site --no-watch -H 0.0.0.0 -P 4000
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
source "https://rubygems.org"

gem "github-pages", "104" #Update me once in a while: https://github.com/github/pages-gem/releases
gem "github-pages", "105" #Update me once in a while: https://github.com/github/pages-gem/releases
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ permalink: pretty
safe: false
lsi: false
url: https://docs.docker.com
keep_files: ["v1.4", "v1.5", "v1.6", "v1.7", "v1.8", "v1.9", "v1.10", "v1.11"]

gems:
- jekyll-redirect-from
Expand Down
14 changes: 12 additions & 2 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,8 @@ toc:
title: Configuring and running Docker
- path: /engine/admin/host_integration/
title: Automatically start containers
- path: /engine/admin/resource_constraints/
title: Limit a container's resources
- path: /engine/admin/live-restore/
title: Keep containers alive during daemon downtime
- path: /engine/admin/systemd/
Expand Down Expand Up @@ -183,6 +185,10 @@ toc:
title: Runtime metrics
- path: /engine/admin/ambassador_pattern_linking/
title: Link via an ambassador container
- sectiontitle: Troubleshoot Docker Engine
section:
- path: /engine/admin/troubleshooting_volume_errors.md
title: Troubleshoot volume problems
- sectiontitle: Manage a swarm
section:
- path: /engine/swarm/
Expand Down Expand Up @@ -637,8 +643,10 @@ toc:
title: Prior CS Engine release notes
- sectiontitle: Docker Datacenter
section:
- path: /datacenter/try/
title: Try Docker Datacenter
- path: /datacenter/install/aws/
title: Deploy Datacenter on AWS
- path: /datacenter/install/linux/
title: Deploy Datacenter on Linux
- sectiontitle: Universal Control Plane 2.0
section:
- path: /datacenter/ucp/2.0/guides/
Expand Down Expand Up @@ -765,6 +773,8 @@ toc:
title: Install offline
- path: /datacenter/dtr/2.1/guides/install/license/
title: License your deployment
- path: /datacenter/dtr/2.1/guides/install/scale-your-deployment/
title: Scale your deployment
- path: /datacenter/dtr/2.1/guides/install/upgrade/
title: Upgrade
- path: /datacenter/dtr/2.1/guides/install/uninstall/
Expand Down
4 changes: 2 additions & 2 deletions compose/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ On a Mac, install with `brew install bash-completion`

Place the completion script in `/etc/bash_completion.d/` (`/usr/local/etc/bash_completion.d/` on a Mac), using e.g.

curl -L https://raw.githubusercontent.com/docker/compose/$(docker-compose version --short)/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose
curl -L https://raw.githubusercontent.com/docker/compose/$(docker-compose version --short)/contrib/completion/bash/docker-compose -o /etc/bash_completion.d/docker-compose

Completion will be available upon next login.

Expand Down Expand Up @@ -58,4 +58,4 @@ Enjoy working with Compose faster and with less typos!
- [Get started with Rails](rails.md)
- [Get started with WordPress](wordpress.md)
- [Command line reference](./reference/index.md)
- [Compose file reference](compose-file.md)
- [Compose file reference](compose-file.md)
2 changes: 1 addition & 1 deletion compose/compose-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -1167,7 +1167,7 @@ available with Docker Engine version **1.12.0+**

Introduces the following additional parameters:

- [`link_local_ips`](compose-file.md#link_local_ips)
- [`link_local_ips`](compose-file.md#linklocalips)
- [`isolation`](compose-file.md#isolation)
- `labels` for [volumes](compose-file.md#volume-configuration-reference) and
[networks](compose-file.md#network-configuration-reference)
Expand Down
Binary file modified compose/images/rails-welcome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions compose/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ which the release page specifies, in your terminal.

The following is an example command illustrating the format:

$ curl -L "https://github.com/docker/compose/releases/download/1.8.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ curl -L "https://github.com/docker/compose/releases/download/1.9.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

If you have problems installing with `curl`, see
[Alternative Install Options](install.md#alternative-install-options).
Expand All @@ -46,7 +46,7 @@ which the release page specifies, in your terminal.
7. Test the installation.

$ docker-compose --version
docker-compose version: 1.8.1
docker-compose version: 1.9.0


## Alternative install options
Expand All @@ -69,7 +69,7 @@ to get started.
Compose can also be run inside a container, from a small bash script wrapper.
To install compose as a container run:

$ curl -L https://github.com/docker/compose/releases/download/1.8.1/run.sh > /usr/local/bin/docker-compose
$ curl -L https://github.com/docker/compose/releases/download/1.9.0/run.sh > /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose

## Master builds
Expand Down
13 changes: 4 additions & 9 deletions compose/rails.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ dependencies, you'll need to define exactly what needs to be included in the
container. This is done using a file called `Dockerfile`. To begin with, the
Dockerfile consists of:

FROM ruby:2.2.0
FROM ruby:2.3.3
RUN apt-get update -qq && apt-get install -y build-essential libpq-dev nodejs
RUN mkdir /myapp
WORKDIR /myapp
Expand All @@ -30,7 +30,7 @@ how to write Dockerfiles, see the [Docker user guide](/engine/tutorials/dockerim
Next, create a bootstrap `Gemfile` which just loads Rails. It'll be overwritten in a moment by `rails new`.

source 'https://rubygems.org'
gem 'rails', '4.2.0'
gem 'rails', '5.0.0.1'

You'll need an empty `Gemfile.lock` in order to build our `Dockerfile`.

Expand Down Expand Up @@ -99,12 +99,7 @@ If you are running Docker on Mac or Windows, you should already have ownership
of all files, including those generated by `rails new`. List the files just to
verify this.

Uncomment the line in your new `Gemfile` which loads `therubyracer`, so you've
got a Javascript runtime:

gem 'therubyracer', platforms: :ruby

Now that you've got a new `Gemfile`, you need to build the image again. (This,
If you edit `Gemfile` at this point or later, you will need to build the image again. (This,
and changes to the Dockerfile itself, should be the only times you'll need to
rebuild.)

Expand All @@ -122,7 +117,7 @@ Replace the contents of `config/database.yml` with the following:
development: &default
adapter: postgresql
encoding: unicode
database: postgres
database: myapp_development
pool: 5
username: postgres
password:
Expand Down
19 changes: 2 additions & 17 deletions cs-engine/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,33 +97,18 @@ to the `docker` group.
$ sudo apt-get update && sudo apt-get install apt-transport-https
```
4. Install additional virtual drivers not in the base image.
4. Install additional kernel modules to add AUFS support.
```bash
$ sudo apt-get install -y linux-image-extra-virtual
$ sudo apt-get install -y linux-image-extra-$(uname -r) linux-image-extra-virtual
```
You may need to reboot your server after updating the LTS kernel.
5. Add the repository for the new version:
```bash
$ echo "deb https://packages.docker.com/1.12/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list
```
This adds the repository of the latest version of CS Docker Engine for the
Ubuntu Trusty distribution. Change the "ubuntu-trusty" string to the
distribution you're using:

* debian-jessie (Debian 8)
* debian-stretch (future release)
* debian-wheezy (Debian 7)
* ubuntu-precise (Ubuntu 12.04)
* ubuntu-trusty (Ubuntu 14.04)
* ubuntu-utopic (Ubuntu 14.10)
* ubuntu-vivid (Ubuntu 15.04)
* ubuntu-wily (Ubuntu 15.10)

6. Run the following to install commercially supported Docker Engine and its
dependencies:
Expand Down
17 changes: 7 additions & 10 deletions datacenter/dtr/2.1/guides/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ install, configure, and backup DTR.

Run the following command to install DTR:

```bash
```none
# Pull the latest version of DTR
$ docker pull docker/dtr
Expand Down Expand Up @@ -98,29 +98,26 @@ replica fails.
For high-availability you should set 3, 5, or 7 DTR replicas. The nodes where
you're going to install these replicas also need to be managed by UCP.

To add replicas to a DTR cluster, use the `docker/dtr join` command. To add
replicas:
To add replicas to a DTR cluster, use the `docker/dtr join` command:

1. Make sure the DTR images are loaded into the node.
1. Load your UCP user bundle.

2. Load you UCP user bundle.

3. Run the join command.
2. Run the join command.

When you join a replica to a DTR cluster, you need to specify the
ID of a replica that is already part of the cluster. You can find an
existing replica ID by going to the **Applications** page on UCP.

Then run:

```bash
$ docker run -it --rm \
```none
docker run -it --rm \
docker/dtr join \
--ucp-node <ucp-node-name> \
--ucp-insecure-tls
```
4. Check that all replicas are running.
3. Check that all replicas are running.
In your browser, navigate to the Docker **Universal Control Plane**
web UI, and navigate to the **Applications** screen. All replicas should
Expand Down
Loading

0 comments on commit f285741

Please sign in to comment.