prefect_kubernetes.credentials
¶
Module for defining Kubernetes credential handling and client generation.
KubernetesClusterConfig
¶
Bases: Block
Stores configuration for interaction with Kubernetes clusters.
See from_file
for creation.
Attributes:
Name | Type | Description |
---|---|---|
config |
Dict
|
The entire loaded YAML contents of a kubectl config file |
context_name |
str
|
The name of the kubectl context to use |
Example
Load a saved Kubernetes cluster config:
from prefect_kubernetes.credentials import import KubernetesClusterConfig
cluster_config_block = KubernetesClusterConfig.load("BLOCK_NAME")
Source code in prefect_kubernetes/credentials.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
|
configure_client
async
¶
Activates this cluster configuration by loading the configuration into the Kubernetes Python client. After calling this, Kubernetes API clients can use this config's context.
Source code in prefect_kubernetes/credentials.py
122 123 124 125 126 127 128 129 130 |
|
from_file
classmethod
¶
Create a cluster config from the a Kubernetes config file.
By default, the current context in the default Kubernetes config file will be used.
An alternative file or context may be specified.
The entire config file will be loaded and stored.
Source code in prefect_kubernetes/credentials.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
|
get_api_client
async
¶
Returns a Kubernetes API client for this cluster config.
Source code in prefect_kubernetes/credentials.py
114 115 116 117 118 119 120 |
|
KubernetesCredentials
¶
Bases: Block
Credentials block for generating configured Kubernetes API clients.
Attributes:
Name | Type | Description |
---|---|---|
cluster_config |
Optional[KubernetesClusterConfig]
|
A |
Example
Load stored Kubernetes credentials:
from prefect_kubernetes.credentials import KubernetesCredentials
kubernetes_credentials = KubernetesCredentials.load("BLOCK_NAME")
Source code in prefect_kubernetes/credentials.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
|
get_client
async
¶
Convenience method for retrieving a Kubernetes API client for deployment resources.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
client_type |
Literal['apps', 'batch', 'core', 'custom_objects']
|
The resource-specific type of Kubernetes client to retrieve. |
required |
Yields:
Type | Description |
---|---|
AsyncGenerator[KubernetesClient, None]
|
An authenticated, resource-specific Kubernetes API client. |
Example
from prefect_kubernetes.credentials import KubernetesCredentials
async with KubernetesCredentials.get_client("core") as core_v1_client:
pods = await core_v1_client.list_namespaced_pod()
for pod in pods.items:
print(pod.metadata.name)
Source code in prefect_kubernetes/credentials.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
|
get_resource_specific_client
async
¶
Utility function for configuring a generic Kubernetes client. It will attempt to connect to a Kubernetes cluster in three steps with the first successful connection attempt becoming the mode of communication with a cluster:
-
It will first attempt to use a
KubernetesCredentials
block'scluster_config
to configure a client usingKubernetesClusterConfig.configure_client
. -
Attempt in-cluster connection (will only work when running on a pod).
-
Attempt out-of-cluster connection using the default location for a kube config file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
client_type |
str
|
The Kubernetes API client type for interacting with specific Kubernetes resources. |
required |
Returns:
Name | Type | Description |
---|---|---|
KubernetesClient |
Union[AppsV1Api, BatchV1Api, CoreV1Api]
|
An authenticated, resource-specific Kubernetes Client. |
Raises:
Type | Description |
---|---|
ValueError
|
If |
Source code in prefect_kubernetes/credentials.py
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
|