Skip to main content
Version: v1.0.67.0

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

  1. Log into RedHat Openshift via the UI.

  2. Create a secret to store DX_PASSKEY, DX_LICENSE, and MSSQL_SA_PASSWORD.

    1. In the menu, select Workloads > Secrets.

    2. Select Create.

    3. Select the key/value secret option.

    4. Name the secret dxe.

    5. 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.

    6. Select Add.

    7. Enter a key name as DX_LICENSE with the value of your DxEnterprise license.

    8. Select Add.

    9. Enter a key name as MSSQL_SA_PASSWORD with the value of a strong SA password.

      caution

      Your password must meet SQL Server password requirements, or the container deployment will fail. See the SQL Server Password Policy for more details.

    10. Select Create.

  3. In the left-hand menu, select OperatorHub.

  4. Search for DxOperator.

  5. Install DxOperator.

  6. Deploy a new SQL Server AG cluster by creating a DxEnterpriseSqlAg.

    1. Navigate to Operators > Installed Operators > DxOperator

    2. Click on the Create DxEnterpriseSqlAg tab.

    3. Click on Create DxEnterpriseSQLAg button.

    4. Enter a name for the deployment.

    5. Select the number of Synchronous Replicas, Asynchronous Replicas, and Configuration Only Replicas.

    6. Under the template dropdown, open the spec dropdown. For each dropdown down the following:

      1. DxEnterprise Container:
        1. Select the secret dxe.
        2. Accept the EULA
        3. If joining an existing cluster, checkmark “joinExistingCluster”
        4. Set VHOST name
        5. If joining another cluster, set the target in “joinTarget”
      2. mssqlServerContainer
        1. set the SQL Server Secret dxe
        2. Select the Product ID or a license key
        3. Accept the EULA
    7. Set the availability group name.

    8. Select Create.

    9. Wait for the installation to complete before proceeding.

  7. Verify your cluster was successfully created.

    1. In the menu, select Installed Operators > DxOperator.
    2. Click on the tab referencing the name created above and then select dxesqlag.
    3. Click on the resources tab and verify the pods and load balances were created