Skip to content

Commit 9d7aaf4

Browse files
Learn Build Service GitHub AppLearn Build Service GitHub App
authored andcommitted
Merging changes synced from https://github.com/MicrosoftDocs/azure-stack-docs-pr (branch live)
2 parents 1038058 + 2537baf commit 9d7aaf4

File tree

5 files changed

+49
-38
lines changed

5 files changed

+49
-38
lines changed

AKS-Arc/aks-create-clusters-cli.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to create Kubernetes clusters in Azure Local using Azure
44
ms.topic: how-to
55
ms.custom: devx-track-azurecli
66
author: sethmanheim
7-
ms.date: 12/18/2024
7+
ms.date: 02/18/2025
88
ms.author: sethm
99
ms.lastreviewed: 01/25/2024
1010
ms.reviewer: guanghu
@@ -52,10 +52,14 @@ az aksarc create -n $aksclustername -g $resource_group --custom-location $custom
5252

5353
After a few minutes, the command completes and returns JSON-formatted information about the cluster.
5454

55-
> [!NOTE]
56-
> - The SSH key value is the public key for accessing nodes in the provisioned cluster. By default, this key is located at `~/.ssh/id_rsa.pub`. You can specify a different location using the `--ssh-key-value` parameter during cluster creation.
57-
> - The `--generate-ssh-keys` parameter is required if there's no pre-existing SSH key on your local machine. If you don't include this parameter during cluster creation and no SSH key exists, you receive an error message.
58-
> - If you already have an SSH key on your local machine, the AKS cluster reuses that key. In this case, specifying `--generate-ssh-keys`, or omitting that parameter, has no effect.
55+
### Considerations
56+
57+
Note the following considerations when you create a cluster:
58+
59+
- SSH keys are essential for troubleshooting and log collection. Be sure to save your private key file for future use. To access nodes, see [Connect to Windows or Linux worker nodes with SSH](/azure/aks/aksarc/ssh-connect-to-windows-and-linux-worker-nodes).
60+
- You can use a pre-existing SSH key or [configure SSH keys for an AKS cluster](configure-ssh-keys.md) during cluster creation. If there's no pre-existing SSH key on your local machine, the `--generate-ssh-keys` parameter is required. You can also restrict SSH access by following [the documentation](restrict-ssh-access.md). For detailed instructions, see [Create and store SSH keys with the Azure CLI](/azure/virtual-machines/ssh-keys-azure-cli), or in the [Azure portal](/azure/virtual-machines/ssh-keys-portal).
61+
- If you don't include `--generate-ssh-keys` during cluster creation and no SSH key exists, you receive an error message. If you already have an SSH key on your local machine, the AKS cluster reuses it. In this case, it makes no difference whether you specify `--generate-ssh-keys` or not.
62+
- By default, the SSH key is stored at **~/.ssh/id_rsa.pub**. During cluster creation, you can specify an alternate location using the `--ssh-key-value` parameter.
5963

6064
> [!IMPORTANT]
6165
> To use Azure RBAC or workload identity for an AKS cluster, you must pass the required parameters during cluster creation using Azure CLI. Currently, updating an existing AKS cluster to enable workload identity and/or Azure RBAC is not supported. For more information, see [Use Azure RBAC for Kubernetes authorization](/azure/aks/hybrid/azure-rbac-23h2) or [Deploy and configure Workload Identity for your cluster](workload-identity.md).
@@ -253,3 +257,4 @@ az aksarc delete --name $aksclustername --resource-group $resource_group
253257
## Next steps
254258

255259
- [Troubleshoot and known issues with cluster provisioning from Azure](aks-known-issues.md)
260+
6

