diff --git a/certs.md b/certs.md index 73978cede1..2e0014e5ec 100644 --- a/certs.md +++ b/certs.md @@ -1,11 +1,13 @@ + - -# Manually setting up a CA +# Manually set up a Certificate Authority A few features of UCP require an external CA (cfssl or equivalent) to sign certs. By default in developer mode, these services aren't created (maybe we'll diff --git a/deploy-application.md b/deploy-application.md new file mode 100644 index 0000000000..7e47adcdff --- /dev/null +++ b/deploy-application.md @@ -0,0 +1,46 @@ + + + +# Deploy an application thru UCP + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + +## Understand the development workflow + Diagram of expected workflow + +## Step 1: Review the Compose file node requirements +* images +* nodes +* volumes +* networks + +## Step 2: Add nodes for supporting application + +tbd + +## Step 3: Import Compose file into UCP + +tbd + +## Step 4: Scaling an application +* existing load balancer +* adding a load balancer + +## Step 4: Verify the deployment +* Dashboard +* Images + +## Step 5: Review UCP logs + +tbd + +## Troubleshooting section diff --git a/evaluation-install.md b/evaluation-install.md new file mode 100644 index 0000000000..82d353298f --- /dev/null +++ b/evaluation-install.md @@ -0,0 +1,707 @@ + + + +# Evaluation installation + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + +## Step 1: Learn a little about UCP + +tbd + +## Step 2: Verify you have the prerequisites + +tbd + +## Step 3: Install the CS Engine AMI + +tbd + +## Step 4: Install the UCP controller + +tbd + +## Step 5: Install a License + +tbd + +## Step 6: Add an Engine node to the UCP cluster + +tbd + +## Step 7: Create a container network + +tbd + +## Step 8: Launch an application on your network + +tbd + +## Step 9: Try your application + +tbd + +## Step 11: Work with a client bundle + +tbd + +## Step 12: Challenge yourself + +tbd + +## Upgrade UCP + +tbd + +## Where to Go Next + + + diff --git a/index.md b/index.md index 1c9cc1943a..34b6a6760d 100644 --- a/index.md +++ b/index.md @@ -1,20 +1,25 @@ + +# Docker Universal Control Plane -# Docker Universal Control Plane BETA docs +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. -The following are available: +## Deploy, manage, and monitor Docker Engine resources -* [Release Notes](release_notes.md) -* [UCP Quickstart Guide](installation.md) -* [Key/Value Store Backends](kv_store.md) -* [Manually setting up a CA](certs.md) -* [Set up container networking with UCP](networking.md) -* [Set up high availability](understand_ha.md) -* [Work with Docker Support](support.md) +tbd + +## Secure communications + +tbd + +## Control user access + +tbd diff --git a/kv_store.md b/kv_store.md index 150b56e592..ffc8fad02e 100644 --- a/kv_store.md +++ b/kv_store.md @@ -1,9 +1,11 @@ + # UCP Key/Value Store Backend diff --git a/manage/index.md b/manage/index.md new file mode 100644 index 0000000000..2c04758bfd --- /dev/null +++ b/manage/index.md @@ -0,0 +1,20 @@ + + +# UCP resource management and monitoring + +* [Your UCP installation](monitor-ucp.md) +* [Applications](monitor-manage-applications.md) +* [Containers](monitor-manage-containers.md) +* [Images](monitor-manage-images.md) +* [Container networks](monitor-manage-networks.md) +* [Users](monitor-manage-users.md) +* [volumes](monitor-manage-volumes.md) diff --git a/manage/monitor-manage-applications.md b/manage/monitor-manage-applications.md new file mode 100644 index 0000000000..cf0e6e58e8 --- /dev/null +++ b/manage/monitor-manage-applications.md @@ -0,0 +1,26 @@ + + +# Monitor, manage, and troubleshoot applications + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## Understand applications and UCP +* version matrix +* which features are supported +* features that aren’t supported +* requirements + +## Review applications on UCP + +tbd + +## Troubleshoot applications diff --git a/manage/monitor-manage-containers.md b/manage/monitor-manage-containers.md new file mode 100644 index 0000000000..5a2dc6e09d --- /dev/null +++ b/manage/monitor-manage-containers.md @@ -0,0 +1,32 @@ + + +# Monitor, manage, and troubleshoot containers + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## Understand containers and UCP + +* UCP launch +* Compose launch +* CLI launch + +## Getting container information + +tbd + +## Monitoring container resources + Best practices document for monitoring Docker containers (if there is one) + +## Restricting container launch + +* From UCP +* From ClI diff --git a/manage/monitor-manage-images.md b/manage/monitor-manage-images.md new file mode 100644 index 0000000000..176ffe3b7b --- /dev/null +++ b/manage/monitor-manage-images.md @@ -0,0 +1,37 @@ + + +# Monitor, manage, and troubleshoot images + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + +## Understand images and UCP +* Which registries can users pull images from +* Image “life cycle” for admins (graphic) + +## Explain how to pull images by example +* GUI +* Contrast with command-line +* Compose for automated pulls + +## Update or review images through UCP + +tbd + +## Ensure containers run the correct image + +tbd + +## Content Trust in UCP + +tbd + +## Troubleshooting image problems +if a container is running an old image (how to tell) diff --git a/manage/monitor-manage-networks.md b/manage/monitor-manage-networks.md new file mode 100644 index 0000000000..739a7f1a97 --- /dev/null +++ b/manage/monitor-manage-networks.md @@ -0,0 +1,25 @@ + + +# Monitor, manage, and troubleshoot networks + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + +## Understand container networks and UCP + +tbd + +## Review networks on UCP + +tbd + +## Restricting network launches +* From UCP +* From CLI diff --git a/manage/monitor-manage-users.md b/manage/monitor-manage-users.md new file mode 100644 index 0000000000..a76a940f0f --- /dev/null +++ b/manage/monitor-manage-users.md @@ -0,0 +1,28 @@ + + +# Monitor, manage, and troubleshoot Users + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## Understand UCP user roles + +tbd + +## Importing users from LDAP + +tbd + +## Manually creating users + +tbd + +## Troubleshoot problems with Users diff --git a/manage/monitor-manage-volumes.md b/manage/monitor-manage-volumes.md new file mode 100644 index 0000000000..e0cf4bd6e0 --- /dev/null +++ b/manage/monitor-manage-volumes.md @@ -0,0 +1,26 @@ + + +# Monitor, manage, and troubleshoot volumes + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## Understand volumes and UCP +* bind mounted volumes +* data volume container + +## Review volumes on UCP + +tbd + +## Troubleshoot volumes + +tbd diff --git a/manage/monitor-ucp.md b/manage/monitor-ucp.md new file mode 100644 index 0000000000..4f26cbf557 --- /dev/null +++ b/manage/monitor-ucp.md @@ -0,0 +1,45 @@ + + +# Monitor, manage, troubleshoot your UCP installation + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## Understand UCP process +* controller +* nodes +* images +* Swarm +* Discovery + +## Configure UCP logging + + +tbd + +## Getting Status from the command line +Using Client Bundle, you can get access to UCP stats, but you can also bypass UCP to get stats directly from Swarm or specific nodes. Admins can use this to troubleshoot UCP if it is not working. Steps below: + +1. Download client bundle on to your desktop and +2. run (e.g. “eval $( info”. +The “-H” flag allows you to access stats for a specific host +5. Can also run “docker –H tcp: version” for version data + +## Review UCP logs + + +tbd + +## Requesting support diff --git a/networking.md b/networking.md index 32d2bdb7d9..e2f213776c 100644 --- a/networking.md +++ b/networking.md @@ -1,9 +1,11 @@ + # Set up container networking with UCP diff --git a/overview.md b/overview.md new file mode 100644 index 0000000000..1ef00897a6 --- /dev/null +++ b/overview.md @@ -0,0 +1,36 @@ + + + + +# UCP overview + +* [Overview](overview.md) +* [Evaluation installation](evaluation-install.md) +* [Plan a production installation](plan-production-install.md) +* [Install UCP for production](production-install.md) +* [Upgrade a production installation](production-upgrade.md) +* [Manage, monitor, and troubleshoot UCP and its resources](manage/index.md) +* [Commands reference](reference/index.md) +* [Work with Docker Support](support.md) +* [UCP Release Notes](release_notes.md) + +* [UCP Key/Value Store Backend](kv_store.md) +* [Set up container networking with UCP](networking.md) +* [Set up high availability](understand_ha.md) +* [Manually set up a Certificate Authority](certs.md) +* [Deploy an application thru UCP](deploy-application.md) diff --git a/plan-production-install.md b/plan-production-install.md new file mode 100644 index 0000000000..3ef1e9c96c --- /dev/null +++ b/plan-production-install.md @@ -0,0 +1,781 @@ + + +# Plan a production installation + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## What is installed + +tbd + +## About the bootstrapper + +tbd + +### UCP Component architecture + +tbd + +#### controller + +tbd + +#### nodes + +tbd + +#### images + +tbd + +#### containers + +tbd + +### CS Docker Engine + +tbd + +### Docker Swarm + +tbd + +### Key/value Store + +tbd + +## Understand your installation options + +tbd + +### Evaluation install is a good trial to do + +tbd + +### AMI or manual installation + +tbd + +### Default versus the custom installation options + +tbd + +### Mix panel analytics + +tbd + +## Network considerations + +tbd + +### Port numbers + +tbd + +### Swarm Manager + +tbd + +### Data Volumes + +tbd + +### High availability + +tbd + +### Discovery + +tbd + +## Security Considerations + +tbd + +### Certificate authority + +tbd + +### Controlling user access + +tbd + +## Docker Engine Configuration + +tbd + +### Starting the daemon + +tbd + +### Docker CLI and the certificate bundle + +tbd + +## Installation checklist + +tbd + +### Hardware and software requirements + +tbd + +### IP addresses and fully-qualified domain names + +tbd + +### Subject alternative names (SANs) + +tbd + +## Where to go next + + + diff --git a/production-install.md b/production-install.md new file mode 100644 index 0000000000..23fa55b01c --- /dev/null +++ b/production-install.md @@ -0,0 +1,700 @@ + + +# Install UCP for production + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## Step 1: Prepare the properly + +tbd + +## Step 2: Configure your network for UCP + +tbd + +## Step 3: Install Docker CS Engine 1.9 on each node + +tbd + +## Step 4: Create user-named volumes + +tbd + +## Step 5: Configure user-supplied certificates + +tbd + +## Step 5: Install the UCP controller + +tbd + +## Step 6: Add a controller replica to the UCP cluster + +tbd + +## Step 7: Add an Engine node to the UCP cluster + +tbd + +## Step 8: Set up certs for the Docker CLI + +tbd + +## Block Mixpanel analytics + +tbd + +## Uninstall + +tbd + +## Where to go next + + diff --git a/installation.md b/production-upgrade.md similarity index 98% rename from installation.md rename to production-upgrade.md index 39b0e8faf5..0a4f50fb4b 100644 --- a/installation.md +++ b/production-upgrade.md @@ -1,10 +1,29 @@ + +# Upgrade a production installation + +Intro 1-2 paras, page purpose, intended user, list steps if page is tutorial. + + +## Plan your upgrade + +tbd + +## Upgrade procedure + +tbd + + + diff --git a/reference/index.md b/reference/index.md index 9c2fc98f17..ec47c8469b 100644 --- a/reference/index.md +++ b/reference/index.md @@ -1,12 +1,12 @@ +++ -title = "ucp Tool" +title = "ucp tool Reference" description = "Run UCP commands" [menu.main] identifier = "ucp_ref" parent = "mn_ucp" +++ -# ucp Tool +# ucp tool Reference ``` diff --git a/release_notes.md b/release_notes.md index 71f6ecbb14..08bfdd96d0 100644 --- a/release_notes.md +++ b/release_notes.md @@ -1,10 +1,12 @@ + # UCP Release Notes diff --git a/support.md b/support.md index f32dd5f607..b91e7f7cfa 100644 --- a/support.md +++ b/support.md @@ -1,10 +1,12 @@ + # Work with Docker Support diff --git a/understand_ha.md b/understand_ha.md index 1f87beef9d..fb9a4378c2 100644 --- a/understand_ha.md +++ b/understand_ha.md @@ -1,9 +1,11 @@ + # Set up high availability