Digital Developer Conference: Hybrid Cloud. On Sep 22 & 24, start your journey to OpenShift certification. Free registration

Get started using a CockroachDB operator hosted on Red Hat Marketplace

Red Hat® OpenShift® 4 users can access certified software for container-based environments via the Red Hat Marketplace. Software in the marketplace is immediately available to deploy on any Red Hat OpenShift cluster in a fast, integrated way. In this tutorial, we show you how to get up and running with CockroachDB hosted on Red Hat Marketplace. CockroachDB is an elastic SQL database that easily scales transactions for your apps and services.

Prerequisites

  • Red Hat OpenShift version 4.3 is required to use with software in Red Hat Marketplace. You can set up a class cluster on IBM Cloud using these instructions: Set up an OpenShift Cluster.
  • Create an account on Red Hat Marketplace.

Steps

To get up and running with CockroachDB hosted on Red Hat Marketplace you will:

  1. Configure a Red Hat OpenShift cluster with Red Hat Marketplace
  2. Connect to the OpenShift Cluster in your CLI
  3. Deploy a CockroachDB Operator on an OpenShift cluster
  4. Create a database instance

1. Configure a Red Hat OpenShift cluster with Red Hat Marketplace

To configure a Red Hat OpenShift cluster with Red Hat Marketplace, you need to download the OpenShift CLI binary, register the cluster on Red Hat Marketplace, and create a project in the Red Hat Marketplace console.

Download an OpenShift command line interface (CLI) binary

To launch the cluster console — also called Red Hat OpenShift Container Platform — follow these steps:

  1. Log in to your IBM Cloud account and navigate to the dashboard.

    Find the Red Hat Marketplace dashboard in IBM Cloud

  2. Click Clusters and select the cluster you created in the prerequisites. In this case, the cluster name is cp-rhm-poc.

    Select your OpenShift cluster

  3. After you launch the cluster, click the OpenShift web console button on the top right-hand side of your screen.

    Click on the OpenShift web console icon

  4. From the Red Hat OpenShift Container Platform web console, select the question mark icon on the top right-hand side and select Command Line Tools.

    Select the Command Line Tools icon

  5. Navigate to the section oc - OpenShift Command Line Interface (CLI) and download the respective oc binary onto your local system.

    Note: You need this binary to manage OpenShift projects from a terminal and to natively support OpenShift Container Platform features.

    download the oc binary

Now you are ready to register the OpenShift cluster on Red Hat Marketplace. This step is mandatory to install any operators from Red Hat Marketplace platform using the OpenShift cluster.

Register the cluster on Red Hat Marketplace

  1. Log in to the Red Hat Marketplace. Select a workspace and click Clusters. You need to add the new OpenShift cluster and register it on the Red Hat Marketplace platform.

    Add OpenShift cluster

  2. Update the cluster name, follow prompts to generate a pull secret, and save it.

    Updated the cluster names

  3. In the GUI, copy the curl command which starts with curl -sL https and append the pull secret towards the end. Keep the entire script handy to use in the next step.

  4. You need to start the cluster first to register it. Open a terminal and type oc login, update the username and password which are used for accessing the cluster, and press Enter.

    Start your cluster

  5. Your cluster should be up and running at this point. You need to run the entire script from the previous step and hit Enter. It will take a couple of minutes to see that you have successfully registered the cluster on the Red Hat Marketplace portal. In the Status column, you should see the word “Registered” beside a green circle.

    Success message

Create a project in the Red Hat Marketplace web console

To create a project that you can use and manage from the command line, go to the Red Hat Marketplace web console and click Create Project. Name the project: Cockroachdb-test-project.

Name your project

2. Connect to the OpenShift cluster in your CLI

  1. Log in to the Red Hat OpenShift on IBM Cloud Kubernetes Service cluster through your CLI. To log in, you need a token which can be generated after you log in to OpenShift Cluster web console. Click the drop-down under your name in the right corner of your screen and select Copy Login Command.

    log in to the Red Hat OpenShift on IBM Cloud

  2. A new window will open requesting the login token details. Copy the login token.

    Copy the login token

  3. In your terminal, paste the login token. Once you log in, you should see a screen that has information about your login name, your server, the token, and the projects.

3. Deploy a CockroachDB Operator on an OpenShift cluster

Now that you have your clusters set up, the following steps show you how to deploy a CockroachDB operator on an OpenShift cluster.

  1. Go to the Red Hat Marketplace catalog and search for CockroachDB. Select CockroachDB from the results.

  2. The CockroachDB product page gives you an overview, documentation, and pricing options associated with the product. Select the Free Trial button.

    rhm-freetrial

  3. Next, the purchase summary will show the Subscription term, with a total cost of $0.00. Click Start trial.

    rhm-starttrial

    You can visit Workspace > My Software to view your list of purchased software.

  4. In the Red Hat Marketplace dashboard, select the CockroachDB tile, and then click the Operators tab. Select the Install Operator button. Leave the default selection for Update channel and Approval strategy. Select the cluster and namespace scope as cockroachdb-test for the operator and click Install.

    Install the operator

  5. You should see a message that indicates the install process initiated in the cluster.

4. Create a database instance

  1. Log in to your OpenShift cluster. From the left navigation, click Operators and select Installed Operators to confirm the installation was successful. You should see the CockroachDB operator listed under the cockroachdb-test project.

    CockroachDB listed under cockraocdb-test

  2. On the CockroachDB operator screen, look under Provided APIs and click on Create Instance.

    Create an API instance

  3. The Create Cockroachdb page displays with the default YAML. Do not edit anything in the YAML file; just click the Create button.

    Yaml file

    CockroachDB pods should come up when the database installation is completed.

  4. Run the following command in your terminal to check the status:

     $ oc project cockroachdb-test
    

    You should get a result similar to the following:

     Now using project "cockroachdb-test" on server "https://c107-e.us-south.containers.cloud.ibm.com:32137".
    
  5. At this point, the database pods are deployed, up, and running. To check the pods, run the following command:

     $ kubectl get pods
    
     NAME                                               READY   STATUS      RESTARTS   AGE
     cockroachdb-6867d47bc5-l44zs                       1/1     Running     0          12d
     example-cockroachdb-0                              1/1     Running     3          3d21h
     example-cockroachdb-1                              1/1     Running     1          12d
     example-cockroachdb-2                              1/1     Running     3          12d
     example-cockroachdb-init-nzvx8                     0/1     Completed   0          12d
    

Summary

This tutorial shows you how to configure a Red Hat OpenShift cluster with Red Hat Marketplace, connect it in your CLI, and deploy and create CockroachDB database instance on OpenShift cluster.