Skip to content

Commit 47507a7

Browse files
ttorblettorble
authored
Merge pull request #277245 from sreekzz/modify-quickstart
Modified Quickstart
2 parents 76bc719 + 7b43008 commit 47507a7

8 files changed

+281
-22
lines changed

‎articles/hdinsight-aks/.openpublishing.redirection.hdinsight-aks.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,31 @@
55
"redirect_url": "/azure/hdinsight-aks/flink/flink-overview",
66
"redirect_document_id": false
77
},
8+
{
9+
"source_path_from_root": "/articles/hdinsight-aks/prerequisites-subscription.md",
10+
"redirect_url": "/azure/hdinsight-aks/quickstart-prerequisites-subscription",
11+
"redirect_document_id": false
12+
},
813
{
914
"source_path_from_root": "/articles/hdinsight-aks/release-notes/index.md",
1015
"redirect_url": "/azure/hdinsight-aks/release-notes/hdinsight-aks-release-notes",
1116
"redirect_document_id": false
1217
},
18+
{
19+
"source_path_from_root": "/articles/hdinsight-aks/prerequisites-resources.md",
20+
"redirect_url": "/azure/hdinsight-aks/quickstart-prerequisites-resources",
21+
"redirect_document_id": false
22+
},
1323
{
1424
"source_path_from_root": "/articles/hdinsight-aks/spark/index.md",
1525
"redirect_url": "/azure/hdinsight-aks/spark/hdinsight-on-aks-spark-overview",
1626
"redirect_document_id": false
1727
},
28+
{
29+
"source_path_from_root": "/articles/hdinsight-aks/get-started.md",
30+
"redirect_url": "/azure/hdinsight-aks/quickstart-get-started",
31+
"redirect_document_id": false
32+
},
1833
{
1934
"source_path_from_root": "/articles/hdinsight-aks/trino/index.md",
2035
"redirect_url": "/azure/hdinsight-aks/trino/trino-overview ",

‎articles/hdinsight-aks/TOC.yml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,22 @@ items:
88
href: overview.md
99
- name: What's new?
1010
href: whats-new.md
11-
- name: Preview information
12-
href: preview.md
1311
- name: Quickstarts
1412
items:
1513
- name: Subscription prerequisites
16-
href: prerequisites-subscription.md
14+
href: quickstart-prerequisites-subscription.md
1715
- name: Resource prerequisites
18-
href: prerequisites-resources.md
16+
href: quickstart-prerequisites-resources.md
1917
- name: One click deployment
20-
href: get-started.md
18+
href: quickstart-get-started.md
19+
- name: Create a cluster pool and cluster
20+
items:
21+
- name: Create a cluster pool and cluster - Azure portal
22+
href: quickstart-create-cluster.md
23+
- name: Create an HDInsight on AKS cluster pool and cluster - Azure CLI
24+
href: quickstart-create-cli.md
25+
- name: Create an HDInsight on AKS cluster pool and cluster - Azure PowerShell
26+
href: quickstart-create-powershell.md
2127
- name: Concepts
2228
items:
2329
- name: Reliability

‎articles/hdinsight-aks/quickstart-create-cli.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: Quickstart - Create HDInsight on AKS cluster with Azure CLI
3+
description: Learn how to use Azure CLI to create an HDInsight on AKS cluster pool.
4+
ms.service: hdinsight-aks
5+
ms.topic: quickstart
6+
ms.date: 06/04/2024
7+
---
8+
9+
# Quickstart: Create an HDInsight on AKS Cluster Pool with the Azure CLI on Azure
10+
11+
This quickstart shows you how to use the PowerShell to deploy an HDInsight on AKS Cluster Pool in Azure.
12+
13+
## Prerequisites
14+
Ensure that you completed the [subscription prerequisites](./quickstart-prerequisites-subscription.md) and [resource prerequisites](./quickstart-prerequisites-resources.md) before creating a cluster pool.
15+
16+
The command New-AzHdInsightOnAksClusterPool is part of Azure PowerShell module "Az.HdInsightOnAks" and it isn't installed. Run **"Install-Module Az.HdInsightOnAks"** to install it.
17+
18+
## Launch Azure Cloud Shell
19+
20+
The Azure Cloud Shell is a free interactive shell that you can use to run the steps in this article. It has common Azure tools preinstalled and configured to use with your account.
21+
22+
To open the Cloud Shell, just select **Try it** from the upper right corner of a code block. Select **Copy** to copy the blocks of code, paste it into the Cloud Shell, and press enter to run it.
23+
24+
## Create a resource group
25+
26+
Create an Azure resource group with [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup). A resource group is a logical container into which Azure resources are deployed and managed:
27+
28+
```Azure PowerShell
29+
New-AzResourceGroup -Name 'HDIonAKSPowershell' -Location 'West US 3'
30+
```
31+
32+
## Create the HDInsight on AKS Cluster Pool
33+
34+
To create an HDInsight on AKS Cluster Pool in this resource group, use the `New-AzHdInsightOnAksClusterPool` command:
35+
```PowerShell
36+
New-AzHdInsightOnAksClusterPool
37+
-Name <String>
38+
-ResourceGroupName <String>
39+
[-SubscriptionId <String>]
40+
-Location <String>
41+
[-ClusterPoolVersion <String>]
42+
[-EnableLogAnalytics]
43+
[-LogAnalyticWorkspaceResourceId <String>]
44+
[-ManagedResourceGroupName <String>]
45+
[-NetworkProfileApiServerAuthorizedIPRange <String[]>]
46+
[-NetworkProfileEnablePrivateApiServer]
47+
[-NetworkProfileOutboundType <String>]
48+
[-SubnetId <String>]
49+
[-Tag <Hashtable>]
50+
[-VmSize <String>]
51+
[-DefaultProfile <PSObject>]
52+
[-AsJob]
53+
[-NoWait]
54+
[-WhatIf]
55+
[-Confirm]
56+
[<CommonParameters>]
57+
```
58+
Here's an example:
59+
```PowerShell
60+
$location = "West US 3"
61+
$clusterResourceGroupName = "HDIonAKSPowershell"
62+
$clusterpoolName = "HDIClusterPoolSample"
63+
$vmSize = "Standard_E4s_v3"
64+
$clusterpoolversion="1.1"
65+
66+
# Create the cluster pool
67+
New-AzHdInsightOnAksClusterPool `
68+
-Name $clusterpoolName `
69+
-ResourceGroupName $clusterResourceGroupName `
70+
-Location $location `
71+
-VmSize $vmSize `
72+
-ClusterPoolVersion $clusterpoolversion
73+
```
74+
75+
It takes a few minutes to create the HDInsight on AKS Cluster Pool. The following example output shows the created operation was successful.
76+
77+
Results:
78+
<!-- expected_similarity=0.3 -->
79+
```
80+
AkClusterProfileAkClusterAgentPoolIdentityProfileMsiClientId : a75ec1ff-3f7f-4f44-820c-6eaa5c8191af
81+
AkClusterProfileAkClusterAgentPoolIdentityProfileMsiObjectId : 13990b78-4140-4d10-b333-69bb78524375
82+
AkClusterProfileAkClusterAgentPoolIdentityProfileMsiResourceId : /subscriptions/12345-abcde-12345-abcde
83+
AkClusterProfileAksClusterResourceId : /subscriptions/subscriptions/12345-abcde-12345-abcde
84+
AkClusterProfileAksVersion : 1.27.9
85+
AksManagedResourceGroupName : MC_hdi-44640a235566423490b9fb694d6c05a3_HDIClusterPoolSample_westus3
86+
ComputeProfileCount : 3
87+
ComputeProfileVMSize : Standard_E4s_v3
88+
DeploymentId : 44640a235566423490b9fb694d6c05a3
89+
Id : /subscriptions/0b130652-e15b-417e-885a-050c9a3024a2/resourceGroups/HDIonAKSPowershell/providers/Microsoft.HDInsight/cl
90+
usterpools/HDIClusterPoolSample
91+
Location : West US 3
92+
LogAnalyticProfileEnabled : False
93+
LogAnalyticProfileWorkspaceId :
94+
ManagedResourceGroupName : hdi-12345
95+
Name : Contosopool
96+
NetworkProfileApiServerAuthorizedIPRange :
97+
NetworkProfileEnablePrivateApiServer :
98+
NetworkProfileOutboundType :
99+
NetworkProfileSubnetId :
100+
ProfileClusterPoolVersion : 1.1
101+
ProvisioningState : Succeeded
102+
ResourceGroupName : HDIonAKSPowershell
103+
Status : Running
104+
SystemDataCreatedAt : 6/2/2024 11:53:01 AM
105+
SystemDataCreatedBy : [email protected]
106+
SystemDataCreatedByType : User
107+
SystemDataLastModifiedAt : 6/2/2024 11:53:01 AM
108+
SystemDataLastModifiedBy : [email protected]
109+
SystemDataLastModifiedByType : User
110+
Tag : {
111+
}
112+
Type : contoso.hdinsight/contosopools
113+
```
114+
115+
## Next steps
116+
117+
* [New-AzHdInsightOnAksClusterPool](/powershell/module/az.hdinsightonaks/new-azhdinsightonaksclusterpool)
118+
* [Create cluster pool and cluster](./quickstart-create-cluster.md)

‎articles/hdinsight-aks/quickstart-create-cluster.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Create cluster pool and cluster
33
description: Creating a cluster pool and cluster in HDInsight on AKS.
44
ms.service: hdinsight-aks
55
ms.topic: quickstart
6-
ms.date: 12/11/2023
6+
ms.date: 06/03/2024
77
---
88

99
# Create cluster pool and cluster
1010

11-
[!INCLUDE [feature-in-preview](includes/feature-in-preview.md)]
11+
1212

1313
HDInsight on AKS has the concept of cluster pools and clusters.
1414

@@ -22,7 +22,7 @@ For creating Apache Spark, Apache Flink, or Trino clusters, you need to first cr
2222

2323
## Prerequisites
2424

25-
Ensure that you have completed the [subscription prerequisites](prerequisites-subscription.md) and [resource prerequisites](prerequisites-resources.md) before creating a cluster pool.
25+
Ensure that you have completed the [subscription prerequisites](quickstart-prerequisites-subscription.md) and [resource prerequisites](quickstart-prerequisites-resources.md) before creating a cluster pool.
2626

2727
## Create a cluster pool
2828

@@ -204,3 +204,5 @@ For a quickstart, refer to the following steps.
204204

205205
> [!TIP]
206206
> For troubleshooting any deployment errors, you can refer to this [page](./create-cluster-error-dictionary.md).
207+
208+

‎articles/hdinsight-aks/quickstart-create-powershell.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
title: Quickstart - Create HDInsight on AKS cluster with Azure PowerShell
3+
description: Learn how to use Azure PowerShell to create an HDInsight on AKS cluster pool.
4+
ms.service: hdinsight-aks
5+
ms.topic: quickstart
6+
ms.date: 06/04/2024
7+
---
8+
9+
# Quickstart: Create an HDInsight on AKS Cluster Pool with the Azure PowerShell on Azure
10+
11+
This quickstart shows you how to use the PowerShell to deploy an HDInsight on AKS Cluster Pool in Azure.
12+
13+
## Prerequisites
14+
15+
Ensure that you completed the [subscription prerequisites](./quickstart-prerequisites-subscription.md) and [resource prerequisites](./quickstart-prerequisites-resources.md) before creating a cluster pool.
16+
17+
The command New-AzHdInsightOnAksClusterPool is part of Azure PowerShell module "Az.HdInsightOnAks" and it isn't installed. Run **Install-Module Az.HdInsightOnAks** to install it.
18+
19+
## Launch Azure Cloud Shell
20+
21+
The Azure Cloud Shell is a free interactive shell that you can use to run the steps in this article. It has common Azure tools preinstalled and configured to use with your account.
22+
23+
To open the Cloud Shell, just select **Try it** from the upper right corner of a code block. Select **Copy** to copy the blocks of code, paste it into the Cloud Shell, and press enter to run it.
24+
25+
## Create a resource group
26+
27+
Create an Azure resource group with [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup). A resource group is a logical container into which Azure resources are deployed and managed:
28+
29+
```Azure PowerShell
30+
New-AzResourceGroup -Name 'HDIonAKSPowershell' -Location 'West US 3'
31+
```
32+
33+
## Create the HDInsight on AKS Cluster Pool
34+
35+
To create an HDInsight on AKS Cluster Pool in this resource group, use the `New-AzHdInsightOnAksClusterPool` command:
36+
```PowerShell
37+
New-AzHdInsightOnAksClusterPool
38+
-Name <String>
39+
-ResourceGroupName <String>
40+
[-SubscriptionId <String>]
41+
-Location <String>
42+
[-ClusterPoolVersion <String>]
43+
[-EnableLogAnalytics]
44+
[-LogAnalyticWorkspaceResourceId <String>]
45+
[-ManagedResourceGroupName <String>]
46+
[-NetworkProfileApiServerAuthorizedIPRange <String[]>]
47+
[-NetworkProfileEnablePrivateApiServer]
48+
[-NetworkProfileOutboundType <String>]
49+
[-SubnetId <String>]
50+
[-Tag <Hashtable>]
51+
[-VmSize <String>]
52+
[-DefaultProfile <PSObject>]
53+
[-AsJob]
54+
[-NoWait]
55+
[-WhatIf]
56+
[-Confirm]
57+
[<CommonParameters>]
58+
```
59+
Here's an actual example:
60+
```PowerShell
61+
$location = "West US 3"
62+
$clusterResourceGroupName = "HDIonAKSPowershell"
63+
$clusterpoolName = "HDIClusterPoolSample"
64+
$vmSize = "Standard_E4s_v3"
65+
$clusterpoolversion="1.1"
66+
67+
# Create the cluster pool
68+
New-AzHdInsightOnAksClusterPool `
69+
-Name $clusterpoolName `
70+
-ResourceGroupName $clusterResourceGroupName `
71+
-Location $location `
72+
-VmSize $vmSize `
73+
-ClusterPoolVersion $clusterpoolversion
74+
```
75+
76+
It takes a few minutes to create the HDInsight on AKS Cluster Pool. The following example output shows the created operation was successful.
77+
78+
Results:
79+
<!-- expected_similarity=0.3 -->
80+
```
81+
AkClusterProfileAkClusterAgentPoolIdentityProfileMsiClientId : a75ec1ff-3f7f-4f44-820c-6eaa5c8191af
82+
AkClusterProfileAkClusterAgentPoolIdentityProfileMsiObjectId : 13990b78-4140-4d10-b333-69bb78524375
83+
AkClusterProfileAkClusterAgentPoolIdentityProfileMsiResourceId : /subscriptions/12345-abcde
84+
AkClusterProfileAkClusterAgentPoolIdentityProfileMsiResourceId : /subscriptions/12345-abcde
85+
AkClusterProfileAksClusterResourceId : AkClusterProfileAksVersion : 1.27.9
86+
AksManagedResourceGroupName : MC_hdi-44640a235566423490b9fb694d6c05a3_HDIClusterPoolSample_westus3
87+
ComputeProfileCount : 3
88+
ComputeProfileVMSize : Standard_E4s_v3
89+
DeploymentId : 44640a235566423490b9fb694d6c05a3
90+
Id : /subscriptions/12345-abcde
91+
Location : West US 3
92+
LogAnalyticProfileEnabled : False
93+
LogAnalyticProfileWorkspaceId :
94+
ManagedResourceGroupName : 12345-abcde
95+
Name : Contosopool
96+
NetworkProfileApiServerAuthorizedIPRange :
97+
NetworkProfileEnablePrivateApiServer :
98+
NetworkProfileOutboundType :
99+
NetworkProfileSubnetId :
100+
ProfileClusterPoolVersion : 1.1
101+
ProvisioningState : Succeeded
102+
ResourceGroupName : HDIonAKSPowershell
103+
Status : Running
104+
SystemDataCreatedAt : 6/2/2024 11:53:01 AM
105+
SystemDataCreatedBy : [email protected]
106+
SystemDataCreatedByType : User
107+
SystemDataLastModifiedAt : 6/2/2024 11:53:01 AM
108+
SystemDataLastModifiedBy : [email protected]
109+
SystemDataLastModifiedByType : User
110+
Tag : {
111+
}
112+
Type : microsoft.hdinsight/clusterpools
113+
```
114+
115+
## Next steps
116+
117+
* [New-AzHdInsightOnAksClusterPool](/powershell/module/az.hdinsightonaks/new-azhdinsightonaksclusterpool)
118+
* [Create cluster pool and cluster](./quickstart-create-cluster.md)

‎articles/hdinsight-aks/get-started.md renamed to ‎articles/hdinsight-aks/quickstart-get-started.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
---
2-
title: One-click deployment for Azure HDInsight on AKS (Preview)
2+
title: One-click deployment for Azure HDInsight on AKS
33
description: How to create cluster pool and cluster with one-click deployment on Azure HDInsight on AKS.
44
ms.service: hdinsight-aks
5-
ms.topic: how-to
5+
ms.topic: quickstart
66
ms.date: 08/29/2023
77
---
88

9-
# Get started with one-click deployment (Preview)
9+
# Get started with one-click deployment
1010

11-
[!INCLUDE [feature-in-preview](includes/feature-in-preview.md)]
1211

1312
One-click deployments are designed for users to experience zero touch creation of HDInsight on AKS. It eliminates the need to manually perform certain steps.
1413
This article describes how to use readily available ARM templates to create a cluster pool and cluster in few clicks.
1514

1615
> [!NOTE]
1716
> - These ARM templates cover the basic requirements to create a cluster pool and cluster along with prerequisite resources. To explore advanced options, see [Create cluster pool and clusters](quickstart-create-cluster.md).
18-
> - Necessary resources are created as part of the ARM template deployment in your resource group. For more information, see [Resource prerequisites](prerequisites-resources.md).
17+
> - Necessary resources are created as part of the ARM template deployment in your resource group. For more information, see [Resource prerequisites](quickstart-prerequisites-resources.md).
1918
> - The user must have permission to create new resources and assign roles to the resources in the subscription to deploy these ARM templates.
2019
> - Before you begin with ARM templates, please keep [object ID ready](#find-object-id-of-an-identity) for the identity you are going to use for deployment.
2120

‎articles/hdinsight-aks/prerequisites-resources.md renamed to ‎articles/hdinsight-aks/quickstart-prerequisites-resources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
22
title: Resource prerequisites for Azure HDInsight on AKS
33
description: Prerequisite steps to complete for Azure resources before working with HDInsight on AKS.
4-
ms.topic: how-to
4+
ms.topic: quickstart
55
ms.service: hdinsight-aks
66
ms.date: 04/08/2024
77
---
88

99
# Resource prerequisites
1010

11-
[!INCLUDE [feature-in-preview](includes/feature-in-preview.md)]
12-
1311
This article details the resources required for getting started with HDInsight on AKS. It covers the necessary and the optional resources and how to create them.
1412

1513
## Necessary resources
@@ -110,3 +108,5 @@ For example, if you provide resource prefix as “demo” then, following resour
110108
> [!NOTE]
111109
> * Make sure to note the secret name, as this is required during cluster creation.
112110
> * You need to have a “Key Vault Administrator” role assigned to your identity or account to add a secret in the Key Vault using Azure portal. Navigate to the Key Vault and follow the steps on [how to assign the role](/azure/role-based-access-control/role-assignments-portal#step-2-open-the-add-role-assignment-page).
111+
112+

0 commit comments

Comments
 (0)