Azure Container Service Engine - provision and deploy container orchestrators on Azure: Kubernetes, DC/OS, and Docker Swarm.
Go Perl 6 Shell Perl PowerShell Groovy Other
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci Update clusterKeyVaultName for kv and sa (#3440) Jul 6, 2018
.codecov change codecov yaml (#3316) Jun 20, 2018
.github Update PULL_REQUEST_TEMPLATE.md (#2515) Mar 22, 2018
.prowci Prow updates (#3189) Jun 6, 2018
cmd Using Fatalf instead of Fatalln when formatting characters are presen… Jul 10, 2018
docs Introduce kata container support (#3465) Jul 13, 2018
examples Introduce kata container support (#3465) Jul 13, 2018
extensions Set extension for custom DNS (#3264) Jun 15, 2018
jenkins Update references to gcr.io to point to Azure CDN endpoint (#2721) Apr 19, 2018
loc LEGO: check in for master to temporary branch. (#2983) May 16, 2018
parts Mount audit log file to disk (#3335) Jul 13, 2018
pkg Commiting the latest code gen files so that circle-ci builds pass. (#… Jul 16, 2018
releases Add TLS Certificates to Docker Image (#3457) Jul 12, 2018
scripts Add support for building win zip from for e2e testing (#3003) May 18, 2018
test Adding more descriptions and clarifications to Windows tests (#3470) Jul 13, 2018
translations Update localization for strings (#2902) May 10, 2018
vendor Cleanup error usage (#3386) Jul 3, 2018
windows update images to 1803 (#2958) May 15, 2018
.dockerignore Fix make generate slowness on Docker for Mac (#1226) Aug 10, 2017
.gitattributes Add devenv for building/testing/validating under Docker Oct 27, 2016
.gitignore openshift: fix comment in ansible.sh (#3222) Jun 8, 2018
CONTRIBUTING.md remove duplicate sentence (#1559) Oct 9, 2017
Dockerfile Add the new signing key for the azure cli package (#2786) May 2, 2018
Dockerfile.k8swin Updating the go-bindata go get paths (#3119) May 31, 2018
LICENSE Add License Oct 6, 2016
Makefile use go-bindata (#3074) May 25, 2018
OWNERS Setup OWNERS files (#2791) Apr 30, 2018
README.md First version of OpenShift docs (#2839) May 10, 2018
README_zh-CN.md ref(docs): reorganize documentation Aug 3, 2017
glide.lock Cleanup error usage (#3386) Jul 3, 2018
glide.yaml Cleanup error usage (#3386) Jul 3, 2018
labels.yaml docs(github): use labeler to manage project labels (#955) Jul 11, 2017
main.go Resubmit PR# 2332: Enable colorized logging on Windows (#2482) Mar 20, 2018
test.mk Add openshift e2e test (#2675) May 4, 2018
versioning.mk version output improvements (#1325) Aug 25, 2017

README.md

Microsoft Azure Container Service Engine - Builds Docker Enabled Clusters

Coverage Status CircleCI

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, OpenShift, Swarm Mode, or Swarm orchestrators. The input to the tool is a cluster definition. The cluster definition (or apimodel) 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 you to customize your Docker enabled cluster in many ways including:

  • choice of DC/OS, Kubernetes, OpenShift, Swarm Mode, or Swarm orchestrators
  • multiple agent pools where each agent pool can specify:
    • standard or premium VM Sizes, including GPU optimized VM sizes
    • node count
    • Virtual Machine ScaleSets or Availability Sets
    • Storage Account Disks or Managed Disks
    • OS and distro
  • Custom VNET
  • Extensions

User guides

Contributing

Follow the developers guide to set up your environment.

To build acs-engine, run make build. If you are developing with a working Docker environment, you can also run make dev first to start a Docker container and run make build inside the container.

Please follow these instructions before submitting a PR:

  1. Execute make test to run unit tests.

  2. 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 that you are not introducing any regressions.

  3. Make sure that your changes are properly documented and include relevant unit tests.

Usage

Generate Templates

Usage is best demonstrated with an example:

$ vim examples/classic/kubernetes.classic.json

# insert your preferred, unique DNS prefix
# insert your SSH public key

$ ./acs-engine generate examples/classic/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.