Skip to content

Commit 7642bd9

Browse files
authored
Merge pull request #277984 from johnmarco/jm-aro-toc-reorg
ARO: TOC reorg and merged cluster creation articles
2 parents 282bafa + 178a331 commit 7642bd9

29 files changed

+210
-238
lines changed

.openpublishing.redirection.json

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4089,7 +4089,27 @@
40894089
"redirect_document_id": false
40904090
},
40914091
{
4092-
"source_path_from_root": "/articles/data-factory/continuous-integration-delivery-automate-github-actions.md",
4092+
"source_path_from_root": "/articles/openshift/tutorial-create-cluster.md",
4093+
"redirect_url": "/azure/openshift/create-cluster",
4094+
"redirect_document_id": false
4095+
},
4096+
{
4097+
"source_path_from_root": "/articles/openshift/tutorial-connect-cluster.md",
4098+
"redirect_url": "/azure/openshift/connect-cluster",
4099+
"redirect_document_id": false
4100+
},
4101+
{
4102+
"source_path_from_root": "/articles/openshift/tutorial-delete-cluster.md",
4103+
"redirect_url": "/azure/openshift/delete-cluster",
4104+
"redirect_document_id": false
4105+
},
4106+
{
4107+
"source_path_from_root": "/articles/openshift/quickstart-portal.md",
4108+
"redirect_url": "/azure/openshift/create-cluster",
4109+
"redirect_document_id": false
4110+
},
4111+
{
4112+
"source_path_from_root": "/articles/data-factory/continuous-integration-delivery-automate-github-actions.md",
40934113
"redirect_url": "/azure",
40944114
"redirect_document_id": false
40954115
}

