Skip to content

Commit e323c0e

Browse files
Merge pull request #227346 from johnmarco/jm-cluster-domain-name-update
Add domain requirements to cluster articles
2 parents 029c352 + 92f3b35 commit e323c0e

File tree

3 files changed

+27
-18
lines changed

3 files changed

+27
-18
lines changed

articles/openshift/quickstart-openshift-arm-bicep-template.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.service: azure-redhat-openshift
66
ms.topic: quickstart
77
ms.custom: mode-arm
88
ms.author: johnmarc
9-
ms.date: 03/17/2022
9+
ms.date: 02/15/2023
1010
keywords: azure, openshift, aro, red hat, arm, bicep
1111
#Customer intent: I need to use ARM templates or Bicep files to deploy my Azure Red Hat OpenShift cluster.
1212
zone_pivot_groups: azure-red-hat-openshift
@@ -575,6 +575,9 @@ This section provides information on deploying the azuredeploy.json template.
575575

576576
The azuredeploy.json template is used to deploy an Azure Red Hat OpenShift cluster. The following parameters are required.
577577

578+
> [!NOTE]
579+
> For the `domain` parameter, specify the domain prefix 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.
580+
578581
| Property | Description | Valid Options | Default Value |
579582
|----------|-------------|---------------|---------------|
580583
| `domain` |The domain prefix for the cluster. | | none |

articles/openshift/quickstart-portal.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: johnmarco
55
ms.author: johnmarc
66
ms.service: azure-redhat-openshift
77
ms.topic: quickstart
8-
ms.date: 11/30/2021
8+
ms.date: 02/14/2023
99
ms.custom: mode-ui
1010
---
1111

@@ -32,6 +32,9 @@ Create a service principal, as explained in [Use the portal to create an Azure A
3232
* Select **Master VM Size** and **Worker VM Size**.
3333

3434
![**Basics** tab on Azure portal](./media/Basics.png)
35+
36+
> [!NOTE]
37+
> In the **Domain name** field, you can either specify a domain name (e.g., *example.com*) or a 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 (e.g., *aro-abc*) that is created to host the cluster VMs.
3538

3639
4. On the **Authentication** tab of the **Azure Red Hat OpenShift** dialog, complete the following sections.
3740

articles/openshift/tutorial-create-cluster.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.date: 10/26/2020
1111

1212
# Tutorial: Create an Azure Red Hat OpenShift 4 cluster
1313

14-
In this tutorial, part one of three, you'll prepare your environment to create an Azure Red Hat OpenShift cluster running OpenShift 4, and create a cluster. You'll learn how to:
14+
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:
1515
> [!div class="checklist"]
1616
> * Setup the prerequisites
1717
> * Create the required virtual network and subnets
@@ -21,9 +21,9 @@ In this tutorial, part one of three, you'll prepare your environment to create a
2121

2222
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).
2323

24-
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 does not 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).
24+
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).
2525

26-
* For example to check the current subscription quota of the smallest supported virtual machine family SKU "Standard DSv3":
26+
* For example, to check the current subscription quota of the smallest supported virtual machine family SKU "Standard DSv3":
2727

