Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

Commit

Permalink
docs: refer to the project as "AKS Engine" consistently (#436)
Browse files Browse the repository at this point in the history
  • Loading branch information
mboersma authored and jackfrancis committed Feb 4, 2019
1 parent b96163c commit e250a6c
Show file tree
Hide file tree
Showing 34 changed files with 87 additions and 87 deletions.
6 changes: 3 additions & 3 deletions .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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! 🎉🎉🎉
Congrats on merging your first pull request! 🎉🎉🎉
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ 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 (
debug bool
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,
Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/community/README.md
Original file line number Diff line number Diff line change
@@ -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 <https://kubernetes.slack.com> 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 <https://kubernetes.slack.com> 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!
8 changes: 4 additions & 4 deletions docs/community/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
18 changes: 9 additions & 9 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# 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`?

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`?

Yes. `aks-engine` [v0.27.0][] is a continuation of acs-engine [v0.26.2][] with all the Kubernetes fixes and features included in [v0.26.2][] and more.


[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/
Expand Down
2 changes: 1 addition & 1 deletion docs/howto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 3 additions & 3 deletions docs/howto/kubernetes-large-clusters.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/howto/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.
Please review the [upgrade documentation](../topics/upgrade.md) for a guide on upgrading `aks-engine` Kubernetes clusters.
6 changes: 3 additions & 3 deletions docs/topics/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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/)

Expand Down
8 changes: 4 additions & 4 deletions docs/topics/architecture.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit e250a6c

Please sign in to comment.