Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

Commit

Permalink
Various docs tweaks (#64)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
rgardler-msft authored and anhowe committed Nov 3, 2016
1 parent 0a08316 commit 5abd98b
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 176 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,29 @@

## 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

## User guides

* [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)

Expand Down
3 changes: 1 addition & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions docs/acsengine.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
For deployment see [deployment usage](../README.md#deployment-usage).
6 changes: 5 additions & 1 deletion docs/dcos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
* [Windows Clusters](windows) - shows how to create windows or mixed Microsoft Windows and Linux Docker clusters on Microsoft Azure
10 changes: 5 additions & 5 deletions examples/dcos-versions/README.md
Original file line number Diff line number Diff line change
@@ -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)
Deploying and using [DC/OS](../../docs/dcos.md)
9 changes: 0 additions & 9 deletions examples/windows/README.md

This file was deleted.

47 changes: 0 additions & 47 deletions examples/windows/swarm.json

This file was deleted.

53 changes: 0 additions & 53 deletions examples/windows/swarmWinAndLin.json

This file was deleted.

49 changes: 0 additions & 49 deletions examples/windows/swarmvolumes.json

This file was deleted.

0 comments on commit 5abd98b

Please sign in to comment.