• An Azure account with an active subscription.Create an account for free.

• A basic understanding ofKubernetes core concepts.

• Anidentity (user or service principal) which can be used tolog in to Azure CLI and connect your cluster to Azure Arc.

• The latest version ofAzure CLI.

• The latest version ofconnectedk8s Azure CLI extension, installed by running the following command:

  az extension add --name connectedk8s

• An up-and-running Kubernetes cluster. If you don't have one, you can create a cluster using one of these options:

  • Kubernetes in Docker (KIND)

  • Create a Kubernetes cluster using Docker forMac orWindows

  • Self-managed Kubernetes cluster usingCluster API

    Note

    The cluster needs to have at least one node of operating system and architecture typelinux/amd64 and/orlinux/arm64. SeeCluster requirements for more about ARM64 scenarios.

• At least 850 MB free for the Arc agents that will be deployed on the cluster, and capacity to use approximately 7% of a single CPU.

• Akubeconfig file and context pointing to your cluster. For more information, seeConfigure access to multiple clusters.

• An Azure account with an active subscription.Create an account for free.

• A basic understanding ofKubernetes core concepts.

• Anidentity (user or service principal) which can be used tolog in to Azure PowerShell and connect your cluster to Azure Arc.

• Azure PowerShell version 6.6.0 or later

• TheAz.ConnectedKubernetes PowerShell module, installed by running the following command:

  Install-Module -Name Az.ConnectedKubernetes

• An up-and-running Kubernetes cluster. If you don't have one, you can create a cluster using one of these options:

  • Kubernetes in Docker (KIND)

  • Create a Kubernetes cluster using Docker forMac orWindows

  • Self-managed Kubernetes cluster usingCluster API

    Note

    The cluster needs to have at least one node of operating system and architecture typelinux/amd64 and/orlinux/arm64. SeeCluster requirements for more about ARM64 scenarios.

• At least 850 MB free for the Arc agents that will be deployed on the cluster, and capacity to use approximately 7% of a single CPU.

• Akubeconfig file and context pointing to your cluster. For more information, seeConfigure access to multiple clusters.

1. Enter the following commands:

   az provider register --namespace Microsoft.Kubernetesaz provider register --namespace Microsoft.KubernetesConfigurationaz provider register --namespace Microsoft.ExtendedLocation

2. Monitor the registration process. Registration may take up to 10 minutes.

   az provider show -n Microsoft.Kubernetes -o tableaz provider show -n Microsoft.KubernetesConfiguration -o tableaz provider show -n Microsoft.ExtendedLocation -o table

   Once registered, you should see theRegistrationState state for these namespaces change toRegistered.

1. Enter the following commands:

   Register-AzResourceProvider -ProviderNamespace Microsoft.KubernetesRegister-AzResourceProvider -ProviderNamespace Microsoft.KubernetesConfigurationRegister-AzResourceProvider -ProviderNamespace Microsoft.ExtendedLocation

2. Monitor the registration process. Registration may take up to 10 minutes.

   Get-AzResourceProvider -ProviderNamespace Microsoft.KubernetesGet-AzResourceProvider -ProviderNamespace Microsoft.KubernetesConfigurationGet-AzResourceProvider -ProviderNamespace Microsoft.ExtendedLocation

   Once registered, you should see theRegistrationState state for these namespaces change toRegistered.

az group create --name AzureArcTest --location EastUS --output table

Output:

Location    Name----------  ------------eastus      AzureArcTest

New-AzResourceGroup -Name AzureArcTest -Location EastUS

Output:

ResourceGroupName : AzureArcTestLocation          : eastusProvisioningState : SucceededTags              :ResourceId        : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/AzureArcTest

az connectedk8s connect --name AzureArcTest1 --resource-group AzureArcTest

Output:

