Steps to Deploy CockroachDB Operator from Red Hat Marketplace on OpenShift Cluster
abstract: # REQUIRED
authors:
completed_date: 2020-01-20
components:
draft: true|false # REQUIRED
excerpt: # REQUIRED
keywords: # REQUIRED - comma separated list
last_updated: # REQUIRED - Note: date format is YYYY-MM-DD
primary_tag: “databases”
pta: # REQUIRED - Note: can be only one
pwg: # REQUIRED - Note: can be one or many
related_content: # OPTIONAL - Note: zero or more related content
related_links: # OPTIONAL - Note: zero or more related links
runtimes: # OPTIONAL - Note: Select runtimes from the complete set of runtimes below. Do not create new runtimes. Only use runtimes specifically in use by your content.
services: # OPTIONAL - Note: please select services from the complete set of services below. Do not create new services. Only use services specifically in use by your content.
subtitle: # REQUIRED
tags:
title: Get started using a CockroachDB operator hosted on Red Hat Marketplace
meta_title: Deploy a CockroachDB operator to an OpenShift cluster
subtitle: Deploy a Cockraoch DB operator to an OpenShift cluster
translators: # OPTIONAL - Note: can be one or more
type: 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.
To get up and running with CockroachDB hosted on Red Hat Marketplace you will:
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.
To launch the cluster console — also called Red Hat OpenShift Container Platform — follow these steps:
Log in to your IBM Cloud Account and navigate to the dashboard.
Click Clusters and select the cluster you created in the prerequisites. In this case, the cluster name is cp-rhm-poc
.
After you launch the cluster, click on OpenShift web console on the top right-hand side of your screen.
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.
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.
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.
Update the cluster name, follow prompts to generate a pull secret, and save it.
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.
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.
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
.
copy the path
as shown.Now that you have your clusters set up, the following steps show you how to dpeploy a CockroachDB operator on an OpenShift cluster.
Go to the Red Hat Marketplace catalog and search for CockroachDB. Select CockroachDB
from the results.
The CockroachDB product page gives you an overview, documentation, and pricing options associated with the product. Select the Free Trial
button.
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.
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.
You should see a message that indicates the install process initiated in the cluster.
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.
On the CockroachDB operator screen, look under Provided APIs and click on Create Instance.
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.
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".
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