# kubernetes-client/python architecture

> Architecture diagram of the GitHub repository kubernetes-client/python, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kubernetes-client/python
- Repository: https://github.com/kubernetes-client/python

## Overview

The Kubernetes Python Client lets applications configure cluster access, invoke Kubernetes APIs, and consume resource data through synchronous or asynchronous clients. Its principal workflow is configuration → API operations → HTTP transport → typed response. Additional capabilities include dynamic resource discovery, watches and informers, streaming, and YAML-based resource creation. The tree and excerpts support these boundaries, but several runtime files were not sampled; uncertain connections are therefore omitted rather than inferred.

Main entry points: [`kubernetes/client/api`](https://github.com/kubernetes-client/python/tree/master/kubernetes/client/api) (Sync API groups), [`kubernetes/client/api_client.py`](https://github.com/kubernetes-client/python/blob/master/kubernetes/client/api_client.py) (Sync API client), [`kubernetes/aio/client/api`](https://github.com/kubernetes-client/python/tree/master/kubernetes/aio/client/api) (Async API groups), [`kubernetes/aio/client/api_client.py`](https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/api_client.py) (Async API client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_clients["API clients"]
  node_sync_api["Sync API groups"]
  node_sync_core["Sync API client<br/>[api_client.py]"]
  node_sync_transport["Sync HTTP transport<br/>[rest.py]"]
  node_sync_response["Sync response<br/>[api_response.py]"]
  node_async_api["Async API groups"]
  node_async_core["Async API client<br/>[api_client.py]"]
  node_async_response["Async response<br/>[api_response.py]"]
  node_async_config["Async settings<br/>[configuration.py]"]
end

subgraph group_runtime["Runtime features"]
  node_dynamic["Dynamic resources<br/>[client.py]"]
  node_discovery["Resource discovery<br/>[discovery.py]"]
  node_resource["Resource operations<br/>[resource.py]"]
  node_watch["Watch streams<br/>[watch.py]"]
  node_informer["Informers<br/>[informer.py]"]
  node_cache[("Informer cache<br/>[cache.py]")]
  node_stream["Exec streaming<br/>[stream.py]"]
  node_yaml["YAML resources"]
end

subgraph group_models["Typed data"]
  node_sync_models["Sync models<br/>[v1_api_group.py]"]
  node_async_models["Async models<br/>[v1_api_group.py]"]
end

subgraph group_support["Configuration"]
  node_config["Cluster configuration"]
  node_async_config_load["Async kube config"]
end

node_app(("Python application"))

node_app -->|"invokes"| node_sync_api
node_app -->|"invokes"| node_async_api
node_app -->|"loads config"| node_config
node_app -->|"loads config"| node_async_config_load
node_sync_api -->|"calls"| node_sync_core
node_sync_core -->|"uses transport"| node_sync_transport
node_sync_core -->|"builds response"| node_sync_response
node_sync_api -->|"serializes models"| node_sync_models
node_async_api -->|"calls"| node_async_core
node_async_core -->|"builds response"| node_async_response
node_async_api -->|"uses models"| node_async_models
node_async_core -->|"reads settings"| node_async_config
node_dynamic -->|"creates discoverer"| node_discovery
node_dynamic -->|"uses resources"| node_resource
node_informer -->|"consumes events"| node_watch
node_informer -->|"updates cache"| node_cache
node_yaml -->|"uses dynamic client"| node_dynamic
node_stream -->|"uses REST"| node_sync_transport

click node_sync_api "https://github.com/kubernetes-client/python/tree/master/kubernetes/client/api"
click node_sync_core "https://github.com/kubernetes-client/python/blob/master/kubernetes/client/api_client.py"
click node_sync_transport "https://github.com/kubernetes-client/python/blob/master/kubernetes/client/rest.py"
click node_sync_response "https://github.com/kubernetes-client/python/blob/master/kubernetes/client/api_response.py"
click node_async_api "https://github.com/kubernetes-client/python/tree/master/kubernetes/aio/client/api"
click node_async_core "https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/api_client.py"
click node_async_response "https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/api_response.py"
click node_async_config "https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/configuration.py"
click node_sync_models "https://github.com/kubernetes-client/python/blob/master/kubernetes/client/models/v1_api_group.py"
click node_async_models "https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/models/v1_api_group.py"
click node_dynamic "https://github.com/kubernetes-client/python/blob/master/kubernetes/dynamic/client.py"
click node_discovery "https://github.com/kubernetes-client/python/blob/master/kubernetes/dynamic/discovery.py"
click node_resource "https://github.com/kubernetes-client/python/blob/master/kubernetes/dynamic/resource.py"
click node_watch "https://github.com/kubernetes-client/python/blob/master/kubernetes/watch/watch.py"
click node_informer "https://github.com/kubernetes-client/python/blob/master/kubernetes/informer/informer.py"
click node_cache "https://github.com/kubernetes-client/python/blob/master/kubernetes/informer/cache.py"
click node_stream "https://github.com/kubernetes-client/python/blob/master/kubernetes/stream/stream.py"
click node_yaml "https://github.com/kubernetes-client/python/blob/master/kubernetes/utils/create_from_yaml.py"
click node_config "https://github.com/kubernetes-client/python/tree/master/kubernetes/config"
click node_async_config_load "https://github.com/kubernetes-client/python/tree/master/kubernetes/aio/config"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_sync_api,node_sync_core,node_sync_transport,node_sync_response,node_async_api,node_async_core,node_async_response,node_async_config toneBlue
class node_dynamic,node_discovery,node_resource,node_watch,node_informer,node_cache,node_stream,node_yaml toneAmber
class node_sync_models,node_async_models toneMint
class node_config,node_async_config_load toneRose
class node_app toneIndigo
```

## Components

### API clients

- [Sync API groups](https://github.com/kubernetes-client/python/tree/master/kubernetes/client/api): `kubernetes/client/api`
- [Sync API client](https://github.com/kubernetes-client/python/blob/master/kubernetes/client/api_client.py): `kubernetes/client/api_client.py`
- [Sync HTTP transport](https://github.com/kubernetes-client/python/blob/master/kubernetes/client/rest.py): `kubernetes/client/rest.py`
- [Sync response](https://github.com/kubernetes-client/python/blob/master/kubernetes/client/api_response.py): `kubernetes/client/api_response.py`
- [Async API groups](https://github.com/kubernetes-client/python/tree/master/kubernetes/aio/client/api): `kubernetes/aio/client/api`
- [Async API client](https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/api_client.py): `kubernetes/aio/client/api_client.py`
- [Async response](https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/api_response.py): `kubernetes/aio/client/api_response.py`
- [Async settings](https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/configuration.py): `kubernetes/aio/client/configuration.py`

### Runtime features

- [Dynamic resources](https://github.com/kubernetes-client/python/blob/master/kubernetes/dynamic/client.py): `kubernetes/dynamic/client.py`
- [Resource discovery](https://github.com/kubernetes-client/python/blob/master/kubernetes/dynamic/discovery.py): `kubernetes/dynamic/discovery.py`
- [Resource operations](https://github.com/kubernetes-client/python/blob/master/kubernetes/dynamic/resource.py): `kubernetes/dynamic/resource.py`
- [Watch streams](https://github.com/kubernetes-client/python/blob/master/kubernetes/watch/watch.py): `kubernetes/watch/watch.py`
- [Informers](https://github.com/kubernetes-client/python/blob/master/kubernetes/informer/informer.py): `kubernetes/informer/informer.py`
- [Informer cache](https://github.com/kubernetes-client/python/blob/master/kubernetes/informer/cache.py): `kubernetes/informer/cache.py`
- [Exec streaming](https://github.com/kubernetes-client/python/blob/master/kubernetes/stream/stream.py): `kubernetes/stream/stream.py`
- [YAML resources](https://github.com/kubernetes-client/python/blob/master/kubernetes/utils/create_from_yaml.py): `kubernetes/utils/create_from_yaml.py`

### Typed data

- [Sync models](https://github.com/kubernetes-client/python/blob/master/kubernetes/client/models/v1_api_group.py): `kubernetes/client/models/v1_api_group.py`
- [Async models](https://github.com/kubernetes-client/python/blob/master/kubernetes/aio/client/models/v1_api_group.py): `kubernetes/aio/client/models/v1_api_group.py`

### Configuration

- [Cluster configuration](https://github.com/kubernetes-client/python/tree/master/kubernetes/config): `kubernetes/config`
- [Async kube config](https://github.com/kubernetes-client/python/tree/master/kubernetes/aio/config): `kubernetes/aio/config`

### Other components

- **Python application**

## Connections

- Python application → Sync API groups: invokes
- Python application → Async API groups: invokes
- Python application → Cluster configuration: loads config
- Python application → Async kube config: loads config
- Sync API groups → Sync API client: calls (evidence: `kubernetes/client/api/storagemigration_v1_api.py`)
- Sync API client → Sync HTTP transport: uses transport (evidence: `kubernetes/client/api_client.py`)
- Sync API client → Sync response: builds response (evidence: `kubernetes/client/api_client.py`)
- Sync API groups → Sync models: serializes models (evidence: `kubernetes/client/api/storagemigration_v1_api.py`)
- Async API groups → Async API client: calls (evidence: `kubernetes/aio/client/api/storagemigration_v1_api.py`)
- Async API client → Async response: builds response (evidence: `kubernetes/aio/client/api_client.py`)
- Async API groups → Async models: uses models (evidence: `kubernetes/aio/client/api/storagemigration_v1_api.py`)
- Async API client → Async settings: reads settings (evidence: `kubernetes/aio/client/api_client.py`)
- Dynamic resources → Resource discovery: creates discoverer (evidence: `kubernetes/dynamic/client.py`)
- Dynamic resources → Resource operations: uses resources (evidence: `kubernetes/dynamic/client.py`)
- Informers → Watch streams: consumes events (evidence: `kubernetes/informer/informer.py`)
- Informers → Informer cache: updates cache (evidence: `kubernetes/informer/informer.py`)
- YAML resources → Dynamic resources: uses dynamic client (evidence: `kubernetes/utils/create_from_yaml.py`)
- Exec streaming → Sync HTTP transport: uses REST
