From 5abd98b9788ba0baacc915d895fceeb0b8c43d52 Mon Sep 17 00:00:00 2001 From: Ross Gardler Date: Thu, 3 Nov 2016 07:55:05 -0700 Subject: [PATCH] Various docs tweaks (#64) * add missing SSHKeyManagement.md * more obvious link to deployment instructions * turns out the SSH doc was moved but under a different name, fixing link and removing my version of the file * add a link to ACOM DC/OS docs * remove Windows docs as this is still a private preview * DCOS -> DC/OS * more DCOS -> DC/OS --- README.md | 8 ++--- docs/README.md | 3 +- docs/acsengine.md | 6 ++-- docs/dcos.md | 6 +++- examples/README.md | 4 +-- examples/dcos-versions/README.md | 10 +++--- examples/windows/README.md | 9 ----- examples/windows/swarm.json | 47 ------------------------ examples/windows/swarmWinAndLin.json | 53 ---------------------------- examples/windows/swarmvolumes.json | 49 ------------------------- 10 files changed, 19 insertions(+), 176 deletions(-) delete mode 100644 examples/windows/README.md delete mode 100644 examples/windows/swarm.json delete mode 100644 examples/windows/swarmWinAndLin.json delete mode 100644 examples/windows/swarmvolumes.json diff --git a/README.md b/README.md index d7d39652e3..9c0aee6991 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,15 @@ ## Overview -The Azure Container Service Engine (`acs-engine`) generates ARM (Azure Resource Manager) templates for Docker enabled clusters on Microsoft Azure with your choice of DCOS, Kubernetes, or Swarm orchestrators. The input to the tool is a cluster definition. The cluster definition is very similar to (in many cases the same as) the ARM template syntax used to deploy a Microsoft Azure Container Service cluster. +The Azure Container Service Engine (`acs-engine`) generates ARM (Azure Resource Manager) templates for Docker enabled clusters on Microsoft Azure with your choice of DC/OS, Kubernetes, or Swarm orchestrators. The input to the tool is a cluster definition. The cluster definition is very similar to (in many cases the same as) the ARM template syntax used to deploy a Microsoft Azure Container Service cluster. The cluster definition file enables the following customizations to your Docker enabled cluster: -* choice of DCOS, Kubernetes, or Swarm orchestrators +* choice of DC/OS, Kubernetes, or Swarm orchestrators * multiple agent pools where each agent pool can specify: * standard or premium VM Sizes, * node count, * Virtual Machine ScaleSets or Availability Sets, * Storage Account Disks or Managed Disks (under private preview), - * and Linux or Microsoft Windows. * Docker cluster sizes of 1200 * Custom VNET @@ -19,14 +18,13 @@ The cluster definition file enables the following customizations to your Docker * [ACS Engine](docs/acsengine.md) - shows you how to build and use the ACS engine to generate custom Docker enabled container clusters * [Cluster Definition](docs/clusterdefinition.md) - describes the components of the cluster definition file -* [DCOS Walkthrough](docs/dcos.md) - shows how to create a DCOS enabled Docker cluster on Azure +* [DC/OS Walkthrough](docs/dcos.md) - shows how to create a DC/OS enabled Docker cluster on Azure * [Kubernetes Walkthrough](docs/kubernetes.md) - shows how to create a Kubernetes enabled Docker cluster on Azure * [Swarm Walkthrough](docs/swarm.md) - shows how to create a Swarm enabled Docker cluster on Azure * [Custom VNET](examples/vnet) - shows how to use a custom VNET * [Attached Disks](examples/disks-storageaccount) - shows how to attach up to 4 disks per node * [Managed Disks](examples/disks-managed) (under private preview) - shows how to use managed disks * [Large Clusters](examples/largeclusters) - shows how to create cluster sizes of up to 1200 nodes -* [Windows Clusters](examples/windows) - shows how to create windows or mixed Microsoft Windows and Linux Docker clusters on Microsoft Azure ## Development (Docker) diff --git a/docs/README.md b/docs/README.md index 1555750f79..b9b3a289a4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,11 +8,10 @@ This cluster definition examples demonstrate how to create a customized Docker E * [ACS Engine](acsengine.md) - shows you how to build and use the ACS engine to generate custom Docker enabled container clusters * [Cluster Definition](clusterdefinition.md) - describes the components of the cluster definition file -* [DCOS Walkthrough](dcos.md) - shows how to create a DCOS enabled Docker cluster on Azure +* [DC/OS Walkthrough](dcos.md) - shows how to create a DC/OS enabled Docker cluster on Azure * [Kubernetes Walkthrough](kubernetes.md) - shows how to create a Kubernetes enabled Docker cluster on Azure * [Swarm Walkthrough](swarm.md) - shows how to create a Swarm enabled Docker cluster on Azure * [Custom VNET](../examples/vnet) - shows how to use a custom VNET * [Attached Disks](../examples/disks-storageaccount) - shows how to attach up to 4 disks per node * [Managed Disks](../examples/disks-managed) (under private preview) - shows how to use managed disks * [Large Clusters](../examples/largeclusters) - shows how to create cluster sizes of up to 1200 nodes -* [Windows Clusters](../examples/windows) - shows how to create windows or mixed Microsoft Windows and Linux Docker clusters on Microsoft Azure \ No newline at end of file diff --git a/docs/acsengine.md b/docs/acsengine.md index 57a4d1c99b..c56a350172 100644 --- a/docs/acsengine.md +++ b/docs/acsengine.md @@ -65,11 +65,11 @@ As a rule of thumb you should always work with the `apimodel.json` when modifyin Here is an example of how to generate a new deployment. This example assumes you are using [examples/dcos.json](../examples/dcos.json). -1. Before starting ensure you have generated a valid [SSH Public/Private key pair](SSHKeyManagement.md). +1. Before starting ensure you have generated a valid [SSH Public/Private key pair](ssh.md#ssh-key-generation). 2. edit [examples/dcos.json](../examples/dcos.json) and fill in the blanks. 3. run `acs-engine examples/dcos.json` to generate the templates in the _output/DCOS184-UNIQUEID directory. The UNIQUEID is a hash of your master's FQDN prefix. -4. now you can use the `azuredeploy.json` and `azuredeploy.parameters.json` for deployment +4. now you can use the `azuredeploy.json` and `azuredeploy.parameters.json` for deployment as described in [deployment usage](../README.md#deployment-usage). # Deploying templates -For deployment see [deployment usage](../README.md#deployment-usage). \ No newline at end of file +For deployment see [deployment usage](../README.md#deployment-usage). diff --git a/docs/dcos.md b/docs/dcos.md index e755983b10..8f2214efb9 100644 --- a/docs/dcos.md +++ b/docs/dcos.md @@ -2,7 +2,7 @@ ## Deployment -Here are the steps to deploy a simple DCOS cluster: +Here are the steps to deploy a simple DC/OS cluster: 1. [install acs-engine](acsengine.md#downloading-and-building-acs-engine) 2. [generate your ssh key](ssh.md#ssh-key-generation) @@ -119,6 +119,10 @@ This walk through is inspired by the wonderful digital ocean tutorial: https://w Here are recommended links to learn more about DC/OS: +1. [Azure DC/OS documentation](https://azure.microsoft.com/en-us/documentation/services/container-service/) + +## DC/OS Community Documentation + 1. [DC/OS Overview](https://dcos.io/docs/1.8/overview/) - provides overview of DC/OS, Architecture, Features, and Concepts. 2. [DC/OS Tutorials](https://docs.mesosphere.com/1.8/usage/tutorials/) - provides various tutorials for DC/OS. diff --git a/examples/README.md b/examples/README.md index e4a0654229..3519ce5961 100644 --- a/examples/README.md +++ b/examples/README.md @@ -8,11 +8,11 @@ This cluster definition examples demonstrate how to create a customized Docker E * [ACS Engine](../docs/acsengine.md) - shows you how to use the ACS engine to generate custom Docker enabled container clusters * [Cluster Definition](../docs/clusterdefinition.md) - describes the components of the cluster definition file -* [DCOS Walkthrough](../docs/dcos.md) - shows how to create a DCOS enabled Docker cluster on Azure +* [DC/OS Walkthrough](../docs/dcos.md) - shows how to create a DC/OS enabled Docker cluster on Azure * [Kubernetes Walkthrough](../docs/kubernetes.md) - shows how to create a Kubernetes enabled Docker cluster on Azure * [Swarm Walkthrough](../docs/swarm.md) - shows how to create a Swarm enabled Docker cluster on Azure * [Custom VNET](vnet) - shows how to use a custom VNET * [Attached Disks](disks-storageaccount) - shows how to attach up to 4 disks per node * [Managed Disks](disks-managed) (under private preview) - shows how to use managed disks * [Large Clusters](largeclusters) - shows how to create cluster sizes of up to 1200 nodes -* [Windows Clusters](windows) - shows how to create windows or mixed Microsoft Windows and Linux Docker clusters on Microsoft Azure \ No newline at end of file +* [Windows Clusters](windows) - shows how to create windows or mixed Microsoft Windows and Linux Docker clusters on Microsoft Azure diff --git a/examples/dcos-versions/README.md b/examples/dcos-versions/README.md index 748873f01f..b1e618e76f 100644 --- a/examples/dcos-versions/README.md +++ b/examples/dcos-versions/README.md @@ -1,12 +1,12 @@ -# Microsoft Azure Container Service Engine - DCOS Versions +# Microsoft Azure Container Service Engine - DC/OS Versions ## Overview -This section provides example templates enable creation of Docker enabled cluster with older version of the DCOS orchestrator. +This section provides example templates enable creation of Docker enabled cluster with older version of the DC/OS orchestrator. Here are the supported versions: -1. DCOS1.7.3 - released July 27, 2016. Access by specifying `DCOS173`. -2. DCOS1.8.4 - released Sept 15, 2016. Access by specifying `DCOS184`. +1. DC/OS1.7.3 - released July 27, 2016. Access by specifying `DCOS173`. +2. DC/OS1.8.4 - released Sept 15, 2016. Access by specifying `DCOS184`. -Deploying and using [DC/OS](../../docs/dcos.md) \ No newline at end of file +Deploying and using [DC/OS](../../docs/dcos.md) diff --git a/examples/windows/README.md b/examples/windows/README.md deleted file mode 100644 index 5dc79d3289..0000000000 --- a/examples/windows/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Microsoft Azure Container Service Engine - Windows - -## Overview - -These examples show you how to build a customized Docker enabled cluster on Microsoft Azure where you can setup Windows Agents. - -Swarm is the only orchestrator that supports windows. Use any of the attached examples to deploy agents with Windows Docker support. - -1. **swarm.json** - deploying and using [Swarm](../../docs/swarm.md) \ No newline at end of file diff --git a/examples/windows/swarm.json b/examples/windows/swarm.json deleted file mode 100644 index 164bec1e29..0000000000 --- a/examples/windows/swarm.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "apiVersion": "vlabs", - "properties": { - "orchestratorProfile": { - "orchestratorType": "Swarm" - }, - "masterProfile": { - "count": 1, - "dnsPrefix": "", - "vmSize": "Standard_D2_v2" - }, - "agentPoolProfiles": [ - { - "name": "publicwin1", - "count": 3, - "vmSize": "Standard_D2_v2", - "dnsPrefix": "", - "osType": "Windows", - "ports": [ - 80, - 443, - 8080 - ] - }, - { - "name": "privatewin", - "count": 3, - "vmSize": "Standard_D2_v2", - "osType": "Windows" - } - ], - "windowsProfile": { - "adminUsername": "azureuser", - "adminPassword": "replacepassword1234$" - }, - "linuxProfile": { - "adminUsername": "azureuser", - "ssh": { - "publicKeys": [ - { - "keyData": "" - } - ] - } - } - } -} \ No newline at end of file diff --git a/examples/windows/swarmWinAndLin.json b/examples/windows/swarmWinAndLin.json deleted file mode 100644 index 900f31bd55..0000000000 --- a/examples/windows/swarmWinAndLin.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "apiVersion": "vlabs", - "properties": { - "orchestratorProfile": { - "orchestratorType": "Swarm" - }, - "masterProfile": { - "count": 1, - "dnsPrefix": "", - "vmSize": "Standard_D2_v2" - }, - "agentPoolProfiles": [ - { - "name": "publicwin1", - "count": 3, - "vmSize": "Standard_D2_v2", - "dnsPrefix": "", - "osType": "Windows", - "ports": [ - 80, - 443, - 8080 - ] - }, - { - "name": "privatewin", - "count": 3, - "vmSize": "Standard_D2_v2", - "osType": "Windows" - }, - { - "name": "privatelinux", - "count": 3, - "vmSize": "Standard_D2_v2", - "osType": "Linux" - } - ], - "windowsProfile": { - "adminUsername": "azureuser", - "adminPassword": "replacepassword1234$" - }, - "linuxProfile": { - "adminUsername": "azureuser", - "ssh": { - "publicKeys": [ - { - "keyData": "" - } - ] - } - } - } -} \ No newline at end of file diff --git a/examples/windows/swarmvolumes.json b/examples/windows/swarmvolumes.json deleted file mode 100644 index 80da9f5660..0000000000 --- a/examples/windows/swarmvolumes.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "apiVersion": "vlabs", - "properties": { - "orchestratorProfile": { - "orchestratorType": "Swarm" - }, - "masterProfile": { - "count": 1, - "dnsPrefix": "", - "vmSize": "Standard_D2_v2" - }, - "agentPoolProfiles": [ - { - "name": "publicwin1", - "count": 3, - "vmSize": "Standard_D2_v2", - "dnsPrefix": "", - "osType": "Windows", - "availabilityProfile": "AvailabilitySet", - "ports": [ - 80, - 443, - 8080 - ] - }, - { - "name": "privatewin", - "count": 3, - "vmSize": "Standard_D2_v2", - "availabilityProfile": "AvailabilitySet", - "osType": "Windows" - } - ], - "windowsProfile": { - "adminUsername": "azureuser", - "adminPassword": "replacepassword1234$" - }, - "linuxProfile": { - "adminUsername": "azureuser", - "ssh": { - "publicKeys": [ - { - "keyData": "" - } - ] - } - } - } -} \ No newline at end of file