Welcome to OCS-CI’s documentation!

This is a documentation for the OCS-CI project. OCS-CI is a testing framework based on pytest to test Red Hat OCS features and functionality using AWS and other supported platforms.

Package documentations:

• ocs_ci modules
  • ocs_ci package

Contents:

• Code review/contribution best practices in OCS-CI
  • Pre-commit hooks
• Coding guidelines for OCS-CI project
• Debugging
  • SSH to the host
  • OC debug
  • Enable debug log level for rook-ceph-operator
• Guidelines for fixtures usage in OCS-CI
  • Basic information
  • Use cases
  • Avoid
  • Examples of fixtures and tests
• Getting Started
  • Prerequisites
  • Installing
  • Initial Setup
  • Tests
• Graceful Stop Feature for ocs-ci Test Execution
  • Overview
  • Stop File Options
  • How It Works
  • Examples
  • Log Messages
  • Technical Details
  • Best Practices
  • Troubleshooting
  • Comparison with Other Stop Methods
  • Future Enhancements
• OCS-CI Logging Guide for Contributors
  • Table of Contents
  • Quick Start
  • Log Level Selection Guide
  • Usage by Code Type
  • Common Patterns
  • Anti-Patterns to Avoid
  • Special Topics
  • Quick Reference
  • Summary
  • Automation
• Multi-cluster test example
  • Example test
  • Execution of the example test
• Config directory
  • OCS CI Config
  • Custom config
  • Example of accessing config/default data
  • Priority of loading configs:
• OCS-CI Release Branches
  • Goals
  • Supported versions and use-cases
  • Usage
  • Creating Release Branches
  • Backporting Changes
  • Fixes related to specific release versions
• Results
  • Report Portal
• Stable Branch
  • Overview
  • Definition of Stable
  • Impact on the Development Process
  • Automation
  • Resolving failed tests
• Supported platforms
  • AWS
  • vSphere
  • Azure
  • IBM Cloud
  • Openshift Dedicated
  • ROSA
• UI Test Guidelines — Black Squad
  • 1. SeleniumDriver — Singleton Access
  • 2. Page Object Model Architecture
  • 3. Locators
  • 4. Locator Quality Rules
  • 5. Versioned Locators and OCP Version Support
  • 6. Wait Strategy
  • 7. Test File Conventions
  • 8. Selenium Driver Integrity
  • 9. Locator Comments
  • 10. Logging in UI Code
  • 11. AI Fallback — Absence Checks
  • 12. Additional Patterns
• Unit tests
  • How to run the unit tests myself?
  • What tests are available?
  • How to run particular test only?
  • Pytest integration tests
• Upgrade
  • Deployment
  • Upgrade execution
  • Live upgrade
  • Stage upgrade
  • FDF (Fusion Data Foundation) upgrade
• Common Use cases and FAQ
  • ACM and Submariner Auto-Configuration
  • Using ocs-ci to deploy OCP cluster without default OCS installation
  • ENABLE HUGE PAGES
  • FDF Image Mirroring
  • Fusion and Fusion Data Foundation
  • IBM HCI Manual Node Power Operations
  • Regional Disaster Recovery (RDR) Architecture and Deployment in ocs-ci
  • Using multiple instances of Vault KMS in OCS-CI
  • How to report test results from ocs-ci not executed by ocs-ci jenkins?
  • How to execute tests on a cluster not deployed by ocs-ci?
  • How to use alternative mirrors/repositories for OCP installer/client download
• Usage
• Usage for run-ci tool
  • Required configuration
  • Required arguments
  • Useful arguments
  • Examples
• usage for getting various ocs image versions
• usage for cleanup
  • AWS
  • vSphere
• usage to shutdown AWS nodes when nodes are not in use
• Usage for ocs-build tool
• Usage for rosa-ocp-version tool
  • Get list of all available OCP versions in ROSA
  • check if provided OCP version is available in ROSA
• UV Usage
  • Overview
  • Basic Usage
• Tracking of workarounds
  • How to track a workaround?
  • Example
• Writing tests
  • Pytest marks
  • Jira decorator
  • Skipping tests based on ocs version
  • Base test classes for teams
  • Constants and Defaults
  • Fixture usage
  • Cluster context
  • Other notes

Indices and tables

• Index

• Module Index

• Search Page