README ¶
Microsoft Azure Container Service Engine - Builds Docker Enabled Clusters
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 DC/OS, Kubernetes, Swarm Mode, 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 DC/OS, Kubernetes, Swarm Mode, 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)
- Docker cluster sizes of 1200
- Custom VNET
User guides
- ACS Engine - shows you how to build and use the ACS engine to generate custom Docker enabled container clusters
- Cluster Definition - describes the components of the cluster definition file
- DC/OS Walkthrough - shows how to create a DC/OS enabled Docker cluster on Azure
- Kubernetes Walkthrough - shows how to create a Kubernetes enabled Docker cluster on Azure
- Swarm Walkthrough - shows how to create a Swarm enabled Docker cluster on Azure
- Swarm Mode Walkthrough - shows how to create a Swarm Mode cluster on Azure
- Custom VNET - shows how to use a custom VNET
- Attached Disks - shows how to attach up to 4 disks per node
- Managed Disks (under private preview) - shows how to use managed disks
- Large Clusters - shows how to create cluster sizes of up to 1200 nodes
Contributing
Please follow these instructions before submitting a PR:
-
Execute
make ci
to run the checkin validation tests. -
Manually test deployments if you are making modifications to the templates. For example, if you have to change the expected resulting templates then you should deploy the relevant example cluster definitions to ensure you're not introducing any sort of regression.
Usage
Generate Templates
Usage is best demonstrated with an example:
$ vim examples/kubernetes.classic.json
# insert your preferred, unique DNS prefix
# insert your SSH public key
$ ./acs-engine generate examples/kubernetes.classic.json
This produces a new directory inside _output/
that contains an ARM template
for deploying Kubernetes into Azure. (In the case of Kubernetes, some additional
needed assets are generated and placed in the output directory.)
Code of conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Documentation ¶
There is no documentation for this package.
Directories ¶
Path | Synopsis |
---|---|
pkg
|
|
acsengine
Package acsengine takes an ACS cluster model and generates the corresponding template
|
Package acsengine takes an ACS cluster model and generates the corresponding template |
api
Package api stores an unversion api
|
Package api stores an unversion api |
api/agentPoolOnlyApi/v20170831
Package v20170831 stores api model for version "2017-08-31"
|
Package v20170831 stores api model for version "2017-08-31" |
api/agentPoolOnlyApi/vlabs
Package vlabs stores api model for version "2017-08-31"
|
Package vlabs stores api model for version "2017-08-31" |
api/v20160330
Package v20160330 stores the api model for version "2016-03-30"
|
Package v20160330 stores the api model for version "2016-03-30" |
api/v20160930
Package v20160930 stores api model for version "2016-09-30"
|
Package v20160930 stores api model for version "2016-09-30" |
api/v20170131
Package v20170131 stores api model for version "2017-01-31"
|
Package v20170131 stores api model for version "2017-01-31" |
api/v20170701
Package v20170701 stores api model for version "2017-07-01"
|
Package v20170701 stores api model for version "2017-07-01" |
api/vlabs
Package vlabs stores an experimental api model for acs
|
Package vlabs stores an experimental api model for acs |
test
|
|