Onboarding Guide

Table of Contents

• Overview

• Purpose

• Onboarding Workflow Diagram

• Onboarding Phases

  • 1. Prerequisites

  • 2. Scenario Kick-off

  • 3. Develop Scenario

  • 4. Maintenance & Expansion

  • 5. Celebrate & Share

Overview

This Onboarding guide is meant to describe a repeatable process that can be followed to create test scenarios for OpenShift integrated products using OpenShift CI. The goal is that we can onboard & expand new scenarios that are easy to understand, maintain and debug.

We must deeply understand the need for each specific scenario that we put through this process and update this process when needed. This is not meant to be followed blindly so that we can onboard scenarios faster. It is meant to teach a generic way to onboard scenarios that is proven to work. It's expected that new scenarios will present new problems and we must develop better solutions than what may be proposed in this document. We need to hear your pain-points and feedback throughout every step of this process.

**NOTE: ** Please communicate over the #forum-qe-cspi-ocp-ci Slack channel

Purpose

There are many layered products that we've built on top of OpenShift. We need to make sure that all of these products are working with the latest OpenShift builds. In order to effectively test, debug, and maintain all of these product tests and show the results in a consumable report, we need to have some structure in place.

If this onboarding process did not exist we'd be scrambling to put together reports efficiently, find automation bugs, fix automation bugs, find testing gaps, update test scenarios frequently, ..etc.

Onboarding Workflow Diagram

TBD

Onboarding Phases

1. Prerequisites

In order for onboarding to run smoothly and avoid becoming blocked for long stretches we will be upholding a high standard for achieving the prerequisites needed for this model. We predict that accomplishing these prerequisites will take longer than the onboarding itself.

The result of working through your prerequisites will be the completion of the Prerequisite JIRA ticket assigned to you. All information proving that this scenario is ready to be onboarded will need to be provided and approved by both parties.

See the Prerequisites Guide for a detailed explanation of what is needed and how to achieve it.

2. Scenario Kick-off

See the Kick-off Guide for the process to follow when officially starting the cross-team collaboration for a scenario.

3. Develop Scenario

Here is where most of work will be done for the scenario.

See the Scenarios Guide for an overview of the work that is needed.

4. Maintenance & Expansion

See the Scenario Maintenance Policy for detailed information meant to help you maintain and expand your scenarios testable versions in a consistent and easy fashion.

5. Celebrate & Share

See Celebrate & Share for fun information meant to help you communicate your success with others so that we can all benefit from what you've created! :)