Browse Source

Merge pull request #13760 from SvenDowideit/update-dhe-docs-jun-5

Bring over DHE docs updates for publishing
Sven Dowideit 10 years ago
parent
commit
159f5e0137

+ 1 - 0
docs/sources/docker-hub-enterprise/adminguide.md

@@ -1,3 +1,4 @@
+no_version_dropdown: true
 page_title: Docker Hub Enterprise: Admin guide
 page_title: Docker Hub Enterprise: Admin guide
 page_description: Documentation describing administration of Docker Hub Enterprise
 page_description: Documentation describing administration of Docker Hub Enterprise
 page_keywords: docker, documentation, about, technology, hub, enterprise
 page_keywords: docker, documentation, about, technology, hub, enterprise

+ 7 - 6
docs/sources/docker-hub-enterprise/configuration.md

@@ -1,3 +1,4 @@
+no_version_dropdown: true
 page_title: Docker Hub Enterprise: Configuration options
 page_title: Docker Hub Enterprise: Configuration options
 page_description: Configuration instructions for Docker Hub Enterprise
 page_description: Configuration instructions for Docker Hub Enterprise
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry
@@ -136,11 +137,11 @@ Continue by following the steps corresponding to your chosen OS.
 
 
 ```
 ```
     $ export DOMAIN_NAME=dhe.yourdomain.com
     $ export DOMAIN_NAME=dhe.yourdomain.com
-    $ openssl s_client -connect $DOMAIN_NAME:443 -showcerts </dev/null 2>/dev/null | openssl x509 -outform PEM | tee /usr/local/share/ca-certificates/$DOMAIN_NAME.crt
-    $ update-ca-certificates
+    $ openssl s_client -connect $DOMAIN_NAME:443 -showcerts </dev/null 2>/dev/null | openssl x509 -outform PEM | sudo tee /usr/local/share/ca-certificates/$DOMAIN_NAME.crt
+    $ sudo update-ca-certificates
     Updating certificates in /etc/ssl/certs... 1 added, 0 removed; done.
     Updating certificates in /etc/ssl/certs... 1 added, 0 removed; done.
     Running hooks in /etc/ca-certificates/update.d....done.
     Running hooks in /etc/ca-certificates/update.d....done.
-    $ service docker restart
+    $ sudo service docker restart
     docker stop/waiting
     docker stop/waiting
     docker start/running, process 29291
     docker start/running, process 29291
 ```
 ```
@@ -149,9 +150,9 @@ Continue by following the steps corresponding to your chosen OS.
 
 
 ```
 ```
     $ export DOMAIN_NAME=dhe.yourdomain.com
     $ export DOMAIN_NAME=dhe.yourdomain.com
-    $ openssl s_client -connect $DOMAIN_NAME:443 -showcerts </dev/null 2>/dev/null | openssl x509 -outform PEM | tee /etc/pki/ca-trust/source/anchors/$DOMAIN_NAME.crt
-    $ update-ca-trust
-    $ /bin/systemctl restart docker.service
+    $ openssl s_client -connect $DOMAIN_NAME:443 -showcerts </dev/null 2>/dev/null | openssl x509 -outform PEM | sudo tee /etc/pki/ca-trust/source/anchors/$DOMAIN_NAME.crt
+    $ sudo update-ca-trust
+    $ sudo /bin/systemctl restart docker.service
 ```
 ```
 
 
 #### Boot2Docker 1.6.0
 #### Boot2Docker 1.6.0

+ 7 - 0
docs/sources/docker-hub-enterprise/index.md

