IBM Cloud Docs
Onboarding your Operator bundle

Onboarding your Operator bundle

This tutorial walks you through how to onboard a Certified Operator bundle from a Red Hat registry. By completing this tutorial, you learn how to import the Red Hat OpenShift on IBM Cloud Operator bundle, configure a deployment, license, and other details, and validate that the Operator bundle can be installed on a cluster.

This tutorial is one of four in a series that demonstrates how to onboard and publish a sample Operator bundle from the Red Hat OpenShift on IBM Cloud Certified registry. It uses a fictitious company called Example Corp. As you complete the tutorial, adapt each step to fit your product's needs.

Before you begin

  1. Go to Red Hat OperatorHub to confirm that your Operator bundle exists in the Red Hat Certified registry.
  2. Create your Red Hat OpenShift on IBM Cloud cluster.
  3. Upload your Operator bundle and application images to IBM Cloud Container Registry.
  4. Verify that you're assigned the correct roles. For more information, see Assigning access to account management services and Managing access to resources.
    • Administrator on all account management services and all IAM services
    • Editor on the catalog management service
    • Editor on the IBM Cloud Container Registry service
    • Administrator on the Red Hat OpenShift on IBM Cloud cluster
    • Editor on the software instance service

Make sure that you use the same account to access IBM Cloud Container Registry and to create the Red Hat OpenShift on IBM Cloud cluster.

Import your Operator bundle

  1. In the IBM Cloud console, click the Navigation Menu icon Navigation Menu icon > Partner Center > My products.
  2. Select the product that you're onboarding.
  3. From the Software page, click Import a version.
  4. Select Operator from Red Hat registry as your deployment method.
  5. Select Certified as your Red Hat repository.
  6. Select your Operator bundle. For example, for the purposes of this tutorial, you can select Akka Cluster Operator as your Operator.
  7. Select the Operator bundle version that you want to import.
  8. Enter the software version that the Operator bundle installs in the format of major version, minor version, and revision. For example, you can use Operator version 1.1.0 to install software version 3.1.1.
  9. Review the summary of your Operator bundle.
  10. Click Add version.

Review your version details

From the Configure version tab, you can review your version details. After you review your version details, click Next.

Set the license requirements

If users are required to accept any license agreements beyond the IBM Cloud Services Agreement, provide the URL to each agreement.

  1. From the Add license agreements tab, click Add license.
  2. Enter the name and URL, and click Add license.
  3. Enter all additional license agreements, and click Next.

Review your readme file

When users install the software, they can view product information by clicking the Readme link. The information in the Readme link is generated from the readme file that you uploaded to your source repository.

  1. From the Edit readme tab, click the Edit icon Edit icon.
  2. Preview how the information in the readme file is displayed to users when they install the Operator bundle.
  3. To make changes, edit the information in the source file and import the updated Operator bundle to your private catalog.
  4. Click Save.
  5. Click Next.

Validate the software version

Before you can publish the Operator bundle, you need to validate it to make sure that the version can be deployed to the intended target.

  1. From the Validate product tab, select the Update channel that you would like to receive updates from.

  2. Select whether you want to apply updates automatically or manually.

  3. Select a Red Hat OpenShift on IBM Cloud cluster.

  4. Select a project.

  5. Click Next.

  6. Confirm or edit your workspace name.

  7. Select a resource group.

  8. Select a Schematics region.

  9. Enter tags for your workspace. Tags provide a way to organize, track usage costs, and manage access to the resources in your account.

  10. Click Next

  11. Click Validate.

Manage compliance

You can add profiles and controls to your software to prove that it meets security and compliance requirements. You must use Security and Compliance Center to scan the resources created during validation.

Only profiles and controls that are supported by the Security and Compliance Center and validated by Security and Compliance Center scans appear in the catalog.

Run a Security and Compliance Center scan

When you claim profiles and controls, you must evaluate the resources that were created during validation to ensure compliance. To run a scan, complete the following steps:

  1. In the IBM Cloud console, click the Menu icon Menu icon > Security and Compliance to access Security and Compliance Center.
  2. In the navigation, click Profile.
  3. Click the Overflow menu in the row of the profile that you want to evaluate and select Run scan.
  4. Click Run scan.

After your scan completes, you can return to your private catalog to continue the onboarding process.

Adding compliance controls

Add the profiles and controls that you want to claim.

  1. In the Manage compliance section of your product, select Add claims.
  2. Select the profile that you want to add.
  3. Choose to add the entire profile or a subset of controls.
  4. If you choose an entire profile, continue to the next step. If you choose to add a subset of controls, select the controls that you want to add.
  5. Click Add.

Applying Security and Compliance Center scans

Add the scans that you previously ran in the Security and Compliance Center. Security and Compliance Center scans determine adherence to regulatory controls. For more information, see Running a scan on demand.

  1. Click Add scan.
  2. Select the profile that you used for the evaluation.
  3. Select the Security and Compliance Center scan.
  4. Click Apply scan.
  5. Click Next.

Review requirements

You must complete validation and any other requirements to publish your bundle.

Next steps

Go to Partner Center and submit your request to publish your Operator bundle to the IBM Cloud catalog.