Prefect integrations for interacting with Kubernetes.
Project description
prefect-kubernetes
Welcome!
prefect-kubernetes
is a collection of Prefect tasks, flows, and blocks enabling orchestration, observation and management of Kubernetes resources.
Jump to examples.
Getting Started
Python setup
Requires an installation of Python 3.7+.
We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the Prefect documentation.
Installation
Install prefect-kubernetes
with pip
:
pip install prefect-kubernetes
Then, to register blocks on Prefect Cloud:
prefect block register -m prefect_kubernetes
Note, to use the load
method on Blocks, you must already have a block document saved through code or saved through the UI.
Example Usage
Use with_options
to customize options on any existing task or flow
from prefect_kubernetes.flows import run_namespaced_job
customized_run_namespaced_job = run_namespaced_job.with_options(
name="My flow running a Kubernetes Job",
retries=2,
retry_delay_seconds=10,
) # this is now a new flow object that can be called
For more tips on how to use tasks and flows in a Collection, check out Using Collections!
Specify and run a Kubernetes Job from a yaml file
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.flows import run_namespaced_job # this is a flow
from prefect_kubernetes.jobs import KubernetesJob
k8s_creds = KubernetesCredentials.load("k8s-creds")
job = KubernetesJob.from_yaml_file( # or create in the UI with a dict manifest
credentials=k8s_creds,
manifest_path="path/to/job.yaml",
)
job.save("my-k8s-job", overwrite=True)
if __name__ == "__main__":
# run the flow
run_namespaced_job(job)
Generate a resource-specific client from KubernetesClusterConfig
# with minikube / docker desktop & a valid ~/.kube/config this should ~just work~™️
from prefect.blocks.kubernetes import KubernetesClusterConfig
from prefect_kubernetes.credentials import KubernetesCredentials
k8s_config = KubernetesClusterConfig.from_file('~/.kube/config')
k8s_credentials = KubernetesCredentials(cluster_config=k8s_config)
with k8s_credentials.get_client("core") as v1_core_client:
for namespace in v1_core_client.list_namespace().items:
print(namespace.metadata.name)
List jobs in a specific namespace
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.jobs import list_namespaced_job
@flow
def kubernetes_orchestrator():
v1_job_list = list_namespaced_job(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
namespace="my-namespace",
)
Patch an existing deployment
from kubernetes.client.models import V1Deployment
from prefect import flow
from prefect_kubernetes.credentials import KubernetesCredentials
from prefect_kubernetes.deployments import patch_namespaced_deployment
from prefect_kubernetes.utilities import convert_manifest_to_model
@flow
def kubernetes_orchestrator():
v1_deployment_updates = convert_manifest_to_model(
manifest="path/to/manifest.yaml",
v1_model_name="V1Deployment",
)
v1_deployment = patch_namespaced_deployment(
kubernetes_credentials=KubernetesCredentials.load("k8s-creds"),
deployment_name="my-deployment",
deployment_updates=v1_deployment_updates,
namespace="my-namespace"
)
Resources
If you encounter any bugs while using prefect-kubernetes
, feel free to open an issue in the prefect-kubernetes repository.
If you have any questions or issues while using prefect-kubernetes
, you can find help in either the Prefect Discourse forum or the Prefect Slack community.
Feel free to ⭐️ or watch prefect-kubernetes
for updates too!
Development
If you'd like to install a version of prefect-kubernetes
for development, clone the repository and perform an editable install with pip
:
git clone https://github.com/PrefectHQ/prefect-kubernetes.git
cd prefect-kubernetes/
pip install -e ".[dev]"
# Install linting pre-commit hooks
pre-commit install
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for prefect_kubernetes-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8856989cf86a8c3b8d860f55b8e661bedd28f2c65b4dac00191dbad05b200b0 |
|
MD5 | 2a744cedfaba6663fc989f1f2e378095 |
|
BLAKE2b-256 | db8b611e71d23c22baf6535c8a418043e4ea58f00ef68cfaac2b145e76917776 |