|
1 | 1 | ---
|
2 | 2 | title: "Deploy and manage Azure Arc-enabled Kubernetes cluster extensions"
|
3 | 3 | ms.custom: event-tier1-build-2022, ignite-2022
|
4 |
| -ms.date: 03/08/2023 |
| 4 | +ms.date: 04/04/2023 |
5 | 5 | ms.topic: how-to
|
6 | 6 | description: "Create and manage extension instances on Azure Arc-enabled Kubernetes clusters."
|
7 | 7 | ---
|
@@ -119,6 +119,11 @@ Use one or more of these optional parameters as needed for your scenarios, along
|
119 | 119 | | `--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`. |
|
120 | 120 | | `--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`. |
|
121 | 121 |
|
| 122 | +> [!NOTE] |
| 123 | +> 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. |
| 124 | +> |
| 125 | +> Because major version upgrades may include breaking changes, automatic upgrades for new major versions of an extension instance aren't supported. |
| 126 | +
|
122 | 127 | ## Show extension details
|
123 | 128 |
|
124 | 129 | To view details of a currently installed extension instance, use `k8s-extension show`, passing in values for the mandatory parameters.
|
@@ -227,6 +232,42 @@ az k8s-extension list --cluster-name <clusterName> --resource-group <resourceGro
|
227 | 232 | ]
|
228 | 233 | ```
|
229 | 234 |
|
| 235 | +## Update extension instance |
| 236 | + |
| 237 | +> [!NOTE] |
| 238 | +> Refer to documentation for the specific extension type to understand the specific settings in `--configuration-settings` and `--configuration-protected-settings` that are able to be updated. For `--configuration-protected-settings`, all settings are expected to be provided, even if only one setting is being updated. If any of these settings are omitted, those settings will be considered obsolete and deleted. |
| 239 | +
|
| 240 | +To update an existing extension instance, use `k8s-extension update`, passing in values for the mandatory and optional parameters. The mandatory and optional parameters are slightly different than those used to create an extension instance. |
| 241 | + |
| 242 | +This example updates the `auto-upgrade-minor-version` setting for an Azure Machine Learning extension instance to `true`: |
| 243 | + |
| 244 | +```azurecli |
| 245 | +az k8s-extension update --name azureml --extension-type Microsoft.AzureML.Kubernetes --scope cluster --cluster-name <clusterName> --resource-group <resourceGroupName> --auto-upgrade-minor-version true --cluster-type managedClusters |
| 246 | +``` |
| 247 | + |
| 248 | +### Required parameters for update |
| 249 | + |
| 250 | +| Parameter name | Description | |
| 251 | +|----------------|------------| |
| 252 | +| `--name` | Name of the extension instance | |
| 253 | +| `--extension-type` | The type of extension you want to install on the cluster. For example: Microsoft.AzureML.Kubernetes | |
| 254 | +| `--cluster-name` | Name of the cluster on which the extension instance has to be created | |
| 255 | +| `--resource-group` | The resource group containing the cluster | |
| 256 | +| `--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`.| |
| 257 | + |
| 258 | +### Optional parameters for update |
| 259 | + |
| 260 | +| Parameter name | Description | |
| 261 | +|--------------|------------| |
| 262 | +| `--auto-upgrade-minor-version` | Boolean property that specifies whether the extension minor version is automatically upgraded. The default setting is `true`. If this parameter is set to true, you can't set the `version` parameter, as the version will be dynamically updated. If set to `false`, the extension won't be automatically upgraded, even for patch versions. | |
| 263 | +| `--version` | Version of the extension to be installed (specific version to pin the extension instance to). Must not be supplied if auto-upgrade-minor-version is set to `true`. | |
| 264 | +| `--configuration-settings` | Settings that can be passed into the extension to control its functionality.These are passed in as space-separated `key=value` pairs after the parameter name. If this parameter is used in the command, then `--configuration-settings-file` can't be used in the same command. Only the settings that require an update need to be provided. The provided settings will be replaced with the specified values. | |
| 265 | +| `--configuration-settings-file` | Path to the JSON file with `key=value` pairs to be used for passing in configuration settings to the extension. If this parameter is used in the command, then `--configuration-settings` can't be used in the same command. | |
| 266 | +| `--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. | |
| 267 | +| `--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. | |
| 268 | +| `--scope` | Scope of installation for the extension - `cluster` or `namespace`. | |
| 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. This parameter can't be used when `autoUpgradeMinorVersion` parameter is set to `false`. | |
| 270 | + |
230 | 271 | ## Delete extension instance
|
231 | 272 |
|
232 | 273 | To delete an extension instance on a cluster, use `k8s-extension delete`, passing in values for the mandatory parameters.
|
|
0 commit comments