2828
```azurecli-interactive
2929
LOCATION=eastus
@@ -34,9 +34,9 @@ Azure Red Hat OpenShift requires a minimum of 40 cores to create and run an Open
3434
3535
### Verify your permissions
3636
37-
During this tutorial, you will create a resource group, which will contain the virtual network for the cluster. You must have either Contributor and User Access Administrator permissions, or Owner permissions, either directly on the virtual network, or on the resource group or subscription containing it.
37+
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.
3838
39-
You will also need sufficient Azure Active Directory permissions (either a member user of the tenant, or a guest user assigned with role **Application administrator**) for the tooling to create an application and service principal on your behalf for the cluster. See [Member and guest users](../active-directory/fundamentals/users-default-permissions.md#member-and-guest-users) and [Assign administrator and non-administrator roles to users with Azure Active Directory](../active-directory/fundamentals/active-directory-users-assign-role-azure-portal.md) for more details.
39+
You'll also need sufficient Azure Active Directory 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 Azure Active Directory](../active-directory/fundamentals/active-directory-users-assign-role-azure-portal.md) for more details.
4040
4141
### Register the resource providers
4242
@@ -74,29 +74,32 @@ You will also need sufficient Azure Active Directory permissions (either a membe
7474
### Get a Red Hat pull secret (optional)
7575
7676
> [!NOTE]
77-
> ARO pull secret does not change the cost of the RH OpenShift license for ARO.
77+
> ARO pull secret doesn't change the cost of the RH OpenShift license for ARO.
7878
79-
A Red Hat pull secret enables your cluster to access Red Hat container registries along with additional content. This step is optional but recommended. Please note that the field `cloud.openshift.com` will be removed from your secret even if your pull-secret contains that field. This field enables an extra monitoring feature which sends data to RedHat and is thus disabled by default. To enable this feature, see https://docs.openshift.com/container-platform/4.11/support/remote_health_monitoring/enabling-remote-health-reporting.html .
79+
A Red Hat pull secret enables your cluster to access Red Hat container registries along with other content. This step is optional but recommended. The field `cloud.openshift.com` is removed from your secret even if your pull-secret contains that field. This field enables an extra monitoring feature, which sends data to RedHat and is thus disabled by default. To enable this feature, see https://docs.openshift.com/container-platform/4.11/support/remote_health_monitoring/enabling-remote-health-reporting.html .
8080
81-
1. [Navigate to your Red Hat OpenShift cluster manager portal](https://console.redhat.com/openshift/install/azure/aro-provisioned) and log in.
81+
1. [Navigate to your Red Hat OpenShift cluster manager portal](https://console.redhat.com/openshift/install/azure/aro-provisioned) and sign-in.
8282
83-
You will need to log in to your Red Hat account or create a new Red Hat account with your business email and accept the terms and conditions.
83+
You'll need to log in to your Red Hat account or create a new Red Hat account with your business email and accept the terms and conditions.
8484
85-
1. Click **Download pull secret** and download a pull secret to be used with your ARO cluster.
85+
1. Select **Download pull secret** and download a pull secret to be used with your ARO cluster.
8686
8787
Keep the saved `pull-secret.txt` file somewhere safe. The file will be used in each cluster creation if you need to create a cluster that includes samples or operators for Red Hat or certified partners.
8888
8989
When running the `az aro create` command, you can reference your pull secret using the `--pull-secret @pull-secret.txt` parameter. Execute `az aro create` from the directory where you stored your `pull-secret.txt` file. Otherwise, replace `@pull-secret.txt` with `@/path/to/my/pull-secret.txt`.
9090
91-
If you are copying your pull secret or referencing it in other scripts, your pull secret should be formatted as a valid JSON string.
91+
If you're copying your pull secret or referencing it in other scripts, your pull secret should be formatted as a valid JSON string.
9292
9393
### Prepare a custom domain for your cluster (optional)
9494
9595
When running the `az aro create` command, you can specify a custom domain for your cluster by using the `--domain foo.example.com` parameter.
9696
97-
If you provide a custom domain for your cluster note the following points:
97+
> [!NOTE]
98+
> Although adding a domain name is optional when creating a cluster through Azure CLI, a domain name (or a prefix used as part of the auto-generated DNS name for OpenShift console and API servers) is needed when adding a cluster through the portal. See [Quickstart: Deploy an Azure Red Hat OpenShift cluster using the Azure portal](quickstart-portal.md#create-an-azure-red-hat-openshift-cluster) for more information.
99+
100+
If you provide a custom domain for your cluster, note the following points:
98101
99-
* After creating your cluster, you must create 2 DNS A records in your DNS server for the `--domain` specified:
102+
* After creating your cluster, you must create two DNS A records in your DNS server for the `--domain` specified:
100103
* **api** - pointing to the api server IP address
101104
* **\*.apps** - pointing to the ingress IP address
102105
* Retrieve these values by executing the following command after cluster creation: `az aro show -n -g --query '{api:apiserverProfile.ip, ingress:ingressProfiles[0].ip}'`.
@@ -107,7 +110,7 @@ If you provide a custom domain for your cluster note the following points:
107110
108111
### Create a virtual network containing two empty subnets
109112
110-
Next, you will create a virtual network containing two empty subnets. If you have existing virtual network that meets your needs, you can skip this step.
113+
Next, you'll create a virtual network containing two empty subnets. If you have existing virtual network that meets your needs, you can skip this step.
111114
112115
1. **Set the following variables in the shell environment in which you will execute the `az` commands.**
113116
@@ -119,7 +122,7 @@ Next, you will create a virtual network containing two empty subnets. If you hav
119122

120123
2. **Create a resource group.**
121124

122-
An Azure resource group is a logical group in which Azure resources are deployed and managed. When you create a resource group, you are asked to specify a location. This location is where resource group metadata is stored, and it is also where your resources run in Azure if you don't specify another region during resource creation. Create a resource group using the [az group create](/cli/azure/group#az-group-create) command.
125+
An Azure resource group is a logical group in which Azure resources are deployed and managed. When you create a resource group, you're asked to specify a location. This location is where resource group metadata is stored, and it is also where your resources run in Azure if you don't specify another region during resource creation. Create a resource group using the [az group create](/cli/azure/group#az-group-create) command.
123126

124127
> [!NOTE]
125128
> Azure Red Hat OpenShift is not available in all regions where an Azure resource group can be created. See [Available regions](https://azure.microsoft.com/global-infrastructure/services/?products=openshift) for information on where Azure Red Hat OpenShift is supported.
@@ -203,7 +206,7 @@ Next, you will create a virtual network containing two empty subnets. If you hav
203206
## Create the cluster
204207

205208
Run the following command to create a cluster. If you choose to use either of the following options, modify the command accordingly:
206-
* Optionally, you can [pass your Red Hat pull secret](#get-a-red-hat-pull-secret-optional) which enables your cluster to access Red Hat container registries along with additional content. Add the `--pull-secret @pull-secret.txt` argument to your command.
209+
* Optionally, you can [pass your Red Hat pull secret](#get-a-red-hat-pull-secret-optional), which enables your cluster to access Red Hat container registries along with other content. Add the `--pull-secret @pull-secret.txt` argument to your command.
207210
* Optionally, you can [use a custom domain](#prepare-a-custom-domain-for-your-cluster-optional). Add the `--domain foo.example.com` argument to your command, replacing `foo.example.com` with your own custom domain.
208211

209212
> [!NOTE]

0 commit comments

Comments
 (0)