articles/openshift/azure-redhat-openshift-release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ We're pleased to announce the launch of OpenShift 4.11 for Azure Red Hat OpenShi
5757
- Ability to deploy OpenShift 4.11
5858
- Multi-version support:
5959
- This enables customers to select specific Y and Z version of the release. See [Red Hat OpenShift versions](support-lifecycle.md#red-hat-openshift-versions) for more information about versions.
60-
- Customers can still deploy 4.10 clusters if that version is specified. See [Selecting a different ARO version](tutorial-create-cluster.md#selecting-a-different-aro-version) for more information.
60+
- Customers can still deploy 4.10 clusters if that version is specified. See [Selecting a different ARO version](create-cluster.md#selecting-a-different-aro-version) for more information.
6161
- OVN as the CNI for clusters 4.11 and above
6262
- Accelerated networking VMs
6363
- UltraSSD support

articles/openshift/built-in-container-registry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ In this article, you'll configure the built-in container image registry for an A
2020
2121
## Before you begin
2222

23-
This article assumes you have an existing ARO cluster (see [Create an Azure Red Hat OpenShift 4 cluster](./tutorial-create-cluster.md)). If you would like to configure Microsoft Entra integration, make sure to create the cluster with the `--pull-secret` argument to `az aro create`.
23+
This article assumes you have an existing ARO cluster (see [Create an Azure Red Hat OpenShift 4 cluster](./create-cluster.md)). If you would like to configure Microsoft Entra integration, make sure to create the cluster with the `--pull-secret` argument to `az aro create`.
2424

2525
> [!NOTE]
2626
> [Configuring Microsoft Entra authentication](./configure-azure-ad-ui.md#configure-openshift-openid-authentication) for your cluster is the easiest way to interact with the internal registry from outside the cluster.
2727
28-
Once you have your cluster, [connect to the cluster](./tutorial-connect-cluster.md) by authenticating as the `kubeadmin` user.
28+
Once you have your cluster, [connect to the cluster](./connect-cluster.md) by authenticating as the `kubeadmin` user.
2929

3030
## Configure authentication to the registry
3131

articles/openshift/concepts-networking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ The following networking features are specific to Azure Red Hat OpenShift:
8282

8383
The following network settings are available for Azure Red Hat OpenShift 4 clusters:
8484

85-
* **API Visibility** - Set the API visibility when running the [az aro create command](tutorial-create-cluster.md#create-the-cluster).
85+
* **API Visibility** - Set the API visibility when running the [az aro create command](create-cluster.md#create-the-cluster).
8686
* "Public" - API Server is accessible by external networks.
8787
* "Private" - API Server assigned a private IP from the control plane subnet, only accessible using connected networks (peered virtual networks and other subnets in the cluster).
88-
* **Ingress Visibility** - Set the API visibility when running the [az aro create command](tutorial-create-cluster.md#create-the-cluster).
88+
* **Ingress Visibility** - Set the API visibility when running the [az aro create command](create-cluster.md#create-the-cluster).
8989
* "Public" routes default to a public Standard Load Balancer. (The default can be changed.)
9090
* "Private" routes default to an internal load balancer. (The default can be changed.)
9191

articles/openshift/concepts-ovn-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ For more information about OVN-Kubernetes CNI network provider, see [About the O
3434

3535
## Recommended content
3636

37-
[Tutorial: Create an Azure Red Hat OpenShift 4 cluster](tutorial-create-cluster.md)
37+
[Tutorial: Create an Azure Red Hat OpenShift 4 cluster](create-cluster.md)

articles/openshift/tutorial-connect-cluster.md renamed to articles/openshift/connect-cluster.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,33 @@
11
---
2-
title: Tutorial - Connect to an Azure Red Hat OpenShift 4 cluster
2+
title: Connect to an Azure Red Hat OpenShift 4 cluster
33
description: Learn how to connect a Microsoft Azure Red Hat OpenShift cluster
44
author: johnmarco
55
ms.author: johnmarc
6-
ms.topic: tutorial
6+
ms.topic: article
77
ms.service: azure-redhat-openshift
8-
ms.date: 04/24/2020
8+
ms.date: 06/12/2024
99
#Customer intent: As a developer, I want learn how to create an Azure Red Hat OpenShift cluster, scale it, and then clean up resources so that I am not charged for what I'm not using.
1010
---
1111

12-
# Tutorial: Connect to an Azure Red Hat OpenShift 4 cluster
12+
# Connect to an Azure Red Hat OpenShift 4 cluster
1313

14-
In this tutorial, part two of three, you will connect to an Azure Red Hat OpenShift cluster running OpenShift 4 as the kubeadmin user through the OpenShift web console. You learn how to:
15-
> [!div class="checklist"]
16-
> * Obtain `kubeadmin` credentials for your cluster
17-
> * Install the OpenShift CLI
18-
> * Connect to an Azure Red Hat OpenShift cluster using the OpenShift CLI
14+
This article shows you how to connect to an Azure Red Hat OpenShift cluster running OpenShift 4 as the kubeadmin user through the OpenShift web console.
1915

2016
## Before you begin
2117

22-
In previous tutorials, an Azure Red Hat OpenShift cluster was created. If you have not done these steps, and would like to follow along, start with [Tutorial 1 - Create an Azure Red Hat OpenShift 4 Cluster.](tutorial-create-cluster.md)
23-
24-
If you choose to install and use the CLI locally, this tutorial requires that you are running the Azure CLI version 2.6.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
18+
This article requires Azure CLI version 2.6.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
2519

2620
## Connect to the cluster
2721

28-
You can log into the cluster using the `kubeadmin` user. Run the following command to find the password for the `kubeadmin` user.
22+
You can log into the cluster using the `kubeadmin` user. Run the following command to find the password for the `kubeadmin` user.
2923

3024
```azurecli-interactive
3125
az aro list-credentials \
3226
--name $CLUSTER \
3327
--resource-group $RESOURCEGROUP
3428
```
3529

36-
The following example output shows what the password will be in `kubeadminPassword`.
30+
The following example output shows the password in `kubeadminPassword`.
3731

3832
```json
3933
{
@@ -57,7 +51,7 @@ Launch the console URL in a browser and login using the `kubeadmin` credentials.
5751

5852
## Install the OpenShift CLI
5953

60-
Once you're logged into the OpenShift Web Console, click on the **?** on the top right and then on **Command Line Tools**. Download the release appropriate to your machine.
54+
Once you're logged into the OpenShift Web Console, select the **?** at the top right and then on **Command Line Tools**. Download the release appropriate to your machine.
6155

6256
![Screenshot that highlights the Command Line Tools option in the list when you select the ? icon.](media/aro4-download-cli.png)
6357

@@ -82,20 +76,12 @@ Retrieve the API server's address.
8276
apiServer=$(az aro show -g $RESOURCEGROUP -n $CLUSTER --query apiserverProfile.url -o tsv)
8377
```
8478

85-
Login to the OpenShift cluster's API server using the following command. Replace **\<kubeadmin password>** with the password you just retrieved.
79+
Login to the OpenShift cluster's API server using the following command. Replace **\<kubeadmin password>** with the password you retrieved.
8680

8781
```azurecli-interactive
8882
oc login $apiServer -u kubeadmin -p <kubeadmin password>
8983
```
9084

9185
## Next steps
9286

93-
In this part of the tutorial, you learned how to:
94-
> [!div class="checklist"]
95-
> * Obtain `kubeadmin` credentials for your cluster
96-
> * Install the OpenShift CLI
97-
> * Connect to an Azure Red Hat OpenShift cluster using the OpenShift CLI
98-
99-
Advance to the next tutorial:
100-
> [!div class="nextstepaction"]
101-
> [Delete an Azure Red Hat OpenShift cluster](tutorial-delete-cluster.md)
87+
Learn how to [delete an Azure Red Hat OpenShift cluster](delete-cluster.md).

articles/openshift/tutorial-create-cluster.md renamed to articles/openshift/create-cluster.md

Lines changed: 77 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
---
2-
title: Tutorial - Create an Azure Red Hat OpenShift 4 cluster
2+
title: Create an Azure Red Hat OpenShift 4 cluster
33
description: Learn how to create a Microsoft Azure Red Hat OpenShift cluster using the Azure CLI
4-
author: joharder
5-
ms.author: joharder
6-
ms.topic: tutorial
4+
author: johnmarco
5+
ms.author: johnmarc
6+
ms.topic: article
77
ms.service: azure-redhat-openshift
88
ms.custom: devx-track-azurecli
9-
ms.date: 02/23/2022
9+
ms.date: 06/12/2024
1010
#Customer intent: As a developer, I want learn how to create an Azure Red Hat OpenShift cluster, scale it, and then clean up resources so that I am not charged for what I'm not using.
1111
---
1212

13-
# Tutorial: Create an Azure Red Hat OpenShift 4 cluster
13+
# Create an Azure Red Hat OpenShift 4 cluster
1414

15-
In this tutorial, part one of three, you prepare your environment to create an Azure Red Hat OpenShift cluster running OpenShift 4, and create a cluster. You learn how to:
16-
> [!div class="checklist"]
17-
> * Setup the prerequisites
18-
> * Create the required virtual network and subnets
19-
> * Deploy a cluster
15+
Azure Red Hat OpenShift is a managed OpenShift service that lets you quickly deploy and manage clusters. This article shows you how to deploy an Azure Red Hat OpenShift cluster using either Azure CLI or the Azure portal.
16+
17+
#### [Azure CLI](#tab/azure-cli)
2018

2119
## Before you begin
2220

23-
If you choose to install and use the CLI locally, this tutorial requires that you're running the Azure CLI version 2.30.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
21+
If you choose to install and use the CLI locally, you'll need to run Azure CLI version 2.30.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
2422

2523
Azure Red Hat OpenShift requires a minimum of 40 cores to create and run an OpenShift cluster. The default Azure resource quota for a new Azure subscription doesn't meet this requirement. To request an increase in your resource limit, see [Standard quota: Increase limits by VM series](../azure-portal/supportability/per-vm-quota-requests.md).
2624

@@ -35,7 +33,7 @@ Azure Red Hat OpenShift requires a minimum of 40 cores to create and run an Open
3533
3634
### Verify your permissions
3735
38-
During this tutorial, you'll create a resource group, which contains the virtual network for the cluster. To do this, you'll need Contributor and User Access Administrator permissions or Owner permissions, either directly on the virtual network or on the resource group or subscription containing it.
36+
In this article, you'll create a resource group which contains the virtual network for the cluster. To do this, you'll need Contributor and User Access Administrator permissions or Owner permissions, either directly on the virtual network or on the resource group or subscription containing it.
3937
4038
You'll also need sufficient Microsoft Entra permissions (either a member user of the tenant, or a guest assigned with role **Application administrator**) for the tooling to create an application and service principal on your behalf for the cluster. See [Member and guests](../active-directory/fundamentals/users-default-permissions.md#member-and-guest-users) and [Assign administrator and non-administrator roles to users with Microsoft Entra ID](../active-directory/fundamentals/active-directory-users-assign-role-azure-portal.md) for more details.
4139
@@ -242,13 +240,71 @@ az aro create \
242240
--version <x.y.z>
243241
```
244242

245-
## Next steps
243+
#### [Azure portal](#tab/azure-portal)
244+
245+
## Before you begin
246+
Sign in to the [Azure portal](https://portal.azure.com).
247+
248+
Register the `Microsoft.RedHatOpenShift` resource provider. For instructions on registering resource providers using Azure portal, see [Register resource provider](../azure-resource-manager/management/resource-providers-and-types.md#register-resource-provider).
249+
250+
## Create an Azure Red Hat OpenShift cluster
251+
1. On the Azure portal menu or from the **Home** page, select **All Services** under three horizontal bars on the top left hand page.
252+
2. Search for and select **Azure Red Hat OpenShift clusters**.
253+
3. Select **Create**.
254+
4. On the **Basics** tab, configure the following options:
255+
* **Project details**:
256+
* Select an Azure **Subscription**.
257+
* Select or create an Azure **Resource group**, such as *myResourceGroup*.
258+
* **Instance details**:
259+
* Select a **Region** for the Azure Red Hat OpenShift cluster.
260+
* Enter an **OpenShift cluster name**, such as *myAROCluster*.
261+
* Enter a **Domain name**.
262+
* Select **Master VM Size** and **Worker VM Size**.
263+
* Select **Worker node count** (i.e., the number of worker nodes to create).
264+
265+
> [!div class="mx-imgBorder"]
266+
> [ ![Screenshot of **Basics** tab on Azure portal.](./media/Basics.png) ](./media/Basics.png#lightbox)
267+
268+
> [!NOTE]
269+
> The **Domain name** field is pre-populated with a random string. You can either specify a domain name (e.g., *example.com*) or a string/prefix (e.g., *abc*) that will be used as part of the auto-generated DNS name for OpenShift console and API servers. This prefix is also used as part of the name of the resource group that is created to host the cluster VMs if a resource group name is not specified.
270+
271+
5. On the **Authentication** tab, complete the following sections.
272+
273+
Under **Service principal information**, select either **Create new** or **Existing**. If you choose to use an existing service principal, enter the following information:
274+
275+
- **Service principal client ID** is your appId.
276+
- **Service principal client secret** is the service principal's decrypted Secret value.
277+
278+
> [!NOTE]
279+
> If you need to create a service principal, see [Creating and using a service principal with an Azure Red Hat OpenShift cluster](howto-create-service-principal.md).
280+
281+
Under **Pull secret**, enter the **Red Hat pull secret** (i.e., your cluster's pull secret's decrypted value). If you don't have a pull secret, leave this field blank.
246282

247-
In this part of the tutorial, you learned how to:
248-
> [!div class="checklist"]
249-
> * Set up the prerequisites and create the required virtual network and subnets
250-
> * Deploy a cluster
283+
:::image type="content" source="./media/openshift-service-principal-portal.png" alt-text="Screenshot that shows how to use the Authentication tab with Azure portal to create a service principal." lightbox="./media/openshift-service-principal-portal.png":::
284+
285+
6. On the **Networking** tab, configure the required options.
286+
287+
> [!NOTE]
288+
> Azure Red Hat OpenShift clusters running OpenShift 4 require a virtual network with two empty subnets: one for the control plane and one for worker nodes.
289+
290+
291+
> [!div class="mx-imgBorder"]
292+
> [ ![Screenshot of **Networking** tab on Azure portal.](./media/Networking.png) ](./media/Networking.png#lightbox)
293+
294+
7. On the **Tags** tab, add tags to organize your resources.
295+
296+
> [!div class="mx-imgBorder"]
297+
> [ ![Screenshot of **Tags** tab on Azure portal.](./media/Tags.png) ](./media/Tags.png#lightbox)
298+
299+
8. Check **Review + create** and then **Create** when validation completes.
300+
301+
![Screenshot of **Review + create** tab on Azure portal.](./media/Review+Create.png)
302+
303+
9. It takes approximately 35 to 45 minutes to create the Azure Red Hat OpenShift cluster. When your deployment is complete, navigate to your resource by either:
304+
* Clicking **Go to resource**, or
305+
* Browsing to the Azure Red Hat OpenShift cluster resource group and selecting the Azure Red Hat OpenShift resource.
306+
* Per example cluster dashboard below: browsing for *myResourceGroup* and selecting *myAROCluster* resource.
307+
308+
## Next steps
251309

252-
Advance to the next tutorial:
253-
> [!div class="nextstepaction"]
254-
> [Connect to an Azure Red Hat OpenShift cluster](tutorial-connect-cluster.md)
310+
Learn how to [connect to an Azure Red Hat OpenShift cluster](connect-cluster.md).

articles/openshift/delete-cluster.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Delete an Azure Red Hat OpenShift cluster
3+
description: Learn how to delete an Azure Red Hat OpenShift cluster using the Azure CLI.
4+
author: johnmarco
5+
ms.custom: fasttrack-edit, devx-track-azurecli
6+
ms.author: johnmarc
7+
ms.topic: article
8+
ms.service: azure-redhat-openshift
9+
ms.date: 06/12/2024
10+
#Customer intent: As a developer, I want learn how to create an Azure Red Hat OpenShift cluster, scale it, and then clean up resources so that I am not charged for what I'm not using.
11+
---
12+
13+
# Delete an Azure Red Hat OpenShift 4 cluster
14+
15+
This article shows you how to delete an Azure Red Hat OpenShift cluster.
16+
17+
18+
## Before you begin
19+
20+
This article requires Azure CLI version 2.6.0 or later. Run `az --version` to find the version. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
21+
22+
## Sign in to Azure
23+
24+
If you're running the Azure CLI locally, run `az login` to sign in to Azure.
25+
26+
```azurecli
27+
az login
28+
```
29+
30+
If you have access to multiple subscriptions, run `az account set -s {subscription ID}` replacing `{subscription ID}` with the subscription you want to use.
31+
32+
## Delete the cluster
33+
34+
In previous articles for [creating](create-cluster.md) and [connecting](connect-cluster.md) a cluster, the following variable was set:
35+
36+
```bash
37+
RESOURCEGROUP=yourresourcegroup
38+
```
39+
40+
Using this value, delete your cluster:
41+
42+
```azurecli
43+
az group delete --name $RESOURCEGROUP
44+
```
45+
46+
You'll then be prompted to confirm if you are sure you want to perform this operation. After you confirm with `y`, it will take several minutes to delete the cluster. When the command finishes, the entire resource group and all resources inside it, including the cluster and the virtual network, will be deleted.
47+
48+
## Next steps
49+
50+
Learn more about using OpenShift with the official [Red Hat OpenShift documentation](https://docs.openshift.com/container-platform/4.6/welcome/index.html).

articles/openshift/howto-add-update-pull-secret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ keywords: pull secret, aro, openshift, red hat
1414

1515
This guide covers adding or updating your Red Hat pull secret for an existing Azure Red Hat OpenShift (ARO) 4.x cluster.
1616

17-
If you're creating a cluster for the first time, you can add your pull secret when you create your cluster. For more information about creating an ARO cluster with a Red Hat pull secret, see [Create an Azure Red Hat OpenShift 4 cluster](tutorial-create-cluster.md#get-a-red-hat-pull-secret-optional).
17+
If you're creating a cluster for the first time, you can add your pull secret when you create your cluster. For more information about creating an ARO cluster with a Red Hat pull secret, see [Create an Azure Red Hat OpenShift 4 cluster](create-cluster.md#get-a-red-hat-pull-secret-optional).
1818

1919
## Before you begin
2020

0 commit comments

Comments
 (0)