Skip to main content

prefect_kubernetes.deployments

Module for interacting with Kubernetes deployments from Prefect flows.

Functions

create_namespaced_deployment

Create a Kubernetes deployment in a given namespace. Args:
  • kubernetes_credentials: KubernetesCredentials block for creating authenticated Kubernetes API clients.
  • new_deployment: A Kubernetes V1Deployment specification.
  • namespace: The Kubernetes namespace to create this deployment in.
  • **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API.
Returns:
  • A Kubernetes V1Deployment object.

delete_namespaced_deployment

Delete a Kubernetes deployment in a given namespace. Args:
  • kubernetes_credentials: KubernetesCredentials block for creating authenticated Kubernetes API clients.
  • deployment_name: The name of the deployment to delete.
  • delete_options: A Kubernetes V1DeleteOptions object.
  • namespace: The Kubernetes namespace to delete this deployment from.
  • **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API.
Returns:
  • A Kubernetes V1Deployment object.

list_namespaced_deployment

List all deployments in a given namespace. Args:
  • kubernetes_credentials: KubernetesCredentials block for creating authenticated Kubernetes API clients.
  • namespace: The Kubernetes namespace to list deployments from.
  • **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API.
Returns:
  • A Kubernetes V1DeploymentList object.

patch_namespaced_deployment

Patch a Kubernetes deployment in a given namespace. Args:
  • kubernetes_credentials: KubernetesCredentials block for creating authenticated Kubernetes API clients.
  • deployment_name: The name of the deployment to patch.
  • deployment_updates: A Kubernetes V1Deployment object.
  • namespace: The Kubernetes namespace to patch this deployment in.
  • **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API.
Returns:
  • A Kubernetes V1Deployment object.

read_namespaced_deployment

Read information on a Kubernetes deployment in a given namespace. Args:
  • kubernetes_credentials: KubernetesCredentials block for creating authenticated Kubernetes API clients.
  • deployment_name: The name of the deployment to read.
  • namespace: The Kubernetes namespace to read this deployment from.
  • **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API.
Returns:
  • A Kubernetes V1Deployment object.

replace_namespaced_deployment

Replace a Kubernetes deployment in a given namespace. Args:
  • kubernetes_credentials: KubernetesCredentials block for creating authenticated Kubernetes API clients.
  • deployment_name: The name of the deployment to replace.
  • new_deployment: A Kubernetes V1Deployment object.
  • namespace: The Kubernetes namespace to replace this deployment in.
  • **kube_kwargs: Optional extra keyword arguments to pass to the Kubernetes API.
Returns:
  • A Kubernetes V1Deployment object.