prefect.blocks.kubernetes
¶
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.blocks.kubernetes import KubernetesClusterConfig
cluster_config_block = KubernetesClusterConfig.load("BLOCK_NAME")
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 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 |
|
configure_client
¶
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 /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
100 101 102 103 104 105 106 107 108 |
|
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 /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
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 |
|
get_api_client
¶
Returns a Kubernetes API client for this cluster config.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/blocks/kubernetes.py
92 93 94 95 96 97 98 |
|