openshift-python-wrapper

Install the package, connect to a cluster, and create, query, and delete your first Kubernetes resource in under 5 minutes

Set up client connections using kubeconfig files, tokens, basic auth, environment variables, or in-cluster config

Create, update, replace, and delete resources using deploy/clean_up, context managers, and YAML files

List resources with label/field selectors, check existence, watch for changes, and retrieve resource status and conditions

Wait for resources to reach a desired status or condition using built-in polling with configurable timeouts

Validate resource definitions before creating them, enable auto-validation, and troubleshoot schema validation errors

Create and manage multiple similar resources or deploy one resource per namespace using ResourceList and NamespacedResourceList

Apply temporary patches to resources during tests and automatically restore original values using ResourceEditor

Create, start, stop, restart, and migrate VirtualMachine resources and interact with VirtualMachineInstances

Write unit tests for Kubernetes code using FakeDynamicClient with CRUD operations, status simulation, and watch events

Use the class-generator CLI to scaffold Python wrapper classes for any Kubernetes or OpenShift CRD

Copy-paste recipes for pods, deployments, networking, RBAC roles, data volumes, and handling resources with duplicate API groups

Set up and use the MCP server with Cursor, Claude Desktop, or other MCP-compatible AI tools to manage cluster resources

Complete API reference for the Resource and NamespacedResource base classes including all methods, properties, and constructor parameters

All CLI options for class-generator including kind generation, schema updates, coverage reports, batch regeneration, and test generation

All supported environment variables for logging, resource reuse, teardown skipping, and hash control

Learn how Resource, NamespacedResource, and generated subclasses fit together to extend the library with new resource types

Understand how OpenAPI schemas are fetched, cached, and used for both resource validation and class generation

How to use the standalone Event class to watch, list, and delete Kubernetes events. Covers Event.get() for streaming events in real-time, Event.list() for fetching existing events with time-based filtering, Event.delete_events() for cleanup, and the resource.events() method for getting events related to a specific resource. Includes field selectors, namespace filtering, and common debugging patterns.

How to use Pod.execute() to run commands inside pod containers with timeout handling, container selection, and error handling via ExecOnPodError. Covers Pod.log() for retrieving pod logs, accessing pod properties like node, IP address, and practical recipes for debugging running workloads.

Reference for all custom exceptions raised by the library including ExecOnPodError, MissingRequiredArgumentError, ResourceTeardownError, ValidationError, ConditionError, NNCPConfigurationFailed, and ClientWithBasicAuthError. Covers which operations raise each exception, how to catch and handle them, and common error-handling patterns for robust automation scripts.