@@ -1,3 +1,4 @@
+no_version_dropdown: true
 page_title: Docker Hub Enterprise: Overview
 page_title: Docker Hub Enterprise: Overview
 page_description: Docker Hub Enterprise
 page_description: Docker Hub Enterprise
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry
@@ -31,6 +32,12 @@ DHE is perfect for:
 
 
 DHE is built on [version 2 of the Docker registry](https://github.com/docker/distribution).
 DHE is built on [version 2 of the Docker registry](https://github.com/docker/distribution).
 
 
+> **Note:** This initial release of DHE has limited access. To get access,
+> you will need an account on [Docker Hub](https://hub.docker.com/). Once you're
+> logged in to the Hub with your account, visit the
+> [early access registration page](https://registry.hub.docker.com/earlyaccess/)
+> and follow the steps there to get signed up.
+
 ## Available Documentation
 ## Available Documentation
 
 
 The following documentation for DHE is available:
 The following documentation for DHE is available:

+ 18 - 3
docs/sources/docker-hub-enterprise/install.md

@@ -1,3 +1,4 @@
+no_version_dropdown: true
 page_title: Docker Hub Enterprise: Install
 page_title: Docker Hub Enterprise: Install
 page_description: Installation instructions for Docker Hub Enterprise
 page_description: Installation instructions for Docker Hub Enterprise
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry
@@ -20,6 +21,12 @@ Specifically, installation requires completion of these steps, in order:
 3. Install DHE
 3. Install DHE
 4. Add your license to your DHE instance
 4. Add your license to your DHE instance
 
 
+> **Note:** This initial release of DHE has limited access. To get access,
+> you will need an account on [Docker Hub](https://hub.docker.com/). Once you're
+> logged in to the Hub with your account, visit the
+> [early access registration page](https://registry.hub.docker.com/earlyaccess/)
+> and follow the steps there to get signed up.
+
 ## Licensing
 ## Licensing
 
 
 In order to run DHE, you will need to acquire a license, either by purchasing
 In order to run DHE, you will need to acquire a license, either by purchasing
@@ -108,6 +115,8 @@ following to install commercially supported Docker Engine and its dependencies:
 
 
 ```
 ```
 $ sudo apt-get update && sudo apt-get upgrade
 $ sudo apt-get update && sudo apt-get upgrade
+$ sudo apt-get install -y linux-image-extra-virtual
+$ sudo reboot
 $ chmod 755 docker-cs-engine-deb.sh
 $ chmod 755 docker-cs-engine-deb.sh
 $ sudo ./docker-cs-engine-deb.sh
 $ sudo ./docker-cs-engine-deb.sh
 $ sudo apt-get install docker-engine-cs
 $ sudo apt-get install docker-engine-cs
@@ -139,19 +148,25 @@ so upgrading the Engine only requires you to run the update commands on your ser
 
 
 ### RHEL 7.0/7.1 upgrade
 ### RHEL 7.0/7.1 upgrade
 
 
-To upgrade CS Docker Engine, run the following command:
+The following commands will stop the running DHE, upgrade CS Docker Engine,
+and then start DHE again:
 
 
 ```
 ```
+    $ sudo bash -c "$(sudo docker run dockerhubenterprise/manager stop)"
     $ sudo yum update
     $ sudo yum update
     $ sudo systemctl daemon-reload && sudo systemctl restart docker
     $ sudo systemctl daemon-reload && sudo systemctl restart docker
+    $ sudo bash -c "$(sudo docker run dockerhubenterprise/manager start)"
 ```
 ```
 
 
 ### Ubuntu 14.04 LTS upgrade
 ### Ubuntu 14.04 LTS upgrade
 
 
-To upgrade CS Docker Engine, run the following command:
+The following commands will stop the running DHE, upgrade CS Docker Engine,
+and then start DHE again:
 
 
 ```
 ```
-   $ sudo apt-get update && sudo apt-get dist-upgrade docker-engine-cs
+    $ sudo bash -c "$(sudo docker run dockerhubenterprise/manager stop)"
+    $ sudo apt-get update && sudo apt-get dist-upgrade docker-engine-cs
+    $ sudo bash -c "$(sudo docker run dockerhubenterprise/manager start)"
 ```
 ```
 
 
 ## Installing Docker Hub Enterprise
 ## Installing Docker Hub Enterprise

+ 19 - 18
docs/sources/docker-hub-enterprise/quick-start.md

@@ -1,3 +1,4 @@
+no_version_dropdown: true
 page_title: Docker Hub Enterprise: Quick-start: Basic Workflow
 page_title: Docker Hub Enterprise: Quick-start: Basic Workflow
 page_description: Brief tutorial on the basics of Docker Hub Enterprise user workflow
 page_description: Brief tutorial on the basics of Docker Hub Enterprise user workflow
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry, image, repository
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry, image, repository
@@ -8,7 +9,7 @@ page_keywords: docker, documentation, about, technology, understanding, enterpri
 ## Overview
 ## Overview
 
 
 This Quick Start Guide will give you a hands-on look at the basics of using
 This Quick Start Guide will give you a hands-on look at the basics of using
-Docker Hub Enterprise (DHE), Dockers on-premise image storage application.
+Docker Hub Enterprise (DHE), Docker's on-premise image storage application.
 This guide will walk you through using DHE to complete a typical, and critical,
 This guide will walk you through using DHE to complete a typical, and critical,
 part of building a development pipeline: setting up a Jenkins instance. Once you
 part of building a development pipeline: setting up a Jenkins instance. Once you
 complete the task, you should have a good idea of how DHE works and how it might
 complete the task, you should have a good idea of how DHE works and how it might
@@ -17,9 +18,9 @@ be useful to you.
 Specifically, this guide demonstrates the process of retrieving the
 Specifically, this guide demonstrates the process of retrieving the
 [official Docker image for Jenkins](https://registry.hub.docker.com/_/jenkins/),
 [official Docker image for Jenkins](https://registry.hub.docker.com/_/jenkins/),
 customizing it to suit your needs, and then hosting it on your private instance
 customizing it to suit your needs, and then hosting it on your private instance
-of DHE located inside your enterprises firewalled environment. Your developers
+of DHE located inside your enterprise's firewalled environment. Your developers
 will then be able to retrieve the custom Jenkins image in order to use it to
 will then be able to retrieve the custom Jenkins image in order to use it to
-build CI/CD infrastructure for their projects, no matter the platform theyre
+build CI/CD infrastructure for their projects, no matter the platform they're
 working from, be it a laptop, a VM, or a cloud provider.
 working from, be it a laptop, a VM, or a cloud provider.
 
 
 The guide will walk you through the following steps:
 The guide will walk you through the following steps:
@@ -72,12 +73,12 @@ Docker will start the process of pulling the image from the Hub. Once it has com
 
 
 ## Customizing the Jenkins image
 ## Customizing the Jenkins image
 
 
-Now that you have a local copy of the Jenkins image, youll customize it so that
+Now that you have a local copy of the Jenkins image, you'll customize it so that
 the containers it builds will integrate with your infrastructure. To do this,
 the containers it builds will integrate with your infrastructure. To do this,
-youll create a custom Docker image that adds a Jenkins plugin that provides
-fine grained user management. Youll also configure Jenkins to be more secure by
+you'll create a custom Docker image that adds a Jenkins plugin that provides
+fine grained user management. You'll also configure Jenkins to be more secure by
 disabling HTTP access and forcing it to use HTTPS.
 disabling HTTP access and forcing it to use HTTPS.
-Youll do this by using a `Dockerfile` and the `docker build` command.
+You'll do this by using a `Dockerfile` and the `docker build` command.
 
 
 > **Note:** These are obviously just a couple of examples of the many ways you
 > **Note:** These are obviously just a couple of examples of the many ways you
 > can modify and configure Jenkins. Feel free to add or substitute whatever
 > can modify and configure Jenkins. Feel free to add or substitute whatever
@@ -105,11 +106,11 @@ line:
 
 
 (The plugin version used above was the latest version at the time of writing.)
 (The plugin version used above was the latest version at the time of writing.)
 
 
-2. You will also need to make copies of the server’s private key and certificate. Give the copies the following names — `https.key` and `https.pem`.
+2. You will also need to make copies of the server's private key and certificate. Give the copies the following names - `https.key` and `https.pem`.
 
 
 > **Note:** Because creating new keys varies widely by platform and
 > **Note:** Because creating new keys varies widely by platform and
-> implementation, this guide wont cover key generation. We assume you have
-> access to existing keys. If you don’t have access, or can’t generate keys
+> implementation, this guide won't cover key generation. We assume you have
+> access to existing keys. If you don't have access, or can't generate keys
 > yourself, feel free to skip the steps involving them and HTTPS config. The
 > yourself, feel free to skip the steps involving them and HTTPS config. The
 > guide will still walk you through building a custom Jenkins image and pushing
 > guide will still walk you through building a custom Jenkins image and pushing
 > and pulling that image using DHE.
 > and pulling that image using DHE.
@@ -142,7 +143,7 @@ defining with the `Dockerfile`.
 The `RUN` instruction will execute the `/usr/local/bin/plugins.sh` script with
 The `RUN` instruction will execute the `/usr/local/bin/plugins.sh` script with
 the newly copied `plugins` file, which will install the listed plugin.
 the newly copied `plugins` file, which will install the listed plugin.
 
 
-The next two `COPY` instructions copy the servers private key and certificate
+The next two `COPY` instructions copy the server's private key and certificate
 into the required directories within the new image.
 into the required directories within the new image.
 
 
 The `ENV` instruction creates an environment variable called `JENKINS_OPT` in
 The `ENV` instruction creates an environment variable called `JENKINS_OPT` in
@@ -156,8 +157,8 @@ tell Jenkins to disable HTTP and operate over HTTPS.
 
 
 The `Dockerfile`, the `plugins` file, as well as the private key and
 The `Dockerfile`, the `plugins` file, as well as the private key and
 certificate, must all be in the same directory because the `docker build`
 certificate, must all be in the same directory because the `docker build`
-command uses the directory that contains the `Dockerfile` as its build
-context”. Only files contained within that “build context” will be included in
+command uses the directory that contains the `Dockerfile` as its "build
+context". Only files contained within that "build context" will be included in
 the image being built.
 the image being built.
 
 
 ### Building your custom image
 ### Building your custom image
@@ -169,7 +170,7 @@ custom image using the
 
 
     docker build -t dhe.yourdomain.com/ci-infrastructure/jnkns-img .
     docker build -t dhe.yourdomain.com/ci-infrastructure/jnkns-img .
 
 
-> **Note:** Dont miss the period (`.`) at the end of the command above. This
+> **Note:** Don't miss the period (`.`) at the end of the command above. This
 > tells the `docker build` command to use the current working directory as the
 > tells the `docker build` command to use the current working directory as the
 > "build context".
 > "build context".
 
 
@@ -214,7 +215,7 @@ image pulled earlier:
 >     ?scope=repository%3Ahello-world%3Apull%2Cpush&service=dhe.yourdomain.com
 >     ?scope=repository%3Ahello-world%3Apull%2Cpush&service=dhe.yourdomain.com
 >     request failed with status: 401 Unauthorized
 >     request failed with status: 401 Unauthorized
 
 
-Now that youve created the custom image, it can be pushed to DHE using the
+Now that you've created the custom image, it can be pushed to DHE using the
 [`docker push`command](https://docs.docker.com/reference/commandline/cli/#push):
 [`docker push`command](https://docs.docker.com/reference/commandline/cli/#push):
 
 
     $ docker push dhe.yourdomain.com/ci-infrastructure/jnkns-img
     $ docker push dhe.yourdomain.com/ci-infrastructure/jnkns-img
@@ -263,7 +264,7 @@ in the output of the `docker images` command:
 
 
 ## Launching a custom Jenkins container
 ## Launching a custom Jenkins container
 
 
-Now that youve successfully pulled the customized Jenkins image from DHE, you
+Now that you've successfully pulled the customized Jenkins image from DHE, you
 can create a container from it with the
 can create a container from it with the
 [`docker run` command](https://docs.docker.com/reference/commandline/cli/#run):
 [`docker run` command](https://docs.docker.com/reference/commandline/cli/#run):
 
 
@@ -299,7 +300,7 @@ You can view the newly launched a container, called `jenkins01`, using the
 
 
 The previous `docker run` command mapped port `1973` on the container to port
 The previous `docker run` command mapped port `1973` on the container to port
 `1973` on the Docker host, so the Jenkins Web UI can be accessed at
 `1973` on the Docker host, so the Jenkins Web UI can be accessed at
-`https://<docker-host>:1973` (Dont forget the `s` at the end of `https`.)
+`https://<docker-host>:1973` (Don't forget the `s` at the end of `https`.)
 
 
 > **Note:** If you are using a self-signed certificate, you may get a security
 > **Note:** If you are using a self-signed certificate, you may get a security
 > warning from your browser telling you that the certificate is self-signed and
 > warning from your browser telling you that the certificate is self-signed and
@@ -315,7 +316,7 @@ plugin should be present with the `Uninstall` button available to the right.
 ![Jenkins plugin manager](../assets/jenkins-plugins.png)
 ![Jenkins plugin manager](../assets/jenkins-plugins.png)
 
 
 In another browser session, try to access Jenkins via the default HTTP port 8080
 In another browser session, try to access Jenkins via the default HTTP port 8080
- `http://<docker-host>:8080`. This should result in a “connection timeout,”
+ `http://<docker-host>:8080`. This should result in a "connection timeout",
 showing that Jenkins is not available on its default port 8080 over HTTP.
 showing that Jenkins is not available on its default port 8080 over HTTP.
 
 
 This demonstration shows your Jenkins image has been configured correctly for
 This demonstration shows your Jenkins image has been configured correctly for

+ 1 - 0
docs/sources/docker-hub-enterprise/release-notes.md

@@ -1,3 +1,4 @@
+no_version_dropdown: true
 page_title: Docker Hub Enterprise: Release notes
 page_title: Docker Hub Enterprise: Release notes
 page_description: Release notes for Docker Hub Enterprise
 page_description: Release notes for Docker Hub Enterprise
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry, release
 page_keywords: docker, documentation, about, technology, understanding, enterprise, hub, registry, release