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

Commit

Permalink
docs: replace mentions of "aks-engine orchestrators" command
Browse files Browse the repository at this point in the history
  • Loading branch information
mboersma committed Feb 7, 2019
1 parent 305d5b9 commit aac7037
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 17 deletions.
2 changes: 1 addition & 1 deletion cmd/get_versions.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func newGetVersionsCmd() *cobra.Command {
f := command.Flags()
oc.orchestrator = "Kubernetes" // orchestrator is always Kubernetes
f.StringVar(&oc.version, "version", "", "Kubernetes version (optional)")
f.BoolVar(&oc.windows, "windows", false, "Kubernetes platform (optional)")
f.BoolVar(&oc.windows, "windows", false, "Kubernetes cluster with Windows nodes (optional)")

return command
}
2 changes: 1 addition & 1 deletion cmd/upgrade.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ func (uc *upgradeCmd) loadCluster(cmd *cobra.Command) error {
}
}
if !found {
return errors.Errorf("upgrading from Kubernetes version %s to version %s is not supported. To see a list of available upgrades, use 'aks-engine orchestrators --orchestrator kubernetes --version %s'", uc.containerService.Properties.OrchestratorProfile.OrchestratorVersion, uc.upgradeVersion, uc.containerService.Properties.OrchestratorProfile.OrchestratorVersion)
return errors.Errorf("upgrading from Kubernetes version %s to version %s is not supported. To see a list of available upgrades, use 'aks-engine get-versions --version %s'", uc.containerService.Properties.OrchestratorProfile.OrchestratorVersion, uc.upgradeVersion, uc.containerService.Properties.OrchestratorProfile.OrchestratorVersion)
}

// Read the name suffix from the parameters to identify VMs in the resource group that belong to this cluster.
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/clusterdefinitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ Here are the valid values for the orchestrator types:

1. `Kubernetes` - this represents the Kubernetes orchestrator.

To learn more about supported orchestrators and versions, run the orchestrators command:
To learn more about supported versions, run the get-versions command:

```console
$ aks-engine orchestrators
$ aks-engine get-versions
```

### kubernetesConfig
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ In order to ensure that your `aks-engine upgrade` operation runs smoothly, there

3) `aks-engine upgrade` allows upgrading the Kubernetes version to any AKS Engine-supported patch release in the current minor release channel that is greater than the current version on the cluster (e.g., from `1.11.4` to `1.11.5`), or to the next aks-engine-supported minor version (e.g., from `1.11.4` to `1.12.5`). In practice, the next AKS Engine-supported minor version will commonly be a single minor version ahead of the current cluster version. However, if the cluster has not been upgraded in a significant amount of time, the "next" minor version may have actually been deprecated by aks-engine. In such a case, your long-lived cluster will be upgradable to the nearest, supported minor version that `aks-engine` supports at the time of upgrade (e.g., from `1.7.16` to `1.9.11`).

To get the list of all available Kubernetes versions and upgrades, run the `orchestrators` command and specify Kubernetes orchestrator type:
To get the list of all available Kubernetes versions and upgrades, run the `get-versions` command:

```bash
./bin/aks-engine orchestrators --orchestrator Kubernetes
./bin/aks-engine get-versions
```

To get the versions of Kubernetes that your particular cluster version is upgradable to, provide its current Kubernetes version in the `version` arg:

```bash
./bin/aks-engine orchestrators --orchestrator Kubernetes --version 1.11.5
./bin/aks-engine get-versions --version 1.11.7
```

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 + the same version of the `aks-engine` binary) 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 possible configuration. Therefore, it is recommended that you ensure in a staging environment that your specific cluster configuration is upgradable using `aks-engine upgrade` before attempting this potentially destructive operation on your production cluster.
Expand Down
11 changes: 6 additions & 5 deletions docs/tutorials/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,23 +107,24 @@ 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
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.
```
Expand Down
11 changes: 6 additions & 5 deletions docs/tutorials/quickstart.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,24 @@ make build

```
# ./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
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.
```
Expand Down

0 comments on commit aac7037

Please sign in to comment.