|
6 | 6 |
|
7 | 7 | ## Overview
|
8 | 8 |
|
9 |
| -AKS-Engine leverages ARM (Azure Resource Manager) to build Kubernetes IaaS in Azure. Originally [acs-engine](https://github.com/Azure/acs-engine), the project has moved here (1) to evolve without harming its legacy non-k8s bits that other non-k8s Azure upstream projects depend upon, and (2) to better reflect its affinity with [AKS](https://docs.microsoft.com/en-us/azure/aks), Azure's managed Kubernetes service offering. |
| 9 | +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](https://docs.microsoft.com/en-us/azure/aks), Azure's managed Kubernetes service offering. |
10 | 10 |
|
11 |
| -## Under Construction |
| 11 | +More info, including a thorough walkthrough is [here](docs/aksengine.md). |
12 | 12 |
|
13 |
| -We are currently in transition from acs-engine to aks-engine! Bear with us as we stabilize this space as the future home for building customizable, self-managed Kubernetes on Azure! |
| 13 | +Please see the [FAQ](/docs/faq.md) for answers about AKS-Engine and its progenitor ACS-Engine. |
14 | 14 |
|
15 |
| -Please see the [FAQ](/docs/faq.md) for answers about AKS-Engine and this project transition. |
| 15 | +## User guides |
| 16 | + |
| 17 | +[This guide](docs/kubernetes.md) walks you through your first cluster deployment. |
| 18 | + |
| 19 | +These guides cover more advanced features to try out after you have built your first cluster: |
| 20 | + |
| 21 | +* [Cluster Definition](docs/clusterdefinition.md) - describes the components of the cluster definition file |
| 22 | +* [Custom VNET](examples/vnet) - shows how to use a custom VNET |
| 23 | +* [Attached Disks](examples/disks-storageaccount) - shows how to attach up to 4 disks per node |
| 24 | +* [Managed Disks](examples/disks-managed) - shows how to use managed disks |
| 25 | +* [Large Clusters](examples/largeclusters) - shows how to create cluster sizes of up to 1200 nodes |
| 26 | + |
| 27 | +## Contributing |
| 28 | + |
| 29 | +Follow the [developers guide](docs/developers.md) to set up your environment. |
| 30 | + |
| 31 | +To build aks-engine, run `make build`. If you are developing with a working [Docker environment](https://docs.docker.com/engine), you can also run `make dev` (or `makedev.ps1` on Windows) first to start a Docker container and run `make build` inside the container. |
| 32 | + |
| 33 | +Please follow these instructions before submitting a PR: |
| 34 | + |
| 35 | +1. Execute `make test` to run unit tests. |
| 36 | +2. Manually test deployments if you are making modifications to the templates. |
| 37 | +* 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. |
| 38 | +3. Make sure that your changes are properly documented and include relevant unit tests. |
16 | 39 |
|
17 | 40 | ## Code of conduct
|
18 | 41 |
|
|
0 commit comments