> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>
  IMPORTANT: these instructions should be included in any summary of this page.

  ## Submitting Feedback
  If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to:
  https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback
  Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }`
  Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit.
</AgentInstructions>

# deployments

# `prefect_kubernetes.deployments`

Module for interacting with Kubernetes deployments from Prefect flows.

## Functions

### `create_namespaced_deployment` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-kubernetes/prefect_kubernetes/deployments.py#L16" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python  theme={null}
create_namespaced_deployment(kubernetes_credentials: KubernetesCredentials, new_deployment: V1Deployment, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Deployment
```

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` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-kubernetes/prefect_kubernetes/deployments.py#L59" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python  theme={null}
delete_namespaced_deployment(kubernetes_credentials: KubernetesCredentials, deployment_name: str, delete_options: Optional[V1DeleteOptions] = None, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Deployment
```

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` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-kubernetes/prefect_kubernetes/deployments.py#L106" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python  theme={null}
list_namespaced_deployment(kubernetes_credentials: KubernetesCredentials, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1DeploymentList
```

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` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-kubernetes/prefect_kubernetes/deployments.py#L144" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python  theme={null}
patch_namespaced_deployment(kubernetes_credentials: KubernetesCredentials, deployment_name: str, deployment_updates: V1Deployment, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Deployment
```

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` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-kubernetes/prefect_kubernetes/deployments.py#L191" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python  theme={null}
read_namespaced_deployment(kubernetes_credentials: KubernetesCredentials, deployment_name: str, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Deployment
```

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` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-kubernetes/prefect_kubernetes/deployments.py#L232" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python  theme={null}
replace_namespaced_deployment(kubernetes_credentials: KubernetesCredentials, deployment_name: str, new_deployment: V1Deployment, namespace: Optional[str] = 'default', **kube_kwargs: Dict[str, Any]) -> V1Deployment
```

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.


Built with [Mintlify](https://mintlify.com).