Red Hat OpenStack Services on OpenShift Certification Workflow Guide
For Use with Red Hat OpenStack 18
Abstract
Making open source more inclusive Copy linkLink copied to clipboard!
Red Hat is committed to replacing problematic language in our code and documentation. We are beginning with these four terms: master, slave, blacklist, and whitelist. Due to the enormity of this endeavor, these changes will be gradually implemented over upcoming releases. For more details on making our language more inclusive, see our CTO Chris Wright’s message.
Chapter 1. Introduction to RHOSO certification program Copy linkLink copied to clipboard!
Certify your infrastructure and applications deployed on Red Hat OpenStack Services on OpenShift (RHOSO).
1.1. The Red Hat certification program overview Copy linkLink copied to clipboard!
The Red Hat certification program ensures the compatibility of your applications deployed on Red Hat OpenStack Services on OpenShift (RHOSO). The program has three main elements:
- Test suite - Contains tests for hardware or software applications undergoing certification.
- Red Hat Certification Ecosystem - Helps to explore and find certified products including hardware, software, cloud, and service providers.
- Support - Provides a joint support relationship between you and Red Hat.
This table summarizes the basic differences between a product listing and components:
| Product listing | Component (Project) |
|---|---|
| Includes detailed information about your product. | The individual containers, operators, helm charts, and infrastructure services that you test, certify, and then add to the product listing. |
| Products are composed of one or more components. | Components are added to a product listing. |
| You add components to a product for proceeding with certification. | A component can be used in multiple products by adding it to each product listing. |
| A product can not be published without certified components. | Certified components are published as part of a product listing. |
1.2. The RHOSO certification workflow Copy linkLink copied to clipboard!
Red Hat recommends that you are a Red Hat Certified Engineer or hold equivalent experience before starting the certification process.
The following diagram gives an overview of the certification process.
Figure 1.1. The RHOSO certification workflow
1.3. Getting support and giving feedback Copy linkLink copied to clipboard!
For any questions related to the Red Hat certification toolset, certification process, or procedure described in this documentation, refer to the KB Articles, Red Hat Customer Portal and Red Hat Partner Connect.
You can also open a support case to get support or submit feedback.
To open a support case see, How do I open and manage a support case on the Customer Portal?
Questions during certification
If you have any questions about a specific certification, record them in the Comments section of the Dialog Tab of the certification entry.
If you face any preliminary issues that stop you from proceeding with the product certification, contact your Engineering Partner Manager or other engineering engagements to resolve them.
Chapter 2. Onboarding certification partners Copy linkLink copied to clipboard!
Use the Red Hat Customer Portal to create a new account if you are a new partner, or use your existing Red Hat account if you are a current partner to onboard with Red Hat for certifying your products.
2.1. Onboarding existing certification partners Copy linkLink copied to clipboard!
Prerequisites
You have an existing Red Hat account.
Procedure
- Access Red Hat Customer Portal and click Log in.
Enter your Red Hat login or email address and click Next.
Then, use either of the following options:
- Log in with company single sign-on
- Log in with Red Hat account
From the menu bar on the header, click your avatar to view the account details.
- If an account number is associated with your account, then you can proceed with the certification process.
If an account number is not associated with your account, then first contact the Red Hat global customer service team to raise a request for creating a new account number.
After you get an account number, contact the certification team to proceed with the certification process.
2.2. Onboarding new certification partners Copy linkLink copied to clipboard!
Creating a new Red Hat account is the first step for onboarding new certification partners.
Procedure
- Access Red Hat Customer Portal and click Register.
Enter the following details to create a new Red Hat account:
Select Corporate in the Account Type field.
If you have created a Corporate type account and require an account number, contact the Red Hat global customer service team.
Ensure that you create a company account and not a personal account. The account created during this step is also used to sign in to the Red Hat Ecosystem Catalog when working with certification requests.
- Choose a Red Hat login and password.
If your login ID is associated with multiple accounts, then do not use your contact email as the login ID as this can cause issues during login. Also, you cannot change your login ID once created.
- Enter your Personal information and Company information.
Click Create My Account.
A new Red Hat account is created.
- Contact your Ecosystem Partner Management (EPM) representative, if available. Else contact the certification team to proceed with the certification process.
2.3. Exploring the Partner landing page Copy linkLink copied to clipboard!
After logging in to Red Hat Partner Connect, the partner landing page opens. This page serves as a centralized hub, offering access to various partner services and capabilities that enable you to start working on opportunities.
The Partner landing page offers the following services:
- Software certification
- Red Hat Demo platform
- Red Hat Partner Training Portal
- Access library of marketing, sales & technical content
- Partner support
- Email preference center
- Partner subscriptions
- User account
As part of the Red Hat partnership, partners receive access to various Red Hat systems and services that enable them to create shared value with Red Hat for our joint customers.
Go to the Software certification tile and click Certify your software to begin your product certification journey. The personalized Product certification dashboard opens.
Chapter 3. Create a product Copy linkLink copied to clipboard!
The product listing provides marketing and technical information, showcasing your product’s features and advantages to potential customers. It lays the foundation for adding all the necessary components to your product for certification.
Prerequisites
Verify the functionality of your product on the target Red Hat platform, in addition to the specific certification testing requirements. If running your product on the targeted Red Hat platform results in a substandard experience then you must resolve the issues before certification.
Procedure
Red Hat recommends completing all the optional fields in the listing tabs for a comprehensive product listing. More information helps mutual customers make informed choices.
Red Hat suggests that you collaborate with your product manager, marketing representative, or other product experts when entering information for your product listing.
Fields marked with an asterisk (*) are mandatory.
- Log in to the Red Hat Partner Connect Portal.
- Click Certify your software.
- On the header bar, click Product management.
- From the Listing and certification tab click Manage products.
From the My Products page, click Create Product.
A Create New Product dialog opens.
- Enter the Product name.
From the What kind of product would you like to certify? drop-down, select the required product category and click Create product. For example, select OpenStack Infrastructure for creating an OpenStack platform based product listing which includes OpenStack Plugins like Cinder or Manila.
A new page with your Product name opens. It comprises the following tabs:
- Section 3.1, “Overview”
- Section 3.2, “Product Information”
- Section 3.3, “Components”
Along with the following tabs, the page header provides the Product Score details. Product Score evaluates your product information and displays a score. It can be:
- Fair
- Good
- Excellent
Best
Click How do I improve my score? to improve your product score.
- After providing the product listing details, click Save before moving to the next section.
3.1. Overview Copy linkLink copied to clipboard!
This tab consists of a series of tasks that you must complete to publish your product:
3.1.1. Complete product listing details Copy linkLink copied to clipboard!
To complete your product listing details, click Start.
The Product Information tab opens.
- Enter all the essential product details and click Save.
3.1.2. Complete company profile information Copy linkLink copied to clipboard!
- To complete your company profile information, click Start. After entering all the details, click Submit.
- To modify the existing details, click Review. The Account Details page opens.
- Review and modify the Company profile information and click Submit.
3.1.3. Add at least one product component Copy linkLink copied to clipboard!
Click Start. You are redirected to the Components tab.
To add a new or existing product component, click Add component.
For adding a new component,
- In the Component Name text box, enter the component name.
- For What kind of standalone component are you creating? select OpenStack Infrastructure for certifying a plugin or driver that uses your own container images on Red Hat OpenStack Platform.
- Click Next.
Are your product’s containers already a part of the Red Hat OpenStack Platform distribution? Your product must use container images provided by Red Hat as part of the RHOSP native distribution.
- If you have not customized the container images, select Yes. Your container images are already certified, and you need to certify your product only.
- If you have customized the container images with, for example, additional software, select No. You will need to certify your container images as well as your product.
From the Services drop-down menu, select the function of your product:
- Cinder (Block Storage)
- Manila (File Storage)
- Neutron (Networking)
- Click Add Component.
- For the Red Hat OpenStack Version, version 18 is enabled by default.
For adding an existing component, from the Add Component dialog, select Existing Component.
- From the Available components list, search and select the components that you wish to certify and click the forward arrow. The selected components are added to the Chosen components list.
- Click Attach existing component.
3.1.4. Certify components for your listing Copy linkLink copied to clipboard!
To certify the components for your listing, click Start. If you have existing product components, you can view the list of Attached Components and their details:
- Name
- Certification
- Security
- Type
- Created
- Click more options to archive or remove the components
- Select the components for certification.
After completing all the above tasks you will see a green tick mark corresponding to all the options.
The Overview tab also provides the following information:
Product contacts - Provides Product marketing and Technical contact information.
- Click Add contacts to product to provide the contact information
- Click Edit to update the information.
Components in product - Provides the list of the components attached to the product along with their last updated information.
- Click Add components to product to add new or existing components to your product.
- Click Edit components to update the existing component information.
After publishing the product listing, you can view your Product Readiness Score and Ways to raise your score on the Overview tab.
3.2. Product Information Copy linkLink copied to clipboard!
Through this tab you can provide all the essential information about your product. The product details are published along with your product on the Red Hat Ecosystem catalog.
General tab:
Provide basic details of the product, including product name and description.
- Enter the Product Name.
- Optional: Upload the Product Logo according to the defined guidelines.
- Enter a Brief description and a Long description.
- Click Save.
Features & Benefits tab:
Provide important features of your product.
- Optional: Enter the Title and Description.
- Optional: To add additional features for your product, click + Add new feature.
- Click Save.
Quick start & Config tab:
Add links to any quick start guide or configuration document to help customers deploy and start using your product.
- Optional: Enter Quick start & configuration instructions.
- Click Save.
- Select Hide default instructions check box, if you don’t want to display them.
Linked resources tab:
Add links to supporting documentation to help our customers use your product. The information is mapped to and is displayed in the Documentation section on the product’s catalog page.
It is mandatory to add a minimum of three resources. Red Hat encourages you to add more resources, if available.
- Select the Type drop-down menu, and enter the Title and Description of the resource.
- Enter the Resource URL.
- Optional: To add additional resources for your product, click + Add new Resource.
- Click Save.
FAQs tab:
Add frequently asked questions and answers of the product’s purpose, operation, installation, or other attribute details. You can include common customer queries about your product and services.
- Enter Question and Answer.
- Optional: To add additional FAQs for your product, click + Add new FAQ.
- Click Save.
Support tab:
Provide contact information of your support team:
- Optional: Support description
- Support website - This field is mandatory
- Optional: Support phone number
- Optional: Support email address
- Click Save.
Contacts tab:
Provide contact information of your marketing and technical team.
- Enter the Marketing contact email address and Technical contact email address.
- Optional: To add additional contacts, click + Add another.
- Click Save.
Legal tab:
Provide the product related license and policy information.
- Enter the License Agreement URL for the product and Privacy Policy URL.
- Click Save.
SEO tab:
Use this tab to improve the discoverability of your product for our mutual customers, enhancing visibility both within the Red Hat Ecosystem Catalog search and on internet search engines. Providing a higher number of search aliases (key and value pairs) will increase the discoverability of your product.
- Select the Product Category.
- Enter the Key and Value to set up Search aliases.
- Click Save.
- Optional: To add additional key-value pair, click + Add new key-value pair.
Add at least one Search alias for your product. Red Hat encourages you to add more aliases, if available.
3.3. Components Copy linkLink copied to clipboard!
Use this tab to add components to your product listing. Through this tab you can also view a list of attached components linked to your Product Listing.
Alternatively, to attach a component to the Product Listing, you can complete the Add at least one product component option available on the Overview tab of a product listing.
- To add a new or existing product component, click Add component.
For adding a new component, from the Add Component dialog, select New Component.
- In the Component Name text box, enter the component name.
- For What kind of OpenStack component are you creating? select OpenStack Infrastructure for certifying a plugin or driver that uses your own container images on Red Hat OpenStack Platform.
- Click Next.
Are your product’s containers already a part of the Red Hat OpenStack Platform distribution? Your product must use container images provided by Red Hat as part of the RHOSP native distribution.
- If you have not customized the container images, select Yes. Your container images are already certified, and you need to certify your product only.
- If you have customized the container images with, for example, additional software, select No. You will need to certify your container images as well as your product.
From the Services drop-down menu, select the function of your product:
- Cinder (Block Storage)
- Manila (File Storage)
Neutron (Networking)
- Click Add Component.
- For the Red Hat OpenStack Version, version 18 is enabled by default.
For adding an existing component, from the Add Component dialog, select Existing Component.
- From the Available components list, search and select the components that you wish to certify and click the forward arrow. The selected components are added to the Chosen components list.
- Click Attach existing component.
You can add the same component to multiple products listings. All attached components must be published before the product listing can be published.
After attaching components, you can view the list of Attached Components and their details:
- Name
- Certification
- Security
- Type
- Created
- Click more options to archive or remove the attached components
Alternatively, to search for specific components, type the component’s name in the Search by component Name text box.
3.4. Support Copy linkLink copied to clipboard!
The Red Hat Partner Acceleration Desk (PAD) is a Products and Technologies level partner help desk service that allows the current and prospective partners a central location to ask non-technical questions pertaining to Red Hat offerings, partner programs, product validation, product certification, engagement process, and so on.
You can also contact the Red Hat Partner Acceleration Desk for any technical questions you may have regarding the validation and certification process. Technical help requests will be redirected to the Red Hat ecosystem team.
By using the Partner Subscriptions program, Red Hat offers free, not-for-resale software subscriptions that you can use to certify your product on the target Red Hat platform. To request access to the program, follow the instructions on the Partner Subscriptions site.
- To request support, click Open a support case. See PAD - How to open & manage PAD cases, to open a PAD ticket.
- To view the list of existing support cases, click View support cases.
3.5. Removing a product Copy linkLink copied to clipboard!
After creating a product listing if you wish to remove it, go to the Overview tab and click Delete.
A published product must first be unpublished before it can be deleted. Red Hat retains information related to deleted products even after you delete the product.
Chapter 4. Adding certification components Copy linkLink copied to clipboard!
4.1. For OpenStack infrastructure containerized applications Copy linkLink copied to clipboard!
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.
To configure the options, go to the Components tab and click on any of the existing components.
4.1.1. Images Copy linkLink copied to clipboard!
The Images tab provides the test results for the container images that you submit by using the preflight tool. You have to configure preflight and push your container images to view the test results.
- Build and test your container images.
- To push your container images, click Set up Preflight.
When your testing is complete you can see two categories of images:
- Manifest Digests - denotes container images that are available for multiple architectures.
- Standalone Container Images - denotes container images that are available only for a single architecture.
This page provides the following details of your container images:
- Specific image ID or the SHA ID
- Image Tag(s)
- Certification - Certified or Not certified, pass or fail status based on the checks performed. Click on it for more details.
- Architecture - specific architecture of your image, if applicable.
- Security - check for any vulnerabilities, if any.
- Health Index - Container Health Index is a measure of the oldest and most severe security updates available for a container image. 'A' is more up-to-date than 'F'. See Container Health Index grades as used inside the Red Hat Container Catalog for more details.
- Created - the day on which you submitted the certification.
Click the Actions menu to perform the following tasks:
- Delete Image - click this option to delete your container image when your image is unpublished.
- Sync Tags - when you have altered your image tag, use this option to synchronize the container image information available on both Red Hat Partner Connect and Red Hat Container catalog.
- View in Catalog - When your container image is published, click this option to view the published container image on the Red Hat Ecosystem Container catalog.
- Click Publish, to publish your certified container images.
4.1.2. Certification Copy linkLink copied to clipboard!
The Certification tab provides detailed information about the Export control questionnaire and all the certification tests performed for the attached container images.
Export Control Questionnaire
The Export control questionnaire contains a series of questions through which the Red Hat legal team evaluates the export compliance by third-party vendors. Partner’s legal representative must review and answer the questions. Red Hat takes approximately five business days to evaluate the responses and based on the responses Red Hat approves partner or declines partner or defers decision or requests more information.
- Click Start questionnaire, to enter all the legal information about your product.
- Click Review to modify the existing details.
If you are using a version of Universal Base Image (UBI) to build your container image, you can host your image in a private repository. This allows you to skip the Export Compliance questionnaire. This form is required only if you are hosting your images on the Red Hat Container Catalog.
Validate the functionality of your product on this Red Hat OpenStack release
Validate the functionality of your product on this Red Hat OpenStack release by using the Certification tab. You can perform the following functions:
- Run the Red Hat Certification Tool locally.
- Share the test results with the Red Hat certification team.
Interact with the certification team, if required.
To validate the functionality of your product perform the following steps:
- If you are a new partner, click Request a partner subscription. When your request is approved, you get active subscriptions added to your account.
When you have active partner subscriptions, then click Start certification and then click Go to Red Hat certification tool.
A new certification case gets created on the Red Hat Certification portal, and you are redirected to the appropriate certification portal page.
The certification team will contact you to start the certification testing process, and will follow up with you in case of a problem. After successful verification, a green check mark is displayed with the validate complete message.
To review the validated product details, click Review.
Submit your container image for verification
- Run the certification suite on your container image. See Running the certification test suite.
Upload the test results.
You can later see the test results on the Images tab.
- Publish the container image certification on the Red Hat catalog.
This step certifies your container only. Use the Certifications tab to certify the functionality.
4.1.3. Security Copy linkLink copied to clipboard!
The security tab provides the health status of the attached product components. Red Hat uses a Health Index to identify security risks with your components that Red Hat provides through the Red Hat Ecosystem Catalog.
The Health Index is a measure of the oldest and most severe security updates available for a container image. An image with a grade of 'A' is more up-to-date than one with a grade of 'F. For more information, see Container Health Index grades as used inside the Red Hat Container Catalog.
This tab provides the health index of your images which includes the following details:
- Image ID
- Health index
4.1.4. Repository information Copy linkLink copied to clipboard!
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. |
| Repository summary | Repository summary obtained from the container image. |
| Repository description | Repository description obtained from the container image. |
| Instructions for users to get your company’s image on the Red Hat Container catalog | Provide specific instructions that you want users to follow when they get your container image. This field is applicable only for container images. |
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.
4.1.5. Component details Copy linkLink copied to clipboard!
Configure the product component details by using this tab.
Enter the required details in the following fields:
| Field name | Description |
|---|---|
| Image Type | Select the respective image type for your product component.
|
| Application categories | Select the respective application type of your software product. |
| Host level access | Select between the two options:
Note If your product’s functionality requires root access, you must select the privileged option, before running the preflight tool. This setting is subject to Red Hat review. |
| Release Category | Select between the two options:
|
| Project name | Name of the project for internal purposes. |
4.1.6. Contact information for containerized applications Copy linkLink copied to clipboard!
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.
4.1.7. Associated products Copy linkLink copied to clipboard!
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.
4.2. For OpenStack infrastructure non-containerized applications Copy linkLink copied to clipboard!
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.
To configure the component options, go to the Components tab and click on any of the existing components.
4.2.1. Certification for non-containers Copy linkLink copied to clipboard!
Validate the functionality of your product on this Red Hat OpenStack release
Validate the functionality of your product on this Red Hat OpenStack release by using the Certification tab.
This feature allows you to perform the following functions:
- Run the Red Hat Certification Tool locally.
- Share the test results with the Red Hat certification team.
- Interact with the certification team, if required.
To validate the functionality of your product, perform the following steps:
- If you are a new partner, click Request a partner subscription. When your request is approved, you get active subscriptions added to your account.
- When you have active partner subscriptions, then click Start certification.
- Click Go to Red Hat certification tool.
A new certification case gets created on the Red Hat Certification portal, and you are redirected to the appropriate component portal page. This page has four tabs:
- Summary - It includes the Certification Case, Partner Product and Progress details of the new certification case. 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.
- Test Plans - displays the Test Plan Summary details of the new certification case.
- Related Certifications - displays the details of the related certification cases.
Properties - displays the certification properties. It includes the following details:
General - Provide the base certification version and platform information for your product certification and click Update Values:
Platform - Select the required information for the following fields from the respective drop-down list:
- Product Version
- Base Version
- Support Case - Add any existing support cases or knowledge base articles that you want to reference with your certification case.
- OpenStack - Provide the details of the Red Hat OpenStack plugin components for certification and click Update. All the provided details along with the selected features and their respective protocols are available on the CertOps hub.
The certification team will contact you to start the certification testing process and will follow up with you in case of a problem. After successful verification, a green check mark is displayed with the validate complete message.
To review the validated product details, click Review.
4.2.2. Component Details Copy linkLink copied to clipboard!
Enter the required component details in the following fields:
- Component name - Enter the component name. This name is not published and is only for internal use.
- Red Hat OpenStack Version - Specifies the Red Hat OpenStack version on which you certify your non-containerized application component. This field is auto-populated with the required OpenStack version.
- Click Save.
4.2.3. Contact Information for non containers Copy linkLink copied to clipboard!
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.
4.2.4. Associated products for non containers Copy linkLink copied to clipboard!
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.
Chapter 5. Setting up the test environment Copy linkLink copied to clipboard!
To certify your product, you must first set up the environment where you can run the tests. The test environment consists of a host system. A test host is a workstation used as a medium for accessing the OpenShift cluster.
Red Hat recommends partners to enable FIPS mode on both control plane and data plane nodes.
5.1. Setting up the test host Copy linkLink copied to clipboard!
Use the test host to start a test run on the OpenShift cluster, display the progress of the tests, and present the final result file after gathering results.
Prerequisites
- Install or use an existing RHEL 9 system.
- Have access to an OpenShift cluster hosting a RHOSO control plane.
-
Install OpenShift CLI (oc) on the test host and check if it is working by using the command
oc version.
Procedure
Use your RHN credentials to register your system by using Red Hat Subscription Management.
subscription-manager register
# subscription-manager registerCopy to Clipboard Copied! Toggle word wrap Toggle overflow Display the list of available subscriptions for your system.
subscription-manager list --available*
# subscription-manager list --available*Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Search for the subscription that provides the Red Hat Certification (for RHEL Server) repository.
- Note the subscription and its Pool ID.
Attach the subscription to your system.
subscription-manager attach --pool=<pool_ID>
# subscription-manager attach --pool=<pool_ID>Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou don’t have to attach the subscription to your system, if you enable the option Simple content access for Red Hat Subscription Management.
-
Replace the
pool_IDwith the Pool ID of the subscription. Subscribe to the Red Hat Certification channel.
subscription-manager repos --enable=cert-1-for-rhel-9-x86_64-rpms
# subscription-manager repos --enable=cert-1-for-rhel-9-x86_64-rpmsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Install the certification RPMs.
dnf install redhat-certification dnf install redhat-certification-rhoso
# dnf install redhat-certification # dnf install redhat-certification-rhosoCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 6. Running the certification test suite Copy linkLink copied to clipboard!
Follow these steps on the test server to run certification tests on the OpenStack deployment under test or test client. Run the tests on OpenStack plugins and drivers for the following services - Block Storage, Shared File System Storage and Networking.
Prerequisites
- You have prepared the test host system as outlined in the Setting up the test environment.
- You have a working directory on the test host system with write privileges.
Procedure
To initialize the certification test environment, enter the OpenShift namespace for the RHOSO control plane (default is openstack) and then select a certification test suite.
rhoso-cert-init
# rhoso-cert-initCopy to Clipboard Copied! Toggle word wrap Toggle overflow The current release supports a cinder test suite, four manila suites and 14 neutron suites. For more information on debugging test failures, see Running the Debug test suite.
The certification test environment is automatically configured with most of the tempest settings required by each test suite. For running the cinder tests, these default settings are sufficient. But for running manila and neutron tests you have to configure certain additional settings:
-
For running manila tests, you can specify the additional settings in a
tempest-config-overridesfile. For running neutron tests, you can configure the advanced image and flavor of the image settings required by the
init rhos-cert-initscript. These settings are used in running certain neutron related tests.Create the
tempest-conf-overridesfile and enter the necessary configuration settings.NoteIn the
tempest-conf-overridesfile, enter the necessary configuration settings as separate lines and do not enter comments.For example, you can configure the following options by providing an appropriate value in the angular braces (<>).
Sample configuration settings
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
For running manila tests, you can specify the additional settings in a
Optional: Create tempest accounts.
It is beneficial to use a dedicated set of tempest test accounts for some test suites, for example the manila suites with
DHSS=True. Using dedicated test accounts prevents a tempest test from deleting a dynamically created resource, while another test is using the resource. For more information about tempest test accounts, see Using tempest test accounts.Run the certification test suite.
rhoso-cert-run
# rhoso-cert-runCopy to Clipboard Copied! Toggle word wrap Toggle overflow Each test suite will run a series of subtests, and when it completes it reports a Pass or Fail status.
NoteIn the current RHOSO version, all the tests are executed, including both mandatory and optional tests, such as consistency groups and multi-attach volumes. The optional tests may fail if your driver does not support those features. This is acceptable and does not impact the overall certification process.
You can view the detailed test results, including the debug data after the certification logs are generated.
Extract the log files.
rhoso-cert-logs
# rhoso-cert-logsCopy to Clipboard Copied! Toggle word wrap Toggle overflow When you extract the log files, you are prompted on whether to include a must-gather report.
-
To skip the must-gather report for faster extraction: Type
no. If you are submitting the test results for certification, you must include the report.
The logs and debug data are extracted into a subdirectory. The name of the directory is displayed at the end.
Sample output
Here is an example of the sample output received while extracting the logs for the cinder test suite without a
must-gatherreport. In this example the extracted logs are stored in the directoryrhoso-cert-cinder-2024-Aug-01_11-48-08.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
To skip the must-gather report for faster extraction: Type
Save the generated log files.
rhoso-cert-save
# rhoso-cert-saveCopy to Clipboard Copied! Toggle word wrap Toggle overflow A filtered subset of the generated test result files are stored in the default location
/var/log/redhat-certification/. You can upload the generated test result files for Red Hat’s review.After uploading the test result files, clean up the host system.
rhoso-cert-cleanup
# rhoso-cert-cleanupCopy to Clipboard Copied! Toggle word wrap Toggle overflow You can execute this command after completing the certification process, or before selecting a different test suite.
6.1. Optional: Running the Debug test suite Copy linkLink copied to clipboard!
The Debug test suite executes a single group of tests specified in the rhoso-cert-debug.yaml file. The Debug test suite helps you to perform the following tasks:
- Debug the tempest test failures that you encounter when running the entire cinder, manila or neutron test suite.
- Rerun specific set of tests that failed but are required for result submission.
Procedure
Copy the YAML file related to the Debug test suite to your working directory.
cp /usr/share/redhat-certification-rhoso/rhoso-cert-debug.yaml <current test directory>
# cp /usr/share/redhat-certification-rhoso/rhoso-cert-debug.yaml <current test directory>Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Open the local
rhoso-cert-debug.yamlfile in an editor, and update the list of tests. The list can include just a single test, or a group of tests that you want to execute. -
Run the command
rhoso-cert-init. - Select the Debug test suite.
-
Rerun the commands
rhoso-cert-runandrhoso-cert-logsto execute the selected list of tempest tests. - Collect the logs for Red Hat’s analysis and verification.
6.2. Optional: Using tempest test accounts Copy linkLink copied to clipboard!
Tempest provides a mechanism for specifying a set of test resources by using an accounts.yaml file. It is optional to use test accounts, but it is helpful if the tempest tests fail when a test resource gets prematurely deleted.
You can pre-create the test accounts by providing an accounts.yaml file in the certification working directory. Refer to tempest’s sample accounts.yaml for knowing the structure of this file. You must have three times the number of test accounts as there are concurrent test threads. Since the default test concurrency is 4, the accounts.yaml file used must list 12 test accounts. These accounts must have 'administrator' users in addition to 'member' users and must also include pre-created networks.
Alternatively, the RHOSO certification tools can create the test accounts and the accounts.yaml file when you perform the following steps:
You must manually clean up the test accounts and their resources after completing the certification process.
Procedure
Run the debug suite and ignore any failures.
rhoso-cert-init rhoso-cert-run
# rhoso-cert-init # rhoso-cert-runCopy to Clipboard Copied! Toggle word wrap Toggle overflow Generate the tempest test accounts and
accounts.yamlfile.rhoso-cert-test-accounts
# rhoso-cert-test-accountsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Clean up after running the debug suite.
rhoso-cert-cleanup
# rhoso-cert-cleanupCopy to Clipboard Copied! Toggle word wrap Toggle overflow Re-initialize the certification test environment and select the desired test suite.
rhoso-cert-init
# rhoso-cert-initCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 7. Uploading the test results to Red Hat certification portal Copy linkLink copied to clipboard!
After running the certification tests, upload the test results file for Red Hat’s review and verification. You can upload it by using two different methods - CLI or the Red Hat certification portal.
7.1. Uploading the results file by using CLI Copy linkLink copied to clipboard!
Prerequisites
- A compressed test results file in tgz, tar or zip format available on the test host system.
You must have superuser privileges on the test host system to run the commands rhcert-login and rhcert-upload. If not, you can run the commands with superuser privileges. For example,
sudo rhcert-cli login sudo rhcert-cli upload
$ sudo rhcert-cli login
$ sudo rhcert-cli upload
Procedure
Log in to authenticate your device.
NoteLogging in is mandatory to upload the test results file.
rhcert-cli login
# rhcert-cli loginCopy to Clipboard Copied! Toggle word wrap Toggle overflow - Open the generated URL in a new browser window or tab.
- Enter the username and password and click Log in.
- Click Grant access. Device login successful message displays.
- Return to the terminal and enter yes to the Please confirm once you grant access prompt.
Submit the result file. You can do it by using two different methods:
Step by step method
Enter the following command.
rhcert-cli upload
# rhcert-cli uploadCopy to Clipboard Copied! Toggle word wrap Toggle overflow When prompted enter the mandatory fields,
- Enter your Certification ID.
- Enter a brief description for your uploaded file.
- Enter the absolute path of your test results file.
Direct method
Alternatively, you can upload your results file by providing all the mandatory fields by using the following command:
rhcert-cli upload --certification-id xxxxx --description "Any file description" --file /var/log/redhat-certification/xyz.tgz
# rhcert-cli upload --certification-id xxxxx --description "Any file description" --file /var/log/redhat-certification/xyz.tgzCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteWhen you are uploading the test results file, if the user is not authorized then an authentication URL is automatically generated and displayed. When you grant access to the user by using the URL, then the test results file gets uploaded for Red Hat certification team’s review.
Sample output
Here is an example of the sample output received while uploading the test results file by using CLI.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Upon successful upload, the details of the uploaded file are displayed.
For example,
Success: Test results rhoso-cert-cinder-2024-Jul-31_04-25-24.tgz uploaded to certification ID 625817
Success: Test results rhoso-cert-cinder-2024-Jul-31_04-25-24.tgz uploaded to certification ID 625817
Red Hat reviews the uploaded test results file and suggests the next steps.
7.2. Uploading the results file by using the certification portal Copy linkLink copied to clipboard!
Prerequisites
A compressed test results file in tgz, tar or zip format available on the test host system.
Procedure
- Log in to the Red Hat Certification portal.
- On the homepage, enter the product case number in the search bar.
- Select the required case number from the list that is displayed.
- On the Summary tab, go to the Files section and then click Upload, to upload your test results file.
Browse for the test results file and click Open.
The file is uploaded for Red Hat’s review.
- Optional: Add your queries related to certification, if any, in the Discussions text box and then click Add Comment. The Red Hat certification team provides clarifications for your queries.
Verification steps
Upon successful upload, the details of the uploaded file are displayed in the Files > Attachments section.
Red Hat reviews the uploaded test results file and suggests the next steps.
Chapter 8. Publishing on the catalog Copy linkLink copied to clipboard!
After uploading your test result files, your application is scanned for vulnerabilities. When the scanning is complete, you can publish your product on the Red Hat Ecosystem Catalog.
To receive RHOSO certification, ensure:
- All required tests have been run successfully.
- Red Hat has reviewed and validated your test configuration report.
Perform the following steps to publish your product on the catalog:
Procedure
- Navigate to your Product listing page.
- Click Publish.
Your certified application is now published on the Red Hat Ecosystem Catalog.