README
¶
AKS-Engine - Units of Kubernetes on Azure!
Overview
AKS-Engine leverages ARM (Azure Resource Manager) to build Kubernetes IaaS in Azure. AKS-Engine provides convenient tooling to quickly bootstrap clusters, and implements cluster provisioning and lifecycle operations for AKS, Azure's managed Kubernetes service offering.
More info, including a thorough walkthrough is here.
Please see the FAQ for answers about AKS-Engine and its progenitor ACS-Engine.
User guides
This guide walks you through your first cluster deployment.
These guides cover more advanced features to try out after you have built your first cluster:
- Cluster Definition - describes the components of the cluster definition file
- Custom VNET - shows how to use a custom VNET
- Attached Disks - shows how to attach up to 4 disks per node
- Managed Disks - shows how to use managed disks
- Large Clusters - shows how to create cluster sizes of up to 1200 nodes
Contributing
Follow the developers guide to set up your environment.
To build aks-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:
- Execute
make testto run unit 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 that you are not introducing any regressions.
- Make sure that your changes are properly documented and include relevant unit tests.
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.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
api
Package api stores an unversioned API.
|
Package api stores an unversioned API. |
|
api/agentPoolOnlyApi/v20170831
Package v20170831 stores the API model for version "2017-08-31." Copyright (c) Microsoft Corporation.
|
Package v20170831 stores the API model for version "2017-08-31." Copyright (c) Microsoft Corporation. |
|
api/agentPoolOnlyApi/v20180331
Package v20180331 stores the API model for version "2018-03-31." Copyright (c) Microsoft Corporation.
|
Package v20180331 stores the API model for version "2018-03-31." Copyright (c) Microsoft Corporation. |
|
api/agentPoolOnlyApi/vlabs
Package vlabs stores an experimental API model.
|
Package vlabs stores an experimental API model. |
|
api/v20160330
Package v20160330 stores the API model for version "2016-03-30." Copyright (c) Microsoft Corporation.
|
Package v20160330 stores the API model for version "2016-03-30." Copyright (c) Microsoft Corporation. |
|
api/v20160930
Package v20160930 stores the API model for version "2016-09-30." Copyright (c) Microsoft Corporation.
|
Package v20160930 stores the API model for version "2016-09-30." Copyright (c) Microsoft Corporation. |
|
api/v20170131
Package v20170131 stores the API model for version "2017-01-31." Copyright (c) Microsoft Corporation.
|
Package v20170131 stores the API model for version "2017-01-31." Copyright (c) Microsoft Corporation. |
|
api/v20170701
Package v20170701 stores the API model for version "2017-07-01." Copyright (c) Microsoft Corporation.
|
Package v20170701 stores the API model for version "2017-07-01." Copyright (c) Microsoft Corporation. |
|
api/v20170930
Package v20170930 stores the API model for version "2017-09-30." Copyright (c) Microsoft Corporation.
|
Package v20170930 stores the API model for version "2017-09-30." Copyright (c) Microsoft Corporation. |
|
api/vlabs
Package vlabs stores an experimental API model.
|
Package vlabs stores an experimental API model. |
|
engine
Package engine takes an AKS cluster model and generates the corresponding template Copyright (c) Microsoft Corporation.
|
Package engine takes an AKS cluster model and generates the corresponding template Copyright (c) Microsoft Corporation. |
|
operations/dcosupgrade
Package dcosupgrade allows upgrading of ACS clusters with DC/OS as the orchestrator.
|
Package dcosupgrade allows upgrading of ACS clusters with DC/OS as the orchestrator. |
|
operations/kubernetesupgrade
Package kubernetesupgrade allows upgrading of Kubernetes clusters.
|
Package kubernetesupgrade allows upgrading of Kubernetes clusters. |
|
test
|
|