Azure Container Service Engine - provision and deploy container orchestrators on Azure: Kubernetes, DC/OS, and Docker Swarm.
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci don’t save _output as artifacts (#4214) Nov 8, 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 Enable multiple Windows vmss agent pools - refactor pool names (#3907) Nov 14, 2018
docs consistent use of kubernetes image base (#4233) Nov 14, 2018
examples Update to Docker 18.09 for Windows (#4223) Nov 10, 2018
extensions Fix typo in prometheus-grafana-k8s extension (#4039) Oct 16, 2018
jenkins retire Azure CDN for container image repository proxying (#3535) Jul 24, 2018
loc LEGO: check in for master to temporary branch. (#2983) May 16, 2018
packer imagePullPolicy: IfNotPresent for all versioned containers (#4212) Nov 8, 2018
parts remove extraneous sed statements for mooncake (#4253) Nov 14, 2018
pkg *string PrincipalID needs to be nil-guarded (#4258) Nov 16, 2018
releases Add TLS Certificates to Docker Image (#3457) Jul 12, 2018
scripts update azure-const.sh with new location of azure constants python file ( Nov 14, 2018
test append bug means we aren’t cleaning up! (#4255) Nov 15, 2018
translations Update localization for strings (#2902) May 10, 2018
vendor update dependencies to point to latest k8s api release (#4157) Nov 5, 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 Using dep 0.5.0 and adding dep check to the CI/CD cycle (#3709) Aug 30, 2018
.vsts-ci.yaml Moby container runtime (#3896) Oct 24, 2018
CONTRIBUTING.md remove duplicate sentence (#1559) Oct 9, 2017
Dockerfile Layer `ADD source-code` prior to `make bootstrap` layer in Dockerfile ( Aug 30, 2018
Dockerfile.k8swin Updating the go-bindata go get paths (#3119) May 31, 2018
Gopkg.lock update dependencies to point to latest k8s api release (#4157) Nov 5, 2018
Gopkg.toml update dependencies to point to latest k8s api release (#4157) Nov 5, 2018
LICENSE Add License Oct 6, 2016
Makefile Update go-dev tools image for go 1.11.1 (#3947) Oct 4, 2018
OWNERS adding Tariq to the owners text file (#3842) Sep 13, 2018
README.md Doc style, minor updates pass (#4017) Oct 16, 2018
README_zh-CN.md Deprecate ACS v1 classic mode support (#3647) Aug 10, 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
makedev.ps1 Update go-dev tools image for go 1.11.1 (#3947) Oct 4, 2018
packer.mk Improve VHD VSTS pipeline output URL (#3682) Aug 16, 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 GoDoc

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

More info, including a thorough walkthrough is here.

User guides

These guides show how to create your first deployment for each orchestrator:

These guides cover more advanced features to try out after you have built your first cluster:

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 (or makedev.ps1 on Windows) 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/kubernetes.json

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

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