Update backup_v1.json (#306)

postgresql.cnpg.io/backup_v1.json

@@ -29,6 +29,35 @@
           "type": "object",
           "additionalProperties": false
         },
+        "method": {
+          "default": "barmanObjectStore",
+          "description": "The backup method to be used, possible options are `barmanObjectStore` and `volumeSnapshot`. Defaults to: `barmanObjectStore`.",
+          "enum": [
+            "barmanObjectStore",
+            "volumeSnapshot"
+          ],
+          "type": "string"
+        },
+        "online": {
+          "description": "Whether the default type of backup with volume snapshots is online/hot (`true`, default) or offline/cold (`false`) Overrides the default setting specified in the cluster field '.spec.backup.volumeSnapshot.online'",
+          "type": "boolean"
+        },
+        "onlineConfiguration": {
+          "description": "Configuration parameters to control the online/hot backup with volume snapshots Overrides the default settings specified in the cluster '.backup.volumeSnapshot.onlineConfiguration' stanza",
+          "properties": {
+            "immediateCheckpoint": {
+              "description": "Control whether the I/O workload for the backup initial checkpoint will be limited, according to the `checkpoint_completion_target` setting on the PostgreSQL server. If set to true, an immediate checkpoint will be used, meaning PostgreSQL will complete the checkpoint as soon as possible. `false` by default.",
+              "type": "boolean"
+            },
+            "waitForArchive": {
+              "default": true,
+              "description": "If false, the function will return immediately after the backup is completed, without waiting for WAL to be archived. This behavior is only useful with backup software that independently monitors WAL archiving. Otherwise, WAL required to make the backup consistent might be missing and make the backup useless. By default, or when this parameter is true, pg_backup_stop will wait for WAL to be archived when archiving is enabled. On a standby, this means that it will wait only when archive_mode = always. If write activity on the primary is low, it may be useful to run pg_switch_wal on the primary in order to trigger an immediate segment switch.",
+              "type": "boolean"
+            }
+          },
+          "type": "object",
+          "additionalProperties": false
+        },
         "target": {
           "description": "The policy to decide which instance should perform this backup. If empty, it defaults to `cluster.spec.backup.target`. Available options are empty string, `primary` and `prefer-standby`. `primary` to have backups run always on primary instances, `prefer-standby` to have backups run preferably on the most updated standby, if available.",
           "enum": [
@@ -38,6 +67,9 @@
           "type": "string"
         }
       },
+      "required": [
+        "cluster"
+      ],
       "type": "object",
       "additionalProperties": false
     },
@@ -135,6 +167,11 @@
           "description": "The ID of the Barman backup",
           "type": "string"
         },
+        "backupLabelFile": {
+          "description": "Backup label file content as returned by Postgres in case of online (hot) backups",
+          "format": "byte",
+          "type": "string"
+        },
         "backupName": {
           "description": "The Name of the Barman backup",
           "type": "string"
@@ -243,6 +280,14 @@
           "type": "object",
           "additionalProperties": false
         },
+        "method": {
+          "description": "The backup method being used",
+          "type": "string"
+        },
+        "online": {
+          "description": "Whether the backup was online/hot (`true`) or offline/cold (`false`)",
+          "type": "boolean"
+        },
         "phase": {
           "description": "The last backup status",
           "type": "string"
@@ -338,6 +383,40 @@
           "description": "The server name on S3, the cluster name is used if this parameter is omitted",
           "type": "string"
         },
+        "snapshotBackupStatus": {
+          "description": "Status of the volumeSnapshot backup",
+          "properties": {
+            "elements": {
+              "description": "The elements list, populated with the gathered volume snapshots",
+              "items": {
+                "description": "BackupSnapshotElementStatus is a volume snapshot that is part of a volume snapshot method backup",
+                "properties": {
+                  "name": {
+                    "description": "Name is the snapshot resource name",
+                    "type": "string"
+                  },
+                  "tablespaceName": {
+                    "description": "TablespaceName is the name of the snapshotted tablespace. Only set when type is PG_TABLESPACE",
+                    "type": "string"
+                  },
+                  "type": {
+                    "description": "Type is tho role of the snapshot in the cluster, such as PG_DATA, PG_WAL and PG_TABLESPACE",
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "name",
+                  "type"
+                ],
+                "type": "object",
+                "additionalProperties": false
+              },
+              "type": "array"
+            }
+          },
+          "type": "object",
+          "additionalProperties": false
+        },
         "startedAt": {
           "description": "When the backup was started",
           "format": "date-time",
@@ -347,11 +426,20 @@
           "description": "When the backup was terminated",
           "format": "date-time",
           "type": "string"
+        },
+        "tablespaceMapFile": {
+          "description": "Tablespace map file content as returned by Postgres in case of online (hot) backups",
+          "format": "byte",
+          "type": "string"
         }
       },
       "type": "object",
       "additionalProperties": false
     }
   },
+  "required": [
+    "metadata",
+    "spec"
+  ],
   "type": "object"
 }