Chapter 20. Adding certification components
After creating the new product listing, add the certification components for the newly created product listing.
You can configure the following options for the newly added components:
The component configurations differ for different product categories.
- Section 20.1, “Certification for Operators”
- Section 20.2, “Optional Qualifications for Operators”
- Section 20.3, “Repository Information for Operators”
- Section 20.4, “Component details for Operators”
- Section 20.5, “Contact Information for Operators”
- Section 20.6, “Associated products for Operators”
- Section 20.7, “Update Graph”
To configure the options, go to the Components tab and click on any of the existing components.
20.1. Certification for Operators
Validate the functionality of your CNI or CSI on Red Hat OpenShift
NoteThis feature is applicable for CNI and CSI operators only.
This feature allows you to run the certification test locally and share the test results with the Red Hat certification team.
To validate the functionality of your specialized CNI or CSI operator:
- Click Go to Red Hat certification tool. A new certification case gets created on the Red Hat Certification portal after which you are redirected to the appropriate portal page.
- On the Summary tab, navigate to the Files section and click Upload, to upload your test results.
Add any relevant comments in the Discussions section, and then click Add Comment.
Red Hat will review the results file you submitted and validate your specialized CNI or CSI operator. Upon successful validation, your operator will get approved and published.
Operator Certification
To run the Operator certification suite, go to Testing Options. It displays two tabs to determine how to test and certify your operator.
- Test locally with OpenShift Use the OpenShift cluster of your choice for testing and certification. This option allows you to integrate the provided pipeline to your own workflows for continuous verification and access to comprehensive logs for a faster feedback loop. This is the recommended approach. For more information, see Running the certification test suite locally.
Test with Red Hat’s hosted pipeline This approach is separate from your OpenShift software testing from certification. After you have tested your operator on the version of OpenShift you wish to certify, you can use this approach if you don’t want the comprehensive logs, or are not ready to include it in your own workflows. For more information, see Running the certification suite with the Red Hat hosted pipeline.
Comparing certification testing options
In the long term, Red Hat recommends using the "local testing" option, also referred to as the CI Pipeline, for testing your Operator. This method allows you to incorporate the tests into your CI/CD workflows and development processes, therefore ensuring the proper functioning of your product on the OpenShift platform and streamlining future updates and recertifications for the Operator.
Although initially learning about the method and debugging errors may take some time, it is an advanced method and provides the best and quickest feedback. On the other hand, Red Hat recommends using the hosted pipeline, running on the Red Hat infrastructure option for several use cases , such as when working on an urgent deadline, or when enough resources and time are not available to learn and use the tooling.
You can use the hosted pipeline simultaneously with the CI/local pipeline as you learn to incorporate the local tooling long term.
Most recent test run tab provides the latest test results, if any.
The certification table provides the following information:
- Operator version
- Pull request
- Tested on
- Test result - Pass or Fail
- Created
Click View all tests for detailed information about all the tests. It has two tabs:
- Test Results - Displays a summary of all the certification tests along with their results.
- Test Artifacts - Displays log files.
20.2. Optional Qualifications for Operators
This tab is applicable only for Operator, Helm and OpenShift container images.
The Optional qualifications tab provides tests to check if your attached product component follows Red Hat’s recommended guidelines and best practices for deploying your product on Red Hat OpenShift clusters.
To test your product,
- Click Start Testing.
- Click Go to Red Hat certification tool to reach the Red Hat Partner Certification (rhcert) portal.
In the Red Hat Partner Certification (rhcert) portal, go to the Summary tab.
- To submit your test results, from the Files section click Upload. A successful upload message is displayed.
- Add your queries related to certification, if any, in the Discussions text box.
- Click Add Comment. By using this option, you can communicate your questions to the Red Hat certification team. The Red Hat certification team will provide clarifications for your queries.
When your testing is complete and to make any changes to the test, click Review.
The test results are published for your reference.
20.3. Repository Information for Operators
You can configure the registry and repository details by using the Repository information tab.
Enter the required details in the following fields:
| Field name | Description |
|---|---|
| Container registry namespace | Registry name set when the container was created. This field becomes non-editable when the container gets published. |
| Outbound repository name | Repository name that you have selected or the name obtained from your private registry in which your image is hosted, for example, ubi-minimal. |
| Authorized GitHub user accounts | It denotes the GitHub users who are allowed to submit operators for certification on behalf of your company. |
| OpenShift Object YAML | Use this option to add a docker config.json secret, if you are using a private container registry. |
| Repository summary | Repository summary obtained from the container image. |
| Repository description | Repository description obtained from the container image. |
After configuring all the mandatory fields click Save.
All the fields marked with an asterisk * are required and must be completed before you can proceed with container certification.
20.4. Component details for Operators
Configure the product component details by using this tab.
Enter the required details in the following fields:
| Field name | Description |
|---|---|
| Image Type | Operator bundle is selected by default. |
| Application categories | Select the respective application type of your software product. |
| Project name | Name of the project for internal purposes. |
After configuring all the mandatory fields click Save.
20.5. Contact Information for Operators
Providing information for this tab is optional.
In the Contact Information tab, enter the primary technical contact details of your product component.
- Optional: In the Technical contact email address field, enter the email address of the image maintainer.
- Optional: To add additional contacts for your component, click + Add new contact.
- Click Save.
20.6. Associated products for Operators
The Associated Product tab provides the list of products that are associated with your product component along with the following information:
- Product Name
- Type
- Visibility - Published or Not Published
- Last Activity - number of days before you ran the test
To add products to your component, perform the following:
- If you want to find a product by its name, enter the product name in the Search by name text box and click the search icon.
- If you are not sure of the product name, click Find a product. From the Add product dialog, select the required product from the Available products list box and click the forward arrow. The selected product is added to the Chosen products list box. Click Update attached products. Added products are listed in the Associated product list.
All the fields marked with an asterisk * are required and must be completed before you can proceed with the certification.
20.7. Update Graph
Select the OpenShift product version and Channel details for your component through this tab.
- Select the required version from the OpenShift Version list box.
- Select the required channel from the Channel list box.
The Update graph table provides the following information:
- Version
- Update Paths
- Other Available Channels
See Operator update documentation tile below the header, for more information on the upgrades.
All the fields marked with asterisk * are required and must be completed before you can proceed with Operator bundle certification.
