+ 
-
+
-
-Latest Release: {{< param operatorVersion >}}
-
-# Production Postgres Made Easy
-
-[PGO](https://github.com/CrunchyData/postgres-operator), the [Postgres Operator]((https://github.com/CrunchyData/postgres-operator)) from [Crunchy Data](https://www.crunchydata.com), gives you a **declarative Postgres** solution that automatically manages your [PostgreSQL](https://www.postgresql.org) clusters.
-
-Designed for your GitOps workflows, it is [easy to get started]({{< relref "quickstart/_index.md" >}}) with Postgres on Kubernetes with PGO. Within a few moments, you can have a production grade Postgres cluster complete with high availability, disaster recovery, and monitoring, all over secure TLS communications.Even better, PGO lets you easily customize your Postgres cluster to tailor it to your workload!
-
-With conveniences like cloning Postgres clusters to using rolling updates to roll out disruptive changes with minimal downtime, PGO is ready to support your Postgres data at every stage of your release pipeline. Built for resiliency and uptime, PGO will keep your desired Postgres in a desired state so you do not need to worry about it.
-
-PGO is developed with many years of production experience in automating Postgres management on Kubernetes, providing a seamless cloud native Postgres solution to keep your data always available.
-
-## Supported Platforms
-
-PGO, the Postgres Operator from Crunchy Data, is tested on the following platforms:
-
-- Kubernetes 1.22-1.25
-- OpenShift 4.8-4.11
-- Rancher
-- Google Kubernetes Engine (GKE), including Anthos
-- Amazon EKS
-- Microsoft AKS
-- VMware Tanzu
-
-This list only includes the platforms that the Postgres Operator is specifically
-tested on as part of the release process. PGO works on other
-[CNCF Certified Kubernetes](https://www.cncf.io/certification/software-conformance/)
-distributions as well.
-
-The PGO Postgres Operator project source code is available subject to the [Apache 2.0 license](https://raw.githubusercontent.com/CrunchyData/postgres-operator/master/LICENSE.md) with the PGO logo and branding assets covered by [our trademark guidelines](/logos/TRADEMARKS.md).
diff --git a/docs/content/architecture/_index.md b/docs/content/architecture/_index.md
deleted file mode 100644
index 452f695c33..0000000000
--- a/docs/content/architecture/_index.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: "Architecture"
-date:
-draft: false
-weight: 40
----
diff --git a/docs/content/architecture/backups.md b/docs/content/architecture/backups.md
deleted file mode 100644
index 02e5f80883..0000000000
--- a/docs/content/architecture/backups.md
+++ /dev/null
@@ -1,83 +0,0 @@
----
-title: "Backup Management"
-date:
-draft: false
-weight: 120
----
-
-When using the PostgreSQL Operator, the answer to the question "do you take
-backups of your database" is automatically "yes!"
-
-The PostgreSQL Operator uses the open source
-[pgBackRest](https://pgbackrest.org) backup and restore utility that is designed
-for working with databases that are many terabytes in size. As described in the
-[tutorial]({{< relref "/tutorial/backups.md" >}}), pgBackRest is enabled by
-default as it permits the PostgreSQL Operator to automate some advanced as well
-as convenient behaviors, including:
-
-- Efficient provisioning of new replicas that are added to the PostgreSQL
-cluster
-- Preventing replicas from falling out of sync from the PostgreSQL primary by
-allowing them to replay old WAL logs
-- Allowing failed primaries to automatically and efficiently heal using the
-"delta restore" feature
-- Serving as the basis for the cluster cloning feature
-- ...and of course, allowing for one to take full, differential, and incremental
-backups and perform full and point-in-time restores
-
-Below is one example of how PGO manages backups with both a local storage and a Amazon S3 configuration.
-
-
-
-The PostgreSQL Operator leverages a pgBackRest repository to facilitate the
-usage of the pgBackRest features in a PostgreSQL cluster. When a new PostgreSQL
-cluster is created, it simultaneously creates a pgBackRest repository.
-
-You can store your pgBackRest backups in up to four different locations and using four different storage types:
-
-- Any Kubernetes supported storage class
-- Amazon S3 (or S3 equivalents like MinIO)
-- Google Cloud Storage (GCS)
-- Azure Blob Storage
-
-PostgreSQL is automatically configured to use the `pgbackrest archive-push` command
-to archive the write-ahead log (WAL) in all repositories.
-
-## Backups
-
-PGO supports three types of pgBackRest backups:
-
-- Full: A full backup of all the contents of the PostgreSQL cluster
-- Differential: A backup of only the files that have changed since the last full backup
-- Incremental: A backup of only the files that have changed since the last full, differential, or incremental backup
-
-## Scheduling Backups
-
-Any effective disaster recovery strategy includes having regularly scheduled
-backups. PGO enables this by managing a series of Kubernetes CronJobs to ensure that backups are executed at scheduled times.
-
-Note that pgBackRest presently only supports taking one backup at a time. This may change in a future release, but for the time being we suggest that you stagger your backup times.
-
-Please see the [backup management tutorial]({{< relref "/tutorial/backup-management.md" >}}) for how to set up backup schedules
-and configure retention policies.
-
-## Restores
-
-The PostgreSQL Operator supports the ability to perform a full restore on a
-PostgreSQL cluster as well as a point-in-time-recovery. There are two types of
-ways to restore a cluster:
-
-- Restore to a new cluster
-- Restore in-place
-
-For examples of this, please see the [disaster recovery tutorial]({{< relref "/tutorial/disaster-recovery.md" >}})
-
-## Deleting a Backup
-
-{{% notice warning %}}
-If you delete a backup that is *not* set to expire, you may be unable to meet
-your retention requirements. If you are deleting backups to free space, it is
-recommended to delete your oldest backups first.
-{{% /notice %}}
-
-A backup can be deleted by running the [`pgbackrest expire`](https://pgbackrest.org/command.html#command-expire) command directly on the pgBackRest repository Pod or a Postgres instance.
diff --git a/docs/content/architecture/disaster-recovery.md b/docs/content/architecture/disaster-recovery.md
deleted file mode 100644
index 70b9a241e8..0000000000
--- a/docs/content/architecture/disaster-recovery.md
+++ /dev/null
@@ -1,113 +0,0 @@
----
-title: "Disaster Recovery"
-date:
-draft: false
-weight: 140
----
-
-Advanced high-availability and disaster recovery strategies involve spreading
-your database clusters across multiple data centers to help maximize uptime.
-In Kubernetes, this technique is known as "[federation](https://en.wikipedia.org/wiki/Federation_(information_technology))".
-Federated Kubernetes clusters can communicate with each other,
-coordinate changes, and provide resiliency for applications that have high
-uptime requirements.
-
-As of this writing, federation in Kubernetes is still in ongoing development
-and is something we monitor with intense interest. As Kubernetes federation
-continues to mature, we wanted to provide a way to deploy PostgreSQL clusters
-managed by the [PostgreSQL Operator](https://www.crunchydata.com/developers/download-postgres/containers/postgres-operator)
-that can span multiple Kubernetes clusters.
-
-At a high-level, the PostgreSQL Operator follows the "active-standby" data
-center deployment model for managing the PostgreSQL clusters across Kubernetes
-clusters. In one Kubernetes cluster, the PostgreSQL Operator deploys PostgreSQL as an
-"active" PostgreSQL cluster, which means it has one primary and one-or-more
-replicas. In another Kubernetes cluster, the PostgreSQL cluster is deployed as
-a "standby" cluster: every PostgreSQL instance is a replica.
-
-A side-effect of this is that in each of the Kubernetes clusters, the PostgreSQL
-Operator can be used to deploy both active and standby PostgreSQL clusters,
-allowing you to mix and match! While the mixing and matching may not be ideal for
-how you deploy your PostgreSQL clusters, it does allow you to perform online
-moves of your PostgreSQL data to different Kubernetes clusters as well as manual
-online upgrades.
-
-Lastly, while this feature does extend high-availability, promoting a standby
-cluster to an active cluster is **not** automatic. While the PostgreSQL clusters
-within a Kubernetes cluster support self-managed high-availability, a
-cross-cluster deployment requires someone to promote the cluster
-from standby to active.
-
-## Standby Cluster Overview
-
-Standby PostgreSQL clusters are managed like any other PostgreSQL cluster that the PostgreSQL
-Operator manages. For example, adding replicas to a standby cluster is identical to adding them to a
-primary cluster.
-
-The main difference between a primary and standby cluster is that there is no primary instance on
-the standby: one PostgreSQL instance is reading in the database changes from either the backup
-repository or via streaming replication, while other instances are replicas of it.
-
-Any replicas created in the standby cluster are known as cascading replicas, i.e., replicas
-replicating from a database server that itself is replicating from another database server. More
-information about [cascading replication](https://www.postgresql.org/docs/current/warm-standby.html#CASCADING-REPLICATION)
-can be found in the PostgreSQL documentation.
-
-Because standby clusters are effectively read-only, certain functionality
-that involves making changes to a database, e.g., PostgreSQL user changes, is
-blocked while a cluster is in standby mode. Additionally, backups and restores
-are blocked as well. While [pgBackRest](https://pgbackrest.org/) supports
-backups from standbys, this requires direct access to the primary database,
-which cannot be done until the PostgreSQL Operator supports Kubernetes
-federation.
-
-### Types of Standby Clusters
-There are three ways to deploy a standby cluster with the Postgres Operator.
-
-#### Repo-based Standby
-
-A repo-based standby will connect to a pgBackRest repo stored in an external storage system
-(S3, GCS, Azure Blob Storage, or any other Kubernetes storage system that can span multiple
-clusters). The standby cluster will receive WAL files from the repo and will apply those to the
-database.
-
-
-
-#### Streaming Standby
-
-A streaming standby relies on an authenticated connection to the primary over the network. The
-standby will receive WAL records directly from the primary as they are generated.
-
-
-
-#### Streaming Standby with an External Repo
-
-You can also configure the operator to create a cluster that takes advantage of both methods. The
-standby cluster will bootstrap from the pgBackRest repo and continue to receive WAL files as they
-are pushed to the repo. The cluster will also directly connect to primary and receive WAL records
-as they are generated. Using a repo while also streaming ensures that your cluster will still be up
-to date with the pgBackRest repo if streaming falls behind.
-
-
-
-For creating a standby Postgres cluster with PGO, please see the [disaster recovery tutorial]({{< relref "tutorial/disaster-recovery.md" >}}#standby-cluster)
-
-### Promoting a Standby Cluster
-
-There comes a time when a standby cluster needs to be promoted to an active cluster. Promoting a
-standby cluster means that the standby leader PostgreSQL instance will become a primary and start
-accepting both reads and writes. This has the net effect of pushing WAL (transaction archives) to
-the pgBackRest repository. Before doing this, we need to ensure we don't accidentally create a split-brain
-scenario.
-
-If you are promoting the standby while the primary is still running, i.e., if this is not a disaster
-scenario, you will want to [shutdown the active PostgreSQL cluster]({{< relref "tutorial/administrative-tasks.md" >}}#shutdown).
-
-The standby can be promoted once the primary is inactive, e.g., is either `shutdown` or failing.
-This process essentially removes the standby configuration from the Kubernetes cluster’s DCS, which
-triggers the promotion of the current standby leader to a primary PostgreSQL instance. You can view
-this promotion in the PostgreSQL standby leader's (soon to be active leader's) logs.
-
-Once the former standby cluster has been successfully promoted to an active PostgreSQL cluster,
-the original active PostgreSQL cluster can be safely [deleted]({{< relref "tutorial/delete-cluster.md" >}})
-and [recreated as a standby cluster]({{< relref "tutorial/disaster-recovery" >}}#standby-cluster).
diff --git a/docs/content/architecture/high-availability.md b/docs/content/architecture/high-availability.md
deleted file mode 100644
index f33f619525..0000000000
--- a/docs/content/architecture/high-availability.md
+++ /dev/null
@@ -1,211 +0,0 @@
----
-title: "High Availability"
-date:
-draft: false
-weight: 110
----
-
-One of the great things about PostgreSQL is its reliability: it is very stable
-and typically "just works." However, there are certain things that can happen in
-the environment that PostgreSQL is deployed in that can affect its uptime,
-including:
-
-- The database storage disk fails or some other hardware failure occurs
-- The network on which the database resides becomes unreachable
-- The host operating system becomes unstable and crashes
-- A key database file becomes corrupted
-- A data center is lost
-
-There may also be downtime events that are due to the normal case of operations,
-such as performing a minor upgrade, security patching of operating system,
-hardware upgrade, or other maintenance.
-
-Fortunately, PGO, the Postgres Operator from Crunchy Data, is prepared for this.
-
-
-
-The Crunchy PostgreSQL Operator supports a distributed-consensus based
-high availability (HA) system that keeps its managed PostgreSQL clusters up and
-running, even if the PostgreSQL Operator disappears. Additionally, it leverages
-Kubernetes specific features such as
-[Pod Anti-Affinity](#how-the-crunchy-postgresql-operator-uses-pod-anti-affinity)
-to limit the surface area that could lead to a PostgreSQL cluster becoming
-unavailable. The PostgreSQL Operator also supports automatic healing of failed
-primaries and leverages the efficient pgBackRest "delta restore" method, which
-eliminates the need to fully reprovision a failed cluster!
-
-The Crunchy PostgreSQL Operator also maintains high availability during a
-routine task such as a PostgreSQL minor version upgrade.
-
-For workloads that are sensitive to transaction loss, PGO supports PostgreSQL synchronous replication.
-
-The high availability backing for your PostgreSQL cluster is only as good as
-your high availability backing for Kubernetes. To learn more about creating a
-[high availability Kubernetes cluster](https://kubernetes.io/docs/tasks/administer-cluster/highly-available-master/),
-please review the [Kubernetes documentation](https://kubernetes.io/docs/tasks/administer-cluster/highly-available-master/)
-or consult your systems administrator.
-
-## The Crunchy Postgres Operator High Availability Algorithm
-
-A critical aspect of any production-grade PostgreSQL deployment is a reliable
-and effective high availability (HA) solution. Organizations want to know that
-their PostgreSQL deployments can remain available despite various issues that
-have the potential to disrupt operations, including hardware failures, network
-outages, software errors, or even human mistakes.
-
-The key portion of high availability that the PostgreSQL Operator provides is
-that it delegates the management of HA to the PostgreSQL clusters themselves.
-This ensures that the PostgreSQL Operator is not a single-point of failure for
-the availability of any of the PostgreSQL clusters that it manages, as the
-PostgreSQL Operator is only maintaining the definitions of what should be in the
-cluster (e.g. how many instances in the cluster, etc.).
-
-Each HA PostgreSQL cluster maintains its availability by using Patroni to manage
-failover when the primary becomes compromised. Patroni stores the primary’s ID in
-annotations on a Kubernetes `Endpoints` object which acts as a lease. The primary
-must periodically renew the lease to signal that it’s healthy. If the primary
-misses its deadline, replicas compare their WAL positions to see who has the most
-up-to-date data. Instances with the latest data try to overwrite the ID on the lease.
-The first to succeed becomes the new primary, and all others follow the new primary.
-
-## How The Crunchy PostgreSQL Operator Uses Pod Anti-Affinity
-
-Kubernetes has two types of Pod anti-affinity:
-
-- Preferred: With preferred (`preferredDuringSchedulingIgnoredDuringExecution`) Pod anti-affinity, Kubernetes will make a best effort to schedule Pods matching the anti-affinity rules to different Nodes. However, if it is not possible to do so, then Kubernetes may schedule one or more Pods to the same Node.
-- Required: With required (`requiredDuringSchedulingIgnoredDuringExecution`) Pod anti-affinity, Kubernetes mandates that each Pod matching the anti-affinity rules **must** be scheduled to different Nodes. However, a Pod may not be scheduled if Kubernetes cannot find a Node that does not contain a Pod matching the rules.
-
-There is a tradeoff with these two types of pod anti-affinity: while "required" anti-affinity will ensure that all the matching Pods are scheduled on different Nodes, if Kubernetes cannot find an available Node, your Postgres instance may not be scheduled. Likewise, while "preferred" anti-affinity will make a best effort to scheduled your Pods on different Nodes, Kubernetes may compromise and schedule more than one Postgres instance of the same cluster on the same Node.
-
-By understanding these tradeoffs, the makeup of your Kubernetes cluster, and your requirements, you can choose the method that makes the most sense for your Postgres deployment. We'll show examples of both methods below!
-
-For an example for how pod anti-affinity works with PGO, please see the [high availability tutorial]({{< relref "tutorial/high-availability.md" >}}#pod-anti-affinity).
-
-## Synchronous Replication: Guarding Against Transactions Loss
-
-Clusters managed by the Crunchy PostgreSQL Operator can be deployed with
-synchronous replication, which is useful for workloads that are sensitive to
-losing transactions, as PostgreSQL will not consider a transaction to be
-committed until it is committed to all synchronous replicas connected to a
-primary. This provides a higher guarantee of data consistency and, when a
-healthy synchronous replica is present, a guarantee of the most up-to-date data
-during a failover event.
-
-This comes at a cost of performance: PostgreSQL has to wait for
-a transaction to be committed on all synchronous replicas, and a connected client
-will have to wait longer than if the transaction only had to be committed on the
-primary (which is how asynchronous replication works). Additionally, there is a
-potential impact to availability: if a synchronous replica crashes, any writes
-to the primary will be blocked until a replica is promoted to become a new
-synchronous replica of the primary.
-
-## Node Affinity
-
-Kubernetes [Node Affinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#node-affinity)
-can be used to scheduled Pods to specific Nodes within a Kubernetes cluster.
-This can be useful when you want your PostgreSQL instances to take advantage of
-specific hardware (e.g. for geospatial applications) or if you want to have a
-replica instance deployed to a specific region within your Kubernetes cluster
-for high availability purposes.
-
-For an example for how node affinity works with PGO, please see the [high availability tutorial]({{< relref "tutorial/high-availability.md" >}}##node-affinity).
-
-## Tolerations
-
-Kubernetes [Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)
-can help with the scheduling of Pods to appropriate nodes. There are many
-reasons that a Kubernetes administrator may want to use tolerations, such as
-restricting the types of Pods that can be assigned to particular Nodes.
-Reasoning and strategy for using taints and tolerations is outside the scope of
-this documentation.
-
-You can configure the tolerations for your Postgres instances on the `postgresclusters` custom resource.
-
-## Pod Topology Spread Constraints
-
-Kubernetes [Pod Topology Spread Constraints](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/)
-can also help you efficiently schedule your workloads by ensuring your Pods are
-not scheduled in only one portion of your Kubernetes cluster. By spreading your
-Pods across your Kubernetes cluster among your various failure-domains, such as
-regions, zones, nodes, and other user-defined topology domains, you can achieve
-high availability as well as efficient resource utilization.
-
-For an example of how pod topology spread constraints work with PGO, please see
-the [high availability tutorial]({{< relref "tutorial/high-availability.md" >}}#pod-topology-spread-constraints).
-
-## Rolling Updates
-
-During the lifecycle of a PostgreSQL cluster, there are certain events that may
-require a planned restart, such as an update to a "restart required" PostgreSQL
-configuration setting (e.g. [`shared_buffers`](https://www.postgresql.org/docs/current/runtime-config-resource.html#GUC-SHARED-BUFFERS))
-or a change to a Kubernetes Pod template (e.g. [changing the memory request]({{< relref "tutorial/resize-cluster.md">}}#customize-cpu-memory)).
-Restarts can be disruptive in a high availability deployment, which is
-why many setups employ a ["rolling update" strategy](https://kubernetes.io/docs/tutorials/kubernetes-basics/update/update-intro/)
-(aka a "rolling restart") to minimize or eliminate downtime during a planned
-restart.
-
-Because PostgreSQL is a stateful application, a simple rolling restart strategy
-will not work: PostgreSQL needs to ensure that there is a primary available that
-can accept reads and writes. This requires following a method that will minimize
-the amount of downtime when the primary is taken offline for a restart.
-
-The PostgreSQL Operator uses the following algorithm to perform the rolling restart to minimize any potential interruptions:
-
-1. Each replica is updated in sequential order. This follows the following
-process:
-
- 1. The replica is explicitly shut down to ensure any outstanding changes are
- flushed to disk.
-
- 2. If requested, the PostgreSQL Operator will apply any changes to the Pod.
-
- 3. The replica is brought back online. The PostgreSQL Operator waits for the
- replica to become available before it proceeds to the next replica.
-
-2. The above steps are repeated until all of the replicas are restarted.
-
-3. A controlled switchover is performed. The PostgreSQL Operator determines
-which replica is the best candidate to become the new primary. It then demotes
-the primary to become a replica and promotes the best candidate to become the
-new primary.
-
-4. The former primary follows a process similar to what is described in step 1.
-
-The downtime is thus constrained to the amount of time the switchover takes.
-
-PGO will automatically detect when to apply a rolling update.
-
-## Pod Disruption Budgets
-
-Pods in a Kubernetes cluster can experience [voluntary disruptions](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/#voluntary-and-involuntary-disruptions)
-as a result of actions initiated by the application owner or a Cluster Administrator. During these
-voluntary disruptions Pod Disruption Budgets (PDBs) can be used to ensure that a minimum number of Pods
-will be running. The operator allows you to define a minimum number of Pods that should be
-available for instance sets and PgBouncer deployments in your postgrescluster. This minimum is
-configured in the postgrescluster spec and will be used to create PDBs associated to a resource defined
-in the spec. For example, the following spec will create two PDBs, one for `instance1` and one for
-the PgBouncer deployment:
-
-```
-spec:
- instances:
- - name: instance1
- replicas: 3
- minAvailable: 1
- proxy:
- pgBouncer:
- replicas: 3
- minAvailable: 1
-```
-
-{{% notice tip %}}
-The `minAvailable` field accepts number (`3`) or string percentage (`50%`) values. For more
-information see [Specifying a PodDisruptionBudget](https://kubernetes.io/docs/tasks/run-application/configure-pdb/#specifying-a-poddisruptionbudget).
-{{% /notice %}}
-
-If `minAvailable` is set to `0`, we will not reconcile a PDB for the resource and any existing PDBs
-will be removed. This will effectively disable Pod Disruption Budgets for the resource.
-
-If `minAvailable` is not provided for an object, a default value will be defined based on the
-number of replicas defined for that object. If there is one replica, a PDB will not be created. If
-there is more than one replica defined, a minimum of one Pod will be used.
diff --git a/docs/content/architecture/monitoring.md b/docs/content/architecture/monitoring.md
deleted file mode 100644
index 071ab876a3..0000000000
--- a/docs/content/architecture/monitoring.md
+++ /dev/null
@@ -1,307 +0,0 @@
----
-title: "Monitoring"
-date:
-draft: false
-weight: 130
----
-
-
-
-While having [high availability]({{< relref "architecture/high-availability.md" >}}),
-[backups]({{< relref "architecture/backups.md" >}}), and disaster recovery systems in place helps in the event of something going wrong with your
-PostgreSQL cluster, monitoring helps you anticipate problems before they happen.
-Additionally, monitoring can help you diagnose and resolve additional issues
-that may not result in downtime, but cause degraded performance.
-
-There are many different ways to monitor systems within Kubernetes, including
-tools that come with Kubernetes itself. This is by no means to be a
-comprehensive on how to monitor everything in Kubernetes, but rather what the
-PostgreSQL Operator provides to give you an
-[out-of-the-box monitoring solution]({{< relref "installation/monitoring/_index.md" >}}).
-
-## Getting Started
-
-If you want to install the metrics stack, please visit the [installation]({{< relref "installation/monitoring/_index.md" >}})
-instructions for the [PostgreSQL Operator Monitoring]({{< relref "installation/monitoring/_index.md" >}})
-stack.
-
-## Components
-
-The [PostgreSQL Operator Monitoring]({{< relref "installation/monitoring/_index.md" >}})
-stack is made up of several open source components:
-
-- [pgMonitor](https://github.com/CrunchyData/pgmonitor), which provides the core
-of the monitoring infrastructure including the following components:
- - [postgres_exporter](https://github.com/CrunchyData/pgmonitor/tree/main/postgres_exporter),
- which provides queries used to collect metrics information about a PostgreSQL
- instance.
- - [Prometheus](https://github.com/prometheus/prometheus), a time-series
- database that scrapes and stores the collected metrics so they can be consumed
- by other services.
- - [Grafana](https://github.com/grafana/grafana), a visualization tool that
- provides charting and other capabilities for viewing the collected monitoring
- data.
- - [Alertmanager](https://github.com/prometheus/alertmanager), a tool that
- can send alerts when metrics hit a certain threshold that require someone to
- intervene.
-- [pgnodemx](https://github.com/CrunchyData/pgnodemx), a PostgreSQL extension
-that is able to pull container-specific metrics (e.g. CPU utilization, memory
-consumption) from the container itself via SQL queries.
-
-## pgnodemx and the DownwardAPI
-
-pgnodemx is able to pull and format container-specific metrics by accessing several
-Kubernetes fields that are mounted from the pod to the `database` container's filesystem.
-By default, these fields include the pod's labels and annotations, as well as the
-`database` pod's CPU and memory. These fields are mounted at the `/etc/database-containerinfo`
-path.
-
-## Visualizations
-
-Below is a brief description of all the visualizations provided by the
-[PostgreSQL Operator Monitoring]({{< relref "installation/monitoring/_index.md" >}})
-stack. Some of the descriptions may include some directional guidance on how to
-interpret the charts, though this is only to provide a starting point: actual
-causes and effects of issues can vary between systems.
-
-Many of the visualizations can be broken down based on the following groupings:
-
-- Cluster: which PostgreSQL cluster should be viewed
-- Pod: the specific Pod or PostgreSQL instance
-
-### Overview
-
-
-
-The overview provides an overview of all of the PostgreSQL clusters that are
-being monitoring by the PostgreSQL Operator Monitoring stack. This includes the
-following information:
-
-- The name of the PostgreSQL cluster and the namespace that it is in
-- The type of PostgreSQL cluster (HA [high availability] or standalone)
-- The status of the cluster, as indicate by color. Green indicates the cluster
-is available, red indicates that it is not.
-
-Each entry is clickable to provide additional cluster details.
-
-### PostgreSQL Details
-
-
-
-The PostgreSQL Details view provides more information about a specific
-PostgreSQL cluster that is being managed and monitored by the PostgreSQL
-Operator. These include many key PostgreSQL-specific metrics that help make
-decisions around managing a PostgreSQL cluster. These include:
-
-- Backup Status: The last time a backup was taken of the cluster. Green is good.
-Orange means that a backup has not been taken in more than a day and may warrant
-investigation.
-- Active Connections: How many clients are connected to the database. Too many
-clients connected could impact performance and, for values approaching 100%, can
-lead to clients being unable to connect.
-- Idle in Transaction: How many clients have a connection state of "idle in
-transaction". Too many clients in this state can cause performance issues and,
-in certain cases, maintenance issues.
-- Idle: How many clients are connected but are in an "idle" state.
-- TPS: The number of "transactions per second" that are occurring. Usually needs
-to be combined with another metric to help with analysis. "Higher is better"
-when performing benchmarking.
-- Connections: An aggregated view of active, idle, and idle in transaction
-connections.
-- Database Size: How large databases are within a PostgreSQL cluster. Typically
-combined with another metric for analysis. Helps keep track of overall disk
-usage and if any triage steps need to occur around PVC size.
-- WAL Size: How much space write-ahead logs (WAL) are taking up on disk. This
-can contribute to extra space being used on your data disk, or can give you an
-indication of how much space is being utilized on a separate WAL PVC. If you
-are using replication slots, this can help indicate if a slot is not being
-acknowledged if the numbers are much larger than the `max_wal_size` setting (the
-PostgreSQL Operator does not use slots by default).
-- Row Activity: The number of rows that are selected, inserted, updated, and
-deleted. This can help you determine what percentage of your workload is read
-vs. write, and help make database tuning decisions based on that, in conjunction
-with other metrics.
-- Replication Status: Provides guidance information on how much replication lag
-there is between primary and replica PostgreSQL instances, both in bytes and
-time. This can provide an indication of how much data could be lost in the event
-of a failover.
-
-
-
-- Conflicts / Deadlocks: These occur when PostgreSQL is unable to complete
-operations, which can result in transaction loss. The goal is for these numbers
-to be `0`. If these are occurring, check your data access and writing patterns.
-- Cache Hit Ratio: A measure of how much of the "working data", e.g. data that
-is being accessed and manipulated, resides in memory. This is used to understand
-how much PostgreSQL is having to utilize the disk. The target number of this
-should be as high as possible. How to achieve this is the subject of books, but
-certain takes efforts on your applications use PostgreSQL.
-- Buffers: The buffer usage of various parts of the PostgreSQL system. This can
-be used to help understand the overall throughput between various parts of the
-system.
-- Commit & Rollback: How many transactions are committed and rolled back.
-- Locks: The number of locks that are present on a given system.
-
-### Pod Details
-
-
-
-Pod details provide information about a given Pod or Pods that are being used
-by a PostgreSQL cluster. These are similar to "operating system" or "node"
-metrics, with the differences that these are looking at resource utilization by
-a container, not the entire node.
-
-It may be helpful to view these metrics on a "pod" basis, by using the Pod
-filter at the top of the dashboard.
-
-- Disk Usage: How much space is being consumed by a volume.
-- Disk Activity: How many reads and writes are occurring on a volume.
-- Memory: Various information about memory utilization, including the request
-and limit as well as actually utilization.
-- CPU: The amount of CPU being utilized by a Pod
-- Network Traffic: The amount of networking traffic passing through each network
-device.
-- Container Resources: The CPU and memory limits and requests.
-
-### Backups
-
-
-
-There are a variety of reasons why you need to monitoring your backups, starting
-from answering the fundamental question of "do I have backups available?"
-Backups can be used for a variety of situations, from cloning new clusters to
-restoring clusters after a disaster. Additionally, Postgres can run into issues
-if your backup repository is not healthy, e.g. if it cannot push WAL archives.
-If your backups are set up properly and healthy, you will be set up to mitigate
-the risk of data loss!
-
-The backup, or pgBackRest panel, will provide information about the overall
-state of your backups. This includes:
-
-- Recovery Window: This is an indicator of how far back you are able to restore
-your data from. This represents all of the backups and archives available in
-your backup repository. Typically, your recovery window should be close to your
-overall data retention specifications.
-- Time Since Last Backup: this indicates how long it has been since your last
-backup. This is broken down into pgBackRest backup type (full, incremental,
-differential) as well as time since the last WAL archive was pushed.
-- Backup Runtimes: How long the last backup of a given type (full, incremental
-differential) took to execute. If your backups are slow, consider providing more
-resources to the backup jobs and tweaking pgBackRest's performance tuning
-settings.
-- Backup Size: How large the backups of a given type (full, incremental,
-differential).
-- WAL Stats: Shows the metrics around WAL archive pushes. If you have failing
-pushes, you should to see if there is a transient or permanent error that is
-preventing WAL archives from being pushed. If left untreated, this could end up
-causing issues for your Postgres cluster.
-
-### PostgreSQL Service Health Overview
-
-
-
-The Service Health Overview provides information about the Kubernetes Services
-that sit in front of the PostgreSQL Pods. This provides information about the
-status of the network.
-
-- Saturation: How much of the available network to the Service is being
-consumed. High saturation may cause degraded performance to clients or create
-an inability to connect to the PostgreSQL cluster.
-- Traffic: Displays the number of transactions per minute that the Service is
-handling.
-- Errors: Displays the total number of errors occurring at a particular Service.
-- Latency: What the overall network latency is when interfacing with the
-Service.
-
-### Query Runtime
-
-
-
-Looking at the overall performance of queries can help optimize a Postgres
-deployment, both from [providing resources]({{< relref "tutorial/customize-cluster.md" >}}) to query tuning in the application
-itself.
-
-You can get a sense of the overall activity of a PostgreSQL cluster from the
-chart that is visualized above:
-
-- Queries Executed: The total number of queries executed on a system during the
-period.
-- Query runtime: The aggregate runtime of all the queries combined across the
-system that were executed in the period.
-- Query mean runtime: The average query time across all queries executed on the
-system in the given period.
-- Rows retrieved or affected: The total number of rows in a database that were
-either retrieved or had modifications made to them.
-
-PostgreSQL Operator Monitoring also further breaks down the queries so you can
-identify queries that are being executed too frequently or are taking up too
-much time.
-
-
-
-- Query Mean Runtime (Top N): This highlights the N number of slowest queries by
-average runtime on the system. This might indicate you are missing an index
-somewhere, or perhaps the query could be rewritten to be more efficient.
-- Query Max Runtime (Top N): This highlights the N number of slowest queries by
-absolute runtime. This could indicate that a specific query or the system as a
-whole may need more resources.
-- Query Total Runtime (Top N): This highlights the N of slowest queries by
-aggregate runtime. This could indicate that a ORM is looping over a single query
-and executing it many times that could possibly be rewritten as a single, faster
-query.
-
-### Alerts
-
-
-
-Alerting lets one view and receive alerts about actions that require
-intervention, for example, a HA cluster that cannot self-heal. The alerting
-system is powered by [Alertmanager](https://github.com/prometheus/alertmanager).
-
-The alerts that come installed by default include:
-
-- `PGExporterScrapeError`: The Crunchy PostgreSQL Exporter is having issues
-scraping statistics used as part of the monitoring stack.
-- `PGIsUp`: A PostgreSQL instance is down.
-- `PGIdleTxn`: There are too many connections that are in the
-"idle in transaction" state.
-- `PGQueryTime`: A single PostgreSQL query is taking too long to run. Issues a
-warning at 12 hours and goes critical after 24.
-- `PGConnPerc`: Indicates that there are too many connection slots being used.
-Issues a warning at 75% and goes critical above 90%.
-- `PGDiskSize`: Indicates that a PostgreSQL database is too large and could be in
-danger of running out of disk space. Issues a warning at 75% and goes critical
-at 90%.
-- `PGReplicationByteLag`: Indicates that a replica is too far behind a primary
-instance, which could risk data loss in a failover scenario. Issues a warning at
-50MB an goes critical at 100MB.
-- `PGReplicationSlotsInactive`: Indicates that a replication slot is inactive.
-Not attending to this can lead to out-of-disk errors.
-- `PGXIDWraparound`: Indicates that a PostgreSQL instance is nearing transaction
-ID wraparound. Issues a warning at 50% and goes critical at 75%. It's important
-that you [vacuum your database](https://info.crunchydata.com/blog/managing-transaction-id-wraparound-in-postgresql)
-to prevent this.
-- `PGEmergencyVacuum`: Indicates that autovacuum is not running or cannot keep
-up with ongoing changes, i.e. it's past its "freeze" age. Issues a warning at
-110% and goes critical at 125%.
-- `PGArchiveCommandStatus`: Indicates that the archive command, which is used
-to ship WAL archives to pgBackRest, is failing.
-- `PGSequenceExhaustion`: Indicates that a sequence is over 75% used.
-- `PGSettingsPendingRestart`: Indicates that there are settings changed on a
-PostgreSQL instance that requires a restart.
-
-Optional alerts that can be enabled:
-
-- `PGMinimumVersion`: Indicates if PostgreSQL is below a desired version.
-- `PGRecoveryStatusSwitch_Replica`: Indicates that a replica has been promoted
-to a primary.
-- `PGConnectionAbsent_Prod`: Indicates that metrics collection is absent from a
-PostgresQL instance.
-- `PGSettingsChecksum`: Indicates that PostgreSQL settings have changed from a
-previous state.
-- `PGDataChecksum`: Indicates that there are data checksum failures on a
-PostgreSQL instance. This could be a sign of data corruption.
-
-You can modify these alerts as you see fit, and add your own alerts as well!
-Please see the [installation instructions]({{< relref "installation/monitoring/_index.md" >}})
-for general setup of the PostgreSQL Operator Monitoring stack.
diff --git a/docs/content/architecture/overview.md b/docs/content/architecture/overview.md
deleted file mode 100644
index 3fc5dc8c8a..0000000000
--- a/docs/content/architecture/overview.md
+++ /dev/null
@@ -1,101 +0,0 @@
----
-title: "Overview"
-date:
-draft: false
-weight: 100
----
-
-The goal of PGO, the Postgres Operator from Crunchy Data is to provide a means to quickly get
-your applications up and running on Postgres for both development and
-production environments. To understand how PGO does this, we
-want to give you a tour of its architecture, with explains both the architecture
-of the PostgreSQL Operator itself as well as recommended deployment models for
-PostgreSQL in production!
-
-# PGO Architecture
-
-The Crunchy PostgreSQL Operator extends Kubernetes to provide a higher-level
-abstraction for rapid creation and management of PostgreSQL clusters. The
-Crunchy PostgreSQL Operator leverages a Kubernetes concept referred to as
-"[Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)”
-to create several
-[custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)
-that allow for the management of PostgreSQL clusters.
-
-The main custom resource definition is [`postgresclusters.postgres-operator.crunchydata.com`]({{< relref "references/crd.md" >}}). This allows you to control all the information about a Postgres cluster, including:
-
-- General information
-- Resource allocation
-- High availability
-- Backup management
-- Where and how it is deployed (affinity, tolerations, topology spread constraints)
-- Disaster Recovery / standby clusters
-- Monitoring
-
-and more.
-
-PGO itself runs as a Deployment and is composed of a single container.
-
-- `operator` (image: postgres-operator) - This is the heart of the PostgreSQL
-Operator. It contains a series of Kubernetes
-[controllers](https://kubernetes.io/docs/concepts/architecture/controller/) that
-place watch events on a series of native Kubernetes resources (Jobs, Pods) as
-well as the Custom Resources that come with the PostgreSQL Operator (Pgcluster,
-Pgtask)
-
-The main purpose of PGO is to create and update information
-around the structure of a Postgres Cluster, and to relay information about the
-overall status and health of a PostgreSQL cluster. The goal is to also simplify
-this process as much as possible for users. For example, let's say we want to
-create a high-availability PostgreSQL cluster that has multiple replicas,
-supports having backups in both a local storage area and Amazon S3 and has
-built-in metrics and connection pooling, similar to:
-
-
-
-This can be accomplished with a relatively simple manifest. Please refer to the [tutorial]({{< relref "tutorial/_index.md" >}}) for how to accomplish this, or see the [Postgres Operator examples](https://github.com/CrunchyData/postgres-operator-examples/fork) repo.
-
-The Postgres Operator handles setting up all of the various StatefulSets, Deployments, Services and other Kubernetes objects.
-
-You will also notice that **high-availability is enabled by default** if you deploy at least one Postgres replica. The
-Crunchy PostgreSQL Operator uses a distributed-consensus method for PostgreSQL
-cluster high-availability, and as such delegates the management of each
-cluster's availability to the clusters themselves. This removes the PostgreSQL
-Operator from being a single-point-of-failure, and has benefits such as faster
-recovery times for each PostgreSQL cluster. For a detailed discussion on
-high-availability, please see the [High-Availability]({{< relref "architecture/high-availability.md" >}})
-section.
-
-## Kubernetes StatefulSets: The PGO Deployment Model
-
-PGO, the Postgres Operator from Crunchy Data, uses [Kubernetes StatefulSets](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/)
-for running Postgres instances, and will use [Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) for more ephemeral services.
-
-PGO deploys Kubernetes Statefulsets in a way to allow for creating both different Postgres instance groups and be able to support advanced operations such as rolling updates that minimize or eliminate Postgres downtime. Additional components in our
-PostgreSQL cluster, such as the pgBackRest repository or an optional PgBouncer,
-are deployed with Kubernetes Deployments.
-
-With the PGO architecture, we can also leverage Statefulsets to apply affinity and toleration rules across every Postgres instance or individual ones. For instance, we may want to force one or more of our PostgreSQL replicas to run on Nodes in a different region than
-our primary PostgreSQL instances.
-
-What's great about this is that PGO manages this for you so you don't have to worry! Being aware of
-this model can help you understand how the Postgres Operator gives you maximum
-flexibility for your PostgreSQL clusters while giving you the tools to
-troubleshoot issues in production.
-
-The last piece of this model is the use of [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/)
-for accessing your PostgreSQL clusters and their various components. The
-PostgreSQL Operator puts services in front of each Deployment to ensure you have
-a known, consistent means of accessing your PostgreSQL components.
-
-Note that in some production environments, there can be delays in accessing
-Services during transition events. The PostgreSQL Operator attempts to mitigate
-delays during critical operations (e.g. failover, restore, etc.) by directly
-accessing the Kubernetes Pods to perform given actions.
-
-# Additional Architecture Information
-
-There is certainly a lot to unpack in the overall architecture of PGO. Understanding the architecture will help you to plan
-the deployment model that is best for your environment. For more information on
-the architectures of various components of the PostgreSQL Operator, please read
-onward!
diff --git a/docs/content/architecture/pgadmin4.md b/docs/content/architecture/pgadmin4.md
deleted file mode 100644
index 047db37397..0000000000
--- a/docs/content/architecture/pgadmin4.md
+++ /dev/null
@@ -1,166 +0,0 @@
----
-title: "pgAdmin 4"
-date:
-draft: false
-weight: 900
----
-
-
-
-[pgAdmin 4](https://www.pgadmin.org/) is a popular graphical user interface that
-makes it easy to work with PostgreSQL databases from a web-based client. With
-its ability to manage and orchestrate changes for PostgreSQL users, the PostgreSQL
-Operator is a natural partner to keep a pgAdmin 4 environment synchronized with
-a PostgreSQL environment.
-
-The PostgreSQL Operator lets you deploy a pgAdmin 4 environment alongside a
-PostgreSQL cluster and keeps users' database credentials synchronized. You can
-simply log into pgAdmin 4 with your PostgreSQL username and password and
-immediately have access to your databases.
-
-## Deploying pgAdmin 4
-
-{{% notice warning %}}
-Unfortunately, pgAdmin 4 is not currently compatible with PostgreSQL 15.
-{{% /notice %}}
-
-If you've done the [quickstart]({{< relref "quickstart/_index.md" >}}), add the
-following fields to the spec and reapply; if you don't have any Postgres clusters
-running, add the fields to a spec, and apply.
-
-```yaml
- userInterface:
- pgAdmin:
- image: {{< param imageCrunchyPGAdmin >}}
- dataVolumeClaimSpec:
- accessModes:
- - "ReadWriteOnce"
- resources:
- requests:
- storage: 1Gi
-```
-
-This creates a pgAdmin 4 deployment unique to this PostgreSQL cluster and synchronizes
-the PostgreSQL user information. To access pgAdmin 4, you can set up a port-forward
-to the Service, which follows the pattern `| Name | -Type | -Description | -Required | -
|---|---|---|---|
| apiVersion | -string | -postgres-operator.crunchydata.com/v1beta1 | -true | -
| kind | -string | -PGAdmin | -true | -
| metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
| spec | -object | -PGAdminSpec defines the desired state of PGAdmin | -false | -
| status | -object | -PGAdminStatus defines the observed state of PGAdmin | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| dataVolumeClaimSpec | -object | -Defines a PersistentVolumeClaim for pgAdmin data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes | -true | -
| affinity | -object | -Scheduling constraints of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| config | -object | -Configuration settings for the pgAdmin process. Changes to any of these values will be loaded without validation. Be careful, as you may put pgAdmin into an unusable state. | -false | -
| image | -string | -The image name to use for pgAdmin instance. | -false | -
| imagePullPolicy | -enum | -ImagePullPolicy is used to determine when Kubernetes will attempt to pull (download) container images. More info: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy | -false | -
| imagePullSecrets | -[]object | -The image pull secrets used to pull from a private registry. Changing this value causes all running PGAdmin pods to restart. https://k8s.io/docs/tasks/configure-pod-container/pull-image-private-registry/ | -false | -
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| priorityClassName | -string | -Priority class name for the PGAdmin pod. Changing this value causes PGAdmin pod to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| resources | -object | -Resource requirements for the PGAdmin container. | -false | -
| serverGroups | -[]object | -ServerGroups for importing PostgresClusters to pgAdmin. To create a pgAdmin with no selectors, leave this field empty. A pgAdmin created with no `ServerGroups` will not automatically add any servers through discovery. PostgresClusters can still be added manually. | -false | -
| tolerations | -[]object | -Tolerations of the PGAdmin pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| accessModes | -[]string | -accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | -false | -
| dataSource | -object | -dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. | -false | -
| dataSourceRef | -object | -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. | -false | -
| resources | -object | -resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | -false | -
| selector | -object | -selector is a label query over volumes to consider for binding. | -false | -
| storageClassName | -string | -storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | -false | -
| volumeMode | -string | -volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. | -false | -
| volumeName | -string | -volumeName is the binding reference to the PersistentVolume backing this claim. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| files | -[]object | -Files allows the user to mount projected volumes into the pgAdmin container so that files can be referenced by pgAdmin as needed. | -false | -
| ldapBindPassword | -object | -A Secret containing the value for the LDAP_BIND_PASSWORD setting. More info: https://www.pgadmin.org/docs/pgadmin4/latest/ldap.html | -false | -
| settings | -object | -Settings for the pgAdmin server process. Keys should be uppercase and values must be constants. More info: https://www.pgadmin.org/docs/pgadmin4/latest/config_py.html | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMap | -object | -configMap information about the configMap data to project | -false | -
| downwardAPI | -object | -downwardAPI information about the downwardAPI data to project | -false | -
| secret | -object | -secret information about the secret data to project | -false | -
| serviceAccountToken | -object | -serviceAccountToken is information about the serviceAccountToken data to project | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -Items is a list of DownwardAPIVolume file | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | -true | -
| fieldRef | -object | -Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | -false | -
| mode | -integer | -Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| resourceFieldRef | -object | -Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -path is the path relative to the mount point of the file to project the token into. | -true | -
| audience | -string | -audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. | -false | -
| expirationSeconds | -integer | -expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. | -false | -
| 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The name for the ServerGroup in pgAdmin. Must be unique in the pgAdmin's ServerGroups since it becomes the ServerGroup name in pgAdmin. | -true | -
| postgresClusterSelector | -object | -PostgresClusterSelector selects clusters to dynamically add to pgAdmin by matching labels. An empty selector like `{}` will select ALL clusters in the namespace. | -true | -
| 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 | -
| 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 | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| conditions | -[]object | -conditions represent the observations of pgadmin's current state. Known .status.conditions.type are: "PersistentVolumeResizing", "Progressing", "ProxyAvailable" | -false | -
| observedGeneration | -integer | -observedGeneration represents the .metadata.generation on which the status was based. | -false | -
| 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. | -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. | -true | -
| type | -string | -type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) | -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. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| apiVersion | -string | -postgres-operator.crunchydata.com/v1beta1 | -true | -
| kind | -string | -PGUpgrade | -true | -
| metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
| spec | -object | -PGUpgradeSpec defines the desired state of PGUpgrade | -false | -
| status | -object | -PGUpgradeStatus defines the observed state of PGUpgrade | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| fromPostgresVersion | -integer | -The major version of PostgreSQL before the upgrade. | -true | -
| postgresClusterName | -string | -The name of the cluster to be updated | -true | -
| toPostgresVersion | -integer | -The major version of PostgreSQL to be upgraded to. | -true | -
| affinity | -object | -Scheduling constraints of the PGUpgrade pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| image | -string | -The image name to use for major PostgreSQL upgrades. | -false | -
| imagePullPolicy | -enum | -ImagePullPolicy is used to determine when Kubernetes will attempt to pull (download) container images. More info: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy | -false | -
| imagePullSecrets | -[]object | -The image pull secrets used to pull from a private registry. Changing this value causes all running PGUpgrade pods to restart. https://k8s.io/docs/tasks/configure-pod-container/pull-image-private-registry/ | -false | -
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| priorityClassName | -string | -Priority class name for the PGUpgrade pod. Changing this value causes PGUpgrade pod to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| resources | -object | -Resource requirements for the PGUpgrade container. | -false | -
| toPostgresImage | -string | -The image name to use for PostgreSQL containers after upgrade. When omitted, the value comes from an operator environment variable. | -false | -
| tolerations | -[]object | -Tolerations of the PGUpgrade pod. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| conditions | -[]object | -conditions represent the observations of PGUpgrade's current state. | -false | -
| observedGeneration | -integer | -observedGeneration represents the .metadata.generation on which the status was based. | -false | -
| 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. | -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. | -true | -
| type | -string | -type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) | -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. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| apiVersion | -string | -postgres-operator.crunchydata.com/v1beta1 | -true | -
| kind | -string | -PostgresCluster | -true | -
| metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
| spec | -object | -PostgresClusterSpec defines the desired state of PostgresCluster | -false | -
| status | -object | -PostgresClusterStatus defines the observed state of PostgresCluster | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| backups | -object | -PostgreSQL backup configuration | -true | -
| instances | -[]object | -Specifies one or more sets of PostgreSQL pods that replicate data for this cluster. | -true | -
| postgresVersion | -integer | -The major version of PostgreSQL installed in the PostgreSQL image | -true | -
| config | -object | -- | false | -
| customReplicationTLSSecret | -object | -The secret containing the replication client certificates and keys for secure connections to the PostgreSQL server. It will need to contain the client TLS certificate, TLS key and the Certificate Authority certificate with the data keys set to tls.crt, tls.key and ca.crt, respectively. NOTE: If CustomReplicationClientTLSSecret is provided, CustomTLSSecret MUST be provided and the ca.crt provided must be the same. | -false | -
| customTLSSecret | -object | -The secret containing the Certificates and Keys to encrypt PostgreSQL traffic will need to contain the server TLS certificate, TLS key and the Certificate Authority certificate with the data keys set to tls.crt, tls.key and ca.crt, respectively. It will then be mounted as a volume projection to the '/pgconf/tls' directory. For more information on Kubernetes secret projections, please see https://k8s.io/docs/concepts/configuration/secret/#projection-of-secret-keys-to-specific-paths NOTE: If CustomTLSSecret is provided, CustomReplicationClientTLSSecret MUST be provided and the ca.crt provided must be the same. | -false | -
| dataSource | -object | -Specifies a data source for bootstrapping the PostgreSQL cluster. | -false | -
| databaseInitSQL | -object | -DatabaseInitSQL defines a ConfigMap containing custom SQL that will be run after the cluster is initialized. This ConfigMap must be in the same namespace as the cluster. | -false | -
| disableDefaultPodScheduling | -boolean | -Whether or not the PostgreSQL cluster should use the defined default scheduling constraints. If the field is unset or false, the default scheduling constraints will be used in addition to any custom constraints provided. | -false | -
| image | -string | -The image name to use for PostgreSQL containers. When omitted, the value comes from an operator environment variable. For standard PostgreSQL images, the format is RELATED_IMAGE_POSTGRES_{postgresVersion}, e.g. RELATED_IMAGE_POSTGRES_13. For PostGIS enabled PostgreSQL images, the format is RELATED_IMAGE_POSTGRES_{postgresVersion}_GIS_{postGISVersion}, e.g. RELATED_IMAGE_POSTGRES_13_GIS_3.1. | -false | -
| imagePullPolicy | -enum | -ImagePullPolicy is used to determine when Kubernetes will attempt to pull (download) container images. More info: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy | -false | -
| imagePullSecrets | -[]object | -The image pull secrets used to pull from a private registry Changing this value causes all running pods to restart. https://k8s.io/docs/tasks/configure-pod-container/pull-image-private-registry/ | -false | -
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| monitoring | -object | -The specification of monitoring tools that connect to PostgreSQL | -false | -
| openshift | -boolean | -Whether or not the PostgreSQL cluster is being deployed to an OpenShift environment. If the field is unset, the operator will automatically detect the environment. | -false | -
| patroni | -object | -- | false | -
| paused | -boolean | -Suspends the rollout and reconciliation of changes made to the PostgresCluster spec. | -false | -
| port | -integer | -The port on which PostgreSQL should listen. | -false | -
| postGISVersion | -string | -The PostGIS extension version installed in the PostgreSQL image. When image is not set, indicates a PostGIS enabled image will be used. | -false | -
| proxy | -object | -The specification of a proxy that connects to PostgreSQL. | -false | -
| service | -object | -Specification of the service that exposes the PostgreSQL primary instance. | -false | -
| shutdown | -boolean | -Whether or not the PostgreSQL cluster should be stopped. When this is true, workloads are scaled to zero and CronJobs are suspended. Other resources, such as Services and Volumes, remain in place. | -false | -
| standby | -object | -Run this cluster as a read-only copy of an existing cluster or archive. | -false | -
| supplementalGroups | -[]integer | -A list of group IDs applied to the process of a container. These can be useful when accessing shared file systems with constrained permissions. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context | -false | -
| userInterface | -object | -The specification of a user interface that connects to PostgreSQL. | -false | -
| users | -[]object | -Users to create inside PostgreSQL and the databases they should access. The default creates one user that can access one database matching the PostgresCluster name. An empty list creates no users. Removing a user from this list does NOT drop the user nor revoke their access. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgbackrest | -object | -pgBackRest archive configuration | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| repos | -[]object | -Defines a pgBackRest repository | -true | -
| configuration | -[]object | -Projected volumes containing custom pgBackRest configuration. These files are mounted under "/etc/pgbackrest/conf.d" alongside any pgBackRest configuration generated by the PostgreSQL Operator: https://pgbackrest.org/configuration.html | -false | -
| global | -map[string]string | -Global pgBackRest configuration settings. These settings are included in the "global" section of the pgBackRest configuration generated by the PostgreSQL Operator, and then mounted under "/etc/pgbackrest/conf.d": https://pgbackrest.org/configuration.html | -false | -
| image | -string | -The image name to use for pgBackRest containers. Utilized to run pgBackRest repository hosts and backups. The image may also be set using the RELATED_IMAGE_PGBACKREST environment variable | -false | -
| jobs | -object | -Jobs field allows configuration for all backup jobs | -false | -
| manual | -object | -Defines details for manual pgBackRest backup Jobs | -false | -
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| repoHost | -object | -Defines configuration for a pgBackRest dedicated repository host. This section is only applicable if at least one "volume" (i.e. PVC-based) repository is defined in the "repos" section, therefore enabling a dedicated repository host Deployment. | -false | -
| restore | -object | -Defines details for performing an in-place restore using pgBackRest | -false | -
| sidecars | -object | -Configuration for pgBackRest sidecar containers | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The name of the the repository | -true | -
| azure | -object | -Represents a pgBackRest repository that is created using Azure storage | -false | -
| gcs | -object | -Represents a pgBackRest repository that is created using Google Cloud Storage | -false | -
| s3 | -object | -RepoS3 represents a pgBackRest repository that is created using AWS S3 (or S3-compatible) storage | -false | -
| schedules | -object | -Defines the schedules for the pgBackRest backups Full, Differential and Incremental backup types are supported: https://pgbackrest.org/user-guide.html#concept/backup | -false | -
| volume | -object | -Represents a pgBackRest repository that is created using a PersistentVolumeClaim | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| container | -string | -The Azure container utilized for the repository | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| bucket | -string | -The GCS bucket utilized for the repository | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| bucket | -string | -The S3 bucket utilized for the repository | -true | -
| endpoint | -string | -A valid endpoint corresponding to the specified region | -true | -
| region | -string | -The region corresponding to the S3 bucket | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| differential | -string | -Defines the Cron schedule for a differential pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax | -false | -
| full | -string | -Defines the Cron schedule for a full pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax | -false | -
| incremental | -string | -Defines the Cron schedule for an incremental pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| volumeClaimSpec | -object | -Defines a PersistentVolumeClaim spec used to create and/or bind a volume | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| accessModes | -[]string | -accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | -true | -
| resources | -object | -resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | -true | -
| dataSource | -object | -dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. | -false | -
| dataSourceRef | -object | -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. | -false | -
| selector | -object | -selector is a label query over volumes to consider for binding. | -false | -
| storageClassName | -string | -storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | -false | -
| volumeMode | -string | -volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. | -false | -
| volumeName | -string | -volumeName is the binding reference to the PersistentVolume backing this claim. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMap | -object | -configMap information about the configMap data to project | -false | -
| downwardAPI | -object | -downwardAPI information about the downwardAPI data to project | -false | -
| secret | -object | -secret information about the secret data to project | -false | -
| serviceAccountToken | -object | -serviceAccountToken is information about the serviceAccountToken data to project | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -Items is a list of DownwardAPIVolume file | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | -true | -
| fieldRef | -object | -Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | -false | -
| mode | -integer | -Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| resourceFieldRef | -object | -Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -path is the path relative to the mount point of the file to project the token into. | -true | -
| audience | -string | -audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. | -false | -
| expirationSeconds | -integer | -expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| affinity | -object | -Scheduling constraints of pgBackRest backup Job pods. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| priorityClassName | -string | -Priority class name for the pgBackRest backup Job pods. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| resources | -object | -Resource limits for backup jobs. Includes manual, scheduled and replica create backups | -false | -
| tolerations | -[]object | -Tolerations of pgBackRest backup Job pods. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| ttlSecondsAfterFinished | -integer | -Limit the lifetime of a Job that has finished. More info: https://kubernetes.io/docs/concepts/workloads/controllers/job | -false | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| repoName | -string | -The name of the pgBackRest repo to run the backup command against. | -true | -
| options | -[]string | -Command line options to include when running the pgBackRest backup command. https://pgbackrest.org/command.html#command-backup | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| affinity | -object | -Scheduling constraints of the Dedicated repo host pod. Changing this value causes repo host to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| priorityClassName | -string | -Priority class name for the pgBackRest repo host pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| resources | -object | -Resource requirements for a pgBackRest repository host | -false | -
| sshConfigMap | -object | -ConfigMap containing custom SSH configuration. Deprecated: Repository hosts use mTLS for encryption, authentication, and authorization. | -false | -
| sshSecret | -object | -Secret containing custom SSH keys. Deprecated: Repository hosts use mTLS for encryption, authentication, and authorization. | -false | -
| tolerations | -[]object | -Tolerations of a PgBackRest repo host pod. Changing this value causes a restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| topologySpreadConstraints | -[]object | -Topology spread constraints of a Dedicated repo host pod. Changing this value causes the repo host to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | -false | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| maxSkew | -integer | -MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. | -true | -
| topologyKey | -string | -TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each |
- true | -
| whenUnsatisfiable | -string | -WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. | -true | -
| labelSelector | -object | -LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. | -false | -
| minDomains | -integer | -MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. - This is an alpha field and requires enabling MinDomainsInPodTopologySpread feature gate. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| enabled | -boolean | -Whether or not in-place pgBackRest restores are enabled for this PostgresCluster. | -true | -
| repoName | -string | -The name of the pgBackRest repo within the source PostgresCluster that contains the backups that should be utilized to perform a pgBackRest restore when initializing the data source for the new PostgresCluster. | -true | -
| affinity | -object | -Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| clusterName | -string | -The name of an existing PostgresCluster to use as the data source for the new PostgresCluster. Defaults to the name of the PostgresCluster being created if not provided. | -false | -
| clusterNamespace | -string | -The namespace of the cluster specified as the data source using the clusterName field. Defaults to the namespace of the PostgresCluster being created if not provided. | -false | -
| options | -[]string | -Command line options to include when running the pgBackRest restore command. https://pgbackrest.org/command.html#command-restore | -false | -
| priorityClassName | -string | -Priority class name for the pgBackRest restore Job pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| resources | -object | -Resource requirements for the pgBackRest restore Job. | -false | -
| tolerations | -[]object | -Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgbackrest | -object | -Defines the configuration for the pgBackRest sidecar container | -false | -
| pgbackrestConfig | -object | -Defines the configuration for the pgBackRest config sidecar container | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| resources | -object | -Resource requirements for a sidecar container | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| resources | -object | -Resource requirements for a sidecar container | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| dataVolumeClaimSpec | -object | -Defines a PersistentVolumeClaim for PostgreSQL data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes | -true | -
| affinity | -object | -Scheduling constraints of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| containers | -[]object | -Custom sidecars for PostgreSQL instance pods. Changing this value causes PostgreSQL to restart. | -false | -
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| minAvailable | -int or string | -Minimum number of pods that should be available at a time. Defaults to one when the replicas field is greater than one. | -false | -
| name | -string | -Name that associates this set of PostgreSQL pods. This field is optional when only one instance set is defined. Each instance set in a cluster must have a unique name. The combined length of this and the cluster name must be 46 characters or less. | -false | -
| priorityClassName | -string | -Priority class name for the PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| replicas | -integer | -Number of desired PostgreSQL pods. | -false | -
| resources | -object | -Compute resources of a PostgreSQL container. | -false | -
| sidecars | -object | -Configuration for instance sidecar containers | -false | -
| tablespaceVolumes | -[]object | -The list of tablespaces volumes to mount for this postgrescluster This field requires enabling TablespaceVolumes feature gate | -false | -
| tolerations | -[]object | -Tolerations of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| topologySpreadConstraints | -[]object | -Topology spread constraints of a PostgreSQL pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | -false | -
| walVolumeClaimSpec | -object | -Defines a separate PersistentVolumeClaim for PostgreSQL's write-ahead log. More info: https://www.postgresql.org/docs/current/wal.html | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| accessModes | -[]string | -accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | -true | -
| resources | -object | -resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | -true | -
| dataSource | -object | -dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. | -false | -
| dataSourceRef | -object | -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. | -false | -
| selector | -object | -selector is a label query over volumes to consider for binding. | -false | -
| storageClassName | -string | -storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | -false | -
| volumeMode | -string | -volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. | -false | -
| volumeName | -string | -volumeName is the binding reference to the PersistentVolume backing this claim. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. 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. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. 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 | -
| resources | -object | -Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the environment variable. Must be a C_IDENTIFIER. | -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 | -
| 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[' |
- 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -The key to select. | -true | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the ConfigMap or its key must be defined | -false | -
| 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 | -
| 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 | -
| 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMapRef | -object | -The ConfigMap to select from | -false | -
| prefix | -string | -An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. | -false | -
| secretRef | -object | -The Secret to select from | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the ConfigMap must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the Secret must be defined | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| httpGet | -object | -HTTPGet specifies the http request to perform. | -false | -
| tcpSocket | -object | -Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. | -false | -
| 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 | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| httpGet | -object | -HTTPGet specifies the http request to perform. | -false | -
| tcpSocket | -object | -Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. | -false | -
| 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 | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| failureThreshold | -integer | -Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. | -false | -
| grpc | -object | -GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. | -false | -
| httpGet | -object | -HTTPGet specifies the http 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 | -false | -
| periodSeconds | -integer | -How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. | -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. | -false | -
| tcpSocket | -object | -TCPSocket specifies an action involving 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. | -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 | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| port | -integer | -Port number of the gRPC service. Number must be in the range 1 to 65535. | -true | -
| 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. | -false | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| 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. | -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. | -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". | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| failureThreshold | -integer | -Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. | -false | -
| grpc | -object | -GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. | -false | -
| httpGet | -object | -HTTPGet specifies the http 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 | -false | -
| periodSeconds | -integer | -How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. | -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. | -false | -
| tcpSocket | -object | -TCPSocket specifies an action involving 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. | -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 | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| port | -integer | -Port number of the gRPC service. Number must be in the range 1 to 65535. | -true | -
| 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. | -false | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 | -
| 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 is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. 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. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| add | -[]string | -Added capabilities | -false | -
| drop | -[]string | -Removed capabilities | -false | -
| 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 | -
| 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 only be set if type is "Localhost". | -false | -
| 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. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| failureThreshold | -integer | -Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. | -false | -
| grpc | -object | -GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. | -false | -
| httpGet | -object | -HTTPGet specifies the http 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 | -false | -
| periodSeconds | -integer | -How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. | -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. | -false | -
| tcpSocket | -object | -TCPSocket specifies an action involving 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. | -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 | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| port | -integer | -Port number of the gRPC service. Number must be in the range 1 to 65535. | -true | -
| 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. | -false | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| mountPath | -string | -Path within the container at which the volume should be mounted. Must not contain ':'. | -true | -
| name | -string | -This must match the Name of a Volume. | -true | -
| 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. | -false | -
| readOnly | -boolean | -Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| replicaCertCopy | -object | -Defines the configuration for the replica cert copy sidecar container | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| resources | -object | -Resource requirements for a sidecar container | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| dataVolumeClaimSpec | -object | -Defines a PersistentVolumeClaim for a tablespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes | -true | -
| name | -string | -The name for the tablespace, used as the path name for the volume. Must be unique in the instance set since they become the directory names. | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| accessModes | -[]string | -accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | -false | -
| dataSource | -object | -dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. | -false | -
| dataSourceRef | -object | -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. | -false | -
| resources | -object | -resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | -false | -
| selector | -object | -selector is a label query over volumes to consider for binding. | -false | -
| storageClassName | -string | -storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | -false | -
| volumeMode | -string | -volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. | -false | -
| volumeName | -string | -volumeName is the binding reference to the PersistentVolume backing this claim. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 | -
| 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 | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| maxSkew | -integer | -MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. | -true | -
| topologyKey | -string | -TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each |
- true | -
| whenUnsatisfiable | -string | -WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. | -true | -
| labelSelector | -object | -LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. | -false | -
| minDomains | -integer | -MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. - This is an alpha field and requires enabling MinDomainsInPodTopologySpread feature gate. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| accessModes | -[]string | -accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | -true | -
| resources | -object | -resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | -true | -
| dataSource | -object | -dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. | -false | -
| dataSourceRef | -object | -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. | -false | -
| selector | -object | -selector is a label query over volumes to consider for binding. | -false | -
| storageClassName | -string | -storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | -false | -
| volumeMode | -string | -volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. | -false | -
| volumeName | -string | -volumeName is the binding reference to the PersistentVolume backing this claim. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| files | -[]object | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMap | -object | -configMap information about the configMap data to project | -false | -
| downwardAPI | -object | -downwardAPI information about the downwardAPI data to project | -false | -
| secret | -object | -secret information about the secret data to project | -false | -
| serviceAccountToken | -object | -serviceAccountToken is information about the serviceAccountToken data to project | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -Items is a list of DownwardAPIVolume file | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | -true | -
| fieldRef | -object | -Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | -false | -
| mode | -integer | -Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| resourceFieldRef | -object | -Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -path is the path relative to the mount point of the file to project the token into. | -true | -
| audience | -string | -audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. | -false | -
| expirationSeconds | -integer | -expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgbackrest | -object | -Defines a pgBackRest cloud-based data source that can be used to pre-populate the the PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore. The PGBackRest field is incompatible with the PostgresCluster field: only one data source can be used for pre-populating a new PostgreSQL cluster | -false | -
| postgresCluster | -object | -Defines a pgBackRest data source that can be used to pre-populate the PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore. The PGBackRest field is incompatible with the PostgresCluster field: only one data source can be used for pre-populating a new PostgreSQL cluster | -false | -
| volumes | -object | -Defines any existing volumes to reuse for this PostgresCluster. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| repo | -object | -Defines a pgBackRest repository | -true | -
| stanza | -string | -The name of an existing pgBackRest stanza to use as the data source for the new PostgresCluster. Defaults to `db` if not provided. | -true | -
| affinity | -object | -Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| configuration | -[]object | -Projected volumes containing custom pgBackRest configuration. These files are mounted under "/etc/pgbackrest/conf.d" alongside any pgBackRest configuration generated by the PostgreSQL Operator: https://pgbackrest.org/configuration.html | -false | -
| global | -map[string]string | -Global pgBackRest configuration settings. These settings are included in the "global" section of the pgBackRest configuration generated by the PostgreSQL Operator, and then mounted under "/etc/pgbackrest/conf.d": https://pgbackrest.org/configuration.html | -false | -
| options | -[]string | -Command line options to include when running the pgBackRest restore command. https://pgbackrest.org/command.html#command-restore | -false | -
| priorityClassName | -string | -Priority class name for the pgBackRest restore Job pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| resources | -object | -Resource requirements for the pgBackRest restore Job. | -false | -
| tolerations | -[]object | -Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The name of the the repository | -true | -
| azure | -object | -Represents a pgBackRest repository that is created using Azure storage | -false | -
| gcs | -object | -Represents a pgBackRest repository that is created using Google Cloud Storage | -false | -
| s3 | -object | -RepoS3 represents a pgBackRest repository that is created using AWS S3 (or S3-compatible) storage | -false | -
| schedules | -object | -Defines the schedules for the pgBackRest backups Full, Differential and Incremental backup types are supported: https://pgbackrest.org/user-guide.html#concept/backup | -false | -
| volume | -object | -Represents a pgBackRest repository that is created using a PersistentVolumeClaim | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| container | -string | -The Azure container utilized for the repository | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| bucket | -string | -The GCS bucket utilized for the repository | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| bucket | -string | -The S3 bucket utilized for the repository | -true | -
| endpoint | -string | -A valid endpoint corresponding to the specified region | -true | -
| region | -string | -The region corresponding to the S3 bucket | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| differential | -string | -Defines the Cron schedule for a differential pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax | -false | -
| full | -string | -Defines the Cron schedule for a full pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax | -false | -
| incremental | -string | -Defines the Cron schedule for an incremental pgBackRest backup. Follows the standard Cron schedule syntax: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| volumeClaimSpec | -object | -Defines a PersistentVolumeClaim spec used to create and/or bind a volume | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| accessModes | -[]string | -accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | -false | -
| dataSource | -object | -dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. | -false | -
| dataSourceRef | -object | -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. | -false | -
| resources | -object | -resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | -false | -
| selector | -object | -selector is a label query over volumes to consider for binding. | -false | -
| storageClassName | -string | -storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | -false | -
| volumeMode | -string | -volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. | -false | -
| volumeName | -string | -volumeName is the binding reference to the PersistentVolume backing this claim. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMap | -object | -configMap information about the configMap data to project | -false | -
| downwardAPI | -object | -downwardAPI information about the downwardAPI data to project | -false | -
| secret | -object | -secret information about the secret data to project | -false | -
| serviceAccountToken | -object | -serviceAccountToken is information about the serviceAccountToken data to project | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -Items is a list of DownwardAPIVolume file | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | -true | -
| fieldRef | -object | -Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | -false | -
| mode | -integer | -Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| resourceFieldRef | -object | -Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -path is the path relative to the mount point of the file to project the token into. | -true | -
| audience | -string | -audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. | -false | -
| expirationSeconds | -integer | -expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| repoName | -string | -The name of the pgBackRest repo within the source PostgresCluster that contains the backups that should be utilized to perform a pgBackRest restore when initializing the data source for the new PostgresCluster. | -true | -
| affinity | -object | -Scheduling constraints of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| clusterName | -string | -The name of an existing PostgresCluster to use as the data source for the new PostgresCluster. Defaults to the name of the PostgresCluster being created if not provided. | -false | -
| clusterNamespace | -string | -The namespace of the cluster specified as the data source using the clusterName field. Defaults to the namespace of the PostgresCluster being created if not provided. | -false | -
| options | -[]string | -Command line options to include when running the pgBackRest restore command. https://pgbackrest.org/command.html#command-restore | -false | -
| priorityClassName | -string | -Priority class name for the pgBackRest restore Job pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| resources | -object | -Resource requirements for the pgBackRest restore Job. | -false | -
| tolerations | -[]object | -Tolerations of the pgBackRest restore Job. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgBackRestVolume | -object | -Defines the existing pgBackRest repo volume and directory to use in the current PostgresCluster. | -false | -
| pgDataVolume | -object | -Defines the existing pgData volume and directory to use in the current PostgresCluster. | -false | -
| pgWALVolume | -object | -Defines the existing pg_wal volume and directory to use in the current PostgresCluster. Note that a defined pg_wal volume MUST be accompanied by a pgData volume. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pvcName | -string | -The existing PVC name. | -true | -
| directory | -string | -The existing directory. When not set, a move Job is not created for the associated volume. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pvcName | -string | -The existing PVC name. | -true | -
| directory | -string | -The existing directory. When not set, a move Job is not created for the associated volume. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pvcName | -string | -The existing PVC name. | -true | -
| directory | -string | -The existing directory. When not set, a move Job is not created for the associated volume. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -Key is the ConfigMap data key that points to a SQL string | -true | -
| name | -string | -Name is the name of a ConfigMap | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgmonitor | -object | -PGMonitorSpec defines the desired state of the pgMonitor tool suite | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exporter | -object | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configuration | -[]object | -Projected volumes containing custom PostgreSQL Exporter configuration. Currently supports the customization of PostgreSQL Exporter queries. If a "queries.yml" file is detected in any volume projected using this field, it will be loaded using the "extend.query-path" flag: https://github.com/prometheus-community/postgres_exporter#flags Changing the values of field causes PostgreSQL and the exporter to restart. | -false | -
| customTLSSecret | -object | -Projected secret containing custom TLS certificates to encrypt output from the exporter web server | -false | -
| image | -string | -The image name to use for crunchy-postgres-exporter containers. The image may also be set using the RELATED_IMAGE_PGEXPORTER environment variable. | -false | -
| resources | -object | -Changing this value causes PostgreSQL and the exporter to restart. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMap | -object | -configMap information about the configMap data to project | -false | -
| downwardAPI | -object | -downwardAPI information about the downwardAPI data to project | -false | -
| secret | -object | -secret information about the secret data to project | -false | -
| serviceAccountToken | -object | -serviceAccountToken is information about the serviceAccountToken data to project | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -Items is a list of DownwardAPIVolume file | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | -true | -
| fieldRef | -object | -Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | -false | -
| mode | -integer | -Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| resourceFieldRef | -object | -Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -path is the path relative to the mount point of the file to project the token into. | -true | -
| audience | -string | -audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. | -false | -
| expirationSeconds | -integer | -expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| dynamicConfiguration | -object | -Patroni dynamic configuration settings. Changes to this value will be automatically reloaded without validation. Changes to certain PostgreSQL parameters cause PostgreSQL to restart. More info: https://patroni.readthedocs.io/en/latest/SETTINGS.html | -false | -
| leaderLeaseDurationSeconds | -integer | -TTL of the cluster leader lock. "Think of it as the length of time before initiation of the automatic failover process." Changing this value causes PostgreSQL to restart. | -false | -
| port | -integer | -The port on which Patroni should listen. Changing this value causes PostgreSQL to restart. | -false | -
| switchover | -object | -Switchover gives options to perform ad hoc switchovers in a PostgresCluster. | -false | -
| syncPeriodSeconds | -integer | -The interval for refreshing the leader lock and applying dynamicConfiguration. Must be less than leaderLeaseDurationSeconds. Changing this value causes PostgreSQL to restart. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| enabled | -boolean | -Whether or not the operator should allow switchovers in a PostgresCluster | -true | -
| targetInstance | -string | -The instance that should become primary during a switchover. This field is optional when Type is "Switchover" and required when Type is "Failover". When it is not specified, a healthy replica is automatically selected. | -false | -
| type | -enum | -Type of switchover to perform. Valid options are Switchover and Failover. "Switchover" changes the primary instance of a healthy PostgresCluster. "Failover" forces a particular instance to be primary, regardless of other factors. A TargetInstance must be specified to failover. NOTE: The Failover type is reserved as the "last resort" case. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgBouncer | -object | -Defines a PgBouncer proxy and connection pooler. | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| affinity | -object | -Scheduling constraints of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| config | -object | -Configuration settings for the PgBouncer process. Changes to any of these values will be automatically reloaded without validation. Be careful, as you may put PgBouncer into an unusable state. More info: https://www.pgbouncer.org/usage.html#reload | -false | -
| containers | -[]object | -Custom sidecars for a PgBouncer pod. Changing this value causes PgBouncer to restart. | -false | -
| customTLSSecret | -object | -A secret projection containing a certificate and key with which to encrypt connections to PgBouncer. The "tls.crt", "tls.key", and "ca.crt" paths must be PEM-encoded certificates and keys. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/configuration/secret/#projection-of-secret-keys-to-specific-paths | -false | -
| image | -string | -Name of a container image that can run PgBouncer 1.15 or newer. Changing this value causes PgBouncer to restart. The image may also be set using the RELATED_IMAGE_PGBOUNCER environment variable. More info: https://kubernetes.io/docs/concepts/containers/images | -false | -
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| minAvailable | -int or string | -Minimum number of pods that should be available at a time. Defaults to one when the replicas field is greater than one. | -false | -
| port | -integer | -Port on which PgBouncer should listen for client connections. Changing this value causes PgBouncer to restart. | -false | -
| priorityClassName | -string | -Priority class name for the pgBouncer pod. Changing this value causes PostgreSQL to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| replicas | -integer | -Number of desired PgBouncer pods. | -false | -
| resources | -object | -Compute resources of a PgBouncer container. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers | -false | -
| service | -object | -Specification of the service that exposes PgBouncer. | -false | -
| sidecars | -object | -Configuration for pgBouncer sidecar containers | -false | -
| tolerations | -[]object | -Tolerations of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| topologySpreadConstraints | -[]object | -Topology spread constraints of a PgBouncer pod. Changing this value causes PgBouncer to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | -false | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| databases | -map[string]string | -PgBouncer database definitions. The key is the database requested by a client while the value is a libpq-styled connection string. The special key "*" acts as a fallback. When this field is empty, PgBouncer is configured with a single "*" entry that connects to the primary PostgreSQL instance. More info: https://www.pgbouncer.org/config.html#section-databases | -false | -
| files | -[]object | -Files to mount under "/etc/pgbouncer". When specified, settings in the "pgbouncer.ini" file are loaded before all others. From there, other files may be included by absolute path. Changing these references causes PgBouncer to restart, but changes to the file contents are automatically reloaded. More info: https://www.pgbouncer.org/config.html#include-directive | -false | -
| global | -map[string]string | -Settings that apply to the entire PgBouncer process. More info: https://www.pgbouncer.org/config.html | -false | -
| users | -map[string]string | -Connection settings specific to particular users. More info: https://www.pgbouncer.org/config.html#section-users | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMap | -object | -configMap information about the configMap data to project | -false | -
| downwardAPI | -object | -downwardAPI information about the downwardAPI data to project | -false | -
| secret | -object | -secret information about the secret data to project | -false | -
| serviceAccountToken | -object | -serviceAccountToken is information about the serviceAccountToken data to project | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -Items is a list of DownwardAPIVolume file | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | -true | -
| fieldRef | -object | -Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | -false | -
| mode | -integer | -Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| resourceFieldRef | -object | -Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -path is the path relative to the mount point of the file to project the token into. | -true | -
| audience | -string | -audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. | -false | -
| expirationSeconds | -integer | -expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. | -false | -
| 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 must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. 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. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. 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 | -
| resources | -object | -Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the environment variable. Must be a C_IDENTIFIER. | -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 | -
| 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[' |
- 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -The key to select. | -true | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the ConfigMap or its key must be defined | -false | -
| 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 | -
| 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 | -
| 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMapRef | -object | -The ConfigMap to select from | -false | -
| prefix | -string | -An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. | -false | -
| secretRef | -object | -The Secret to select from | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the ConfigMap must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the Secret must be defined | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| httpGet | -object | -HTTPGet specifies the http request to perform. | -false | -
| tcpSocket | -object | -Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. | -false | -
| 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 | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| httpGet | -object | -HTTPGet specifies the http request to perform. | -false | -
| tcpSocket | -object | -Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. | -false | -
| 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 | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| failureThreshold | -integer | -Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. | -false | -
| grpc | -object | -GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. | -false | -
| httpGet | -object | -HTTPGet specifies the http 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 | -false | -
| periodSeconds | -integer | -How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. | -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. | -false | -
| tcpSocket | -object | -TCPSocket specifies an action involving 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. | -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 | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| port | -integer | -Port number of the gRPC service. Number must be in the range 1 to 65535. | -true | -
| 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. | -false | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| 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. | -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. | -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". | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| failureThreshold | -integer | -Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. | -false | -
| grpc | -object | -GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. | -false | -
| httpGet | -object | -HTTPGet specifies the http 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 | -false | -
| periodSeconds | -integer | -How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. | -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. | -false | -
| tcpSocket | -object | -TCPSocket specifies an action involving 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. | -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 | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| port | -integer | -Port number of the gRPC service. Number must be in the range 1 to 65535. | -true | -
| 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. | -false | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 | -
| 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 is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. 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. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| add | -[]string | -Added capabilities | -false | -
| drop | -[]string | -Removed capabilities | -false | -
| 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 | -
| 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 only be set if type is "Localhost". | -false | -
| 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. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exec | -object | -Exec specifies the action to take. | -false | -
| failureThreshold | -integer | -Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. | -false | -
| grpc | -object | -GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate. | -false | -
| httpGet | -object | -HTTPGet specifies the http 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 | -false | -
| periodSeconds | -integer | -How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. | -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. | -false | -
| tcpSocket | -object | -TCPSocket specifies an action involving 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. | -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 | -false | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| port | -integer | -Port number of the gRPC service. Number must be in the range 1 to 65535. | -true | -
| 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. | -false | -
| 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 | -
| scheme | -string | -Scheme to use for connecting to the host. Defaults to HTTP. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The header field name | -true | -
| value | -string | -The header field value | -true | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| mountPath | -string | -Path within the container at which the volume should be mounted. Must not contain ':'. | -true | -
| name | -string | -This must match the Name of a Volume. | -true | -
| 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. | -false | -
| readOnly | -boolean | -Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| nodePort | -integer | -The port on which this service is exposed when type is NodePort or LoadBalancer. Value must be in-range and not in use or the operation will fail. If unspecified, a port will be allocated if this Service requires one. - https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport | -false | -
| type | -enum | -More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgbouncerConfig | -object | -Defines the configuration for the pgBouncer config sidecar container | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| resources | -object | -Resource requirements for a sidecar container | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| maxSkew | -integer | -MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. | -true | -
| topologyKey | -string | -TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each |
- true | -
| whenUnsatisfiable | -string | -WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. | -true | -
| labelSelector | -object | -LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. | -false | -
| minDomains | -integer | -MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. - This is an alpha field and requires enabling MinDomainsInPodTopologySpread feature gate. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| nodePort | -integer | -The port on which this service is exposed when type is NodePort or LoadBalancer. Value must be in-range and not in use or the operation will fail. If unspecified, a port will be allocated if this Service requires one. - https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport | -false | -
| type | -enum | -More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| enabled | -boolean | -Whether or not the PostgreSQL cluster should be read-only. When this is true, WAL files are applied from a pgBackRest repository or another PostgreSQL server. | -false | -
| host | -string | -Network address of the PostgreSQL server to follow via streaming replication. | -false | -
| port | -integer | -Network port of the PostgreSQL server to follow via streaming replication. | -false | -
| repoName | -string | -The name of the pgBackRest repository to follow for WAL files. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgAdmin | -object | -Defines a pgAdmin user interface. | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| dataVolumeClaimSpec | -object | -Defines a PersistentVolumeClaim for pgAdmin data. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes | -true | -
| affinity | -object | -Scheduling constraints of a pgAdmin pod. Changing this value causes pgAdmin to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node | -false | -
| config | -object | -Configuration settings for the pgAdmin process. Changes to any of these values will be loaded without validation. Be careful, as you may put pgAdmin into an unusable state. | -false | -
| image | -string | -Name of a container image that can run pgAdmin 4. Changing this value causes pgAdmin to restart. The image may also be set using the RELATED_IMAGE_PGADMIN environment variable. More info: https://kubernetes.io/docs/concepts/containers/images | -false | -
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| priorityClassName | -string | -Priority class name for the pgAdmin pod. Changing this value causes pgAdmin to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ | -false | -
| replicas | -integer | -Number of desired pgAdmin pods. | -false | -
| resources | -object | -Compute resources of a pgAdmin container. Changing this value causes pgAdmin to restart. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers | -false | -
| service | -object | -Specification of the service that exposes pgAdmin. | -false | -
| tolerations | -[]object | -Tolerations of a pgAdmin pod. Changing this value causes pgAdmin to restart. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration | -false | -
| topologySpreadConstraints | -[]object | -Topology spread constraints of a pgAdmin pod. Changing this value causes pgAdmin to restart. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| accessModes | -[]string | -accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 | -false | -
| dataSource | -object | -dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. | -false | -
| dataSourceRef | -object | -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. | -false | -
| resources | -object | -resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | -false | -
| selector | -object | -selector is a label query over volumes to consider for binding. | -false | -
| storageClassName | -string | -storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 | -false | -
| volumeMode | -string | -volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. | -false | -
| volumeName | -string | -volumeName is the binding reference to the PersistentVolume backing this claim. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -string | -Kind is the type of resource being referenced | -true | -
| name | -string | -Name is the name of resource being referenced | -true | -
| apiGroup | -string | -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| nodeSelectorTerms | -[]object | -Required. A list of node selector terms. The terms are ORed. | -true | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 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 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 | -
| 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. | -true | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| 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. | -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 | -
| 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 | -
| 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 | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| files | -[]object | -Files allows the user to mount projected volumes into the pgAdmin container so that files can be referenced by pgAdmin as needed. | -false | -
| ldapBindPassword | -object | -A Secret containing the value for the LDAP_BIND_PASSWORD setting. More info: https://www.pgadmin.org/docs/pgadmin4/latest/ldap.html | -false | -
| settings | -object | -Settings for the pgAdmin server process. Keys should be uppercase and values must be constants. More info: https://www.pgadmin.org/docs/pgadmin4/latest/config_py.html | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| configMap | -object | -configMap information about the configMap data to project | -false | -
| downwardAPI | -object | -downwardAPI information about the downwardAPI data to project | -false | -
| secret | -object | -secret information about the secret data to project | -false | -
| serviceAccountToken | -object | -serviceAccountToken is information about the serviceAccountToken data to project | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional specify whether the ConfigMap or its keys must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -Items is a list of DownwardAPIVolume file | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' | -true | -
| fieldRef | -object | -Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | -false | -
| mode | -integer | -Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| resourceFieldRef | -object | -Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| items | -[]object | -items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. | -false | -
| name | -string | -Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -optional field specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| key | -string | -key is the key to project. | -true | -
| path | -string | -path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. | -true | -
| mode | -integer | -mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| path | -string | -path is the path relative to the mount point of the file to project the token into. | -true | -
| audience | -string | -audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. | -false | -
| expirationSeconds | -integer | -expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. | -false | -
| 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | -false | -
| optional | -boolean | -Specify whether the Secret or its key must be defined | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| metadata | -object | -Metadata contains metadata for custom resources | -false | -
| nodePort | -integer | -The port on which this service is exposed when type is NodePort or LoadBalancer. Value must be in-range and not in use or the operation will fail. If unspecified, a port will be allocated if this Service requires one. - https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport | -false | -
| type | -enum | -More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| annotations | -map[string]string | -- | false | -
| labels | -map[string]string | -- | false | -
| 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 and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. | -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. | -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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| maxSkew | -integer | -MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. | -true | -
| topologyKey | -string | -TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each |
- true | -
| whenUnsatisfiable | -string | -WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. | -true | -
| labelSelector | -object | -LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. | -false | -
| minDomains | -integer | -MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. - This is an alpha field and requires enabling MinDomainsInPodTopologySpread feature gate. | -false | -
| 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 | -
| 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 | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The name of this PostgreSQL user. The value may contain only lowercase letters, numbers, and hyphen so that it fits into Kubernetes metadata. | -true | -
| databases | -[]string | -Databases to which this user can connect and create objects. Removing a database from this list does NOT revoke access. This field is ignored for the "postgres" user. | -false | -
| options | -string | -ALTER ROLE options except for PASSWORD. This field is ignored for the "postgres" user. More info: https://www.postgresql.org/docs/current/role-attributes.html | -false | -
| password | -object | -Properties of the password generated for this user. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| type | -enum | -Type of password to generate. Defaults to ASCII. Valid options are ASCII and AlphaNumeric. "ASCII" passwords contain letters, numbers, and symbols from the US-ASCII character set. "AlphaNumeric" passwords contain letters and numbers from the US-ASCII character set. | -true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| conditions | -[]object | -conditions represent the observations of postgrescluster's current state. Known .status.conditions.type are: "PersistentVolumeResizing", "Progressing", "ProxyAvailable" | -false | -
| databaseInitSQL | -string | -DatabaseInitSQL state of custom database initialization in the cluster | -false | -
| databaseRevision | -string | -Identifies the databases that have been installed into PostgreSQL. | -false | -
| instances | -[]object | -Current state of PostgreSQL instances. | -false | -
| monitoring | -object | -Current state of PostgreSQL cluster monitoring tool configuration | -false | -
| observedGeneration | -integer | -observedGeneration represents the .metadata.generation on which the status was based. | -false | -
| patroni | -object | -- | false | -
| pgbackrest | -object | -Status information for pgBackRest | -false | -
| postgresVersion | -integer | -Stores the current PostgreSQL major version following a successful major PostgreSQL upgrade. | -false | -
| proxy | -object | -Current state of the PostgreSQL proxy. | -false | -
| startupInstance | -string | -The instance that should be started first when bootstrapping and/or starting a PostgresCluster. | -false | -
| startupInstanceSet | -string | -The instance set associated with the startupInstance | -false | -
| userInterface | -object | -Current state of the PostgreSQL user interface. | -false | -
| usersRevision | -string | -Identifies the users that have been installed into PostgreSQL. | -false | -
| 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. | -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. | -true | -
| type | -string | -type of condition in 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. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -- | true | -
| readyReplicas | -integer | -Total number of ready pods. | -false | -
| replicas | -integer | -Total number of pods. | -false | -
| updatedReplicas | -integer | -Total number of pods that have the desired specification. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| exporterConfiguration | -string | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| switchover | -string | -Tracks the execution of the switchover requests. | -false | -
| switchoverTimeline | -integer | -Tracks the current timeline during switchovers | -false | -
| systemIdentifier | -string | -The PostgreSQL system identifier reported by Patroni. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| manualBackup | -object | -Status information for manual backups | -false | -
| repoHost | -object | -Status information for the pgBackRest dedicated repository host | -false | -
| repos | -[]object | -Status information for pgBackRest repositories | -false | -
| restore | -object | -Status information for in-place restores | -false | -
| scheduledBackups | -[]object | -Status information for scheduled backups | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| finished | -boolean | -Specifies whether or not the Job is finished executing (does not indicate success or failure). | -true | -
| id | -string | -A unique identifier for the manual backup as provided using the "pgbackrest-backup" annotation when initiating a backup. | -true | -
| active | -integer | -The number of actively running manual backup Pods. | -false | -
| completionTime | -string | -Represents the time the manual backup Job was determined by the Job controller to be completed. This field is only set if the backup completed successfully. Additionally, it is represented in RFC3339 form and is in UTC. | -false | -
| failed | -integer | -The number of Pods for the manual backup Job that reached the "Failed" phase. | -false | -
| startTime | -string | -Represents the time the manual backup Job was acknowledged by the Job controller. It is represented in RFC3339 form and is in UTC. | -false | -
| succeeded | -integer | -The number of Pods for the manual backup Job that reached the "Succeeded" phase. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| apiVersion | -string | -APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | -false | -
| kind | -string | -Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | -false | -
| ready | -boolean | -Whether or not the pgBackRest repository host is ready for use | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -The name of the pgBackRest repository | -true | -
| bound | -boolean | -Whether or not the pgBackRest repository PersistentVolumeClaim is bound to a volume | -false | -
| replicaCreateBackupComplete | -boolean | -ReplicaCreateBackupReady indicates whether a backup exists in the repository as needed to bootstrap replicas. | -false | -
| repoOptionsHash | -string | -A hash of the required fields in the spec for defining an Azure, GCS or S3 repository, Utilizd to detect changes to these fields and then execute pgBackRest stanza-create commands accordingly. | -false | -
| stanzaCreated | -boolean | -Specifies whether or not a stanza has been successfully created for the repository | -false | -
| volume | -string | -The name of the volume the containing the pgBackRest repository | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| finished | -boolean | -Specifies whether or not the Job is finished executing (does not indicate success or failure). | -true | -
| id | -string | -A unique identifier for the manual backup as provided using the "pgbackrest-backup" annotation when initiating a backup. | -true | -
| active | -integer | -The number of actively running manual backup Pods. | -false | -
| completionTime | -string | -Represents the time the manual backup Job was determined by the Job controller to be completed. This field is only set if the backup completed successfully. Additionally, it is represented in RFC3339 form and is in UTC. | -false | -
| failed | -integer | -The number of Pods for the manual backup Job that reached the "Failed" phase. | -false | -
| startTime | -string | -Represents the time the manual backup Job was acknowledged by the Job controller. It is represented in RFC3339 form and is in UTC. | -false | -
| succeeded | -integer | -The number of Pods for the manual backup Job that reached the "Succeeded" phase. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| active | -integer | -The number of actively running manual backup Pods. | -false | -
| completionTime | -string | -Represents the time the manual backup Job was determined by the Job controller to be completed. This field is only set if the backup completed successfully. Additionally, it is represented in RFC3339 form and is in UTC. | -false | -
| cronJobName | -string | -The name of the associated pgBackRest scheduled backup CronJob | -false | -
| failed | -integer | -The number of Pods for the manual backup Job that reached the "Failed" phase. | -false | -
| repo | -string | -The name of the associated pgBackRest repository | -false | -
| startTime | -string | -Represents the time the manual backup Job was acknowledged by the Job controller. It is represented in RFC3339 form and is in UTC. | -false | -
| succeeded | -integer | -The number of Pods for the manual backup Job that reached the "Succeeded" phase. | -false | -
| type | -string | -The pgBackRest backup type for this Job | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgBouncer | -object | -- | false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| postgresRevision | -string | -Identifies the revision of PgBouncer assets that have been installed into PostgreSQL. | -false | -
| readyReplicas | -integer | -Total number of ready pods. | -false | -
| replicas | -integer | -Total number of non-terminated pods. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| pgAdmin | -object | -The state of the pgAdmin user interface. | -false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| usersRevision | -string | -Hash that indicates which users have been installed into pgAdmin. | -false | -