In-Cluster Checks
A generic framework for running health validation rules directly on OpenShift cluster nodes using oc debug.
Key Advantages
- Direct node access - Rules run directly on cluster nodes via
oc debug - Fast execution - Parallel rule execution across multiple nodes
- Relevant rules execution - Only relevant rules run based on prerequisite checks
- Easy debugging - Full visibility into commands executed for each rule
Originally developed as part of Red Hat's Pendrive project, this framework has been extracted as open-source to benefit the broader OpenShift community.
Rules are organized by topic into domains (hardware, network, linux, storage).
Installation
Prerequisites:
- Python >= 3.12
- pip (Python package installer)
Connected Environment
Install the framework:
pip install in-cluster-checks
Or if pip is not found, use:
python3 -m pip install in-cluster-checks
Disconnected Environment
For environments without internet access:
-
Download the package on a connected machine:
pip download in-cluster-checks --dest ./packages # Or: python3 -m pip download in-cluster-checks --dest ./packages
-
Transfer the packages to the disconnected environment
Copy the entire
./packagesdirectory to the disconnected machine. You can place it anywhere, but note the location for the next step. -
Install from local packages:
# If packages are in the current directory: pip install --no-index --find-links=./packages in-cluster-checks # Or specify the full path to where you copied them: pip install --no-index --find-links=/path/to/packages in-cluster-checks # Using python3 -m pip: # python3 -m pip install --no-index --find-links=./packages in-cluster-checks
Running in-cluster-checks
Cluster Login
Ensure you're logged into your OpenShift cluster.
You can login by one of the following options:
Login with Username and Password:
Use the cluster API URL and your credentials.
oc login https://api.your-cluster.com:6443
Login Using a Kubeconfig File:
If you already have a kubeconfig file with credentials:
export KUBECONFIG=/path/to/kubeconfig
Usage Examples
You can run in-cluster-checks with the following options:
# Run all checks. Use --output to save run results to ./cluster-checks.json
in-cluster-checks --output ./cluster-checks.json
# Run a specific rule (disables secret filtering)
in-cluster-checks --debug-rule "check_disk_usage"
# Run with debug logging
in-cluster-checks --log-level DEBUG
# Specify namespace for debug pods (default: default)
in-cluster-checks --namespace openshift-debug
To see all available options, run:
in-cluster-checks --help
Notes:
- To control execution performance, use
--max-workersto set the maximum number of parallel workers (default: 50). - When using
--namespace, ensure you have permissions to create debug pods in the specified namespace.
Contributing
Contributions are welcome! Please see our CONTRIBUTING.md for detailed guidelines on how to:
- Set up your development environment
- Add new rules and domains
- Write tests
- Submit pull requests
Related Projects
- Pendrive: Red Hat's on-premise Insights validation tool (internal)
- OpenShift: Container orchestration platform
Acknowledgments
This framework was extracted from Red Hat's Pendrive project. The core validation infrastructure is generic and contains no confidential logic, making it suitable for open-source release to benefit the wider OpenShift community.
License
The 3-Clause BSD License
See LICENSE for full text.
3 maintainers
Metadata
3 maintainers
Release files for in-cluster-checks 0.1.37
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| in_cluster_checks-0.1.37.tar.gz | 150.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| in_cluster_checks-0.1.37-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 330.9 kB
Release files / in_cluster_checks-0.1.37.tar.gz
| Download URL | in_cluster_checks-0.1.37.tar.gz |
|---|---|
| Size | 150.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
079696157a6626e8bdedf1359a370e75adb1b58f5e899f2c72aae8e79f342ee5
|
|
BLAKE2b-256 checksum How to use checksums |
4e588927283fb6217f232e4ab2947bc1f6c69fe07227be2de459646618e0c09b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.
Transparency logRelease files / in_cluster_checks-0.1.37-py3-none-any.whl
| Download URL | in_cluster_checks-0.1.37-py3-none-any.whl |
|---|---|
| Size | 180.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
428b973ab842e1174745cc5fa85cd793595e789a9d3673f6b4fd28e022dd8b28
|
|
BLAKE2b-256 checksum How to use checksums |
c3315caf8b419bedba8ef695ae7645a1af46dd78e306da5862318dbddc27dae2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 12, 2026.
Transparency log
