Skip to content

Commit 644f58c

Browse files
Tyler WhitneyTyler Whitney
authored andcommittedApr 6, 2019
first cut at openshift docs. Get into repo so can start tech review
1 parent d3c7a67 commit 644f58c

19 files changed

+818
-15
lines changed
 
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Create an Azure Application for your Azure Red Hat Open Shift cluster | Microsoft Docs
3+
description: Shows you how to create an Azure application object so that you can use Open Shift on Azure
4+
documentationcenter: .net
5+
author: tylermsft
6+
ms.author: twhitney
7+
ms.service: openshift
8+
manager: jeconnoc
9+
editor: ''
10+
ms.topic: conceptual
11+
ms.tgt_pltfrm: NA
12+
ms.workload: NA
13+
ms.date: 5/6/2019
14+
---
15+
16+
# How to create a new app registration and new Azure Active Directory user
17+
18+
Microsoft Azure Red Hat OpenShift needs permissions to perform tasks on behalf of your cluster in Azure. If your organization doesn't already have an Azure Active Directory (AD) app registration you can use as the service principal in Azure Active Directory, follow these instructions to create one.
19+
20+
This topic concludes with instructions for creating a new AD user that you'll need to access apps running on your ARO cluster.
21+
22+
## Create a new app registration
23+
24+
An application that wants to use the capabilities of Azure AD must first be registered in an Azure AD tenant. This registration process involves giving Azure AD details about your application such as the URL where the app is located, the URL to send replies after a user is authenticated, the URI that identifies the app, and so on.
25+
26+
1. In the [Azure portal](https://portal.azure.com), ensure that your tenant appears under your user name in the top right of the portal:
27+
![Tenant display][tenantcallout]
28+
If the wrong tenant is displayed, click on your user name in the top right, then click **Switch Directory**, and select the directory created above from the **All Directories** list.
29+
2. Click on the following link to go to the [App registrations blade](https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps)
30+
3. The **App registrations** blade appears. Click **+New application registration**.
31+
4. In the **Create** pane, enter a friendly name (can be any name) for your application.
32+
5. Ensure that **Application type** is set to **Web app/API**.
33+
6. Create a **Sign-on URL** comprised of the name you'll use when you create your cluster, the location of the cluster, and append `.cloudapp.azure.com` For example, if your cluster name is going to be `mycluster` (note that the cluster name must be all lowercase), and you will be creating it in the `eastus` region, the fully-qualified domain name (FQDN) that you'll enter for the **Sign-on URL** would be `https://mycluster.eastus.cloudapp.azure.com` Remember this URL because you'll need it to access the app running on your cluster. This URL needs to be unique so take that into account when you decide on your cluster name in this step. We will refer to this value as 'FQDN' in the tutorials.
34+
7. Press Tab to move focus out of the **Sign-on URL** field to validate the URL.
35+
8. At the bottom of the Create pane, click **Create** to create the Azure Active Directory application object.
36+
37+
For more information about Azure Application Objects, see [Application and service principal objects in Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals).
38+
Refer to [Register an app with the Azure Active Directory v1.0 endpoint](https://docs.microsoft.com/azure/active-directory/develop/quickstart-v1-add-azure-ad-app) if you want more detailed instructions about creating a new Azure AD application.
39+
40+
### Create a client secret
41+
42+
Next, generate a client secret.
43+
44+
1. While still in the portal on the **Registered App** page from the previous step, copy the **Application ID** and save it where you can refer to it later. We will refer to this value as `APPID` in the tutorials.
45+
![App id][appidimage]
46+
2. Click on **Settings** to open the settings for your registered app.
47+
3. On the **Settings** pane that appears, click **Keys**. The Keys pane appears.
48+
![Create key][createkeyimage]
49+
4. Provide a **Key description**.
50+
5. Set the expiration duration to **In 2 years**
51+
6. Click **Save** and the key value will appear.
52+
7. Make a copy of the key value. We will refer to this value as `SECRET` in the tutorials.
53+
54+
### Create a Reply URL
55+
56+
Azure Active Directory uses the app object reply URL to specify the callback to use when authorizing the app. Even the smallest mismatch (trailing slash missing, different casing) will cause the token-issuance operation to fail and you won't be able to sign in.
57+
58+
1. Back on the **Settings** pane, click **Reply URLs**. The Reply URLs pane appears.
59+
2. A reply URL that is the `FQDN` value from step 6 in [Create a new app registration](#create-a-new-app-registration) will already be entered as one of the Reply URLs on the right. Edit it and append `/oauth2callback/Azure%20AD`. For example, a reply URL will look something like `https://mycluster.eastus.cloudapp.azure.com/oauth2callback/Azure%20AD`
60+
3. Click **Save** to save the Reply URL.
61+
62+
## Create a new Active Directory user
63+
64+
Create a new user in Active Directory that you'll use to sign in to the app running on your ARO cluster.
65+
66+
1. Click this [link](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade/AllUsers) to go to the **Users - All users** pane.
67+
2. Click **+ New user**. The **User** pane appears.
68+
3. Enter a **Name** that you'd like for this user.
69+
4. Create a **User name** based on the name of the tenant you created with `.onmicrosoft.com` appended at the end. For example, `chris@yourTenantName.onmicrosoft.com`. Write down the user name. You'll use it to sign in to use the app on your cluster later.
70+
5. Click **Directory role** and select **Global administrator** and then click **Ok** at the bottom of the pane.
71+
6. In the middle of the **User** pane, click **Show Password** and record the temporary password. After you sign in the first time, you'll be prompted to reset it.
72+
7. At the bottom of the pane, click **Create** to create the user.
73+
74+
## Resources
75+
76+
[Applications and service principals](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals)
77+
[Register an app with the Azure Active Directory v1.0 endpoint](https://docs.microsoft.com/azure/active-directory/develop/quickstart-v1-add-azure-ad-app)
78+
79+
[appidimage]: ./media/howto-create-tenant/get-app-id.png
80+
[createkeyimage]: ./media/howto-create-tenant/create-key.png
81+
[tenantcallout]: ./media/howto-create-tenant/tenant-callout.png
82+
83+
## Next steps
84+
85+
Try the [Create an Azure Red Hat Openshift cluster](tutorial-create-cluster.md) tutorial.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Create a tenant for your Azure Open Shift cluster | Microsoft Docs
3+
description: Shows you how to create a tenant and Azure application object so that you can use OpenShift on Azure
4+
documentationcenter: .net
5+
author: tylermsft
6+
ms.author: twhitney
7+
ms.service: container-service
8+
manager: jeconnoc
9+
editor: ''
10+
ms.topic: conceptual
11+
ms.date: 5/6/2019
12+
---
13+
14+
# How to create a tenant for your ARO cluster
15+
16+
Before you can create a Microsoft Azure Red Hat OpenShift cluster, you need a tenant in which to create the cluster. Follow these instructions to create an Azure tenant if you don't already have one.
17+
18+
A tenant is a dedicated instance of Azure Active Directory (AD) that an organization or app developer receives when they create a relationship with Microsoft by signing up for Azure, Microsoft Intune, or Microsoft 365. Each Azure AD tenant is distinct and separate from other Azure AD tenants and has its own work and school identities and app registrations.
19+
20+
## Create a new tenant
21+
22+
To create a tenant:
23+
24+
1. Sign in to the [Azure portal](https://portal.azure.com/) using the account you want to use to create your Azure Red Hat OpenShift cluster.
25+
2. Click this [link](https://portal.azure.com/#create/Microsoft.AzureActiveDirectory) to go to the Azure Active Directory blade to create a tenant, or as it is otherwise referred to, an Azure Active Directory.
26+
3. Provide an **Organization name**.
27+
4. Provide an **Initial domain name**. What you put here will have *onmicrosoft.com* appended to it. You can use what you put for **Organization name** here.
28+
5. At the bottom of the page click **Create**.
29+
6. After your tenant (Azure Active Directory) is created, click on **Click here to manage your new directory**. Your tenant will be displayed in the upper right of the Azure portal:
30+
![Tenant display][tenantcallout]
31+
7. We need to get the tenant ID to specify where to create the cluster later. On the portal, you should now see the Azure Active Directory blade for your new tenant. In the **Manage** section of the **Azure Active Directory** blade, click **Properties**. Copy the value for **Directory ID**. We will refer to this value as the `TENANT` later in the docs.
32+
33+
Refer to [Set up a dev environment](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) for more detailed instructions about setting up an Azure tenant.
34+
35+
## Resources
36+
37+
[Create a tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant)
38+
39+
[tenantcallout]: ./media/howto-create-tenant/tenant-callout.png
40+
41+
## Next steps
42+
43+
[Create a new app registration and Azure Active Directory user for your cluster](howto-aad-app-configuration.md)
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: Set up your Azure Red Hat OpenShift development environment | Microsoft Docs
3+
description: Set up your Microsoft Red Hat OpenShift development environment
4+
services: openshift
5+
keywords: red hat open shift setup
6+
author: TylerMSFT
7+
ms.author: twhitney
8+
ms.date: 5/6/2019
9+
ms.topic: conceptual
10+
ms.service: openshift
11+
manager: jeconnoc
12+
#Customer intent: As a developer, I need to install the prerequisites so I can create an Azure Red Hat Openshift cluster
13+
---
14+
15+
# Set up your Microsoft Azure Red Hat OpenShift dev environment
16+
17+
To build and run Microsoft Azure Red Hat OpenShift (ARO) applications on your Windows development machine, you'll need:
18+
19+
* Version 2.0.43 or higher of the Azure CLI (or use the Azure Cloud Shell)
20+
* A tenant (Azure Active Directory) for your OpenShift cluster
21+
* An Azure Active Directory (AAD) application object and Active Directory user object
22+
* Manually register providers and features
23+
24+
The following instructions will help you get everything ready.
25+
26+
## Install the Azure CLI
27+
28+
If you don't have version [2.0.61] of the Azure CLI, install the [latest version here][azure-cli-install].
29+
You can see which version of the Azure CLI you have by running the following from a command window:
30+
```bat
31+
az --version
32+
```
33+
34+
The first line of output will have the CLI version, for example `azure-cli (2.0.61)`.
35+
36+
## Create a tenant (Azure Active Directory)
37+
38+
Before you can create an Azure Red Hat OpenShift cluster, you need a tenant (an Azure Active Directory (AAD)) for it.
39+
40+
If you don't have an AAD to use as the tenant for your OpenShift cluster, or you wish to create a tenant for testing, follow the instructions in [Create a tenant for your Azure Open Shift cluster](howto-create-tenant.md) before continuing with these instructions.
41+
42+
## Create an Azure Active Directory application object and user
43+
44+
Before you can create an Azure Red Hat OpenShift cluster, you also need an app registration that allows the cluster to perform functions such as configuring storage. You'll also need to create a new user in AAD to use to sign in to the app running on your ARO cluster.
45+
46+
If you don't have an app registration in the AAD tenant you are using to create your ARO cluster, or don't have a AAD user to use to sign in to your cluster, follow the instructions in [Create an Azure Active Directory application object](howto-aad-app-configuration.md).
47+
48+
## Register providers and features
49+
50+
The `Microsoft.ContainerService openshiftmanagedcluster` feature, `Microsoft.Solutions` and `Microsoft.Network` providers must be registered to your subscription manually before deploying your first ARO cluster.
51+
52+
To register these providers and features manually, use the following instructions:
53+
54+
1. Start an Azure Cloud Shell (Bash) session from the Azure portal.
55+
2. If you have access to multiple subscriptions, specify the relevant
56+
subscription ID:
57+
58+
```bash
59+
az account set --subscription <SUBSCRIPTION ID>
60+
```
61+
62+
3. Register the Microsoft.ContainerService openshiftmanagedcluster feature:
63+
64+
```bash
65+
az feature register --namespace Microsoft.ContainerService -n openshiftmanagedcluster
66+
```
67+
68+
4. Register the Microsoft.Solutions provider:
69+
70+
```bash
71+
az provider register -n Microsoft.Solutions --wait
72+
```
73+
74+
5. Register the Microsoft.Network provider:
75+
76+
```bash
77+
az provider register -n Microsoft.Network --wait
78+
```
79+
80+
6. Refresh the registration of the Microsoft.ContainerService resource provider:
81+
82+
```bash
83+
az provider register -n Microsoft.ContainerService --wait
84+
```
85+
86+
You're now ready to create Azure Red Hat Openshift applications.
87+
88+
## Next steps
89+
90+
Try the [Create an Azure Red Hat Openshift cluster](tutorial-create-cluster.md) tutorial.
91+
Find answers to [common questions and known issues](openshift-faq.md).
92+
93+
[azure-cli-install]: https://docs.microsoft.com/cli/azure/install-azure-cli

‎articles/openshift/index.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
### YamlMime:YamlDocument
2+
documentType: LandingData
3+
title: Microsoft Azure Red Hat OpenShift Service (AOS)
4+
metadata:
5+
document_id:
6+
title: Microsoft Azure Red Hat OpenShift Service (AOS) Documentation - Tutorials, API Reference | Microsoft Docs
7+
meta.description: AOS allows you to quickly deploy a production ready Red Hat OpenShift cluster in Azure. Learn how to use AOS with these tutorials and how-to guides.
8+
services: container-service
9+
author: tylermsft
10+
manager: jeconnoc
11+
ms.service: container-service
12+
ms.tgt_pltfrm: na
13+
ms.devlang: na
14+
ms.topic: landing-page
15+
ms.date: 05-06-2019
16+
ms.author: twhitney
17+
abstract:
18+
description: 'Microsoft Azure Red Hat OpenShift Service (AOS) provides a self-service deployment of fully managed OpenShift clusters that allows you to maintain regulatory compliance while focusing on your application development.'
19+
sections:
20+
- title: Step-by-Step Tutorials
21+
items:
22+
- type: paragraph
23+
text: 'Learn how to create and manage an AOS cluster.'
24+
- type: list
25+
style: ordered
26+
items:
27+
- html: <a href="/azure/openshift/tutorial-create-cluster">Create an ARO cluster</a>
28+
- html: <a href="/azure/openshift/tutorial-scale-cluster">Scale an ARO cluster</a>
29+
- html: <a href="/azure/openshift/tutorial-delete-cluster">Delete an ARO cluster</a>
30+
31+
- title: Reference
32+
items:
33+
- type: list
34+
style: cards
35+
className: cardsD
36+
items:
37+
- title: Command line
38+
html: <p><a href="/cli/azure/aks">Azure CLI</a></p>
39+
- title: REST
40+
html: <p><a href="/rest/api/aks">REST API</a></p>
41+
- title: Red Hat OpenShift dedicated documentation
42+
html: <p><a href="https://access.redhat.com/documentation/openshift_dedicated/3/)"

‎articles/openshift/intro-openshift.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Introduction to Microsoft Azure Red Hat OpenShift (ARO)
3+
description: Learn the features and benefits of Azure Red Hat OpenShift (ARO) to deploy and manage container-based applications in Azure.
4+
services: container-service
5+
author: tylermsft
6+
ms.author: twhitney
7+
ms.service: container-service
8+
manager: jeconnoc
9+
ms.topic: overview
10+
ms.date: 05/6/2019
11+
ms.custom: mvc
12+
---
13+
14+
# Microsoft Azure Red Hat OpenShift Service
15+
16+
Microsoft Azure Red Hat OpenShift (ARO) provides a self-service deployment of fully managed OpenShift clusters that allows you to maintain regulatory compliance while focusing on your application develpopment. ARO is jointly engineered, operated, and supported by both Microsoft and Red Hat. It provides an integrated support experience. Clusters are deployed into your Azure subscription and are included on your Azure bill.
17+
18+
Master, infrastructure and application nodes are patched, updated, and monitored by Microsoft and Red Hat. Choose your own registry, networking, storage, or CI/CD solutions. Or get going with immediately using built-in solutions automated source code management, container and application builds, deployments, scaling, health management, and more.
19+
20+
There are no virtual machines to operate. No patching is required. ARO provides an integrated sign-on experience through Azure Active Directory and regulatory compliance with SOC, ISO, PCI DSS, and HIPAA.
21+
22+
OpenShift extends Kubernetes. Running containers in production with Kubernetes requires additional tools and resources, such as an image registry, storage management, networking solutions, and logging and monitoring tools, all of which must be versioned and tested together.
23+
24+
Building container-based applications requires even more integration work with middleware, frameworks, databases, and CI/CD tools.
25+
26+
OpenShift combines these into a single platform, bringing ease of operations to IT teams while giving application teams what they need to execute.
27+
28+
To get started, complete the [Deploy a Red Hat OpenShift cluster on Azure](tutorial-create-cluster.md) tutorial.
29+
30+
## Access, security, and monitoring
31+
32+
For improved security and management, ARO lets you integrate with Azure Active Directory and use Kubernetes role-based access controls. You can also monitor the health of your cluster and resources.
33+
34+
## Cluster and node
35+
36+
ARO nodes run on Azure virtual machines. You can connect storage to nodes and pods, upgrade cluster components, and use GPUs.
37+
38+
## Virtual networks and ingress
39+
40+
An AKS cluster can be deployed into an existing virtual network. In this configuration, every pod in the cluster is assigned an IP address in the virtual network, and can directly communicate with other pods in the cluster, and other nodes in the virtual network. Pods can connect also to other services in a peered virtual network, and to on-premises networks over ExpressRoute or site-to-site (S2S) VPN connections.
41+
42+
For more information, see [Create a Microsoft Red Hat OpenShift cluster on Azure](tutorial-create-cluster.md).
43+
44+
## Kubernetes certification
45+
46+
Azure Red Hat OpenShift service has been CNCF certified as Kubernetes conformant.
47+
48+
## Regulatory compliance
49+
50+
Azure Red Hat OpenShift service is compliant with SOC, ISO, PCI DSS, and HIPAA.
51+
52+
## Next steps
53+
54+
Try the [Create an Azure Red Hat Openshift cluster](tutorial-create-cluster.md) tutorial.

‎articles/openshift/media/aro-auth.png

37 KB
Loading
618 KB
Loading
Loading
Loading
Loading
Loading

‎articles/openshift/openshift-faq.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Frequently asked questions for Azure Red Hat OpenShift (ARO)
3+
description: Provides answers to some of the common questions about Azure Red Hat OpenShift (ARO).
4+
services: container-service
5+
author: tylermsft
6+
ms.author: twhitney
7+
manager: jeconnoc
8+
ms.service: container-service
9+
ms.topic: article
10+
ms.date: 05/06/2019
11+
---
12+
13+
# Frequently asked questions about Microsoft Azure Red Hat OpenShift
14+
15+
This article addresses frequent questions about the Microsoft Azure Red Hat OpenShift (ARO) service.
16+
17+
## Which Azure regions support ARO?
18+
19+
See [Supported resources](supported-resources.md#azure-regions) for a list of regions around the globe that support ARO.
20+
21+
## Can I deploy ARO into my existing virtual network?
22+
23+
You can deploy an ARO cluster into an existing virtual network when you create the cluster. See the [Create a Red Hat OpenShift cluster on Azure](tutorial-create-cluster.md) for details.
24+
25+
## What ARO cluster operations are available?
26+
27+
Currently, no modifications are permitted to the `Microsoft.ContainerService/openShiftManagedClusters` resource after creation, except for scaling up or down the number of compute nodes. The maximum number of compute nodes is limited to 20.
28+
29+
## What virtual machine sizes can I use with my ARO cluster?
30+
31+
See [ARO virtual machine sizes](supported-resources.md#aro-virtual-machine-sizes) for a list of permitted virtual machine sizes.
32+
33+
## Is data on my ARO cluster encrypted?
34+
35+
By default, there is encryption at rest. The Azure storage platform automatically encrypts your data before persisting it, and decrypts the data before retrieval. See [Azure Storage Service Encryption for data at rest](https://docs.microsoft.com/azure/storage/common/storage-service-encryption) for details.
36+
37+
## Does ARO have a service level agreement?
38+
39+
Yes. JTW -further details and link.
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Supported resources for Microsoft Azure Red Hat OpenShift (ARO)
3+
description: Provides answers about which regions and virtual machine sizes are supported by Microsoft Azure Red Hat OpenShift (ARO).
4+
services: container-service
5+
author: tylermsft
6+
ms.author: twhitney
7+
manager: jeconnoc
8+
ms.service: container-service
9+
ms.topic: article
10+
ms.date: 05/06/2019
11+
---
12+
13+
# Microsoft Red Hat OpenShift on Azure resources
14+
15+
This topic lists the Azure regions and virtual machine sizes supported by Microsoft Red Hat OpenShift on Azure (ARO).
16+
17+
## Azure regions
18+
19+
You can deploy ARO clusters to the following Azure regions around the globe:
20+
21+
|Region|CLI code|
22+
|-|-|
23+
|🇦🇺 Australia East|`australiaeast`|
24+
|🇨🇦 Canada Central|`canadacentral`|
25+
|🇨🇦 Canada East|`canadaeast`|
26+
|🇺🇸 East US|`eastus`|
27+
|🇺🇸 West US|`westus`|
28+
|🇪🇺 West Europe|`westeurope`|
29+
|🇪🇺 North Europe|`northeurope`|
30+
31+
## ARO virtual machine sizes
32+
33+
The following is a list of supported virtual machine sizes you can specify for the compute nodes in your ARO cluster.
34+
35+
> [!Important]
36+
> Each VM has a different number of drives that can be attached. This may not be as immediately clear as memory or CPU size.
37+
> Not all VM sizes are available in all regions. If the API support the size you specify, you will get an error if the size is not available in the region you specify.
38+
> See [Current list of supported VM sizes per region](https://azure.microsoft.com/global-infrastructure/services/?products=virtual-machines) for more information.
39+
40+
## Compute node sizes supported by the ARO REST API
41+
42+
|Size|vCPU|RAM|
43+
|-|-|-|
44+
|Standard D4s v3|4|16G|
45+
|Standard D8s v3|8|32G|
46+
|Standard D16s v3|16|64G|
47+
|Standard D32s v3|32|128G|
48+
|-|-|-|
49+
|Standard E4s v3|4|32G|
50+
|Standard E8s v3|8|64G|
51+
|Standard E16s v3|16|128G|
52+
|Standard E32s v3|32|256G|
53+
|-|-|-|
54+
|Standard F8s v2|8|16G|
55+
|Standard F16s v2|16|32G|
56+
|Standard F32s v2|32|64G|
57+
58+
## Valid infra/master nodes supported by the ARO REST API
59+
60+
|Size|vCPU|RAM|
61+
|-|-|-|
62+
|Standard D4s v3|4|16G|
63+
|Standard D8s v3|8|32G|
64+
|Standard D16s v3|16|64G|
65+
|Standard D32s v3|32|128G|
66+
67+
## Next steps
68+
69+
Try the [Create an Azure Red Hat Openshift cluster](tutorial-create-cluster.md) tutorial.

‎articles/openshift/toc.yml

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,45 @@
1-
- name: OpenShift Documentation
2-
href: index.md
3-
- name: Quickstarts
4-
expanded: true
1+
- name: Azure Red Hat OpenShift (ARO)
2+
href: index.yml
3+
- name: Overview
54
items:
6-
- name: 'OpenShift: Community template'
7-
href: https://azure.microsoft.com/resources/templates/openshift-origin-rhel/
5+
- name: What is Azure Red Hat Openshift?
6+
href: intro-openshift.md
87
- name: Tutorials
98
items:
10-
- name: Deploy to Azure VMs
11-
href: /azure/virtual-machines/linux/openshift-get-started
9+
- name: Create and manage an Azure Red Hat OpenShift cluster
10+
items:
11+
- name: 1 - Create an ARO cluster
12+
href: tutorial-create-cluster.md
13+
- name: 2 - Scale an ARO cluster
14+
href: tutorial-scale-cluster.md
15+
- name: 3 - Delete an ARO cluster
16+
href: tutorial-delete-cluster.md
17+
18+
- name: How-to guides
19+
items:
20+
- name: Set up your ARO dev environment
21+
href: howto-setup-environment.md
22+
- name: Create a tenant for your ARO cluster
23+
href: howto-create-tenant.md
24+
- name: Create an AAD app object and user
25+
href: howto-aad-app-configuration.md
26+
27+
- name: Reference
28+
items:
29+
- name: Azure Red Hat Open Shift CLI
30+
href: https://docs.microsoft.com/cli/azure/openshift?view=azure-cli-latest#az-openshift-create,
31+
- name: Azure Red Hat Open Shift REST APIs
32+
href: https://docs.microsoft.com/rest/api/azure/
33+
1234
- name: Resources
1335
items:
14-
- name: Azure Roadmap
15-
href: https://azure.microsoft.com/roadmap/
16-
- name: OpenShift Container template
17-
href: https://github.com/Microsoft/openshift-container-platform
18-
- name: OpenShift Origin
19-
href: https://docs.openshift.org/latest/getting_started/index.html
20-
- name: OpenShift site
36+
- name: Common questions
37+
href: openshift-faq.md
38+
- name: Troubleshoot
39+
href: troubleshoot.md
40+
- name: Regional availability
41+
href: https://azure.microsoft.com/regions/services/
42+
- name: Red Hat OpenShift documentation
2143
href: https://docs.openshift.org/latest/welcome/index.html
44+
- name: Azure Roadmap
45+
href: https://azure.microsoft.com/roadmap/

‎articles/openshift/troubleshoot.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Troubleshoot common Microsoft Azure Red Hat OpenShift problems
3+
description: Learn how to troubleshoot and resolve common problems when using Microsoft Azure Red Hat OpenShift (ARO)
4+
services: container-service
5+
author: tylermsft
6+
ms.author: twhitney
7+
manager: jeconnoc
8+
ms.service: container-service
9+
ms.topic: troubleshooting
10+
ms.date: 05/6/2019
11+
---
12+
13+
# ARO troubleshooting
14+
15+
This article details some common problems encountered while creating or managing Microsoft Azure Red Hat OpenShift (ARO) clusters.
16+
17+
## Retrying the creation of a failed ARO cluster
18+
19+
If creating a cluster using the `az` CLI command fails, retrying creation will always fail.
20+
Use `az openshift delete` to delete the failed cluster. Then create an entirely new cluster.
21+
22+
## Untrusted ARO server certificate
23+
24+
Currently, the OpenShift console certificate is untrusted. When you navigate to the console, manually accept the untrusted certificate from your browser.
25+
26+
## Hidden ARO cluster resource group
27+
28+
Currently, the `Microsoft.ContainerService/openShiftManagedClusters` resource created by the `az` CLI is hidden in the Azure portal. In the `Resource group` view, check `Show hidden types` to view the resource group.
29+
30+
![Hidden Type](./media/aro-portal-hiddentype.png)
31+
32+
## Next steps
33+
34+
View the [Official guide to troubleshooting kubernetes clusters](https://kubernetes.io/docs/tasks/debug-application-cluster/troubleshooting/).
35+
View [Kubernetes troubleshooting](https://github.com/feiskyer/kubernetes-handbook/blob/master/en/troubleshooting/index.md) for troubleshooting pods, nodes, clusters, and other features.
36+
37+
Find answers to [common questions and known issues](openshift-faq.md).
Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
---
2+
title: Tutorial - Create a Red Hat OpenShift cluster on Azure
3+
description: In this tutorial, quickly learn to create a Microsoft Azure Red Hat OpenShift cluster using the Azure CLI
4+
services: container-service
5+
author: TylerMSFT
6+
ms.author: twhitney
7+
manager: jeconnoc
8+
ms.topic: tutorial
9+
ms.service: openshift
10+
ms.date: 5/6/2019
11+
#Customer intent: As a developer, I want learn how to create a Microsoft Azure Red Hat OpenShift cluster, scale it, and then clean up resources so that I am not charged for what I'm not using.
12+
---
13+
14+
# Tutorial: Create a Microsoft Red Hat OpenShift cluster on Azure
15+
16+
This tutorial is part one of a series. You'll learn how to create a Microsoft Red Hat OpenShift cluster on Azure using the Azure CLI, scale it, and clean up unused Azure resources so that you are not charged for what you aren't using.
17+
18+
In part one of the series, you learn how to:
19+
20+
> [!div class="checklist"]
21+
> * Create an Azure Red Hat OpenShift cluster
22+
23+
In this tutorial series you learn how to:
24+
> [!div class="checklist"]
25+
> * Create an Azure Red Hat OpenShift cluster
26+
> * [Scale an Azure Red Hat OpenShift cluster](tutorial-scale-cluster.md)
27+
> * [Delete an Azure Red Hat OpenShift cluster](tutorial-delete-cluster.md)
28+
29+
## Prerequisites
30+
31+
Before you begin this tutorial:
32+
33+
Make sure that you've [set up your development environment](howto-setup-environment.md), which includes:
34+
- Installing the latest CLI
35+
- Creating a tenant
36+
- Creating an Azure Application object
37+
- Creating an Active Directory user used to sign in to apps running on the cluster.
38+
39+
## Step 1: Sign in to Azure
40+
41+
If you're running the Azure CLI locally, run `az login` to sign in to Azure.
42+
43+
```bash
44+
az login
45+
```
46+
47+
If you have access to multiple subscriptions, run `az account set -s
48+
SUBSCRIPTION_ID` to default to the correct subscription.
49+
50+
## Step 2: Create an Azure Red Hat OpenShift cluster
51+
52+
Open a Bash command window and set the following variables:
53+
54+
> [!IMPORTANT]
55+
> The name of your cluster must be all lowercase or cluster creation will fail.
56+
57+
```BASH
58+
CLUSTER_NAME=<the name of your cluster - lowercase only>
59+
```
60+
61+
Use the same name for the cluster that you chose in step 6 of [Create new app registration](howto-aad-app-configuration.md#create-a-new-app-registration).
62+
63+
```BASH
64+
LOCATION=<location>
65+
```
66+
67+
Choose a location to create your cluster, for example:
68+
`LOCATION=eastus`
69+
70+
For a list of azure regions that supports OpenShift on Azure, see [Supported Regions](supported-resources.md#azure-regions).
71+
72+
All being well, after 10-15 minutes `az openshift create` will complete
73+
successfully and return a JSON document containing your cluster details.
74+
75+
Set `FQDN` to the fully qualified name of your cluster. This name is composed of the cluster name, the location, with `.cloudapp.azure.com` appended to the end. For example:
76+
77+
```BASH
78+
FQDN=$CLUSTER_NAME.$LOCATION.cloudapp.azure.com
79+
```
80+
81+
Set `APPID` to the value you saved in step 1 of [Create a client secret](howto-aad-app-configuration.md#create-a-client-secret).
82+
```BASH
83+
APPID=<app ID value>
84+
```
85+
86+
Set `SECRET` to the value you saved in step 7 of [Create a client secret](howto-aad-app-configuration.md#create-a-client-secret).
87+
```BASH
88+
SECRET=<secret value>
89+
```
90+
91+
Set `TENANT` to the value you provided in step 7 of [Create a new tenant](howto-create-tenant.md#create-a-new-tenant)
92+
```BASH
93+
TENANT=<tenant id>
94+
```
95+
96+
Create the resource group for the cluster. Run the following command from the Bash shell that you used to define the variables above:
97+
98+
```BASH
99+
az group create --name $CLUSTER_NAME --location $LOCATION
100+
```
101+
102+
Now create the cluster:
103+
104+
```BASH
105+
az openshift create --resource-group $CLUSTER_NAME --name $CLUSTER_NAME -l $LOCATION --fqdn $FQDN --aad-client-app-id $APPID --aad-client-app-secret $SECRET --aad-tenant-id $TENANT
106+
```
107+
108+
## Step 3: Test your cluster
109+
110+
To test your cluster, you need to use a fresh browser instance. Use a browser instance that hasn't cached the identity that you use to sign in to the Azure portal because you need to sign in as the new user you created earlier.
111+
112+
1. Open an incognito window (Chrome) or a InPrivate windows (Microsoft Edge)
113+
2. Navigate to the sign-on URL that you created in step 6 of [Create new app registration](howto-aad-app-configuration.md#create-a-new-app-registration). For example, https://mycluster.eastus.cloudapp.azure.com
114+
115+
> [!NOTE]
116+
> Currently the OpenShift console certificate is untrusted, therefore
117+
> when navigating to the console, you will need to manually accept the
118+
> untrusted certificate in your browser.
119+
120+
You'll get message that the site isn't secure. Click **Details** > **Go on to the webpage**
121+
122+
Sign in with the user and password that you created in [Create a new Active Directory user](howto-aad-app-configuration.md#create-a-new-active-directory-user)
123+
When the **Permissions requested** dialog appears, select **Consent on behalf of your organization** and then **Accept**.
124+
125+
You should now be logged into the cluster console.
126+
127+
![](./media/aro-console.png)
128+
129+
You now have an Azure Red Hat OpenShift cluster in your tenant.
130+
131+
## Step 4: Try the oc CLI
132+
133+
In the cluster console, click the question mark in the upper right corner and select `Command Line Tools`. Follow the `Latest Release` link to download and install the supported oc CLI for Linux, MacOS, or Windows. If you can't sign in to the Red Hat portal, the oc CLI is also available [here](https://www.okd.io/download.html).
134+
135+
> [!NOTE]
136+
> If you do not see the question mark icon in the upper right corner,
137+
> select Service Catalog or Application Console from the upper left hand drop-down.
138+
139+
The same page also has a command of the form `oc login https://myuniqueclustername.eastus.cloudapp.azure.com --token=<hidden>`. Click the copy to clipboard button to copy this command. Paste it in your terminal to sign in to the cluster using the oc CLI.
140+
141+
Alternatively your token is available here: `https://myuniqueclustername.eastus.cloudapp.azure.com/oauth/token/request`
142+
143+
## Next steps
144+
145+
In this part of the tutorial, you learned how to:
146+
147+
> [!div class="checklist"]
148+
> * Create an Azure Redhat OpenShift cluster
149+
150+
Advance to the next tutorial:
151+
> [!div class="nextstepaction"]
152+
> [Scale an Azure Redhat OpenShift cluster](tutorial-scale-cluster.md)
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Delete an Azure Open Shift cluster | Microsoft Docs
3+
description: In this tutorial, learn how to delete an Azure Red Hat OpenShift cluster using the Azure CLI
4+
services: container-service
5+
author: tylermsft
6+
ms.author: twhitney
7+
manager: jeconnoc
8+
ms.topic: tutorial
9+
ms.service: openshift
10+
ms.date: 5/6/2019
11+
#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.
12+
---
13+
14+
# Tutorial: Delete an Azure Red Hat OpenShift cluster
15+
16+
This is the end of the tutorial. When you are done with the resources you have created, delete your cluster and associated resources so that you are not charged for resources you're no longer using.
17+
18+
In part three of the series, you learn how to:
19+
20+
> [!div class="checklist"]
21+
> * Delete an Azure Red Hat OpenShift cluster
22+
23+
In this tutorial series you learn how to:
24+
> [!div class="checklist"]
25+
> * [Create an Azure Red Hat OpenShift cluster](tutorial-create-cluster.md)
26+
> * [Scale an Azure Red Hat OpenShift cluster](tutorial-scale-cluster.md)
27+
> * Delete an Azure Red Hat OpenShift cluster
28+
29+
## Prerequisites
30+
31+
Before you begin this tutorial:
32+
33+
* Create a cluster by following the [Create an ARO cluster](tutorial-create-cluster.md) tutorial.
34+
35+
## Step 1: Sign in to Azure
36+
37+
If you're running the Azure CLI locally, run `az login` to sign in to Azure.
38+
39+
```bash
40+
az login
41+
```
42+
43+
If you have access to multiple subscriptions, run `az account set -s
44+
SUBSCRIPTION_ID` to default to the correct subscription.
45+
46+
## Step 2: Delete the cluster
47+
48+
Using the CLI command `az openshift delete <cluster name>` to delete the cluster.
49+
50+
## Step 3: Delete resources associated with the cluster
51+
52+
To clean up all resources associated with the cluster, you must delete the resource group that you specified when you created the cluster. Which will also delete all of the other related resources that get created when you build an ARO cluster.
53+
54+
Currently, the `Microsoft.ContainerService/openShiftManagedClusters` resource that is created when you create the cluster is hidden in the Azure portal. In the `Resource group` view, check `Show hidden types` to view the resource group.
55+
56+
![Hidden Type](./media/aro-portal-hiddentype.png)
57+
58+
Or, you can run `az openshift list` to output the resource groups. Note the name of the resource group that you specified when you created the ARO cluster.
59+
60+
Delete the resource group with `az group delete --name <ARO cluster resource group name>` The process will take a few minutes, and at the end the entire Resource Group and all resources inside it will be deleted.
61+
62+
## Next steps
63+
64+
In this part of the tutorial, you learned how to:
65+
> [!div class="checklist"]
66+
> * Delete an ARO cluster
67+
> * Delete the related resources that go with it.
68+
69+
Now that you have completed the tutorial series, learn more about Red Hat Open Shift at [Red Hat OpenShift dedicated documentation](https://access.redhat.com/documentation/openshift_dedicated/3/)
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: Tutorial - Scale a Microsoft Azure Red Hat OpenShift cluster on Azure
3+
description: In this tutorial, learn how to scale a Microsoft Azure Red Hat OpenShift cluster using the Azure CLI
4+
services: container-service
5+
author: tylermsft
6+
ms.author: twhitney
7+
manager: jeconnoc
8+
ms.topic: tutorial
9+
ms.service: copenshift
10+
ms.date: 5/6/2019
11+
#Customer intent: As a developer, I want learn how to create a Microsoft Azure Red Hat OpenShift cluster, scale it, and then clean up resources so that I am not charged for what I'm not using.
12+
---
13+
14+
# Tutorial: Scale a Microsoft Azure Red Hat OpenShift cluster
15+
16+
This tutorial is part two of a series. You'll learn how to create a Microsoft Red Hat OpenShift cluster on Azure using the Azure CLI, scale it, and clean up unused Azure resources so that you are not charged for what you aren't using.
17+
18+
In part two of the series, you learn how to:
19+
20+
> [!div class="checklist"]
21+
> * Scale a Red Hat OpenShift cluster
22+
23+
In this tutorial series you learn how to:
24+
> [!div class="checklist"]
25+
> * [Create an Azure Red Hat OpenShift cluster](tutorial-create-cluster.md)
26+
> * Scale an Azure Red Hat OpenShift cluster
27+
> * [Delete an Azure Red Hat OpenShift cluster](tutorial-delete-cluster.md)
28+
29+
## Prerequisites
30+
31+
Before you begin this tutorial:
32+
33+
* Create a cluster by following the [Create an ARO cluster](tutorial-create-cluster.md) tutorial.
34+
35+
## Step 1: Sign in to Azure
36+
37+
If you're running the Azure CLI locally, run `az login` to sign in to Azure.
38+
39+
```bash
40+
az login
41+
```
42+
43+
If you have access to multiple subscriptions, run `az account set -s
44+
SUBSCRIPTION_ID` to default to the correct subscription.
45+
46+
## Step 2: Navigate to the OpenShift on Azure cluster console
47+
48+
After `az openshift create` has completed, open your browser and navigate to https://$FQDN/, for example, https://myuniqueclustername.eastus.cloudapp.azure.com/.
49+
50+
> [!NOTE]
51+
> Currently, the OpenShift console certificate is untrusted, therefore when navigating to the console, you will need to manually
52+
> accept the untrusted certificate in your browser.
53+
54+
To sign in to the cluster, click on `Azure AD`.
55+
56+
![](./media/aro-auth.png)
57+
58+
The cluster console appears:
59+
60+
![](./media/aro-console.png)
61+
62+
## Step 3: Use the oc CLI
63+
64+
In the cluster console, click the question mark in the upper right corner and select `Command Line Tools`. Follow the `Latest Release` link to download and
65+
install the supported oc CLI for Linux, MacOS, or Windows. If you can't sign in to the Red Hat portal, the oc CLI is also available [here](https://www.okd.io/download.html).
66+
67+
> [!NOTE]
68+
> If you do not see the question mark icon in the upper right corner, select **Service Catalog** or **Application Console**
69+
> from the upper left hand drop-down.
70+
71+
The same page also has a command of the form `oc login https://myuniqueclustername.eastus.cloudapp.azure.com --token=<hidden>`. Click
72+
the copy to clipboard button to copy this command. Paste it in your terminal to sign in to the cluster using the oc CLI.
73+
74+
You can also find your token here: `https://myuniqueclustername.eastus.cloudapp.azure.com/oauth/token/request`
75+
76+
## Step 4: Scale up to 5 compute nodes
77+
78+
From the Azure CLI, run:
79+
80+
```bash
81+
az openshift scale --resource-group $CLUSTER_NAME --name $CLUSTER_NAME --compute-count 5
82+
```
83+
84+
All being well, after a few minutes `az openshift create` will complete successfully and return a JSON document containing your cluster details.
85+
86+
In this part of the tutorial, you learned how to:
87+
88+
> [!div class="checklist"]
89+
> * Scale an Azure Redhat OpenShift cluster
90+
91+
Advance to the next tutorial:
92+
> [!div class="nextstepaction"]
93+
> [Delete an Azure Redhat OpenShift cluster](tutorial-delete-cluster.md)

‎bread/toc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,9 @@
342342
- name: AKS
343343
tocHref: /azure/aks/
344344
topicHref: /azure/aks/
345+
- name: Openshift
346+
tocHref: /azure/openshift/
347+
topicHref: /azure/openshift/
345348
- name: Container Service
346349
tocHref: /azure/container-service/
347350
topicHref: /azure/container-service/

0 commit comments

Comments
 (0)
Please sign in to comment.