Skip to content

Commit ad1ae29

Browse files
committed
upgrade section
1 parent d1d8a31 commit ad1ae29

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

articles/azure-arc/kubernetes/extensions.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Deploy and manage Azure Arc-enabled Kubernetes cluster extensions"
33
ms.custom: event-tier1-build-2022, ignite-2022
4-
ms.date: 04/04/2023
4+
ms.date: 04/13/2023
55
ms.topic: how-to
66
description: "Create and manage extension instances on Azure Arc-enabled Kubernetes clusters."
77
---
@@ -110,7 +110,7 @@ Use one or more of these optional parameters as needed for your scenarios, along
110110
> [!NOTE]
111111
> You can choose to automatically upgrade your extension instance to the latest minor and patch versions by setting `auto-upgrade-minor-version` to `true`, or you can instead set the version of the extension instance manually using the `--version` parameter. We recommend enabling automatic upgrades for minor and patch versions so that you always have the latest security patches and capabilities.
112112
>
113-
> Because major version upgrades may include breaking changes, automatic upgrades for new major versions of an extension instance aren't supported.
113+
> Because major version upgrades may include breaking changes, automatic upgrades for new major versions of an extension instance aren't supported. You can choose when to [manually upgrade extension instances](#upgrade-extension-instance) to a new major version.
114114
115115

116116
| Parameter name | Description |
@@ -122,7 +122,7 @@ Use one or more of these optional parameters as needed for your scenarios, along
122122
| `--configuration-protected-settings` | Settings that aren't retrievable using `GET` API calls or `az k8s-extension show` commands. Typically used to pass in sensitive settings. These are passed in as space-separated `key=value` pairs after the parameter name. If this parameter is used in the command, then `--configuration-protected-settings-file` can't be used in the same command. |
123123
| `--configuration-protected-settings-file` | Path to a JSON file with `key=value` pairs to be used for passing sensitive settings into the extension. If this parameter is used in the command, then `--configuration-protected-settings` can't be used in the same command. |
124124
| `--release-namespace` | This parameter indicates the namespace within which the release will be created. Only relevant if `scope` is set to `cluster`. |
125-
| `--release-train` | Extension authors can publish versions in different release trains such as `Stable`, `Preview`, etc. If this parameter isn't set explicitly, `Stable` is used as default. This parameter can't be used when `--auto-upgrade-minor-version` is set to `false`. |
125+
| `--release-train` | Extension authors can publish versions in different release trains such as `Stable`, `Preview`, etc. If this parameter isn't set explicitly, `Stable` is used as default. If `--auto-upgrade-minor-version` is set to `true`, the latest version for the specified release train is used when the extension instance is created (unless a different version is specified in the `--version` parameter) and for future automatic upgrades. If `--auto-upgrade-minor-version` parameter is set to `false`, this parameter will only apply to the newly created extension (unless a different version is specified in the `--version` parameter). |
126126
| `--target-namespace` | Indicates the namespace within which the release will be created. Permission of the system account created for this extension instance will be restricted to this namespace. Only relevant if `scope` is set to `namespace`. |
127127

128128
## Show extension details
@@ -251,7 +251,6 @@ az k8s-extension update --name azureml --extension-type Microsoft.AzureML.Kubern
251251
| Parameter name | Description |
252252
|----------------|------------|
253253
| `--name` | Name of the extension instance |
254-
| `--extension-type` | The type of extension you want to install on the cluster. For example: Microsoft.AzureML.Kubernetes |
255254
| `--cluster-name` | Name of the cluster on which the extension instance has to be created |
256255
| `--resource-group` | The resource group containing the cluster |
257256
| `--cluster-type` | The cluster type on which the extension instance has to be created. For Azure Arc-enabled Kubernetes clusters, use `connectedClusters`. For AKS clusters, use `managedClusters`.|
@@ -267,11 +266,25 @@ az k8s-extension update --name azureml --extension-type Microsoft.AzureML.Kubern
267266
| `--configuration-protected-settings` | Settings that aren't retrievable using `GET` API calls or `az k8s-extension show` commands. Typically used to pass in sensitive settings. These are passed in as space-separated `key=value` pairs after the parameter name. If this parameter is used in the command, then `--configuration-protected-settings-file` can't be used in the same command. When you update a protected setting, all of the protected settings are expected to be specified. If any of these settings are omitted, those settings will be considered obsolete and deleted. |
268267
| `--configuration-protected-settings-file` | Path to a JSON file with `key=value` pairs to be used for passing in sensitive settings to the extension. If this parameter is used in the command, then `--configuration-protected-settings` can't be used in the same command. |
269268
| `--scope` | Scope of installation for the extension - `cluster` or `namespace`. |
270-
| `--release-train` | Extension authors can publish versions in different release trains such as `Stable`, `Preview`, etc. If this parameter isn't set explicitly, `Stable` is used as default. This parameter can't be used when `autoUpgradeMinorVersion` parameter is set to `false`. |
269+
| `--release-train` | Extension authors can publish versions in different release trains such as `Stable`, `Preview`, etc. If this parameter isn't set explicitly, `Stable` is used as default. If `--auto-upgrade-minor-version` is set to `true`, the latest version for the specified release train is used for automatic upgrades. If `--auto-upgrade-minor-version` parameter is set to `false`, and you specify a specific version for an upgrade, this parameter should not be used. |
270+
271+
## Upgrade extension instance
272+
273+
As noted earlier, if you set `auto-upgrade-minor-version` to true, the extension will automatically be upgraded when a new minor version is released. For most scenarios, we recommend enabling automatic upgrades. If you set `auto-upgrade-minor-version` to false, you'll have to upgrade the extension manually if you want a newer version.
274+
275+
Manual upgrades are also required to get a new major instance of an extension. You can choose when to upgrade in order to avoid any unexpected breaking changes with major version upgrades.
276+
277+
To manually upgrade an extension instance, use `k8s-extension update` and set the `version` parameter to specify a version.
278+
279+
This example updates an Azure Machine Learning extension instance to version x.y.z:
280+
281+
```azurecli
282+
az k8s-extension update --cluster-name <clusterName> --resource-group <resourceGroupName> --cluster-type connectedClusters --name azureml --version x.y.z
283+
```
271284

272285
## Delete extension instance
273286

274-
To delete an extension instance on a cluster, use `k8s-extension delete`, passing in values for the mandatory parameters.
287+
To delete an extension instance on a cluster, use `k8s-extension delete`, passing in values for the mandatory parameters:
275288

276289
```azurecli
277290
az k8s-extension delete --name azuremonitor-containers --cluster-name <clusterName> --resource-group <resourceGroupName> --cluster-type connectedClusters

0 commit comments

Comments
 (0)