From 74031d8731a7c8a2f45aef88acac5d5d84a64ae9 Mon Sep 17 00:00:00 2001 From: Matt Boersma Date: Mon, 4 Feb 2019 16:50:32 -0700 Subject: [PATCH] docs: refer to the project as "AKS Engine" consistently (#436) --- .github/config.yml | 6 +++--- CONTRIBUTING.md | 2 +- README.md | 14 +++++++------- cmd/root.go | 6 +++--- docs/README.md | 12 ++++++------ docs/community/README.md | 10 +++++----- docs/community/developer-guide.md | 8 ++++---- docs/faq.md | 18 +++++++++--------- docs/howto/README.md | 2 +- docs/howto/kubernetes-large-clusters.md | 6 +++--- docs/howto/troubleshooting.md | 4 ++-- docs/topics/README.md | 6 +++--- docs/topics/architecture.md | 8 ++++---- docs/topics/extensions.md | 4 ++-- docs/topics/monitoring.md | 8 ++++---- docs/topics/upgrade.md | 2 +- docs/tutorials/README.md | 4 ++-- docs/tutorials/containermonitoringaddon.md | 4 ++-- docs/tutorials/custom-vnet.md | 2 +- docs/tutorials/quickstart.md | 2 +- examples/README.md | 2 +- examples/addons/container-monitoring/README.md | 8 ++++---- examples/customfiles/README.md | 2 +- examples/disks-managed/README.md | 2 +- examples/disks-storageaccount/README.md | 2 +- examples/keyvault-params/README.md | 2 +- examples/keyvaultcerts/README.md | 2 +- examples/kubernetes-config/README.md | 2 +- examples/largeclusters/README.md | 2 +- examples/multiple-nodepools/README.md | 2 +- examples/networkplugin/README.md | 2 +- examples/networkpolicy/README.md | 14 +++++++------- examples/vnet/README.md | 2 +- examples/windows/README.md | 2 +- 34 files changed, 87 insertions(+), 87 deletions(-) diff --git a/.github/config.yml b/.github/config.yml index 50a82adef2b..11c31c03495 100644 --- a/.github/config.yml +++ b/.github/config.yml @@ -13,12 +13,12 @@ newPRWelcomeComment: > Examples of commit messages with semantic prefixes: - `fix: change azure disk cachingMode to ReadOnly` - `feat: make maximumLoadBalancerRuleCount configurable` - - `docs: add note on AKS-Engine and AKS relationship` - + - `docs: add note on AKS Engine and AKS relationship` + Make sure to check out the [developer guide](https://github.com/Azure/aks-engine/blob/master/docs/community/developer-guide.md) for guidance on testing your change. # Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge # Comment to be posted to on pull requests merged by a first time user firstPRMergeComment: > - Congrats on merging your first pull request! 🎉🎉🎉 \ No newline at end of file + Congrats on merging your first pull request! 🎉🎉🎉 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa8a91d8445..02d4770d9fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ signed the CLA can be accepted into the repository. This is an open source project and as such no formal support is available. However, like all good open source projects we do offer "best effort" support through github issues. GitHub issues: -- AKS-Engine: https://github.com/Azure/aks-engine/issues - file issues and PRs related to AKS-Engine +- AKS Engine: https://github.com/Azure/aks-engine/issues - file issues and PRs related to AKS Engine - AKS: https://github.com/Azure/AKS/issues - file issues and PRs related to Azure Kubernetes Service Before opening a new issue or submitting a new pull request, it's helpful to search the project - it's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of. diff --git a/README.md b/README.md index 91952a68a7c..08e91985108 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,27 @@ -# AKS-Engine - Units of Kubernetes on Azure! +# AKS Engine - Units of Kubernetes on Azure! [![Coverage Status](https://codecov.io/gh/Azure/aks-engine/branch/master/graph/badge.svg)](https://codecov.io/gh/Azure/aks-engine) [![GoDoc](https://godoc.org/github.com/Azure/aks-engine?status.svg)](https://godoc.org/github.com/Azure/aks-engine) -AKS-Engine is the easiest way to provision a self-managed Kubernetes cluster on Azure. +AKS Engine is the easiest way to provision a self-managed Kubernetes cluster on Azure. ## Overview -AKS-Engine provides convenient tooling to quickly bootstrap Kubernetes clusters on Azure. By leveraging [ARM (Azure Resource Manager)][ARM], AKS-Engine helps you create, destroy and maintain clusters provisioned with basic IaaS resources in Azure. AKS-Engine is also the library used by AKS for performing these operations to provide managed service implementations. +AKS Engine provides convenient tooling to quickly bootstrap Kubernetes clusters on Azure. By leveraging [ARM (Azure Resource Manager)][ARM], AKS Engine helps you create, destroy and maintain clusters provisioned with basic IaaS resources in Azure. AKS Engine is also the library used by AKS for performing these operations to provide managed service implementations. ## Getting started -Depending on how new you are to AKS-Engine, you can try [a tutorial][tutorials], or just dive straight into the [documentation][docs]. +Depending on how new you are to AKS Engine, you can try [a tutorial][tutorials], or just dive straight into the [documentation][docs]. -Please see the [FAQ][] for answers about AKS-Engine and its progenitor ACS-Engine. +Please see the [FAQ][] for answers about AKS Engine and its progenitor ACS-Engine. ## Sharpen your skills -The official [AKS-Engine documentation][docs] covers everything you need to know about AKS-Engine (and then some). +The official [AKS Engine documentation][docs] covers everything you need to know about AKS Engine (and then some). ## Join the community -Want to get involved? The [community guide][community] covers everything you need to know about the AKS-Engine community and how you can contribute. +Want to get involved? The [community guide][community] covers everything you need to know about the AKS Engine community and how you can contribute. ## Code of conduct diff --git a/cmd/root.go b/cmd/root.go index 9c60ba0ef04..a89912dc254 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -24,8 +24,8 @@ import ( const ( rootName = "aks-engine" - rootShortDescription = "AKS-Engine deploys and manages Kubernetes clusters in Azure" - rootLongDescription = "AKS-Engine deploys and manages Kubernetes clusters in Azure" + rootShortDescription = "AKS Engine deploys and manages Kubernetes clusters in Azure" + rootLongDescription = "AKS Engine deploys and manages Kubernetes clusters in Azure" ) var ( @@ -33,7 +33,7 @@ var ( dumpDefaultModel bool ) -// NewRootCmd returns the root command for AKS-Engine. +// NewRootCmd returns the root command for AKS Engine. func NewRootCmd() *cobra.Command { rootCmd := &cobra.Command{ Use: rootName, diff --git a/docs/README.md b/docs/README.md index 8510f548c67..09f9fa3cb29 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,18 +1,18 @@ -# AKS-Engine documentation +# AKS Engine documentation -Everything you need to know about AKS-Engine. +Everything you need to know about AKS Engine. ## How the documentation is organized -AKS-Engine has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things. +AKS Engine has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things. -[Tutorials][] take you by the hand through a series of steps on a given subject. Start here if you’re new to AKS-Engine. +[Tutorials][] take you by the hand through a series of steps on a given subject. Start here if you’re new to AKS Engine. [Topic guides][] discuss key topics and concepts at a fairly high level and provide useful background information and explanation. -[How-to guides][] are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how AKS-Engine works. +[How-to guides][] are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how AKS Engine works. -[Community guides][] teach you about the AKS-Engine community. It incudes information on the project's Code of Conduct, the planning process for the AKS-Engine project itself, its release cycle, and how you can contribute to the project. +[Community guides][] teach you about the AKS Engine community. It incudes information on the project's Code of Conduct, the planning process for the AKS Engine project itself, its release cycle, and how you can contribute to the project. [quickstart]: tutorials/quickstart.md [getting started]: tutorials/hello-world.md diff --git a/docs/community/README.md b/docs/community/README.md index a4ff1657cc9..daf71f0d87f 100644 --- a/docs/community/README.md +++ b/docs/community/README.md @@ -1,14 +1,14 @@ # Community -Here you'll find documentation geared towards learning about the development process for the AKS-Engine project itself and how you can contribute. +Here you'll find documentation geared towards learning about the development process for the AKS Engine project itself and how you can contribute. - [Code of Conduct](code-of-conduct.md) - [Developer Guide](developer-guide.md) - [Planning Process](planning-process.md) - [Release Checklist](release-checklist.md) -AKS-Engine is a community effort. As it keeps growing, we always need more people to help others. As soon as you learn AKS-Engine, you can contribute in many ways: +AKS Engine is a community effort. As it keeps growing, we always need more people to help others. As soon as you learn AKS Engine, you can contribute in many ways: -- Join the #sig-azure Slack channel on and answer questions. By explaining AKS-Engine to other users, you’re going to learn a lot about the tool yourself. -- Blog about AKS-Engine. We syndicate all the AKS-Engine blogs we know about on the [topics page](../topics/README.md); if you’d like to see your blog on that page, you are more than welcome to add it there. -- Contribute to other projects that use AKS-Engine, write documentation, or release your own code as an open-source extension. The ecosystem of extensions is a community effort; help us build it! +- Join the #sig-azure Slack channel on and answer questions. By explaining AKS Engine to other users, you’re going to learn a lot about the tool yourself. +- Blog about AKS Engine. We syndicate all the AKS Engine blogs we know about on the [topics page](../topics/README.md); if you’d like to see your blog on that page, you are more than welcome to add it there. +- Contribute to other projects that use AKS Engine, write documentation, or release your own code as an open-source extension. The ecosystem of extensions is a community effort; help us build it! diff --git a/docs/community/developer-guide.md b/docs/community/developer-guide.md index 0a16d2bc7e2..90487546cda 100644 --- a/docs/community/developer-guide.md +++ b/docs/community/developer-guide.md @@ -137,16 +137,16 @@ Example launch.json file: ## Test pipeline -AKS-Engine employs a Continuous Integration (CI) system that incorporates Azure DevOps, configured to interact with the AKS-Engine GitHub project. +AKS Engine employs a Continuous Integration (CI) system that incorporates Azure DevOps, configured to interact with the AKS Engine GitHub project. -The following steps constitute the AKS-Engine CI pipeline: +The following steps constitute the AKS Engine CI pipeline: -1. Contributor opens a Pull Request (PR) against the AKS-Engine project +1. Contributor opens a Pull Request (PR) against the AKS Engine project 1. The PR triggers an Azure DevOps job that + applies the changes to the HEAD of the master branch + runs unit tests and code coverage reports + generates multiple ARM templates for different deployment scenarios + simultaneously provisions the clusters based on generated templates in Azure -1. The PR is code reviewed by the members of AKS-Engine team +1. The PR is code reviewed by the members of AKS Engine team 1. Once the PR is approved and the end-to-end job has passed, the PR can now be merged into the master branch 1. Once merged, another job is triggered to verify integrity of the master branch. This job is similar to the PR job. diff --git a/docs/faq.md b/docs/faq.md index 86616396f89..9ef934a2c10 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,16 +1,16 @@ -# AKS-Engine FAQ +# AKS Engine FAQ -This page provides help with the most common questions about AKS-Engine. +This page provides help with the most common questions about AKS Engine. -### What's the Difference Between AKS and AKS-Engine? +### What's the Difference Between AKS and AKS Engine? -Azure Kubernetes Service ([AKS][]) is a Microsoft Azure service that supports fully managed Kubernetes clusters. [AKS-Engine][] is an Azure open source project that creates Kubernetes clusters with your custom requirements. AKS uses AKS-Engine internally, but they are not the same. +Azure Kubernetes Service ([AKS][]) is a Microsoft Azure service that supports fully managed Kubernetes clusters. [AKS Engine][] is an Azure open source project that creates Kubernetes clusters with your custom requirements. AKS uses AKS Engine internally, but they are not the same. -AKS clusters can be created in the Azure portal or with `az aks create` in the [Azure command-line tool][]. AKS-Engine clusters can be created with `aks-engine deploy` in the AKS-Engine command-line tool, or by generating the ARM templates with `aks-engine generate` and deploying them as a separate step. +AKS clusters can be created in the Azure portal or with `az aks create` in the [Azure command-line tool][]. AKS Engine clusters can be created with `aks-engine deploy` in the AKS Engine command-line tool, or by generating the ARM templates with `aks-engine generate` and deploying them as a separate step. ### What's the Difference Between `acs-engine` and `aks-engine`? -AKS-Engine is the next version of the ACS-Engine project. AKS-Engine supports current and future versions of [Kubernetes][], while ACS-Engine also supported the Docker Swarm and Mesos DC/OS container orchestrators. +AKS Engine is the next version of the ACS-Engine project. AKS Engine supports current and future versions of [Kubernetes][], while ACS-Engine also supported the Docker Swarm and Mesos DC/OS container orchestrators. ### Can I Scale or Upgrade an `acs-engine` Cluster with `aks-engine`? @@ -18,11 +18,11 @@ Yes. ### Is ACS-Engine Still Active? -No further development or releases in ACS-Engine are planned. AKS-Engine is a backward-compatible continuation of ACS-Engine, so all fixes and new features will target AKS-Engine. +No further development or releases in ACS-Engine are planned. AKS Engine is a backward-compatible continuation of ACS-Engine, so all fixes and new features will target AKS Engine. ### Can I Build an AKS Cluster with `aks-engine`? -No, Azure Kubernetes Service itself is the way to create a supported, managed AKS cluster. AKS-Engine shares some code with AKS, but does not create managed clusters. +No, Azure Kubernetes Service itself is the way to create a supported, managed AKS cluster. AKS Engine shares some code with AKS, but does not create managed clusters. ### Should I use the latest `aks-engine` release if I was previously using `acs-engine`? @@ -30,7 +30,7 @@ Yes. `aks-engine` [v0.27.0][] is a continuation of acs-engine [v0.26.2][] with a [AKS]: https://azure.microsoft.com/en-us/services/kubernetes-service/ -[AKS-Engine]: https://github.com/Azure/aks-engine +[AKS Engine]: https://github.com/Azure/aks-engine [Azure command-line tool]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest [acs-engine release]: https://github.com/Azure/acs-engine/releases [Kubernetes]: https://kubernetes.io/ diff --git a/docs/howto/README.md b/docs/howto/README.md index d6d880bde61..da3d242218f 100644 --- a/docs/howto/README.md +++ b/docs/howto/README.md @@ -4,5 +4,5 @@ Here you’ll find short answers to “How do I….?” types of questions. Thes - [Troubleshooting](troubleshooting.md) - [Building Windows Kubernetes Binaries](building-windows-kubernetes-binaries.md) -- [Large Kubernetes Clusters with AKS-Engine](kubernetes-large-clusters.md) +- [Large Kubernetes Clusters with AKS Engine](kubernetes-large-clusters.md) - [Using HTTP Ingress Routing in a Mixed Cluster](mixed-cluster-ingress.md) diff --git a/docs/howto/kubernetes-large-clusters.md b/docs/howto/kubernetes-large-clusters.md index 4fe2eb424c7..b38b16ec287 100644 --- a/docs/howto/kubernetes-large-clusters.md +++ b/docs/howto/kubernetes-large-clusters.md @@ -1,13 +1,13 @@ -# Large Kubernetes Clusters with AKS-Engine +# Large Kubernetes Clusters with AKS Engine ## Background -Starting from AKS-Engine v0.3.0, AKS-Engine supports using exponential cloud backoff that is a feature of Kubernetes v1.6.6 and newer. Cloud backoff allows Kubernetes nodes to backoff on HTTP 429 errors that are usually caused by exceeding Azure API limits. +Starting from AKS Engine v0.3.0, AKS Engine supports using exponential cloud backoff that is a feature of Kubernetes v1.6.6 and newer. Cloud backoff allows Kubernetes nodes to backoff on HTTP 429 errors that are usually caused by exceeding Azure API limits. ## To Use Declare your kubernetes cluster API model config as you normally would, with the following requirements: -- You must be using at minimum the `v1.6.6` version of Kubernetes to have access to the `kubernetesConfig` configuration vectors exemplified in [examples/largeclusters/kubernetes.json](https://github.com/Azure/aks-engine/blob/master/examples/largeclusters/kubernetes.json). As long as you are using a version of AKS-Engine `v0.3.0` or newer, your kubernetes cluster specification will fulfill this minimum version requirement. +- You must be using at minimum the `v1.6.6` version of Kubernetes to have access to the `kubernetesConfig` configuration vectors exemplified in [examples/largeclusters/kubernetes.json](https://github.com/Azure/aks-engine/blob/master/examples/largeclusters/kubernetes.json). As long as you are using a version of AKS Engine `v0.3.0` or newer, your kubernetes cluster specification will fulfill this minimum version requirement. - We recommend the use of smaller pools (e.g., count of 20) over larger pools (e.g., count of 100); produce your desired total node count with lots of pools, as opposed to as few as possible. - We also recommend using large vmSize configurations to reduce node counts, where appropriate. Make sure you have a defensible infrastructure justification for more nodes in terms of node count (for example as of kubernetes 1.7 there is a 100 pods per node limit), instead of opting to use more powerful nodes. Doing so reduces cluster complexity, and azure resource administrative overhead. As Kubernetes excels in binpacking pods onto available instances, vertically scaling VM sizes (more CPU/RAM) is a better approach for expanding cluster capacity, if you are not approaching the pod-per-node limit. diff --git a/docs/howto/troubleshooting.md b/docs/howto/troubleshooting.md index 02531c23c69..79babd1d0fe 100644 --- a/docs/howto/troubleshooting.md +++ b/docs/howto/troubleshooting.md @@ -1,6 +1,6 @@ ## Troubleshooting -Common issues or questions that users have run into when using AKS-Engine are detailed below. +Common issues or questions that users have run into when using AKS Engine are detailed below. ## VMExtensionProvisioningError or VMExtensionProvisioningTimeout @@ -158,4 +158,4 @@ read and **write** permissions to the target Subscription. ## Failed upgrade -Please review the [upgrade documentation](../topics/upgrade.md) for a guide on upgrading `aks-engine` Kubernetes clusters. \ No newline at end of file +Please review the [upgrade documentation](../topics/upgrade.md) for a guide on upgrading `aks-engine` Kubernetes clusters. diff --git a/docs/topics/README.md b/docs/topics/README.md index 84611f733dd..354ac438c54 100644 --- a/docs/topics/README.md +++ b/docs/topics/README.md @@ -1,6 +1,6 @@ # Topic Guides -Introductions to all the key parts of AKS-Engine you’ll need to know. +Introductions to all the key parts of AKS Engine you’ll need to know. - [AAD integration Walkthrough](aad.md) - [Architecture](architecture.md) @@ -20,9 +20,9 @@ Introductions to all the key parts of AKS-Engine you’ll need to know. ## Community Material -This material is external to the core documentation, but provide valuable pieces of information related to AKS-Engine thanks to the many community members. +This material is external to the core documentation, but provide valuable pieces of information related to AKS Engine thanks to the many community members. -If you're new to AKS-Engine, adding snippets from these pieces into the core documentation is a great way to get started... Hint hint. ;) +If you're new to AKS Engine, adding snippets from these pieces into the core documentation is a great way to get started... Hint hint. ;) - [Getting started with the ACS Engine to deploy Kubernetes in Azure](http://starkfell.github.io/getting-started-with-using-the-acs-engine-to-deploy-k8s-in-azure/) diff --git a/docs/topics/architecture.md b/docs/topics/architecture.md index 99d69523ee4..4a3af86f41a 100644 --- a/docs/topics/architecture.md +++ b/docs/topics/architecture.md @@ -1,6 +1,6 @@ # Architecture -AKS-Engine is a command line tool that generates ARM (Azure Resource Manager) templates in order for one to deploy container-based clusters (like Kubernetes , DCOS, Openshift, Docker swarm) on the Azure platform. +AKS Engine is a command line tool that generates ARM (Azure Resource Manager) templates in order for one to deploy container-based clusters (like Kubernetes , DCOS, Openshift, Docker swarm) on the Azure platform. This design document provides a brief and high-level overview of what aks-engine does internally to achieve deployment of containerized clusters. The scope of this document will be limited to the execution of aks-engine when creating Kubernetes clusters. @@ -12,7 +12,7 @@ This design document provides a brief and high-level overview of what aks-engine ### Cluster api model -AKS-Engine accepts JSONs of cluster api models as inputs. These api models allow the user to specify cluster configuration items such as +AKS Engine accepts JSONs of cluster api models as inputs. These api models allow the user to specify cluster configuration items such as - Master and worker nodes configuration - Kubernetes version @@ -227,11 +227,11 @@ The template generator then creates the following artifacts ### ARM Interface -AKS-Engine interfaces with Azure Resource Manager (ARM) through the Azure Go SDK. The Go SDK provides interfaces to perform functions like template deployment, validation. +AKS Engine interfaces with Azure Resource Manager (ARM) through the Azure Go SDK. The Go SDK provides interfaces to perform functions like template deployment, validation. ### Kubernetes Client API -AKS-Engine also performs kubernetes cluster management operations (kubectl) through the imported Kubernetes API libraries. The Client API calls are made during the scale and upgrade commands of aks-engine. +AKS Engine also performs kubernetes cluster management operations (kubectl) through the imported Kubernetes API libraries. The Client API calls are made during the scale and upgrade commands of aks-engine. Design challenges and proposals diff --git a/docs/topics/extensions.md b/docs/topics/extensions.md index f5f8cc97fcf..00537d46565 100644 --- a/docs/topics/extensions.md +++ b/docs/topics/extensions.md @@ -1,6 +1,6 @@ # Extensions -Extensions in AKS-Engine provide an easy way for AKS-Engine users to add pre-packaged functionality into their cluster. For example, an extension could configure a monitoring solution on an AKS cluster. The user would not need to know the details of how to install the monitoring solution. Rather, the user would simply add the extension into the extensionProfiles section of the template. +Extensions in AKS Engine provide an easy way for AKS Engine users to add pre-packaged functionality into their cluster. For example, an extension could configure a monitoring solution on an AKS cluster. The user would not need to know the details of how to install the monitoring solution. Rather, the user would simply add the extension into the extensionProfiles section of the template. ## extensionProfiles @@ -215,7 +215,7 @@ The following is an example of the template.json file. ## Creating extension template-link.json -When AKS-Engine generates the azuredeploy.json file, this JSON snippet will be injected. This code calls the linked template (template.json) defined above. +When AKS Engine generates the azuredeploy.json file, this JSON snippet will be injected. This code calls the linked template (template.json) defined above. Any parameters from the main azuredeploy.json file that is needed by template.json must be passed in via the parameters section. The parameter, "extensionParameters" is an optional parameter that is passed in directly by the user in the **extensionProfiles** section as defined in an earlier section. This special parameter can be used to pass in information such as an activation key or access code (as an example). If the extension does not need this capability, this optional parameter can be deleted. diff --git a/docs/topics/monitoring.md b/docs/topics/monitoring.md index 365dbb9e091..b4ea26302c6 100644 --- a/docs/topics/monitoring.md +++ b/docs/topics/monitoring.md @@ -56,16 +56,16 @@ somePod 0m 11Mi ## Azure Monitor for containers -Azure Monitor for containers is a feature designed to monitor the performance of container workloads deployed to AKS-Engine (formerly known as ACS-Engine) cluster(s) hosted on Azure. Monitoring your containers is critical, especially when you're running a production cluster, at scale, with multiple applications. +Azure Monitor for containers is a feature designed to monitor the performance of container workloads deployed to AKS Engine (formerly known as ACS-Engine) cluster(s) hosted on Azure. Monitoring your containers is critical, especially when you're running a production cluster, at scale, with multiple applications. Azure Monitor for containers gives you performance visibility by collecting memory and processor metrics from controllers, nodes, and containers that are available in Kubernetes through the Metrics API. Container logs are also collected. After you enable monitoring from Kubernetes clusters, these metrics and logs are automatically collected for you through a containerized version of the Log Analytics agent for Linux and stored in your Log Analytics workspace. -Azure Monitor for containers for AKS-Engine cluster(s) can be configured through following options +Azure Monitor for containers for AKS Engine cluster(s) can be configured through following options 1. Helm chart [azuremonitor-containers](https://github.com/helm/charts/tree/master/incubator/azuremonitor-containers) 2. [Container-monitoring add-on](../../examples/addons/container-monitoring/README.md) -> Note: If more than one AKS-Engine cluster planned to configure to the same Azure Log Analytics Workspace then recommend option is to use Helm chart (i.e. option #1 above) +> Note: If more than one AKS Engine cluster planned to configure to the same Azure Log Analytics Workspace then recommend option is to use Helm chart (i.e. option #1 above) Navigate to [azmon-containers](https://aka.ms/azmon-containers) to view the health, metrics and logs of AKS-engine cluster(s). @@ -75,7 +75,7 @@ Refer to [azuremonitor-containers-aks-engine](https://github.com/Microsoft/OMS-d ![Image of Azure Monitor for containers](../static/img/azure_monitor_aks_engine.png) -If you have any questions or feedback regarding the monitoring of your AKS-Engine (or ACS-Engine) cluster(s), please reach us out through [this](mailto:askcoin@microsoft.com) email. +If you have any questions or feedback regarding the monitoring of your AKS Engine (or ACS-Engine) cluster(s), please reach us out through [this](mailto:askcoin@microsoft.com) email. ## Kubernetes dashboard diff --git a/docs/topics/upgrade.md b/docs/topics/upgrade.md index 2da7f485a6f..b9c30a99bee 100644 --- a/docs/topics/upgrade.md +++ b/docs/topics/upgrade.md @@ -34,7 +34,7 @@ In order to ensure that your `aks-engine upgrade` operation runs smoothly, there ./bin/aks-engine orchestrators --orchestrator Kubernetes --version 1.11.5 ``` -4) If using `aks-engine upgrade` in production, it is recommended to stage an upgrade test on an cluster that was built to the same specifications (built with the same cluster configuration + `aks-engine` version) as your production cluster before performing the upgrade, especially if the cluster configuration is "interesting", or in other words differs significantly from defaults. The reason for this is that `aks-engine` supports many different cluster configurations and the extent of E2E testing that the AKS-Engine team runs cannot practically cover every single configuration out there. Therefore, it is recommended that you make sure that your specific cluster configuration works with the existing upgrade implementation before starting this long-running operation. +4) If using `aks-engine upgrade` in production, it is recommended to stage an upgrade test on an cluster that was built to the same specifications (built with the same cluster configuration + `aks-engine` version) as your production cluster before performing the upgrade, especially if the cluster configuration is "interesting", or in other words differs significantly from defaults. The reason for this is that `aks-engine` supports many different cluster configurations and the extent of E2E testing that the AKS Engine team runs cannot practically cover every single configuration out there. Therefore, it is recommended that you make sure that your specific cluster configuration works with the existing upgrade implementation before starting this long-running operation. 5) `aks-engine upgrade` is backwards compatible. If you deployed with `aks-engine` version `0.27.x`, you can run upgrade with version `0.29.y`. In fact, it is recommended that you use the latest available `aks-engine` version when running an upgrade operation. This will ensure that you get the latest available software and bug fixes in your upgraded cluster. diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md index 0274b2155e2..7ba31a36730 100644 --- a/docs/tutorials/README.md +++ b/docs/tutorials/README.md @@ -1,9 +1,9 @@ # Tutorials -New to AKS-Engine? Well, you came to the right place. +New to AKS Engine? Well, you came to the right place. - [Quick Install Guide](quickstart.md) ([Chinese](quickstart.zh-CN.md)) - [Deploy a Kubernetes Cluster](deploy.md) - ["Day 2" Operations](day2-operations.md) -- [Using a custom virtual network with AKS-Engine](custom-vnet.md) +- [Using a custom virtual network with AKS Engine](custom-vnet.md) - [Using the Container Monitoring Add-on](containermonitoringaddon.md) diff --git a/docs/tutorials/containermonitoringaddon.md b/docs/tutorials/containermonitoringaddon.md index b6f526bec39..46da1c3f119 100644 --- a/docs/tutorials/containermonitoringaddon.md +++ b/docs/tutorials/containermonitoringaddon.md @@ -7,7 +7,7 @@ Container Monitoring addon gives you performance monitoring ability by collectin - Review the resource utilization of workloads running on the host that are unrelated to the standard processes that support the pod. - Understand the behavior of the cluster under average and heaviest loads. This knowledge can help you identify capacity needs and determine the maximum load that the cluster can sustain. - Logs (stdout/stderr) of the Containers to troubleshoot the issues in containers - + ## Components Your ability to monitor performance relies on a containerized Log Analytics agent for Linux, which collects performance and event data from all nodes in the cluster. The agent is automatically deployed and registered with the specified Log Analytics workspace after you enable container monitoring addon and specify the right encoded workspaceid and workspace key in the addon config. @@ -21,4 +21,4 @@ Your ability to monitor performance relies on a containerized Log Analytics agen ## Onboarding -Follow the instructions to [onboard the container monitoring addon for the AKS-Engine cluster(s)](../../examples/addons/container-monitoring/README.md) +Follow the instructions to [onboard the container monitoring addon for the AKS Engine cluster(s)](../../examples/addons/container-monitoring/README.md) diff --git a/docs/tutorials/custom-vnet.md b/docs/tutorials/custom-vnet.md index 50120397728..4597a8459bf 100644 --- a/docs/tutorials/custom-vnet.md +++ b/docs/tutorials/custom-vnet.md @@ -1,4 +1,4 @@ -# Using a custom virtual network with AKS-Engine +# Using a custom virtual network with AKS Engine In this tutorial you are going to learn how to use [AKS Engine](https://github.com/Azure/aks-engine) to deploy a brand new cluster into an existing or pre-created virtual network. By doing this, you will be able to control the properties of the virtual network or integrate a new cluster into your existing infrastructure. diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md index dc6cc41390c..fcb1251829e 100644 --- a/docs/tutorials/quickstart.md +++ b/docs/tutorials/quickstart.md @@ -1,4 +1,4 @@ -# AKS-Engine +# AKS Engine The Azure Kubernetes Engine (`aks-engine`) generates ARM (Azure Resource Manager) templates for Kubernetes clusters on Microsoft Azure. The input to aks-engine is a cluster definition file which describes the desired cluster, including orchestrator, features, and agents. The structure of the input files is very similar to the public API for Azure Kubernetes Service. diff --git a/examples/README.md b/examples/README.md index f5b10a8565e..9b9b628823e 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Builds Kubernetes Clusters +# AKS Engine - Builds Kubernetes Clusters ## Overview diff --git a/examples/addons/container-monitoring/README.md b/examples/addons/container-monitoring/README.md index ef4c51c27bd..e6999ccbe20 100644 --- a/examples/addons/container-monitoring/README.md +++ b/examples/addons/container-monitoring/README.md @@ -1,6 +1,6 @@ # Container-monitoring addon -> Note: If more than one AKS-Engine cluster planned to configure to the same Azure Log Analytics Workspace then preferred option to use Helm chart to onboard the container monitoring addon. Refer [azuremonitor-containers](https://github.com/helm/charts/tree/master/incubator/azuremonitor-containers) to onboard using HELM chart. +> Note: If more than one AKS Engine cluster planned to configure to the same Azure Log Analytics Workspace then preferred option to use Helm chart to onboard the container monitoring addon. Refer [azuremonitor-containers](https://github.com/helm/charts/tree/master/incubator/azuremonitor-containers) to onboard using HELM chart. This is the Container-monitoring addon. This addon requires Azure Log Analytics Workspace GUID and key in Base64 encoded form. If you don't have Azure Log Analytics workspace, please create one by following the instructions in https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-quick-create-workspace. > Note: Workspace GUID and Key MUST be in Base-64 encoded. @@ -15,13 +15,13 @@ Here are the instructions to obtain the Workspace Guid and Key of your Azure Log Update the json file with your Base-64 encoded Workspace Guid and Key along with other parameter values, and use this update json file to automatically enable container monitoring in your new Kubernetes cluster. -Following additional steps required to view the health, metrics and logs of your AKS-Engine cluster(s) +Following additional steps required to view the health, metrics and logs of your AKS Engine cluster(s) 1. [Add the 'AzureMonitor-Containers' Solution to your Log Analytics workspace.](http://aka.ms/coinhelmdoc) 2. [For AKS-engine K8S cluster, add clusterName and Log Analytics workspace tag to cluster resources, to be able to use Azure Container monitoring User experience (aka.ms/azmon-containers)](http://aka.ms/coin-acs-tag-doc) -> Note: At the moment, if the AKS-Engine version is v0.29.1 or ACS-Engine Kubernetes cluster, then default clusterName is my_acs_cluster_name in the container monitoring addon. In AKS-Engine version greater than v0.29.1, the default cluster name is aks-engine-cluster. This name needs to be tagged as clusterName value in step #2 above. +> Note: At the moment, if the AKS Engine version is v0.29.1 or ACS-Engine Kubernetes cluster, then default clusterName is my_acs_cluster_name in the container monitoring addon. In AKS Engine version greater than v0.29.1, the default cluster name is aks-engine-cluster. This name needs to be tagged as clusterName value in step #2 above. Navigate to [azmon-containers](https://aka.ms/azmon-containers) to view the health, metrics and logs of your Kubernetes cluster(s). @@ -99,7 +99,7 @@ For more details on how to use the product, see [Azure Monitor for containers](h ## Disable Monitoring -After you enable monitoring of your AKS-Engine cluster, you can stop monitoring the cluster if you decide you no longer want to monitor it. +After you enable monitoring of your AKS Engine cluster, you can stop monitoring the cluster if you decide you no longer want to monitor it. - If you have onboarded the monitoring using the HELM chart, then you can disable monitoring by uninstalling the chart. Refer Uninstalling the Chart section in [azuremonitor-containers](https://github.com/helm/charts/tree/master/incubator/azuremonitor-containers) diff --git a/examples/customfiles/README.md b/examples/customfiles/README.md index 12276dd7285..73f945fd26d 100644 --- a/examples/customfiles/README.md +++ b/examples/customfiles/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Provisioning of master node custom files +# AKS Engine - Provisioning of master node custom files ## Overview diff --git a/examples/disks-managed/README.md b/examples/disks-managed/README.md index 91ee3f1029b..3c1854b464c 100644 --- a/examples/disks-managed/README.md +++ b/examples/disks-managed/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Managed Disks +# AKS Engine - Managed Disks ## Overview diff --git a/examples/disks-storageaccount/README.md b/examples/disks-storageaccount/README.md index 58b818fc3cc..6c64db3daae 100644 --- a/examples/disks-storageaccount/README.md +++ b/examples/disks-storageaccount/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Attached Disks +# AKS Engine - Attached Disks ## Overview diff --git a/examples/keyvault-params/README.md b/examples/keyvault-params/README.md index 21bd963d85b..160845d2593 100644 --- a/examples/keyvault-params/README.md +++ b/examples/keyvault-params/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Key vault referencing for k8s parameters +# AKS Engine - Key vault referencing for k8s parameters ## Overview diff --git a/examples/keyvaultcerts/README.md b/examples/keyvaultcerts/README.md index 582533ab38c..0fca009f481 100644 --- a/examples/keyvaultcerts/README.md +++ b/examples/keyvaultcerts/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Key vault certificate deployment +# AKS Engine - Key vault certificate deployment ## Overview diff --git a/examples/kubernetes-config/README.md b/examples/kubernetes-config/README.md index fcc941e32e6..15ce0cf0443 100644 --- a/examples/kubernetes-config/README.md +++ b/examples/kubernetes-config/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Kubernetes Features +# AKS Engine - Kubernetes Features ## Overview diff --git a/examples/largeclusters/README.md b/examples/largeclusters/README.md index 9ca42a6616e..efed833961a 100644 --- a/examples/largeclusters/README.md +++ b/examples/largeclusters/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Large Clusters +# AKS Engine - Large Clusters ## Overview diff --git a/examples/multiple-nodepools/README.md b/examples/multiple-nodepools/README.md index 81b2ea24057..c868f6ec899 100644 --- a/examples/multiple-nodepools/README.md +++ b/examples/multiple-nodepools/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Multiple Node Pools +# AKS Engine - Multiple Node Pools aks-engine supports creating a Kubernetes cluster with more than one node pool. These pools can have different configurations, such as VM size or storage profile. diff --git a/examples/networkplugin/README.md b/examples/networkplugin/README.md index a28171a81f9..1a040596683 100644 --- a/examples/networkplugin/README.md +++ b/examples/networkplugin/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Network Plugin +# AKS Engine - Network Plugin There are 2 different Network Plugin options : diff --git a/examples/networkpolicy/README.md b/examples/networkpolicy/README.md index 566fd38952e..fa9326eec7c 100644 --- a/examples/networkpolicy/README.md +++ b/examples/networkpolicy/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Network Policy +# AKS Engine - Network Policy There are 2 different Network Policy options : @@ -7,11 +7,11 @@ There are 2 different Network Policy options : ## Calico -Before enabling Calico policy for the AKS-Engine cluster, you must first decide which network plugin to use for the cluster: Azure or Kubenet. +Before enabling Calico policy for the AKS Engine cluster, you must first decide which network plugin to use for the cluster: Azure or Kubenet. The difference between Azure and Kubenet lies in the way IP addresses get allocated; Azure uses Azure-native IPs while Kubenet does static IP assignment based on the node's pod CIDR. If you're not sure which one to go with, we recommend going with Azure. -The kubernetes-calico deployment template enables Calico networking and policies for the AKS-Engine cluster via `"networkPolicy": "calico"` being present inside the `kubernetesConfig`. +The kubernetes-calico deployment template enables Calico networking and policies for the AKS Engine cluster via `"networkPolicy": "calico"` being present inside the `kubernetesConfig`. ```json "properties": { @@ -35,10 +35,10 @@ Once the template has been successfully deployed, following the [simple policy t > Note: `ping` (ICMP) traffic is blocked on the cluster by default. Wherever `ping` is used in any tutorial substitute testing access with something like `wget -q --timeout=5 google.com -O -` instead. -### Update guidance for clusters deployed by AKS-Engine releases prior to 0.17.0 +### Update guidance for clusters deployed by AKS Engine releases prior to 0.17.0 Clusters deployed with calico networkPolicy enabled prior to `0.17.0` had calico `2.6.3` deployed, and a daemonset with an `updateStrategy` of `Ondelete`. -AKS-Engine releases starting with 0.17.0 now produce an addon manifest for calico in `/etc/kubernetes/addons/calico-daemonset.yaml` contaning calico 3.1.x, and an `updateStrategy` of `RollingUpdate`. Due to breaking changes introduced by calico 3, one must first migrate through calico `2.6.5` or a later 2.6.x release in order to migrate to calico 3.1.x. as described in the [calico kubernetes upgrade documentation](https://docs.projectcalico.org/v3.1/getting-started/kubernetes/upgrade/). The AKS-Engine manifest for calico uses the [kubernetes API datastore, policy-only setup](https://docs.projectcalico.org/v3.1/getting-started/kubernetes/upgrade/upgrade#upgrading-an-installation-that-uses-the-kubernetes-api-datastore). +AKS Engine releases starting with 0.17.0 now produce an addon manifest for calico in `/etc/kubernetes/addons/calico-daemonset.yaml` contaning calico 3.1.x, and an `updateStrategy` of `RollingUpdate`. Due to breaking changes introduced by calico 3, one must first migrate through calico `2.6.5` or a later 2.6.x release in order to migrate to calico 3.1.x. as described in the [calico kubernetes upgrade documentation](https://docs.projectcalico.org/v3.1/getting-started/kubernetes/upgrade/). The AKS Engine manifest for calico uses the [kubernetes API datastore, policy-only setup](https://docs.projectcalico.org/v3.1/getting-started/kubernetes/upgrade/upgrade#upgrading-an-installation-that-uses-the-kubernetes-api-datastore). 1. To update to `2.6.5+` in preparation of an upgrade to 3.1.x as specified, edit `/etc/kubernetes/addons/calico-daemonset.yaml` on a master node, replacing `calico/node:v3.1.1` with `calico/node:v2.6.10` and `calico/cni:v3.1.1` with `calico/cni:v2.0.6`. Run `kubectl apply -f /etc/kubernetes/addons/calico-daemonset.yaml`. @@ -64,7 +64,7 @@ If you have any customized calico resource manifests, you must also follow the [ ## Cilium -The kubernetes-cilium deployment template enables Cilium networking and policies for the AKS-Engine cluster via `"networkPolicy": "cilium"` or `"networkPlugin": "cilium"` being present inside the `kubernetesConfig`. +The kubernetes-cilium deployment template enables Cilium networking and policies for the AKS Engine cluster via `"networkPolicy": "cilium"` or `"networkPlugin": "cilium"` being present inside the `kubernetesConfig`. ```json "properties": { @@ -94,6 +94,6 @@ The kubernetes-cilium deployment template enables Cilium networking and policies ### Post installation -Once the template has been successfully deployed, following the [deploy the demo application](http://cilium.readthedocs.io/en/latest/gettingstarted/minikube/#step-2-deploy-the-demo-application) tutorial will provide a good foundation for how to do L3/4 policy as well as more advanced Layer 7 inspection and routing. If you have [Istio](https://istio.io) you can try this [tutorial](http://cilium.readthedocs.io/en/latest/gettingstarted/istio/) where cilium is used to side by side with Istio to enforce security policies in a Kubernetes deployment. +Once the template has been successfully deployed, following the [deploy the demo application](http://cilium.readthedocs.io/en/latest/gettingstarted/minikube/#step-2-deploy-the-demo-application) tutorial will provide a good foundation for how to do L3/4 policy as well as more advanced Layer 7 inspection and routing. If you have [Istio](https://istio.io) you can try this [tutorial](http://cilium.readthedocs.io/en/latest/gettingstarted/istio/) where cilium is used to side by side with Istio to enforce security policies in a Kubernetes deployment. For the latest documentation on Cilium (including BPF and XDP reference guides), please refer to [this](http://cilium.readthedocs.io/en/latest/) diff --git a/examples/vnet/README.md b/examples/vnet/README.md index 270e397442a..8f59353e551 100644 --- a/examples/vnet/README.md +++ b/examples/vnet/README.md @@ -1,4 +1,4 @@ -# AKS-Engine - Custom VNET +# AKS Engine - Custom VNET ## Overview diff --git a/examples/windows/README.md b/examples/windows/README.md index 516f0eb8deb..bf517de019c 100644 --- a/examples/windows/README.md +++ b/examples/windows/README.md @@ -1,4 +1,4 @@ -# AKS-Engine +# AKS Engine ## Overview