abstract	authors	completed_date	components	draft	excerpt	keywords	last_updated	primary_tag	pta	pwg	related_content	related_links	runtimes	services	subtitle	tags	title	meta_title	translators	type
	name email Manoj Jahgirdar manoj.jahgirdar@in.ibm.com name email Rahul Reddy Ravipally raravi86@in.ibm.com name email Srikanth Manne srikanth.manne@in.ibm.com name email Manjula G. Hosurmath mhosurma@in.ibm.com	2020-01-20	slug name url type cockroachdb CockroachDB https://marketplace.redhat.com/en-us/products/cockroachdb-operator component slug name url type redhat-marketplace Red Hat Marketplace https://marketplace.redhat.com/ component	true|false				databases			type slug announcements|articles|blogs|patterns|series|tutorials|videos	title url description			Deploy a Cockraoch DB operator to an OpenShift cluster		Get started using a CockroachDB operator hosted on Red Hat Marketplace	Deploy a CockroachDB operator to an OpenShift cluster	name email	tutorial

Red Hat® OpenShift® 4 users can use Red Hat Marketplace to access certified software for container-based environments. Software in the marketplace is immediately available to deploy on any Red Hat OpenShift cluster, in a fast, integrated way. In this tutorial, in this tutorial, we show you how to get up 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 requried to use with the software in Red Hat Markeplace. You can set up a class cluster on IBM Cloud using these instructions: Set up 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 by:
   • Downloading an OpenShift command line interface (CLI) binary
   • Registering the cluster on Red Hat Marketplace
   • Creating a project in the Red Hat Marketplace web console
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.

   

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

   

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

   

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.

   

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.

   

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 Cluster. You need to add the new OpenShift cluster and register it on the Red Hat Marketplace platform.

   

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

   

3. In the GUI, copy the curl command which starts with curl -sL https and append the pull secret towards the end. The entire script should be handy to be used in 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. Press Enter.

   

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

  

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.

2. Connect to the Openshift Cluster in your CLI

1. Log in to the Red Hat OpenShift Kubernetes Service (ROKS) (IBM Managed) cluster through your CLI. To log in, you need a token which can be genrated after you log in to OpenShift Cluster web console. Click on the IAM Username on top left corner and copy the path as shown.

1. A new window will open requesting the login token details. Click on display token and copy the first login token as shown.

1. In your terminal, paste the login command. Once you login, 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 dpeploy 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.

   

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

   

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

4. In the Red Hat Marketplace dashbaord, 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.

   

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.

   

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

   

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

   

   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