Helm release deployment succeeded    {      "aadProfile": {        "clientAppId": "",        "serverAppId": "",        "tenantId": ""      },      "agentPublicKeyCertificate": "xxxxxxxxxxxxxxxxxxx",      "agentVersion": null,      "connectivityStatus": "Connecting",      "distribution": "gke",      "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/AzureArcTest/providers/Microsoft.Kubernetes/connectedClusters/AzureArcTest1",      "identity": {        "principalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",        "tenantId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",        "type": "SystemAssigned"      },      "infrastructure": "gcp",      "kubernetesVersion": null,      "lastConnectivityTime": null,      "location": "eastus",      "managedIdentityCertificateExpirationTime": null,      "name": "AzureArcTest1",      "offering": null,      "provisioningState": "Succeeded",      "resourceGroup": "AzureArcTest",      "tags": {},      "totalCoreCount": null,      "totalNodeCount": null,      "type": "Microsoft.Kubernetes/connectedClusters"    }

New-AzConnectedKubernetes -ClusterName AzureArcTest1 -ResourceGroupName AzureArcTest -Location eastus

Output:

Location Name          Type-------- ----          ----eastus   AzureArcTest1 microsoft.kubernetes/connectedclusters

1. On the deployment machine, set the environment variables needed for Azure CLI to use the outbound proxy server:

   export HTTP_PROXY=<proxy-server-ip-address>:<port>export HTTPS_PROXY=<proxy-server-ip-address>:<port>export NO_PROXY=<cluster-apiserver-ip-address>:<port>

2. On the Kubernetes cluster, run the connect command with theproxy-https andproxy-http parameters specified. If your proxy server is set up with both HTTP and HTTPS, be sure to use--proxy-http for the HTTP proxy and--proxy-https for the HTTPS proxy. If your proxy server only uses HTTP, you can use that value for both parameters.

   az connectedk8s connect --name <cluster-name> --resource-group <resource-group> --proxy-https https://<proxy-server-ip-address>:<port> --proxy-http http://<proxy-server-ip-address>:<port> --proxy-skip-range <excludedIP>,<excludedCIDR> --proxy-cert <path-to-cert-file>

For outbound proxy servers, if you're only providing a trusted certificate, you can runaz connectedk8s connect with just the--proxy-cert parameter specified:

az connectedk8s connect --name <cluster-name> --resource-group <resource-group> --proxy-cert <path-to-cert-file>

If there are multiple trusted certificates, then the certificate chain (Leaf cert, Intermediate cert, Root cert) needs to be combined into a single file which is passed in the--proxy-cert parameter.

1. On the deployment machine, set the environment variables needed for Azure PowerShell to use the outbound proxy server:

   $Env:HTTP_PROXY = "<proxy-server-ip-address>:<port>"$Env:HTTPS_PROXY = "<proxy-server-ip-address>:<port>"$Env:NO_PROXY = "<cluster-apiserver-ip-address>:<port>"

2. On the Kubernetes cluster, run the connect command with the proxy parameter specified:

   New-AzConnectedKubernetes -ClusterName <cluster-name> -ResourceGroupName <resource-group> -Location eastus -Proxy 'https://<proxy-server-ip-address>:<port>'

The ability to pass in the proxy certificate only, without proxy server endpoint details, isn't currently supported via PowerShell.

az connectedk8s list --resource-group AzureArcTest --output table

Output:

Name           Location    ResourceGroup-------------  ----------  ---------------AzureArcTest1  eastus      AzureArcTest

Get-AzConnectedKubernetes -ResourceGroupName AzureArcTest

Output:

Location Name          Type-------- ----          ----eastus   AzureArcTest1 microsoft.kubernetes/connectedclusters

You can delete the Azure Arc-enabled Kubernetes resource, any associated configuration resources, and any agents running on the cluster by using the following command:

az connectedk8s delete --name AzureArcTest1 --resource-group AzureArcTest

If the deletion process fails, use the following command to force deletion (adding-y if you want to bypass the confirmation prompt):

az connectedk8s delete -n AzureArcTest1 -g AzureArcTest --force

This command can also be used if you experience issues when creating a new cluster deployment (due to previously created resources not being completely removed).

Remove-AzConnectedKubernetes -ClusterName AzureArcTest1 -ResourceGroupName AzureArcTest