PrefectDeployment.md

API Reference

Packages:

• prefect.io/v1

prefect.io/v1

Resource Types:

• PrefectDeployment

PrefectDeployment

^{↩ Parent}

PrefectDeployment is the Schema for the prefectdeployments API

Name	Type	Description	Required
apiVersion	string	prefect.io/v1	true
kind	string	PrefectDeployment	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	PrefectDeploymentSpec defines the desired state of a PrefectDeployment	false
status	object	PrefectDeploymentStatus defines the observed state of PrefectDeployment	false

PrefectDeployment.spec

^{↩ Parent}

PrefectDeploymentSpec defines the desired state of a PrefectDeployment

Name	Type	Description	Required
deployment	object	Deployment configuration defining the Prefect deployment	true
server	object	Server configuration for connecting to Prefect API	true
workPool	object	WorkPool configuration specifying where the deployment should run	true

PrefectDeployment.spec.deployment

^{↩ Parent}

Deployment configuration defining the Prefect deployment

Name	Type	Description	Required
entrypoint	string	Entrypoint is the entrypoint for the flow (e.g., "my_code.py:my_function")	true
concurrencyLimit	integer	ConcurrencyLimit limits concurrent runs of this deployment	false
description	string	Description is a human-readable description of the deployment	false
enforceParameterSchema	boolean	EnforceParameterSchema determines if parameter schema should be enforced	false
globalConcurrencyLimit	object	GlobalConcurrencyLimit references a global concurrency limit	false
jobVariables	object	JobVariables are variables passed to the infrastructure	false
labels	map[string]string	Labels are key-value pairs for additional metadata	false
parameterOpenApiSchema	object	ParameterOpenApiSchema defines the OpenAPI schema for flow parameters	false
parameters	object	Parameters are default parameters for flow runs	false
path	string	Path is the path to the flow code	false
paused	boolean	Paused indicates if the deployment is paused	false
pullSteps	[]object	PullSteps defines steps to retrieve the flow code	false
schedules	[]object	Schedules defines when the deployment should run	false
tags	[]string	Tags are labels for organizing and filtering deployments	false
versionInfo	object	VersionInfo describes the deployment version	false

PrefectDeployment.spec.deployment.globalConcurrencyLimit

^{↩ Parent}

GlobalConcurrencyLimit references a global concurrency limit

Name	Type	Description	Required
name	string	Name is the name of the global concurrency limit	true
active	boolean	Active indicates if the limit is active	false
collisionStrategy	string	CollisionStrategy defines behavior when limit is exceeded	false
limit	integer	Limit is the concurrency limit value	false
slotDecayPerSecond	string	SlotDecayPerSecond defines how quickly slots are released	false

PrefectDeployment.spec.deployment.schedules[index]

^{↩ Parent}

PrefectSchedule defines a schedule for the deployment

Name	Type	Description	Required
schedule	object	Schedule defines the schedule configuration	true
slug	string	Slug is a unique identifier for the schedule	true

PrefectDeployment.spec.deployment.schedules[index].schedule

^{↩ Parent}

Schedule defines the schedule configuration

Name	Type	Description	Required
active	boolean	Active indicates if the schedule is active	false
anchorDate	string	AnchorDate is the anchor date for the schedule	false
interval	integer	Interval is the schedule interval in seconds	false
maxScheduledRuns	integer	MaxScheduledRuns limits the number of scheduled runs	false
timezone	string	Timezone for the schedule	false

PrefectDeployment.spec.deployment.versionInfo

^{↩ Parent}

VersionInfo describes the deployment version

Name	Type	Description	Required
type	string	Type is the version type (e.g., "git")	false
version	string	Version is the version string	false

PrefectDeployment.spec.server

^{↩ Parent}

Server configuration for connecting to Prefect API

Name	Type	Description	Required
accountId	string	AccountID is the ID of the account to use to connect to Prefect Cloud	false
apiKey	object	APIKey is the API key to use to connect to a remote Prefect Server	false
name	string	Name is the name of the in-cluster Prefect Server in the given namespace	false
namespace	string	Namespace is the namespace where the in-cluster Prefect Server is running	false
remoteApiUrl	string	RemoteAPIURL is the API URL for the remote Prefect Server. Set if using with an external Prefect Server or Prefect Cloud	false
workspaceId	string	WorkspaceID is the ID of the workspace to use to connect to Prefect Cloud	false

PrefectDeployment.spec.server.apiKey

^{↩ Parent}

APIKey is the API key to use to connect to a remote Prefect Server

Name	Type	Description	Required
value	string	Value is the literal value of the API key	false
valueFrom	object	ValueFrom is a reference to a secret containing the API key	false

PrefectDeployment.spec.server.apiKey.valueFrom

^{↩ Parent}

ValueFrom is a reference to a secret containing the API key

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
fileKeyRef	object	FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

PrefectDeployment.spec.server.apiKey.valueFrom.configMapKeyRef

^{↩ Parent}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Default:	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

PrefectDeployment.spec.server.apiKey.valueFrom.fieldRef

^{↩ Parent}

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

PrefectDeployment.spec.server.apiKey.valueFrom.fileKeyRef

^{↩ Parent}

FileKeyRef selects a key of the env file. Requires the EnvFiles feature gate to be enabled.

Name	Type	Description	Required
key	string	The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.	true
path	string	The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.	true
volumeName	string	The name of the volume mount containing the env file.	true
optional	boolean	Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers. If optional is set to false and the specified key does not exist, an error will be returned during Pod creation. Default: false	false

PrefectDeployment.spec.server.apiKey.valueFrom.resourceFieldRef

^{↩ Parent}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

PrefectDeployment.spec.server.apiKey.valueFrom.secretKeyRef

^{↩ Parent}

Selects a key of a secret in the pod's namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Default:	false
optional	boolean	Specify whether the Secret or its key must be defined	false

PrefectDeployment.spec.workPool

^{↩ Parent}

WorkPool configuration specifying where the deployment should run

Name	Type	Description	Required
name	string	Name is the name of the work pool	true
namespace	string	Namespace is the namespace containing the work pool	false
workQueue	string	WorkQueue is the specific work queue within the work pool	false

PrefectDeployment.status

^{↩ Parent}

PrefectDeploymentStatus defines the observed state of PrefectDeployment

Name	Type	Description	Required
ready	boolean	Ready indicates that the deployment exists and is configured correctly	true
conditions	[]object	Conditions store the status conditions of the PrefectDeployment instances	false
flowId	string	FlowId is the flow ID from Prefect	false
id	string	Id is the deployment ID from Prefect	false
lastSyncTime	string	LastSyncTime is the last time the deployment was synced with Prefect Format: date-time	false
observedGeneration	integer	ObservedGeneration tracks the last processed generation Format: int64	false
specHash	string	SpecHash tracks changes to the spec to minimize API calls	false

PrefectDeployment.status.conditions[index]

^{↩ Parent}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false