OpenShift
Conformance test suite for OpenShift, providing end-to-end and extended tests for the OKD platform.
What is OpenShift?
OpenShift Origin is the conformance test suite for OpenShift, the open-source Kubernetes platform. It provides end-to-end and extended tests that validate cluster functionality, compatibility, and reliability. The project maintains the `openshift-tests` binary used for automated testing of OpenShift deployments.
Platform engineers, SREs, and developers working with OpenShift or OKD who need to validate cluster conformance and run comprehensive integration tests.
It offers a standardized, automated testing framework specifically designed for OpenShift, ensuring clusters meet compatibility requirements and reducing manual validation effort.
Overview
Conformance test suite for OpenShift
Use Cases
Best For
- Validating OpenShift cluster conformance before production deployment
- Running end-to-end tests for OpenShift platform features
- Automating integration testing in CI/CD pipelines for Kubernetes
- Ensuring compatibility between OpenShift and upstream Kubernetes
- Testing custom OpenShift configurations and extensions
- Verifying cluster stability after upgrades or configuration changes
Not Ideal For
- Teams using vanilla Kubernetes distributions like EKS or GKE without OpenShift
- Projects needing simple unit testing or quick functional validation
- Organizations seeking a lightweight, easy-to-set-up test framework with minimal maintenance
Pros & Cons
Pros
Validates OpenShift clusters against Kubernetes standards and OpenShift-specific behaviors, ensuring reliability for production deployments through automated test suites.
Includes end-to-end tests that model actual user interactions, covering complex scenarios like deployments and scaling to simulate real-world usage.
Uses environmental selectors to skip tests based on cluster configuration, making test execution efficient and reducing noise from incompatible tests.
Maintains synchronization with the OpenShift Kubernetes fork, ensuring tests are compatible with the latest platform changes and dependencies.
Cons
Requires managing dependencies from forks with scripts like update-kube-vendor.sh, which can encounter errors like '410 Gone' and adds significant maintenance overhead.
Only applicable to OpenShift or OKD clusters, as tests rely on OpenShift-specific APIs, making it useless for other Kubernetes distributions.
Different branches (e.g., pre- and post-4.6) have varying maintenance strategies, which can confuse users and complicate long-term support.
Setup involves understanding multiple repositories, test exclusion rules, and vendoring processes, making initial adoption and configuration non-trivial.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.