Skip to content

Latest commit

 

History

History
8880 lines (7835 loc) · 276 KB

PrefectServer.md

File metadata and controls

8880 lines (7835 loc) · 276 KB

API Reference

Packages:

prefect.io/v1

Resource Types:

PrefectServer

↩ Parent

PrefectServer is the Schema for the prefectservers API

Name Type Description Required
apiVersion string prefect.io/v1 true
kind string PrefectServer true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object PrefectServerSpec defines the desired state of a PrefectServer

Validations:
  • !has(self.replicas) || self.replicas <= 1 || (has(self.postgres) && !has(self.sqlite)): replicas > 1 is only supported with the postgres backend alone (the controller prefers sqlite when both are set, and sqlite/ephemeral use node-local storage and must run a single replica)
  • false
    status object PrefectServerStatus defines the observed state of PrefectServer
    false

    PrefectServer.spec

    ↩ Parent

    PrefectServerSpec defines the desired state of a PrefectServer

    Name Type Description Required
    affinity object Affinity defines the scheduling affinity/anti-affinity for the Prefect Server Deployment. Only node affinity is applied to the migration Job.
    false
    deploymentLabels map[string]string DeploymentLabels defines additional labels to add to the server Deployment
    false
    deploymentTemplate object DeploymentTemplate is a partial pod template, with metadata and spec like a Deployment's spec.template, applied to the pod template of the Prefect Server Deployment as a Kubernetes strategic merge patch. It is applied after the other fields, so it wins over them. Containers are matched by name; the stable names are "prefect-server" and, with the PostgreSQL backend, the init container "wait-for-database". The operator puts back any override of the fields it depends on: the selector labels, the "api" port, the "prefect-data" volume and its mounts, and the environment variables it derives from the other fields. It doesn't affect the migration Job; see MigrationJobTemplate.
    false
    ephemeral object Ephemeral defines whether the Prefect Server will be deployed with an ephemeral storage backend
    false
    extraArgs []string ExtraArgs defines additional arguments to pass to the Prefect Server Deployment
    false
    extraContainers []object ExtraContainers defines additional containers to add to the Prefect Server Deployment
    false
    extraServicePorts []object ExtraServicePorts defines additional ports to expose on the Prefect Server Service
    false
    host string Host defines the host address to bind the Prefect Server to. Defaults to "0.0.0.0" for IPv4 compatibility. Use "" (empty string) to bind to all interfaces for IPv6-only or dual-stack environments. Note: Prefect does not accept "::" as a valid host value.
    false
    image string Image defines the exact image to deploy for the Prefect Server, overriding Version
    false
    migrationJobLabels map[string]string MigrationJobLabels defines additional labels to add to the migration Job
    false
    migrationJobTemplate object MigrationJobTemplate is a partial pod template, with metadata and spec like a Job's spec.template, applied to the pod template of the PostgreSQL migration Job as a Kubernetes strategic merge patch. It is applied after the other fields, so it wins over them. Containers are matched by name; the stable names are "prefect-server-migration" and the init container "wait-for-database". The operator puts back any override of the Job's labels and the environment variables it derives from the other fields. Changing it starts a new migration Job.
    false
    nodeSelector map[string]string NodeSelector defines the node selector for the Prefect Server Deployment and migration Job
    false
    postgres object Postgres defines whether the server will be deployed with a PostgreSQL backend connecting to the database with the provided connection information
    false
    redis object Redis defines whether the server will be deployed with a Redis message broker
    false
    replicas integer Replicas defines the number of Prefect Server Deployment replicas (Postgres backend only; sqlite/ephemeral must run a single replica). Defaults to 1.

    Format: int32
    false
    resources object Resources defines the CPU and memory resources for each replica of the Prefect Server
    false
    serviceLabels map[string]string ServiceLabels defines additional labels to add to the server Service
    false
    settings []object A list of environment variables to set on the Prefect Server
    false
    sqlite object SQLite defines whether the server will be deployed with a SQLite backend with persistent volume storage
    false
    tolerations []object Tolerations allow the Prefect Server Deployment and migration Job pods to be scheduled onto nodes with matching taints.
    false
    version string Version defines the version of the Prefect Server to deploy
    false

    PrefectServer.spec.affinity

    ↩ Parent

    Affinity defines the scheduling affinity/anti-affinity for the Prefect Server Deployment. Only node affinity is applied to the migration Job.

    Name Type Description Required
    nodeAffinity object Describes node affinity scheduling rules for the pod.
    false
    podAffinity object Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
    false
    podAntiAffinity object Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
    false

    PrefectServer.spec.affinity.nodeAffinity

    ↩ Parent

    Describes node affinity scheduling rules for the pod.

    Name Type Description Required
    preferredDuringSchedulingIgnoredDuringExecution []object The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
    false
    requiredDuringSchedulingIgnoredDuringExecution object If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
    false

    PrefectServer.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

    ↩ Parent

    An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

    Name Type Description Required
    preference object A node selector term, associated with the corresponding weight.
    true
    weight integer Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

    Format: int32
    true

    PrefectServer.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

    ↩ Parent

    A node selector term, associated with the corresponding weight.

    Name Type Description Required
    matchExpressions []object A list of node selector requirements by node's labels.
    false
    matchFields []object A list of node selector requirements by node's fields.
    false

    PrefectServer.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

    ↩ Parent

    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string The label key that the selector applies to.
    true
    operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
    true
    values []string An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

    ↩ Parent

    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string The label key that the selector applies to.
    true
    operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
    true
    values []string An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

    ↩ Parent

    If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

    Name Type Description Required
    nodeSelectorTerms []object Required. A list of node selector terms. The terms are ORed.
    true

    PrefectServer.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

    ↩ Parent

    A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

    Name Type Description Required
    matchExpressions []object A list of node selector requirements by node's labels.
    false
    matchFields []object A list of node selector requirements by node's fields.
    false

    PrefectServer.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

    ↩ Parent

    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string The label key that the selector applies to.
    true
    operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
    true
    values []string An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

    ↩ Parent

    A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string The label key that the selector applies to.
    true
    operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
    true
    values []string An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAffinity

    ↩ Parent

    Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

    Name Type Description Required
    preferredDuringSchedulingIgnoredDuringExecution []object The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
    false
    requiredDuringSchedulingIgnoredDuringExecution []object If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
    false

    PrefectServer.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

    ↩ Parent

    The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

    Name Type Description Required
    podAffinityTerm object Required. A pod affinity term, associated with the corresponding weight.
    true
    weight integer weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

    Format: int32
    true

    PrefectServer.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

    ↩ Parent

    Required. A pod affinity term, associated with the corresponding weight.

    Name Type Description Required
    topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
    true
    labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    false
    matchLabelKeys []string MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    false
    mismatchLabelKeys []string MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    false
    namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    false
    namespaces []string namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    false

    PrefectServer.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

    ↩ Parent

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

    ↩ Parent

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

    ↩ Parent

    Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

    Name Type Description Required
    topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
    true
    labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    false
    matchLabelKeys []string MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    false
    mismatchLabelKeys []string MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    false
    namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    false
    namespaces []string namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    false

    PrefectServer.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

    ↩ Parent

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

    ↩ Parent

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAntiAffinity

    ↩ Parent

    Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

    Name Type Description Required
    preferredDuringSchedulingIgnoredDuringExecution []object The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
    false
    requiredDuringSchedulingIgnoredDuringExecution []object If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
    false

    PrefectServer.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

    ↩ Parent

    The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

    Name Type Description Required
    podAffinityTerm object Required. A pod affinity term, associated with the corresponding weight.
    true
    weight integer weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

    Format: int32
    true

    PrefectServer.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

    ↩ Parent

    Required. A pod affinity term, associated with the corresponding weight.

    Name Type Description Required
    topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
    true
    labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    false
    matchLabelKeys []string MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    false
    mismatchLabelKeys []string MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    false
    namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    false
    namespaces []string namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    false

    PrefectServer.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

    ↩ Parent

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

    ↩ Parent

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

    ↩ Parent

    Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

    Name Type Description Required
    topologyKey string This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
    true
    labelSelector object A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
    false
    matchLabelKeys []string MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set.
    false
    mismatchLabelKeys []string MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
    false
    namespaceSelector object A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.
    false
    namespaces []string namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
    false

    PrefectServer.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

    ↩ Parent

    A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

    ↩ Parent

    A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces.

    Name Type Description Required
    matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
    false
    matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    false

    PrefectServer.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

    ↩ Parent

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    Name Type Description Required
    key string key is the label key that the selector applies to.
    true
    operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    true
    values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    false

    PrefectServer.spec.extraContainers[index]

    ↩ Parent

    A single application container that you want to run within a pod.

    Name Type Description Required
    name string Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
    true
    args []string Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    false
    command []string Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
    false
    env []object List of environment variables to set in the container. Cannot be updated.
    false
    envFrom []object List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
    false
    image string Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
    false
    imagePullPolicy string Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
    false
    lifecycle object Actions that the management system should take in response to container lifecycle events. Cannot be updated.
    false
    livenessProbe object Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    false
    ports []object List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See kubernetes/kubernetes#108255. Cannot be updated.
    false
    readinessProbe object Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    false
    resizePolicy []object Resources resize policy for the container. This field cannot be set on ephemeral containers.
    false
    resources object Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    false
    restartPolicy string RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Additionally, setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
    false
    restartPolicyRules []object Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining rules are ignored. If no rule matches the container exit condition, the Container-level restart policy determines the whether the container is restarted or not. Constraints on the rules: - At most 20 rules are allowed. - Rules can have the same action. - Identical rules are not forbidden in validations. When rules are specified, container MUST set RestartPolicy explicitly even it if matches the Pod's RestartPolicy.
    false
    securityContext object SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
    false
    startupProbe object StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
    false
    stdin boolean Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
    false
    stdinOnce boolean Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
    false
    terminationMessagePath string Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
    false
    terminationMessagePolicy string Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
    false
    tty boolean Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
    false
    volumeDevices []object volumeDevices is the list of block devices to be used by the container.
    false
    volumeMounts []object Pod volumes to mount into the container's filesystem. Cannot be updated.
    false
    workingDir string Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
    false

    PrefectServer.spec.extraContainers[index].env[index]

    ↩ Parent

    EnvVar represents an environment variable present in a Container.

    Name Type Description Required
    name string Name of the environment variable. May consist of any printable ASCII characters except '='.
    true
    value string Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
    false
    valueFrom object Source for the environment variable's value. Cannot be used if value is not empty.
    false

    PrefectServer.spec.extraContainers[index].env[index].valueFrom

    ↩ Parent

    Source for the environment variable's value. Cannot be used if value is not empty.

    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

    PrefectServer.spec.extraContainers[index].env[index].valueFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.extraContainers[index].env[index].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

    PrefectServer.spec.extraContainers[index].env[index].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

    PrefectServer.spec.extraContainers[index].env[index].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

    PrefectServer.spec.extraContainers[index].env[index].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

    PrefectServer.spec.extraContainers[index].envFrom[index]

    ↩ Parent

    EnvFromSource represents the source of a set of ConfigMaps or Secrets

    Name Type Description Required
    configMapRef object The ConfigMap to select from
    false
    prefix string Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.
    false
    secretRef object The Secret to select from
    false

    PrefectServer.spec.extraContainers[index].envFrom[index].configMapRef

    ↩ Parent

    The ConfigMap to select from

    Name Type Description Required
    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 must be defined
    false

    PrefectServer.spec.extraContainers[index].envFrom[index].secretRef

    ↩ Parent

    The Secret to select from

    Name Type Description Required
    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 must be defined
    false

    PrefectServer.spec.extraContainers[index].lifecycle

    ↩ Parent

    Actions that the management system should take in response to container lifecycle events. Cannot be updated.

    Name Type Description Required
    postStart object PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
    false
    preStop object PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
    false
    stopSignal string StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods with a non-empty .spec.os.name
    false

    PrefectServer.spec.extraContainers[index].lifecycle.postStart

    ↩ Parent

    PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

    Name Type Description Required
    exec object Exec specifies a command to execute in the container.
    false
    httpGet object HTTPGet specifies an HTTP GET request to perform.
    false
    sleep object Sleep represents a duration that the container should sleep.
    false
    tcpSocket object Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
    false

    PrefectServer.spec.extraContainers[index].lifecycle.postStart.exec

    ↩ Parent

    Exec specifies a command to execute in the container.

    Name Type Description Required
    command []string Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    false

    PrefectServer.spec.extraContainers[index].lifecycle.postStart.httpGet

    ↩ Parent

    HTTPGet specifies an HTTP GET request to perform.

    Name Type Description Required
    port int or string Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
    false
    httpHeaders []object Custom headers to set in the request. HTTP allows repeated headers.
    false
    path string Path to access on the HTTP server.
    false
    protocol string Protocol selects the wire protocol for the probe connection. Nil defaults to HTTP/1.1.
    false
    scheme string Scheme to use for connecting to the host. Defaults to HTTP.
    false

    PrefectServer.spec.extraContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

    ↩ Parent

    HTTPHeader describes a custom header to be used in HTTP probes

    Name Type Description Required
    name string The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
    true
    value string The header field value
    true

    PrefectServer.spec.extraContainers[index].lifecycle.postStart.sleep

    ↩ Parent

    Sleep represents a duration that the container should sleep.

    Name Type Description Required
    seconds integer Seconds is the number of seconds to sleep.

    Format: int64
    true

    PrefectServer.spec.extraContainers[index].lifecycle.postStart.tcpSocket

    ↩ Parent

    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

    Name Type Description Required
    port int or string Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Optional: Host name to connect to, defaults to the pod IP.
    false

    PrefectServer.spec.extraContainers[index].lifecycle.preStop

    ↩ Parent

    PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

    Name Type Description Required
    exec object Exec specifies a command to execute in the container.
    false
    httpGet object HTTPGet specifies an HTTP GET request to perform.
    false
    sleep object Sleep represents a duration that the container should sleep.
    false
    tcpSocket object Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.
    false

    PrefectServer.spec.extraContainers[index].lifecycle.preStop.exec

    ↩ Parent

    Exec specifies a command to execute in the container.

    Name Type Description Required
    command []string Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    false

    PrefectServer.spec.extraContainers[index].lifecycle.preStop.httpGet

    ↩ Parent

    HTTPGet specifies an HTTP GET request to perform.

    Name Type Description Required
    port int or string Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
    false
    httpHeaders []object Custom headers to set in the request. HTTP allows repeated headers.
    false
    path string Path to access on the HTTP server.
    false
    protocol string Protocol selects the wire protocol for the probe connection. Nil defaults to HTTP/1.1.
    false
    scheme string Scheme to use for connecting to the host. Defaults to HTTP.
    false

    PrefectServer.spec.extraContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

    ↩ Parent

    HTTPHeader describes a custom header to be used in HTTP probes

    Name Type Description Required
    name string The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
    true
    value string The header field value
    true

    PrefectServer.spec.extraContainers[index].lifecycle.preStop.sleep

    ↩ Parent

    Sleep represents a duration that the container should sleep.

    Name Type Description Required
    seconds integer Seconds is the number of seconds to sleep.

    Format: int64
    true

    PrefectServer.spec.extraContainers[index].lifecycle.preStop.tcpSocket

    ↩ Parent

    Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for backward compatibility. There is no validation of this field and lifecycle hooks will fail at runtime when it is specified.

    Name Type Description Required
    port int or string Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Optional: Host name to connect to, defaults to the pod IP.
    false

    PrefectServer.spec.extraContainers[index].livenessProbe

    ↩ Parent

    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Name Type Description Required
    exec object Exec specifies a command to execute in the container.
    false
    failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    Format: int32
    false
    grpc object GRPC specifies a GRPC HealthCheckRequest.
    false
    httpGet object HTTPGet specifies an HTTP GET request to perform.
    false
    initialDelaySeconds integer Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Format: int32
    false
    periodSeconds integer How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    Format: int32
    false
    successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    Format: int32
    false
    tcpSocket object TCPSocket specifies a connection to a TCP port.
    false
    terminationGracePeriodSeconds integer Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    Format: int64
    false
    timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Format: int32
    false

    PrefectServer.spec.extraContainers[index].livenessProbe.exec

    ↩ Parent

    Exec specifies a command to execute in the container.

    Name Type Description Required
    command []string Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    false

    PrefectServer.spec.extraContainers[index].livenessProbe.grpc

    ↩ Parent

    GRPC specifies a GRPC HealthCheckRequest.

    Name Type Description Required
    port integer Port number of the gRPC service. Number must be in the range 1 to 65535.

    Format: int32
    true
    mode string mode specifies the connection mode for the gRPC health probe. Set to "TLS" to use TLS without certificate verification. Set to "Plaintext" to use a plaintext (insecure) connection explicitly. If not specified, the probe uses a plaintext (insecure) connection.
    false
    service string Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    Default:

    false

    PrefectServer.spec.extraContainers[index].livenessProbe.httpGet

    ↩ Parent

    HTTPGet specifies an HTTP GET request to perform.

    Name Type Description Required
    port int or string Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
    false
    httpHeaders []object Custom headers to set in the request. HTTP allows repeated headers.
    false
    path string Path to access on the HTTP server.
    false
    protocol string Protocol selects the wire protocol for the probe connection. Nil defaults to HTTP/1.1.
    false
    scheme string Scheme to use for connecting to the host. Defaults to HTTP.
    false

    PrefectServer.spec.extraContainers[index].livenessProbe.httpGet.httpHeaders[index]

    ↩ Parent

    HTTPHeader describes a custom header to be used in HTTP probes

    Name Type Description Required
    name string The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
    true
    value string The header field value
    true

    PrefectServer.spec.extraContainers[index].livenessProbe.tcpSocket

    ↩ Parent

    TCPSocket specifies a connection to a TCP port.

    Name Type Description Required
    port int or string Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Optional: Host name to connect to, defaults to the pod IP.
    false

    PrefectServer.spec.extraContainers[index].ports[index]

    ↩ Parent

    ContainerPort represents a network port in a single container.

    Name Type Description Required
    containerPort integer Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

    Format: int32
    true
    hostIP string What host IP to bind the external port to.
    false
    hostPort integer Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

    Format: int32
    false
    name string If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
    false
    protocol string Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

    Default: TCP
    false

    PrefectServer.spec.extraContainers[index].readinessProbe

    ↩ Parent

    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Name Type Description Required
    exec object Exec specifies a command to execute in the container.
    false
    failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    Format: int32
    false
    grpc object GRPC specifies a GRPC HealthCheckRequest.
    false
    httpGet object HTTPGet specifies an HTTP GET request to perform.
    false
    initialDelaySeconds integer Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Format: int32
    false
    periodSeconds integer How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    Format: int32
    false
    successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    Format: int32
    false
    tcpSocket object TCPSocket specifies a connection to a TCP port.
    false
    terminationGracePeriodSeconds integer Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    Format: int64
    false
    timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Format: int32
    false

    PrefectServer.spec.extraContainers[index].readinessProbe.exec

    ↩ Parent

    Exec specifies a command to execute in the container.

    Name Type Description Required
    command []string Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    false

    PrefectServer.spec.extraContainers[index].readinessProbe.grpc

    ↩ Parent

    GRPC specifies a GRPC HealthCheckRequest.

    Name Type Description Required
    port integer Port number of the gRPC service. Number must be in the range 1 to 65535.

    Format: int32
    true
    mode string mode specifies the connection mode for the gRPC health probe. Set to "TLS" to use TLS without certificate verification. Set to "Plaintext" to use a plaintext (insecure) connection explicitly. If not specified, the probe uses a plaintext (insecure) connection.
    false
    service string Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    Default:

    false

    PrefectServer.spec.extraContainers[index].readinessProbe.httpGet

    ↩ Parent

    HTTPGet specifies an HTTP GET request to perform.

    Name Type Description Required
    port int or string Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
    false
    httpHeaders []object Custom headers to set in the request. HTTP allows repeated headers.
    false
    path string Path to access on the HTTP server.
    false
    protocol string Protocol selects the wire protocol for the probe connection. Nil defaults to HTTP/1.1.
    false
    scheme string Scheme to use for connecting to the host. Defaults to HTTP.
    false

    PrefectServer.spec.extraContainers[index].readinessProbe.httpGet.httpHeaders[index]

    ↩ Parent

    HTTPHeader describes a custom header to be used in HTTP probes

    Name Type Description Required
    name string The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
    true
    value string The header field value
    true

    PrefectServer.spec.extraContainers[index].readinessProbe.tcpSocket

    ↩ Parent

    TCPSocket specifies a connection to a TCP port.

    Name Type Description Required
    port int or string Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Optional: Host name to connect to, defaults to the pod IP.
    false

    PrefectServer.spec.extraContainers[index].resizePolicy[index]

    ↩ Parent

    ContainerResizePolicy represents resource resize policy for the container.

    Name Type Description Required
    resourceName string Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
    true
    restartPolicy string Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
    true

    PrefectServer.spec.extraContainers[index].resources

    ↩ Parent

    Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    Name Type Description Required
    claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This field depends on the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    false
    limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    false
    requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    false

    PrefectServer.spec.extraContainers[index].resources.claims[index]

    ↩ Parent

    ResourceClaim references one entry in PodSpec.ResourceClaims.

    Name Type Description Required
    name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
    true
    request string Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
    false

    PrefectServer.spec.extraContainers[index].restartPolicyRules[index]

    ↩ Parent

    ContainerRestartRule describes how a container exit is handled.

    Name Type Description Required
    action string Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.
    true
    exitCodes object Represents the exit codes to check on container exits.
    false

    PrefectServer.spec.extraContainers[index].restartPolicyRules[index].exitCodes

    ↩ Parent

    Represents the exit codes to check on container exits.

    Name Type Description Required
    operator string Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of specified values. - NotIn: the requirement is satisfied if the container exit code is not in the set of specified values.
    true
    values []integer Specifies the set of values to check for container exit codes. At most 255 elements are allowed.
    false

    PrefectServer.spec.extraContainers[index].securityContext

    ↩ Parent

    SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

    Name Type Description Required
    allowPrivilegeEscalation boolean AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.
    false
    appArmorProfile object appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.
    false
    capabilities object The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.
    false
    privileged boolean Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
    false
    procMount string procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. Note that this field cannot be set when spec.os.name is windows.
    false
    readOnlyRootFilesystem boolean Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
    false
    runAsGroup integer The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    Format: int64
    false
    runAsNonRoot boolean Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    false
    runAsUser integer The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    Format: int64
    false
    seLinuxOptions object The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
    false
    seccompProfile object The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.
    false
    windowsOptions object The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.
    false

    PrefectServer.spec.extraContainers[index].securityContext.appArmorProfile

    ↩ Parent

    appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.

    Name Type Description Required
    type string type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement.
    true
    localhostProfile string localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost".
    false

    PrefectServer.spec.extraContainers[index].securityContext.capabilities

    ↩ Parent

    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

    Name Type Description Required
    add []string Added capabilities
    false
    drop []string Removed capabilities
    false

    PrefectServer.spec.extraContainers[index].securityContext.seLinuxOptions

    ↩ Parent

    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

    Name Type Description Required
    level string Level is SELinux level label that applies to the container.
    false
    role string Role is a SELinux role label that applies to the container.
    false
    type string Type is a SELinux type label that applies to the container.
    false
    user string User is a SELinux user label that applies to the container.
    false

    PrefectServer.spec.extraContainers[index].securityContext.seccompProfile

    ↩ Parent

    The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

    Name Type Description Required
    type string type indicates which kind of seccomp profile will be applied. Valid options are:

    Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

    true
    localhostProfile string localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.
    false

    PrefectServer.spec.extraContainers[index].securityContext.windowsOptions

    ↩ Parent

    The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

    Name Type Description Required
    gmsaCredentialSpec string GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
    false
    gmsaCredentialSpecName string GMSACredentialSpecName is the name of the GMSA credential spec to use.
    false
    hostProcess boolean HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.
    false
    runAsUserName string The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
    false

    PrefectServer.spec.extraContainers[index].startupProbe

    ↩ Parent

    StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Name Type Description Required
    exec object Exec specifies a command to execute in the container.
    false
    failureThreshold integer Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    Format: int32
    false
    grpc object GRPC specifies a GRPC HealthCheckRequest.
    false
    httpGet object HTTPGet specifies an HTTP GET request to perform.
    false
    initialDelaySeconds integer Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Format: int32
    false
    periodSeconds integer How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    Format: int32
    false
    successThreshold integer Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    Format: int32
    false
    tcpSocket object TCPSocket specifies a connection to a TCP port.
    false
    terminationGracePeriodSeconds integer Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    Format: int64
    false
    timeoutSeconds integer Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    Format: int32
    false

    PrefectServer.spec.extraContainers[index].startupProbe.exec

    ↩ Parent

    Exec specifies a command to execute in the container.

    Name Type Description Required
    command []string Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
    false

    PrefectServer.spec.extraContainers[index].startupProbe.grpc

    ↩ Parent

    GRPC specifies a GRPC HealthCheckRequest.

    Name Type Description Required
    port integer Port number of the gRPC service. Number must be in the range 1 to 65535.

    Format: int32
    true
    mode string mode specifies the connection mode for the gRPC health probe. Set to "TLS" to use TLS without certificate verification. Set to "Plaintext" to use a plaintext (insecure) connection explicitly. If not specified, the probe uses a plaintext (insecure) connection.
    false
    service string Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

    If this is not specified, the default behavior is defined by gRPC.

    Default:

    false

    PrefectServer.spec.extraContainers[index].startupProbe.httpGet

    ↩ Parent

    HTTPGet specifies an HTTP GET request to perform.

    Name Type Description Required
    port int or string Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
    false
    httpHeaders []object Custom headers to set in the request. HTTP allows repeated headers.
    false
    path string Path to access on the HTTP server.
    false
    protocol string Protocol selects the wire protocol for the probe connection. Nil defaults to HTTP/1.1.
    false
    scheme string Scheme to use for connecting to the host. Defaults to HTTP.
    false

    PrefectServer.spec.extraContainers[index].startupProbe.httpGet.httpHeaders[index]

    ↩ Parent

    HTTPHeader describes a custom header to be used in HTTP probes

    Name Type Description Required
    name string The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
    true
    value string The header field value
    true

    PrefectServer.spec.extraContainers[index].startupProbe.tcpSocket

    ↩ Parent

    TCPSocket specifies a connection to a TCP port.

    Name Type Description Required
    port int or string Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
    true
    host string Optional: Host name to connect to, defaults to the pod IP.
    false

    PrefectServer.spec.extraContainers[index].volumeDevices[index]

    ↩ Parent

    volumeDevice describes a mapping of a raw block device within a container.

    Name Type Description Required
    devicePath string devicePath is the path inside of the container that the device will be mapped to.
    true
    name string name must match the name of a persistentVolumeClaim in the pod
    true

    PrefectServer.spec.extraContainers[index].volumeMounts[index]

    ↩ Parent

    VolumeMount describes a mounting of a Volume within a container.

    Name Type Description Required
    mountPath string Path within the container at which the volume should be mounted.
    true
    name string This must match the Name of a Volume.
    true
    bindMountOptions []string bindMountOptions is the list of additional bind mount options to apply when mounting this volume into the container. Allowed values are noexec, nodev, and nosuid. These are Linux mount options and have no effect on Windows nodes. This field is not supported with image volumes. This is an alpha field and requires enabling the VolumeBindMountOptions feature gate.
    false
    mountPropagation string mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).
    false
    readOnly boolean Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
    false
    recursiveReadOnly string RecursiveReadOnly specifies whether read-only mounts should be handled recursively.

    If ReadOnly is false, this field has no meaning and must be unspecified.

    If ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.

    If this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).

    If this field is not specified, it is treated as an equivalent of Disabled.

    false
    subPath string Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
    false
    subPathExpr string Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
    false

    PrefectServer.spec.extraServicePorts[index]

    ↩ Parent

    ServicePort contains information on service's port.

    Name Type Description Required
    port integer The port that will be exposed by this service.

    Format: int32
    true
    appProtocol string The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: false
    name string The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
    false
    nodePort integer The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

    Format: int32
    false
    protocol string The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

    Default: TCP
    false
    targetPort int or string Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
    false

    PrefectServer.spec.postgres

    ↩ Parent

    Postgres defines whether the server will be deployed with a PostgreSQL backend connecting to the database with the provided connection information

    Name Type Description Required
    database string
    false
    databaseFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    host string
    false
    hostFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    password string
    false
    passwordFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    port integer
    false
    portFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    user string
    false
    userFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    waitForDatabaseImage string WaitForDatabaseImage defines the image used by init containers to wait for PostgreSQL. The image must include pg_isready. Defaults to "postgres:16-alpine".
    false

    PrefectServer.spec.postgres.databaseFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.postgres.databaseFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.postgres.databaseFrom.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

    PrefectServer.spec.postgres.databaseFrom.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

    PrefectServer.spec.postgres.databaseFrom.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

    PrefectServer.spec.postgres.databaseFrom.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

    PrefectServer.spec.postgres.hostFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.postgres.hostFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.postgres.hostFrom.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

    PrefectServer.spec.postgres.hostFrom.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

    PrefectServer.spec.postgres.hostFrom.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

    PrefectServer.spec.postgres.hostFrom.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

    PrefectServer.spec.postgres.passwordFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.postgres.passwordFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.postgres.passwordFrom.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

    PrefectServer.spec.postgres.passwordFrom.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

    PrefectServer.spec.postgres.passwordFrom.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

    PrefectServer.spec.postgres.passwordFrom.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

    PrefectServer.spec.postgres.portFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.postgres.portFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.postgres.portFrom.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

    PrefectServer.spec.postgres.portFrom.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

    PrefectServer.spec.postgres.portFrom.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

    PrefectServer.spec.postgres.portFrom.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

    PrefectServer.spec.postgres.userFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.postgres.userFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.postgres.userFrom.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

    PrefectServer.spec.postgres.userFrom.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

    PrefectServer.spec.postgres.userFrom.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

    PrefectServer.spec.postgres.userFrom.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

    PrefectServer.spec.redis

    ↩ Parent

    Redis defines whether the server will be deployed with a Redis message broker

    Name Type Description Required
    database integer
    false
    databaseFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    host string
    false
    hostFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    leaseStorage boolean LeaseStorage defines whether the server also stores concurrency-limit leases in this Redis (PREFECT_SERVER_CONCURRENCY_LEASE_STORAGE = prefect_redis.lease_storage), so leases are shared across server replicas instead of held in each replica's memory. Requires an image whose prefect-redis ships the lease_storage module; defaults to false to keep older images working.
    false
    password string
    false
    passwordFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    port integer
    false
    portFrom object EnvVarSource represents a source for the value of an EnvVar.
    false
    username string
    false
    usernameFrom object EnvVarSource represents a source for the value of an EnvVar.
    false

    PrefectServer.spec.redis.databaseFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.redis.databaseFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.redis.databaseFrom.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

    PrefectServer.spec.redis.databaseFrom.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

    PrefectServer.spec.redis.databaseFrom.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

    PrefectServer.spec.redis.databaseFrom.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

    PrefectServer.spec.redis.hostFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.redis.hostFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.redis.hostFrom.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

    PrefectServer.spec.redis.hostFrom.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

    PrefectServer.spec.redis.hostFrom.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

    PrefectServer.spec.redis.hostFrom.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

    PrefectServer.spec.redis.passwordFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.redis.passwordFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.redis.passwordFrom.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

    PrefectServer.spec.redis.passwordFrom.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

    PrefectServer.spec.redis.passwordFrom.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

    PrefectServer.spec.redis.passwordFrom.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

    PrefectServer.spec.redis.portFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.redis.portFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.redis.portFrom.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

    PrefectServer.spec.redis.portFrom.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

    PrefectServer.spec.redis.portFrom.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

    PrefectServer.spec.redis.portFrom.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

    PrefectServer.spec.redis.usernameFrom

    ↩ Parent

    EnvVarSource represents a source for the value of an EnvVar.

    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

    PrefectServer.spec.redis.usernameFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.redis.usernameFrom.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

    PrefectServer.spec.redis.usernameFrom.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

    PrefectServer.spec.redis.usernameFrom.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

    PrefectServer.spec.redis.usernameFrom.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

    PrefectServer.spec.resources

    ↩ Parent

    Resources defines the CPU and memory resources for each replica of the Prefect Server

    Name Type Description Required
    claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This field depends on the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

    false
    limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    false
    requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
    false

    PrefectServer.spec.resources.claims[index]

    ↩ Parent

    ResourceClaim references one entry in PodSpec.ResourceClaims.

    Name Type Description Required
    name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
    true
    request string Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
    false

    PrefectServer.spec.settings[index]

    ↩ Parent

    EnvVar represents an environment variable present in a Container.

    Name Type Description Required
    name string Name of the environment variable. May consist of any printable ASCII characters except '='.
    true
    value string Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
    false
    valueFrom object Source for the environment variable's value. Cannot be used if value is not empty.
    false

    PrefectServer.spec.settings[index].valueFrom

    ↩ Parent

    Source for the environment variable's value. Cannot be used if value is not empty.

    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

    PrefectServer.spec.settings[index].valueFrom.configMapKeyRef

    ↩ Parent

    Selects a key of a ConfigMap.

    Name Type Description Required
    key string The key to select from the ConfigMap's Data field. Keys in the BinaryData field are not currently propagated to container env vars.
    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

    PrefectServer.spec.settings[index].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

    PrefectServer.spec.settings[index].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

    PrefectServer.spec.settings[index].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

    PrefectServer.spec.settings[index].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

    PrefectServer.spec.sqlite

    ↩ Parent

    SQLite defines whether the server will be deployed with a SQLite backend with persistent volume storage

    Name Type Description Required
    size int or string Size is the requested size of the PersistentVolumeClaim storing the `prefect.db`
    false
    storageClassName string StorageClassName is the name of the StorageClass of the PersistentVolumeClaim storing the SQLite database
    false

    PrefectServer.spec.tolerations[index]

    ↩ Parent

    The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

    Name Type Description Required
    effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
    false
    key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
    false
    operator string Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).
    false
    tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

    Format: int64
    false
    value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
    false

    PrefectServer.status

    ↩ Parent

    PrefectServerStatus defines the observed state of PrefectServer

    Name Type Description Required
    ready boolean Ready indicates that the PrefectServer is ready to serve requests
    true
    version string Version is the version of the PrefectServer that is currently running
    true
    conditions []object Conditions store the status conditions of the PrefectServer instances
    false

    PrefectServer.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