docs: align documented dependency versions with requirements.txt (#1455)

Signed-off-by: abhiraj75 <itsabhiraj27@gmail.com>
Co-authored-by: Paige Patton <64206430+paigerube14@users.noreply.github.com>
This commit is contained in:
Abhiraj Singh
2026-07-08 13:24:36 -04:00
committed by GitHub
co-authored by Paige Patton
parent 501755d193
commit 9d78fa4b93
2 changed files with 6 additions and 6 deletions
+2 -2
View File
@@ -172,8 +172,8 @@ to generate scenario plugins **MUST** verify:
AI tools may suggest dependency versions that conflict with Krkn's
requirements. Contributors **MUST** verify:
- `docker` package remains <7.0
- `requests` package remains <2.32
- `docker` package stays `>=7.0.0` (Unix socket support is native in docker 7+)
- `requests` package stays `>=2.32.4` (required security fixes)
- New dependencies are compatible with the existing dependency tree
- Dependencies are pinned to specific versions in `requirements.txt`
- Dependencies are checked for known security vulnerabilities
+4 -4
View File
@@ -44,12 +44,12 @@ python -m coverage run -a -m unittest discover -s tests -v
### Python Environment
- **Python 3.11+** required
- **NEVER install packages globally** - always use virtual environment
- **CRITICAL**: `docker` must be <7.0 and `requests` must be <2.32 (Unix socket compatibility)
- **CRITICAL**: `docker` must be >=7.0.0 and `requests` must be >=2.32.4 — match the pins in `requirements.txt` (docker 7+ handles Unix sockets natively; requests bumped for security fixes)
### Key Dependencies
- **krkn-lib** (5.1.13): Core library for Kubernetes/OpenShift operations
- **kubernetes** (34.1.0): Kubernetes Python client
- **docker** (<7.0), **requests** (<2.32): DO NOT upgrade without verifying compatibility
- **krkn-lib** (6.1.2): Core library for Kubernetes/OpenShift operations
- **kubernetes** (>=35.0.0,<36.0.0): Kubernetes Python client
- **docker** (>=7.0.0), **requests** (>=2.32.4): match `requirements.txt`; do not change without verifying Unix-socket compatibility
- Cloud SDKs: boto3 (AWS), azure-mgmt-* (Azure), google-cloud-compute (GCP), ibm_vpc (IBM), pyVmomi (VMware)
## Plugin Architecture (CRITICAL)