Chapter 3. Deploying OpenShift Data Foundation on Azure Red Hat OpenShift
The Azure Red Hat OpenShift service enables you to deploy fully managed OpenShift clusters. Red Hat OpenShift Data Foundation can be deployed on Azure Red Hat OpenShift service.
OpenShift Data Foundation on Azure Red Hat OpenShift is not a managed service offering. Red Hat OpenShift Data Foundation subscriptions are required to have the installation supported by the Red Hat support team. Open support cases by choosing the product as Red Hat OpenShift Data Foundation with the Red Hat support team (and not Microsoft) if you need any assistance for Red Hat OpenShift Data Foundation on Azure Red Hat OpenShift.
To install OpenShift Data Foundation on Azure Red Hat OpenShift, follow sections:
- Getting a Red Hat pull secret for new deployment of Azure Red Hat OpenShift.
- Preparing a Red Hat pull secret for existing Azure Red Hat OpenShift clusters.
- Adding the pull secret to the cluster.
- Validating your Red Hat pull secret is working.
- Install the Red Hat OpenShift Data Foundation Operator.
- Create the OpenShift Data Foundation Cluster Service.
3.1. Getting a Red Hat pull secret for new deployment of Azure Red Hat OpenShift
A Red Hat pull secret enables the cluster to access Red Hat container registries along with additional content.
- A Red Hat portal account.
- OpenShift Data Foundation subscription.
To get a Red Hat pull secret for a new deployment of Azure Red Hat OpenShift, follow the steps in the section Get a Red Hat pull secret in the official Microsoft Azure documentation.
Note that while creating the Azure Red Hat OpenShift cluster, you may need larger worker nodes, controlled by --worker-vm-size or more worker nodes, controlled by --worker-count. The recommended worker-vm-size is Standard_D16s_v3. You can also use dedicated worker nodes, for more information, see How to use dedicated worker nodes for Red Hat OpenShift Data Foundation in the Managing and allocating storage resources guide.
3.2. Preparing a Red Hat pull secret for existing Azure Red Hat OpenShift clusters
When you create an Azure Red Hat OpenShift cluster without adding a Red Hat pull secret, a pull secret is still created on the cluster automatically. However, this pull secret is not fully populated.
Use this section to update the automatically created pull secret with the additional values from the Red Hat pull secret.
- Existing Azure Red Hat OpenShift cluster without a Red Hat pull secret.
To prepare a Red Hat pull secret for existing an existing Azure Red Hat OpenShift clusters, follow the steps in the section Prepare your pull secret in the official Mircosoft Azure documentation.
3.3. Adding the pull secret to the cluster
- A Red Hat pull secret.
Run the following command to update your pull secret.Note
Running this command causes the cluster nodes to restart one by one as they are updated.
oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=./pull-secret.json
After the secret is set, you can enable the Red Hat Certified Operators.
3.3.1. Modifying the configuration files to enable Red Hat operators
To modify the configuration files to enable Red Hat operators, follow the steps in the section Modify the configuration files in the official Microsoft Azure documentation.
3.4. Validating your Red Hat pull secret is working
After you add the pull secret and modify the configuration files, the cluster can take several minutes to get updated.
To check if the cluster has been updated, run the following command to show the Certified Operators and Red Hat Operators sources available:
$ oc get catalogsource -A NAMESPACE NAME DISPLAY openshift-marketplace redhat-operators Red Hat Operators TYPE PUBLISHER AGE grpc Red Hat 11s
If you do not see the Red Hat Operators, wait a few minutes and try again.
To ensure that your pull secret has been updated and is working correctly, open Operator Hub and check for any Red Hat verified Operator. For example, check if the OpenShift Data Foundation Operator is available, and see if you have permissions to install it.
3.5. Installing Red Hat OpenShift Data Foundation Operator
You can install Red Hat OpenShift Data Foundation Operator using the Red Hat OpenShift Container Platform Operator Hub.
Access to an OpenShift Container Platform cluster using an account with
cluster-adminand Operator installation permissions.
- You must have at least three worker nodes in the Red Hat OpenShift Container Platform cluster.
- For additional resource requirements, see the Planning your deployment guide.
When you need to override the cluster-wide default node selector for OpenShift Data Foundation, you can use the following command in the command line interface to specify a blank node selector for the
openshift-storagenamespace (create openshift-storage namespace in this case):
$ oc annotate namespace openshift-storage openshift.io/node-selector=
Taint a node as
infrato ensure only Red Hat OpenShift Data Foundation resources are scheduled on that node. This helps you save on subscription costs. For more information, see How to use dedicated worker nodes for Red Hat OpenShift Data Foundation chapter in the Managing and Allocating Storage Resources guide.
- Log in to the OpenShift Web Console.
- Click Operators → OperatorHub.
Scroll or type
OpenShift Data Foundationinto the Filter by keyword box to find the OpenShift Data Foundation Operator.
- Click Install.
Set the following options on the Install Operator page:
- Update Channel as stable-4.9.
- Installation Mode as A specific namespace on the cluster.
Installed Namespace as Operator recommended namespace openshift-storage. If Namespace
openshift-storagedoes not exist, it is created during the operator installation.
Select Approval Strategy as Automatic or Manual.
If you select Automatic updates, then the Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without any intervention.
If you select Manual updates, then the OLM creates an update request. As a cluster administrator, you must then manually approve that update request to update the Operator to a newer version.
- Ensure that the Enable option is selected for the Console plugin.
- Click Install.
We recommend using all default settings. Changing it may result in unexpected behavior. Alter only if you are aware of its result.
- Verify that the OpenShift Data Foundation Operator shows a green tick indicating successful installation.
After the operator is successfully installed, a pop-up with a message,
Web console update is availableappears on the user interface. Click Refresh web console from this pop-up for the console changes to reflect.
- In the Web Console, navigate to Operators and verify if OpenShift Data Foundation is available.
In case the console plugin option was not automatically enabled after you installed the OpenShift Data Foundation Operator, you need to enable it.
For more information on how to enable the console plugin, see Enabling the Red Hat OpenShift Data Foundation console plugin.
3.6. Creating an OpenShift Data Foundation cluster
Create an OpenShift Data Foundation cluster after you install the OpenShift Data Foundation operator.
- The OpenShift Data Foundation operator must be installed from the Operator Hub. For more information, see Installing OpenShift Data Foundation Operator using the Operator Hub.
In the OpenShift Web Console, click Operators → Installed Operators to view all the installed operators.
Ensure that the Project selected is
- Click on the OpenShift Data Foundation operator, and then click Create StorageSystem.
In the Backing storage page, select the following:
- Select the Use an existing StorageClass option.
Select the Storage Class.
By default, it is set to
Expand Advanced and select
Full Deploymentfor the Deployment type option.
- Click Next.
In the Capacity and nodes page, provide the necessary information:
Select a value for Requested Capacity from the dropdown list. It is set to
2 TiBby default.Note
Once you select the initial storage capacity, cluster expansion is performed only using the selected usable capacity (three times of raw storage).
In the Select Nodes section, select at least three available nodes.
For cloud platforms with multiple availability zones, ensure that the Nodes are spread across different Locations/availability zones.
If the nodes selected do not match the OpenShift Data Foundation cluster requirement of an aggregated 30 CPUs and 72 GiB of RAM, a minimal cluster is deployed. For minimum starting node requirements, see the Resource requirements section in the Planning guide.
- Click Next.
Optional: In the Security and network page, configure the following based on your requirements:
- To enable encryption, select Enable data encryption for block and file storage.
Choose either one or both the encryption levels:
Encrypts the entire cluster (block and file).
Creates encrypted persistent volume (block only) using encryption enabled storage class.
Select the Connect to an external key management service checkbox. This is optional for cluster-wide encryption.
Key Management Service Provider is set to
- Enter Vault Service Name, host Address of Vault server ('https://<hostname or ip>'), Port number and Token.
Expand Advanced Settings to enter additional settings and certificate details based on your
- Enter the Key Value secret path in Backend Path that is dedicated and unique to OpenShift Data Foundation.
- Optional: Enter TLS Server Name and Vault Enterprise Namespace.
- Upload the respective PEM encoded certificate file to provide the CA Certificate, Client Certificate and Client Private Key .
- Click Save.
- Key Management Service Provider is set to
- Click Next.
In the Review and create page, review the configuration details.
To modify any configuration settings, click Back.
- Click Create StorageSystem.
To verify the final Status of the installed storage cluster:
- In the OpenShift Web Console, navigate to Installed Operators → OpenShift Data Foundation → Storage System → ocs-storagecluster-storagesystem → Resources.
Readyand has a green tick mark next to it.
- To verify that all components for OpenShift Data Foundation are successfully installed, see Verifying your OpenShift Data Foundation deployment.
To enable Overprovision Control alerts, refer to Alerts in Monitoring guide.