From cf33aaa0f19c672cf120186437d8dfb95c6e2f55 Mon Sep 17 00:00:00 2001 From: Joao Fernandes Date: Wed, 4 May 2016 13:56:57 -0700 Subject: [PATCH] Integrates feedback in docs * fixes #1472 * fixes #1411 --- .../backups-and-disaster-recovery.md | 5 +- installation/install-production.md | 12 +++- installation/system-requirements.md | 2 +- release_notes.md | 60 ++++++++++++------- 4 files changed, 51 insertions(+), 28 deletions(-) diff --git a/high-availability/backups-and-disaster-recovery.md b/high-availability/backups-and-disaster-recovery.md index bdfbc7ad08..e3df4aca69 100644 --- a/high-availability/backups-and-disaster-recovery.md +++ b/high-availability/backups-and-disaster-recovery.md @@ -48,7 +48,8 @@ The example below shows how to create a backup of a UCP controller node: # Create a backup, encrypt it, and store it on /tmp/backup.tar $ docker run --rm -i --name ucp \ -v /var/run/docker.sock:/var/run/docker.sock \ - docker/ucp --interactive --passphrase "secret" > /tmp/backup.tar + docker/ucp backup --interactive \ + --passphrase "secret" > /tmp/backup.tar # Decrypt the backup and list its contents $ gpg --decrypt /tmp/backup.tar | tar --list @@ -87,7 +88,7 @@ and your most recent backup was of node A: 1. Stop controllers B and C with the `stop` command, 2. Restore controller A, 3. Uninstall UCP from controllers B and C, -4. Join nodes B and C to the cluster. +4. Join nodes B and C as replica controllers to the cluster. You should now have your cluster up and running. diff --git a/installation/install-production.md b/installation/install-production.md index 24884f372a..7b57c22792 100644 --- a/installation/install-production.md +++ b/installation/install-production.md @@ -114,8 +114,10 @@ To install UCP: 3. Check that the UCP web application is running. In your browser, navigate to the address where you've installed UCP. + If you're not using an external CA, your browser warns that UCP is - an unsafe site. + an unsafe site. This happens because you're accessing UCP using HTTPS + but the certificates used by UCP are not trusted by your browser. ![](../images/login.png) @@ -162,11 +164,15 @@ For each node that you want to install as a controller replica: --replica ``` -3. Repeat steps 1 and 2 on the other nodes you want to set up as replicas. +3. Since UCP configures your Docker Engine for multi-host networking, it might +prompt you to restart the Docker daemon. To make the installation faster, join +all replica nodes first, and only then restart the Docker daemon on those nodes. + +4. Repeat steps 1 and 2 on the other nodes you want to set up as replicas. Make sure you set up 3, 5, or 7 controllers. -4. Check the cluster state. +5. Check the cluster state. The Dashboard page of UCP should list all your controller nodes. diff --git a/installation/system-requirements.md b/installation/system-requirements.md index 7b70ad899d..693b091b5a 100644 --- a/installation/system-requirements.md +++ b/installation/system-requirements.md @@ -23,7 +23,7 @@ all nodes must have: * 1.50 GB of RAM * 3.00 GB of available disk space * One of the supported operating systems installed: - * RHEL 7.0, 7.1 + * RHEL 7.0, 7.1, or 7.2 * Ubuntu 14.04 LTS * CentOS 7.1 * SUSE Linux Enterprise 12 diff --git a/release_notes.md b/release_notes.md index b5646f8d4f..5dd57e9dc8 100644 --- a/release_notes.md +++ b/release_notes.md @@ -20,40 +20,53 @@ weight=110 * Core * Added new commands to the docker/ucp image: backup, restore, id, - regen-certs, restart, stop - * UCP and DTR are now using a unified authentication service + regen-certs, restart, stop, + * UCP and DTR are now using a unified authentication service, * Users and teams created in UCP are displayed in DTR under the 'Datacenter' - organization - * When installing UCP, multi-host networking is Automatically configured - * All controllers joined to the cluster now have replicated CAs + organization, + * When installing UCP, multi-host networking is Automatically configured, + * All controllers joined to the cluster now have replicated CAs, * All UCP components were compiled the Go 1.5.4 and 1.6 to address Go security - vulnerabilities + vulnerabilities. ​ * UI - * Now you can deploy apps from the UI using a docker-compse.yml file + * Now you can deploy apps from the UI using a docker-compse.yml file, * There's a new setting to prevent users from deploying containers to the UCP - controller nodes - * Improved usability of LDAP configuration settings - * Images page no longer shows the sha256 id of each image ID - * User profiles now display default permissions - * Improved feedback when creating users and teams with invalid characters - * Added horizontal scrollbar to wide pages + controller nodes, + * Improved usability of LDAP configuration settings, + * Images page no longer shows the sha256 id of each image ID, + * User profiles now display default permissions, + * Improved feedback when creating users and teams with invalid characters, + * Added horizontal scrollbar to wide pages. **Bug Fixes** -* Improved messages when installing UCP on a host with firewall rules -* Images page no longer shows images generated from intermediate builds -* Images page no longer hangs when pulling an image -* Scaling a container from the UI now preserves parameters like 'net' and 'privileged' -* Fixed `docker ps --filter` to filter containers correctly +* Improved messages when installing UCP on a host with firewall rules, +* Images page no longer shows images generated from intermediate builds, +* Images page no longer hangs when pulling an image, +* Scaling a container from the UI now preserves parameters like 'net' and +'privileged', +* Fixed `docker ps --filter` to filter containers correctly. **Misc** -* You no longer need to install UCP with --swarm-experimental to use swarm container rescheduling -* All UCP containers now have the 'com.docker.ucp.version' label with their upstream version or UCP version -* When running docker/ucp in interactive mode, the parameters and environment variables passed to the command are displayed -* Renamed 'external-ucp-ca' flag to 'external-server-cert' for clarity. The first is deprecated but still available +* You no longer need to install UCP with --swarm-experimental to use swarm +container rescheduling, +* All UCP containers now have the 'com.docker.ucp.version' label with their +upstream version or UCP version, +* When running docker/ucp in interactive mode, the parameters and environment +variables passed to the command are displayed, +* Renamed 'external-ucp-ca' flag to 'external-server-cert' for clarity. +The first is deprecated but still available. + +**Known issues** + +* When joining replicas to the cluster, you may be prompted to restart the +Docker daemon on that node. For a faster installation, only restart the Docker +daemon after joining all replicas. +* When deploying applications from the UI, using the `host` network option +might cause errors. If this happens, deploy the application from the CLI. **Component Versions** @@ -65,6 +78,9 @@ UCP 1.1.0 uses: * etcd 2.2.5 * RethinkDB 2.3.0 ​ +**Upgrading** + +[Learn how to upgrade to the latest version](installation/upgrade.md) ## Version 1.0.4