Skip to content

Commit

Permalink
docs: remove mentions of old orchestrators (#2501)
Browse files Browse the repository at this point in the history
mboersma authored and acs-bot committed Dec 26, 2019
1 parent bbd5e80 commit 81175cc
Showing 12 changed files with 40 additions and 47 deletions.
16 changes: 9 additions & 7 deletions docs/community/developer-guide.md
Original file line number Diff line number Diff line change
@@ -55,23 +55,25 @@ The build process leaves the compiled `aks-engine` binary in the `bin` directory

```sh
$ ./bin/aks-engine
AKS Engine deploys and manages Kubernetes, Swarm Mode, and DC/OS clusters in Azure

Usage:
aks-engine [flags]
aks-engine [command]

Available Commands:
completion Generates bash completion scripts
deploy Deploy an Azure Resource Manager template
generate Generate an Azure Resource Manager template
get-versions Display info about supported Kubernetes versions
help Help about any command
orchestrators Display info about supported orchestrators
rotate-certs Rotate certificates on an existing Kubernetes cluster
scale Scale an existing Kubernetes cluster
upgrade Upgrade an existing Kubernetes cluster
version Print the version of AKS Engine

Flags:
--debug enable verbose debug logs
-h, --help help for aks-engine
--debug enable verbose debug logs
-h, --help help for aks-engine
--show-default-model Dump the default API model to stdout

Use "aks-engine [command] --help" for more information about a command.
```
@@ -339,12 +341,12 @@ The following steps constitute the AKS Engine CI pipeline:
To make it easier use AKS Engine as a library and to `go get github.com/Azure/aks-engine`, some
generated Go code is committed to the repository. Your pull request may need to regenerate those
files before it will pass the required `make ensure-generated` step.
Always run `make build` before you submit a pull request to validate compilation and
generated code hygiene. Run `make ensure-generated` yourself to validate that things check out. If there are
discrepencies, `make ensure-generated` will output a brief error report.
### What is generated?
- Changes under the `parts/` folder require the `pkg/engine/templates_generated.go` file to be updated.
- Changes under `pkg/i8n/translations` require the `pkg/engine/translations_generated.go` file to be updated.
- Changes under `pkg/i8n/translations` require the `pkg/engine/translations_generated.go` file to be updated.
2 changes: 1 addition & 1 deletion 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 to deploy Kubernetes clusters 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.

8 changes: 4 additions & 4 deletions docs/topics/extensions.md
Original file line number Diff line number Diff line change
@@ -4,18 +4,18 @@ Extensions in AKS Engine provide an easy way for AKS Engine users to add pre-pac

## extensionProfiles

The extensionProfiles contains the extensions that the cluster will install. The following illustrates a template with a hello-world-dcos extension.
The extensionProfiles contains the extensions that the cluster will install. The following illustrates a template with a hello-world extension.

``` javascript
{
...
"extensionProfiles": [
{
"name": "hello-world-dcos",
"name": "hello-world",
"version": "v1",
"extensionParameters": "parameters",
"rootURL": "http://mytestlocation.com/hello-world-dcos/",
"script": "hello-world-dcos.sh"
"rootURL": "http://mytestlocation.com/hello-world/",
"script": "hello-world.sh"
}
]
}
4 changes: 2 additions & 2 deletions docs/tutorials/custom-vnet.md
Original file line number Diff line number Diff line change
@@ -71,7 +71,7 @@ az group create -n aks-custom-vnet -l "westeurope"
Then you can deploy the virtual network using the JSON description above and the following command:

```bash
az group deployment create -g aks-custom-vnet --name "CustomVNet" --template-file azuredeploy.swarm.vnet.json
az group deployment create -g aks-custom-vnet --name "CustomVNet" --template-file azuredeploy.vnet.json
```

Alternatively, you can use Azure CLI to create the vnet and the subnet directly:
@@ -140,7 +140,7 @@ _Note: Make sure the the vnetSubnetId matches with your subnet, by giving your *

## Deploy the AKS Engine template

Once you are ready with the cluster definition file, you can either use AKS engine to deploy the cluster on Azure or you can use AKS Engine to generate an ARM template to deploy using Azure CLI.
Once you are ready with the cluster definition file, you can either use AKS engine to deploy the cluster on Azure or you can use AKS Engine to generate an ARM template to deploy using Azure CLI.

### Deploy using AKS Engine

9 changes: 3 additions & 6 deletions examples/disks-storageaccount/README.md
Original file line number Diff line number Diff line change
@@ -2,11 +2,8 @@

## Overview

AKS Engine enables you to create customized Kubernetes cluster on Microsoft Azure with attached disks.
AKS Engine enables you to create a customized Kubernetes cluster on Microsoft Azure with attached disks.

The examples show you how to configure up to 4 attached disks. The disks can range from 1 to 1024 GB in size:
The example JSON apimodel file in this directory shows you how to configure up to 4 attached disks. Disks can range from 1 to 1024 GB in size.

1. **dcos.json** - deploying and using [DC/OS](../../docs/dcos.md)
2. **kubernetes.json** - deploying and using [Kubernetes](../../docs/kubernetes.md)
3. **swarm.json** - deploying and using [Swarm](../../docs/swarm.md)
4. **swarmmode.json** - deploying and using [Swarm Mode](../../docs/swarmmode.md)
1. **kubernetes.json** - deploying and using [Kubernetes](../../docs/tutorials/deploy.md)
10 changes: 3 additions & 7 deletions examples/keyvaultcerts/README.md
Original file line number Diff line number Diff line change
@@ -2,15 +2,11 @@

## Overview

AKS Engine enables you to create customized Kubernetes cluster on Microsoft Azure with certs installed from key vault during deployment.
AKS Engine enables you to create a customized Kubernetes cluster on Microsoft Azure with certs installed from key vault during deployment.

The examples show you how to configure installing a cert from keyvault. These certs are assumed to be in the secrets portion of your keyvault:
The example shows you how to configure installing a cert from keyvault. These certs are assumed to be in the secrets portion of your keyvault:

1. **dcos.json** - deploying and using [DC/OS](../../docs/dcos.md)
2. **kubernetes.json** - deploying and using [Kubernetes](../../docs/kubernetes.md)
3. **swarm.json** - deploying and using [Swarm](../../docs/swarm.md)
4. **swarm-windows.json** - deploying and using [Swarm](../../docs/swarm.md)
5. **swarmmode.json** - deploying and using [Swarm Mode](../../docs/swarmmode.md)
1. **kubernetes.json** - deploying and using [Kubernetes](../../docs/tutorials/deploy.md)

On windows machines certificates will be installed under the machine in the specified store.
On linux machines the certificates will be installed in the folder /var/lib/waagent/. There will be two files
2 changes: 1 addition & 1 deletion examples/kubernetes-config/README.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

## Overview

These cluster definition examples show how to create customized [Kubernetes](../../docs/kubernetes.md) clusters on Microsoft Azure.
These cluster definition examples show how to create customized [Kubernetes](../../docs/tutorials/deploy.md) clusters on Microsoft Azure.

1. [**kubernetes-clustersubnet.json**](kubernetes-clustersubnet.json) - Configuring a custom cluster IP subnet.
2. [**kubernetes-maxpods.json**](kubernetes-maxpods.json) - Configuring a custom maximum limit on the number of pods per node.
2 changes: 1 addition & 1 deletion examples/networkpolicy/README.md
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ This template will deploy the [Kubernetes Datastore backed version of Calico](ht

If deploying on a K8s 1.8 or later cluster, then egress policies are also supported!

To understand how to deploy this template, please read the baseline [Kubernetes](../../docs/kubernetes.md) document, and use the appropriate **kubernetes-calico-[azure|kubenet].json** example file in this folder as an api model reference.
To understand how to deploy this template, please read the baseline [Kubernetes](../../docs/tutorials/deploy.md) document, and use the appropriate **kubernetes-calico-[azure|kubenet].json** example file in this folder as an api model reference.

### Post installation

2 changes: 0 additions & 2 deletions examples/vnet/vnetarmtemplate/deploy.ps1
Original file line number Diff line number Diff line change
@@ -2,8 +2,6 @@ $VerbosePreference="Continue"
$deployName="myKubeVnet"
$RGName=$deployName
$locName="West US"
#$templateFile = "azuredeploy.dcos.json"
#$templateFile = "azuredeploy.swarm.json"
$templateFile = "azuredeploy.kubernetes.json"
New-AzureRmResourceGroup -Name $RGName -Location $locName -Force
New-AzureRmResourceGroupDeployment -Name $deployName -ResourceGroupName $RGName -TemplateFile $templateFile
6 changes: 3 additions & 3 deletions extensions/hello-world/README.md
Original file line number Diff line number Diff line change
@@ -26,15 +26,15 @@ ls -l /var/log
...
"extensions": [
{
"name": "hello-world-dcos",
"name": "hello-world",
"singleOrAll": "single"
}
]
},
...
"extensionProfiles": [
{
"name": "hello-world-dcos",
"name": "hello-world",
"version": "v1",
"script": "hello.sh"
}
@@ -44,4 +44,4 @@ ls -l /var/log
```

# Supported Orchestrators
All
All
2 changes: 1 addition & 1 deletion extensions/hello-world/v1/supported-orchestrators.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
["Kubernetes","Swarm","SwarmMode","DCOS", "DCOS173", "DCOS184", "DCOS188", "DCOS190"]
["Kubernetes"]
24 changes: 12 additions & 12 deletions releases/README.Dockerfile.md
Original file line number Diff line number Diff line change
@@ -2,57 +2,57 @@

**Bash**
```bash
$ export VERSION=0.32.0
$ export VERSION=0.45.0
$ docker build --no-cache --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` --build-arg AKSENGINE_VERSION="$VERSION" -t microsoft/aks-engine:$VERSION --file ./Dockerfile.linux .
```
**PowerShell**
```powershell
PS> $VERSION="0.32.0"
PS> $VERSION="0.45.0"
PS> docker build --no-cache --build-arg BUILD_DATE=$(Get-Date((Get-Date).ToUniversalTime()) -UFormat "%Y-%m-%dT%H:%M:%SZ") --build-arg AKSENGINE_VERSION="$VERSION" -t microsoft/aks-engine:$VERSION --file .\Dockerfile.linux .
```

# Inspect Docker image metadata

**Bash**
```bash
$ docker image inspect microsoft/aks-engine:0.32.0 --format "{{json .Config.Labels}}" | jq
$ docker image inspect microsoft/aks-engine:0.45.0 --format "{{json .Config.Labels}}" | jq
{
"maintainer": "Microsoft",
"org.label-schema.build-date": "2017-10-25T04:35:06Z",
"org.label-schema.description": "The Azure Kubernetes Engine (aks-engine) generates ARM (Azure Resource Manager) templates for Kubernetes clusters on Microsoft Azure with your choice of DCOS, Kubernetes, or Swarm orchestrators.",
"org.label-schema.docker.cmd": "docker run --rm microsoft/aks-engine:0.32.0",
"org.label-schema.build-date": "2019-12-23T20:37:06Z",
"org.label-schema.description": "The Azure Kubernetes Engine (aks-engine) generates ARM (Azure Resource Manager) templates for Kubernetes clusters on Microsoft Azure.",
"org.label-schema.docker.cmd": "docker run -v ${PWD}:/aks-engine/workspace -it --rm microsoft/aks-engine:0.45.0",
"org.label-schema.license": "MIT",
"org.label-schema.name": "Azure Kubernetes Engine (aks-engine)",
"org.label-schema.schema-version": "1.0",
"org.label-schema.url": "https://github.com/Azure/aks-engine",
"org.label-schema.usage": "https://github.com/Azure/aks-engine/blob/master/docs/aksengine.md",
"org.label-schema.vcs-url": "https://github.com/Azure/aks-engine.git",
"org.label-schema.vendor": "Microsoft",
"org.label-schema.version": "0.32.0"
"org.label-schema.version": "0.45.0"
}
```

**PowerShell**
```powershell
PS> docker image inspect microsoft/aks-engine:0.32.0 --format "{{json .Config.Labels}}" | ConvertFrom-Json | ConvertTo-Json
PS> docker image inspect microsoft/aks-engine:0.45.0 --format "{{json .Config.Labels}}" | ConvertFrom-Json | ConvertTo-Json
{
"maintainer": "Microsoft",
"org.label-schema.build-date": "2017-10-25T04:35:06Z",
"org.label-schema.build-date": "2019-12-23T20:37:06Z",
"org.label-schema.description": "The Azure Kubernetes Engine (aks-engine) generates ARM (Azure Resource Manager) templates for Kubernetes clusters on Microsoft Azure.",
"org.label-schema.docker.cmd": "docker run --rm microsoft/aks-engine:0.32.0",
"org.label-schema.docker.cmd": "docker run --rm microsoft/aks-engine:0.45.0",
"org.label-schema.license": "MIT",
"org.label-schema.name": "Azure Kubernetes Engine (aks-engine)",
"org.label-schema.schema-version": "1.0",
"org.label-schema.url": "https://github.com/Azure/aks-engine",
"org.label-schema.usage": "https://github.com/Azure/aks-engine/blob/master/docs/aksengine.md",
"org.label-schema.vcs-url": "https://github.com/Azure/aks-engine.git",
"org.label-schema.vendor": "Microsoft",
"org.label-schema.version": "0.32.0"
"org.label-schema.version": "0.45.0"
}
```

# Run Docker image

```
$ docker run --rm microsoft/aks-engine:0.32.0
$ docker run --rm microsoft/aks-engine:0.45.0
```

0 comments on commit 81175cc

Please sign in to comment.