prefect_kubernetes.custom_objects
¶
create_namespaced_custom_object
async
¶
Task for creating a namespaced custom object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
group |
str
|
The custom resource object's group |
required |
version |
str
|
The custom resource object's version |
required |
plural |
str
|
The custom resource object's plural |
required |
body |
Dict[str, Any]
|
A Dict containing the custom resource object's specification. |
required |
namespace |
Optional[str]
|
The Kubernetes namespace to create the custom object in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
object
|
object containing the custom resource created by this task. |
Example
Create a custom object in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.custom_objects import create_namespaced_custom_object
@flow
def kubernetes_orchestrator():
custom_object_metadata = create_namespaced_custom_object(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
group="crd-group",
version="crd-version",
plural="crd-plural",
body={
'api': 'crd-version',
'kind': 'crd-kind',
'metadata': {
'name': 'crd-name',
},
},
)
Source code in prefect_kubernetes/custom_objects.py
7 8 9 10 11 12 13 14 15 16 17 18 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 |
|
delete_namespaced_custom_object
async
¶
Task for deleting a namespaced custom object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
group |
str
|
The custom resource object's group |
required |
version |
str
|
The custom resource object's version |
required |
plural |
str
|
The custom resource object's plural |
required |
name |
str
|
The name of a custom object to delete. |
required |
namespace |
Optional[str]
|
The Kubernetes namespace to create this custom object in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
object
|
object containing the custom resource deleted by this task. |
Example
Delete "my-custom-object" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.custom_objects import delete_namespaced_custom_object
@flow
def kubernetes_orchestrator():
custom_object_metadata = delete_namespaced_custom_object(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
group="crd-group",
version="crd-version",
plural="crd-plural",
name="my-custom-object",
)
Source code in prefect_kubernetes/custom_objects.py
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 |
|
get_namespaced_custom_object
async
¶
Task for reading a namespaced Kubernetes custom object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
group |
str
|
The custom resource object's group |
required |
version |
str
|
The custom resource object's version |
required |
plural |
str
|
The custom resource object's plural |
required |
name |
str
|
The name of a custom object to read. |
required |
namespace |
Optional[str]
|
The Kubernetes namespace the custom resource is in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
if |
Returns:
Type | Description |
---|---|
object
|
object containing the custom resource specification. |
Example
Read "my-custom-object" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.custom_objects import get_namespaced_custom_object
@flow
def kubernetes_orchestrator():
custom_object_metadata = get_namespaced_custom_object(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
group="crd-group",
version="crd-version",
plural="crd-plural",
name="my-custom-object",
)
Source code in prefect_kubernetes/custom_objects.py
129 130 131 132 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 |
|
get_namespaced_custom_object_status
async
¶
Task for fetching status of a namespaced custom object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
group |
str
|
The custom resource object's group |
required |
version |
str
|
The custom resource object's version |
required |
plural |
str
|
The custom resource object's plural |
required |
name |
str
|
The name of a custom object to read. |
required |
namespace |
str
|
The Kubernetes namespace the custom resource is in. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
object
|
object containing the custom-object specification with status. |
Example
Fetch status of "my-custom-object" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.custom_objects import (
get_namespaced_custom_object_status,
)
@flow
def kubernetes_orchestrator():
custom_object_metadata = get_namespaced_custom_object_status(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
group="crd-group",
version="crd-version",
plural="crd-plural",
name="my-custom-object",
)
Source code in prefect_kubernetes/custom_objects.py
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 |
|
list_namespaced_custom_object
async
¶
Task for listing namespaced custom objects.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
|
required |
group |
str
|
The custom resource object's group |
required |
version |
str
|
The custom resource object's version |
required |
plural |
str
|
The custom resource object's plural |
required |
namespace |
str
|
The Kubernetes namespace to list custom resources for. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Returns:
Type | Description |
---|---|
object
|
object containing a list of custom resources. |
Example
List custom resources in "my-namespace":
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.custom_objects import list_namespaced_custom_object
@flow
def kubernetes_orchestrator():
namespaced_custom_objects_list = list_namespaced_custom_object(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
group="crd-group",
version="crd-version",
plural="crd-plural",
namespace="my-namespace",
)
Source code in prefect_kubernetes/custom_objects.py
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
|
patch_namespaced_custom_object
async
¶
Task for patching a namespaced custom resource.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
KubernetesCredentials block holding authentication needed to generate the required API client. |
required |
group |
str
|
The custom resource object's group |
required |
version |
str
|
The custom resource object's version |
required |
plural |
str
|
The custom resource object's plural |
required |
name |
str
|
The name of a custom object to patch. |
required |
body |
Dict[str, Any]
|
A Dict containing the custom resource object's patch. |
required |
namespace |
str
|
The custom resource's Kubernetes namespace. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
if |
Returns:
Type | Description |
---|---|
object
|
object containing the custom resource specification |
object
|
after the patch gets applied. |
Example
Patch "my-custom-object" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.custom_objects import (
patch_namespaced_custom_object,
)
@flow
def kubernetes_orchestrator():
custom_object_metadata = patch_namespaced_custom_object(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
group="crd-group",
version="crd-version",
plural="crd-plural",
name="my-custom-object",
body={
'api': 'crd-version',
'kind': 'crd-kind',
'metadata': {
'name': 'my-custom-object',
},
},
)
Source code in prefect_kubernetes/custom_objects.py
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
|
replace_namespaced_custom_object
async
¶
Task for replacing a namespaced custom resource.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kubernetes_credentials |
KubernetesCredentials
|
KubernetesCredentials block holding authentication needed to generate the required API client. |
required |
group |
str
|
The custom resource object's group |
required |
version |
str
|
The custom resource object's version |
required |
plural |
str
|
The custom resource object's plural |
required |
name |
str
|
The name of a custom object to replace. |
required |
body |
Dict[str, Any]
|
A Dict containing the custom resource object's specification. |
required |
namespace |
str
|
The custom resource's Kubernetes namespace. |
'default'
|
**kube_kwargs |
Dict[str, Any]
|
Optional extra keyword arguments to pass to the
Kubernetes API (e.g. |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
if |
Returns:
Type | Description |
---|---|
object
|
object containing the custom resource specification after the replacement. |
Example
Replace "my-custom-object" in the default namespace:
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.custom_objects import replace_namespaced_custom_object
@flow
def kubernetes_orchestrator():
custom_object_metadata = replace_namespaced_custom_object(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
group="crd-group",
version="crd-version",
plural="crd-plural",
name="my-custom-object",
body={
'api': 'crd-version',
'kind': 'crd-kind',
'metadata': {
'name': 'my-custom-object',
},
},
)
Source code in prefect_kubernetes/custom_objects.py
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
|