AKS-Arc/aks-create-clusters-portal.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Create Kubernetes clusters using the Azure portal.
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 02/20/2025
7+
ms.date: 02/26/2025
88
ms.reviewer: guanghu
99
ms.lastreviewed: 01/30/2024
1010
---
@@ -48,8 +48,9 @@ This article describes how to create Kubernetes clusters in Azure Local using th
4848
- **Primary node pool**:
4949
- You can leave the default values selected, or change the default value from the drop down list.
5050
- **SSH Keys**
51-
- Configure SSH access to the underlying VMs in your Kubernetes nodes for troubleshooting operations. You must provide an existing SSH public key.
52-
- Provide an RSA public key in the single line format (starting with "ssh-rsa") or the multi-line PEM format. You can generate SSH keys using PuTTYGen on Windows.
51+
- SSH keys are essential for troubleshooting and log collection. Be sure to save your private key file for future use.
52+
- You can use an existing SSH key or generate a new key pair during cluster creation. For information about how to create new SSH keys from the Azure portal, see [Create and store SSH keys in the portal](/azure/virtual-machines/ssh-keys-portal#generate-new-keys).
53+
- To **Use an existing public key by providing the SSH public key value**, provide an RSA public key in the single line format (starting with "ssh-rsa") or the multi-line PEM format.
5354

5455
1. Select **Next: Node pools** when complete.
5556
1. On the **Node pools** page, configure the following options:

AKS-Arc/create-clusters-bicep.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Create Kubernetes clusters using Bicep
33
description: Learn how to create Kubernetes clusters in Azure Local using Bicep.
44
ms.topic: how-to
55
ms.custom: devx-track-azurecli
6-
ms.date: 07/26/2024
6+
ms.date: 02/26/2025
77
author: sethmanheim
88
ms.author: sethm
99
ms.reviewer: haojiehang
@@ -34,22 +34,25 @@ Before you begin, make sure you have the following prerequisites:
3434

3535
## Create an SSH key pair
3636

37-
To create an SSH key pair (same as Azure AKS), use the following procedure:
37+
Create an SSH key pair in Azure and store the private key file for troubleshooting and log collection purposes. For detailed instructions, see [Create and store SSH keys with the Azure CLI](/azure/virtual-machines/ssh-keys-azure-cli) or in the [Azure portal](/azure/virtual-machines/ssh-keys-portal).
3838

39-
1. [Open a Cloud Shell session](https://shell.azure.com) in your browser or open a terminal on your local machine.
40-
1. Create an SSH key pair using `az sshkey create`:
39+
1. [Open a Cloud Shell session](https://shell.azure.com/) in your web browser or launch a terminal on your local machine.
40+
1. Create an SSH key pair using the [az sshkey create](/cli/azure/sshkey#az-sshkey-create) command:
4141

4242
```azurecli
43-
az sshkey create --name <Public_SSH_Key> --resource-group <Resource_Group_Name>
43+
az sshkey create --name "mySSHKey" --resource-group $<resource_group_name>
4444
```
4545

46-
Or, create a local SSH key pair using `ssh-keygen`:
46+
or, use the `ssh-keygen` command:
4747

48-
```bash
49-
ssh-keygen -t rsa -b 4096
48+
```azurecli
49+
ssh-keygen -t rsa -b 4096
5050
```
5151

52-
It's recommended that you create an SSH key pair in Azure, as you can use it later for node access or troubleshooting. For more information about creating SSH keys, see [Create and manage SSH keys for authentication in Azure](/azure/virtual-machines/linux/create-ssh-keys-detailed) and [Restrict SSH Access](restrict-ssh-access.md).
52+
1. Retrieve the value of your public key from Azure or from your local machine under **/.ssh/id_rsa.pub**.
53+
54+
For more options, you can either follow [Configure SSH keys for an AKS cluster](/azure/aks/aksarc/configure-ssh-keys) to create SSH keys, or use [Restrict SSH access](/azure/aks/aksarc/restrict-ssh-access) during cluster creation. To access nodes afterward, see [Connect to Windows or Linux worker nodes with SSH](/azure/aks/aksarc/ssh-connect-to-windows-and-linux-worker-nodes).
55+
5356

5457
## Download and update the Bicep scripts
5558

AKS-Arc/create-clusters-terraform.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to create Kubernetes clusters using Terraform.
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 02/10/2025
7+
ms.date: 02/26/2025
88

99
---
1010

@@ -32,23 +32,25 @@ Before you begin, make sure you have the following prerequisites:
3232

3333
## Create an SSH key pair
3434

35-
To create an SSH key pair (same as Azure AKS), use the following procedure:
35+
Create an SSH key pair in Azure and store the private key file for troubleshooting and log collection purposes. For detailed instructions, see [Create and store SSH keys with the Azure CLI](/azure/virtual-machines/ssh-keys-azure-cli) or in the [Azure portal](/azure/virtual-machines/ssh-keys-portal).
3636

37-
1. [Open a Cloud Shell session](https://shell.azure.com/) in your browser.
38-
1. Create an SSH key pair using the [az sshkey create](/cli/azure/sshkey#az-sshkey-create) command, [from the portal](/azure/virtual-machines/ssh-keys-portal), or the `ssh-keygen`command:
37+
1. [Open a Cloud Shell session](https://shell.azure.com/) in your web browser or launch a terminal on your local machine.
38+
1. Create an SSH key pair using the [az sshkey create](/cli/azure/sshkey#az-sshkey-create) command:
3939

4040
```azurecli
41-
az sshkey create --name "mySSHKey" --resource-group "myResourceGroup"
41+
az sshkey create --name "mySSHKey" --resource-group $<resource_group_name>
4242
```
4343

44-
or
44+
or, use the `ssh-keygen` command:
4545

4646
```azurecli
4747
ssh-keygen -t rsa -b 4096
4848
```
4949

5050
1. Retrieve the value of your public key from Azure or from your local machine under **/.ssh/id_rsa.pub**.
5151

52+
For more options, you can either follow [Configure SSH keys for an AKS cluster](/azure/aks/aksarc/configure-ssh-keys) to create SSH keys, or use [Restrict SSH access](/azure/aks/aksarc/restrict-ssh-access) during cluster creation. To access nodes afterward, see [Connect to Windows or Linux worker nodes with SSH](/azure/aks/aksarc/ssh-connect-to-windows-and-linux-worker-nodes).
53+
5254
## Sign in to Azure
5355

5456
Terraform only supports authenticating to Azure with the Azure CLI using [`az login`](/cli/azure/reference-index#az-login). Authenticating using Azure PowerShell isn't supported. Therefore, while you can use the Azure PowerShell module when doing your Terraform work, you must first [authenticate to Azure](/azure/developer/terraform/authenticate-to-azure):

AKS-Arc/resource-manager-quickstart.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deploy a Kubernetes (AKS) cluster using an Azure Resource Manager templat
33
description: Learn how to deploy a Kubernetes cluster in AKS enabled by Azure Arc using an Azure Resource Manager template.
44
ms.topic: quickstart-arm
55
ms.custom: devx-track-arm-template, devx-track-azurecli
6-
ms.date: 12/18/2024
6+
ms.date: 02/26/2025
77
author: sethmanheim
88
ms.author: sethm
99
ms.lastreviewed: 01/31/2024
@@ -42,27 +42,27 @@ To deploy an ARM template, you need write access on the resources you're deployi
4242
az account set --subscription "<your-subscription-id>"
4343
```
4444

45-
## Step 2: Create an SSH key pair using Azure CLI
45+
## Step 2: Create an SSH key pair
4646

47-
```azurecli
48-
az sshkey create --name "mySSHKey" --resource-group "myResourceGroup"
49-
```
47+
Create an SSH key pair in Azure and store the private key file for troubleshooting and log collection purposes. For detailed instructions, see [Create and store SSH keys with the Azure CLI](/azure/virtual-machines/ssh-keys-azure-cli), or in the [Azure portal](/azure/virtual-machines/ssh-keys-portal).
5048

51-
or, create an SSH key pair using **ssh-keygen**:
49+
1. [Open a Cloud Shell session](https://shell.azure.com/) in your web browser or launch a terminal on your local machine.
50+
1. Create an SSH key pair using the [az sshkey create](/cli/azure/sshkey#az-sshkey-create) command:
5251

53-
```cmd
54-
ssh-keygen -t rsa -b 4096
55-
```
52+
```azurecli
53+
az sshkey create --name "mySSHKey" --resource-group $<resource_group_name>
54+
```
5655

57-
To deploy the template, you must provide the public key from the SSH pair. To retrieve the public key, use the `az sshkey show` command:
56+
or, use the `ssh-keygen` command:
5857

59-
```azurecli
60-
az sshkey show --name "mySSHKey" --resource-group "myResourceGroup" --query "publicKey"
61-
```
58+
```azurecli
59+
ssh-keygen -t rsa -b 4096
60+
```
61+
62+
1. Retrieve the value of your public key from Azure or from your local machine under **/.ssh/id_rsa.pub**.
6263

63-
By default, the SSH key files are created in the **~/.ssh** directory. Run the `az sshkey create` or `ssh-keygen` command to overwrite any existing SSH key pair with the same name.
64+
For more options, you can either follow [Configure SSH keys for an AKS cluster](/azure/aks/aksarc/configure-ssh-keys) to create SSH keys, or use [Restrict SSH access](/azure/aks/aksarc/restrict-ssh-access) during cluster creation. To access nodes afterward, see [Connect to Windows or Linux worker nodes with SSH](/azure/aks/aksarc/ssh-connect-to-windows-and-linux-worker-nodes).
6465

65-
For more information about creating SSH keys, see [Create and manage SSH keys for authentication in Azure](/azure/virtual-machines/linux/create-ssh-keys-detailed).
6666

6767
## Step 3: Review the template
6868

0 commit comments

Comments
 (0)