README
¶
AKS Engine - Units of Kubernetes on Azure!
Project status
This project is stable, meaning the pace of new features is intentionally low. AKS Engine is maintained by teams who depend on it including AKS Engine on Azure Stack Hub.
Overview
AKS Engine is an ARM template-driven way to provision a self-managed Kubernetes cluster on Azure. By leveraging ARM (Azure Resource Manager), AKS Engine helps you create, destroy and maintain clusters provisioned with basic IaaS resources in Azure. AKS Engine has limited support for ongoing operational capabilities such as scaling, in-place upgrade, and extensions. The Cluster API Provider for Azure a.k.a. CAPZ provides more complete operational capabilities. AKS Engine remains the tool for managing Kubernetes clusters on Azure Stack Hub as CAPZ does not yet work there.
Getting started
-
Read the CLI Overview for a list of features provided by the
aks-enginecommand line tool. -
The Quickstart Guide describes how to download the latest release of
aks-enginefor your environment, and demonstrates how to useaks-engineto create a Kubernetes cluster on Azure that you will manage and customize.
Please see the FAQ for answers about AKS Engine and its progenitor ACS-Engine.
Join the community
If you are committed to using AKS Engine longer term and would like to become a project maintainer, please reach out to us via the #aks-engine-dev Slack channel! The community guide covers everything you need to know about the AKS Engine community and how you can contribute. The developer guide will help you onboard as a developer. The AKS Engine community is committed to integrating and validating new versions of Kubernetes into AKS Engine. We encourage AKS Engine users to evaluate moving to CAPZ as it provides stronger support for managing the cluster lifecycle compared to AKS Engine.
Support
Please see our support policy.
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.
Data Collection
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
For more information, please see the telemetry documentation.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd stores the command line interface implementation.
|
Package cmd stores the command line interface implementation. |
|
rotatecerts/internal/mock_internal
Package mock_internal is a generated GoMock package.
|
Package mock_internal is a generated GoMock package. |
|
pkg
|
|
|
api
Package api stores an unversioned API.
|
Package api stores an unversioned API. |
|
api/common
Package common stores helpers and utility functions.
|
Package common stores helpers and utility functions. |
|
api/vlabs
Package vlabs stores an experimental API model.
|
Package vlabs stores an experimental API model. |
|
armhelpers/utils
Package utils provides helper methods to assist with ARM operations.
|
Package utils provides helper methods to assist with ARM operations. |
|
engine
Package engine takes an AKS cluster model and generates the corresponding template.
|
Package engine takes an AKS cluster model and generates the corresponding template. |
|
engine/transform
Package transform provides helper methods to introspect and modify existing ARM templates.
|
Package transform provides helper methods to introspect and modify existing ARM templates. |
|
helpers
Package helpers provides general purpose utility methods that are used throughout aks-engine codebase.
|
Package helpers provides general purpose utility methods that are used throughout aks-engine codebase. |
|
i18n
Package i18n contains localized strings for user facing messages.
|
Package i18n contains localized strings for user facing messages. |
|
kubernetes/internal/mock_internal
Package mock_internal is a generated GoMock package.
|
Package mock_internal is a generated GoMock package. |
|
kubernetes/mock_kubernetes
Package mock_kubernetes is a generated GoMock package.
|
Package mock_kubernetes is a generated GoMock package. |
|
operations
Package operations provides methods to perform kubernetes-specific IaaS operations like cordon & drain, cluster upgrades, remote SSH, and scaling of agentpools.
|
Package operations provides methods to perform kubernetes-specific IaaS operations like cordon & drain, cluster upgrades, remote SSH, and scaling of agentpools. |
|
operations/kubernetesupgrade
Package kubernetesupgrade allows upgrading of Kubernetes clusters.
|
Package kubernetesupgrade allows upgrading of Kubernetes clusters. |
|
test
Package test provides a method to export Ginkgo test results to custom unit test reporters.
|
Package test provides a method to export Ginkgo test results to custom unit test reporters. |
|
test
|
|
|
e2e
Module
|