docs: clarify that update is for node pools only (Azure#3877)

penggu · Oct 28, 2020 · fe5d6eb · fe5d6eb
1 parent fdf771a
commit fe5d6eb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/topics/update.md b/docs/topics/update.md
@@ -10,6 +10,8 @@ This guide assumes you already have a running cluster deployed using the `aks-en
 
 The `aks-engine update` command can update the VMSS model of a node pool according to a modified configuration of the aks-engine-generated `apimodel.json`. When used in combination with a newer version of the `aks-engine` CLI compared to the version used to build the cluster originally, node pools can be regularly refreshed so that as they scale over time, new nodes always run the latest, validated bits, using your latest, validated node configuration.
 
+Note: `aks-engine update` **can not** be used to update the control plane! To update control plane VM configuration, see [`aks-engine upgrade --control-plane-only` documentation here](upgrade.md#when-should-i-use-aks-engine-upgrade---control-plane-only).
+
 This command can *only* be used with VMSS-backed node pools (the default AKS Engine node pool type is VMSS).
 
 The example below will assume you have a cluster deployed, and that the API model originally used to deploy that cluster is stored at `_output/<dnsPrefix>/apimodel.json`. It will also assume that there is a node pool named "agentpool1" in your cluster.

diff --git a/docs/tutorials/cli-overview.md b/docs/tutorials/cli-overview.md
@@ -123,6 +123,8 @@ Detailed documentation on `aks-engine scale` can be found [here](../topics/scale
 
 The `aks-engine update` command will update the VMSS model of a node pool according to a modified configuration of the aks-engine-generated `apimodel.json`. The updated node configuration will not take affect on any existing nodes, but will be applied to all future, new nodes created by VMSS scale out operations. Use this command to update the node configuration (such as the OS configuration, VM SKU, or Kubernetes kubelet configuration) of an existing VMSS node pool.
 
+Note: `aks-engine update` **can not** be used to update the control plane! To update control plane VM configuration, see [`aks-engine upgrade --control-plane-only` documentation here](../topics/upgrade.md#when-should-i-use-aks-engine-upgrade---control-plane-only).
+
 
 ```sh
 $ aks-engine update --help