DxOperator OpenShift Quick-Start Guide
This guide walks you through deploying the DxOperator on Red Hat OpenShift. By following the steps, you will:
- Provision a DxEnterprise cluster directly from the OpenShift web console.
- Create a SQL Server Availability Group (AG) within that cluster.
Prerequisites
- A Red Hat OpenShift cluster with access to OperatorHub.
- A valid DxEnterprise license with availability group management features and tunnels enabled. A fully featured Developer Edition is available free for non-production use. To purchase DxEnterprise software for production workloads, visit the DH2i Store.
Install DxEnterprise using the OpenShift Operator bundle
-
Log into RedHat Openshift via the UI.
-
Create a secret to store DX_PASSKEY, DX_LICENSE, and MSSQL_SA_PASSWORD.
-
In the menu, select Workloads > Secrets.
-
Select Create.
-
Select the key/value secret option.
-
Name the secret dxe.
-
Enter a key name as DX_PASSKEY with the value of your DxEnterprise cluster passkey. This value will be set as the cluster passkey for the DxEnterprise component to be deployed.
-
Select Add.
-
Enter a key name as DX_LICENSE with the value of your DxEnterprise license.
-
Select Add.
-
Enter a key name as MSSQL_SA_PASSWORD with the value of a strong SA password.
cautionYour password must meet SQL Server password requirements, or the container deployment will fail. See the SQL Server Password Policy for more details.
-
Select Create.
-
-
In the left-hand menu, select OperatorHub.
-
Search for DxOperator.
-
Install DxOperator.
-
Deploy a new SQL Server AG cluster by creating a DxEnterpriseSqlAg.
-
Navigate to Operators > Installed Operators > DxOperator
-
Click on the Create DxEnterpriseSqlAg tab.
-
Click on Create DxEnterpriseSQLAg button.
-
Enter a name for the deployment.
-
Select the number of Synchronous Replicas, Asynchronous Replicas, and Configuration Only Replicas.
-
Under the template dropdown, open the spec dropdown. For each dropdown down the following:
- DxEnterprise Container:
- Select the secret dxe.
- Accept the EULA
- If joining an existing cluster, checkmark “joinExistingCluster”
- Set VHOST name
- If joining another cluster, set the target in “joinTarget”
- mssqlServerContainer
- set the SQL Server Secret dxe
- Select the Product ID or a license key
- Accept the EULA
- DxEnterprise Container:
-
Set the availability group name.
-
Select Create.
-
Wait for the installation to complete before proceeding.
-
-
Verify your cluster was successfully created.
- In the menu, select Installed Operators > DxOperator.
- Click on the tab referencing the name created above and then select dxesqlag.
- Click on the resources tab and verify the pods and load balances were created