github.com/verrazzano/verrazzano@v1.7.0/platform-operator/thirdparty/charts/velero/crds/backups.yaml (about) 1 2 --- 3 apiVersion: apiextensions.k8s.io/v1 4 kind: CustomResourceDefinition 5 metadata: 6 labels: 7 component: velero 8 annotations: 9 controller-gen.kubebuilder.io/version: v0.7.0 10 creationTimestamp: null 11 name: backups.velero.io 12 spec: 13 group: velero.io 14 names: 15 kind: Backup 16 listKind: BackupList 17 plural: backups 18 singular: backup 19 scope: Namespaced 20 versions: 21 - name: v1 22 schema: 23 openAPIV3Schema: 24 description: Backup is a Velero resource that represents the capture of Kubernetes 25 cluster state at a point in time (API objects and associated volume state). 26 properties: 27 apiVersion: 28 description: 'APIVersion defines the versioned schema of this representation 29 of an object. Servers should convert recognized schemas to the latest 30 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 31 type: string 32 kind: 33 description: 'Kind is a string value representing the REST resource this 34 object represents. Servers may infer this from the endpoint the client 35 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 36 type: string 37 metadata: 38 type: object 39 spec: 40 description: BackupSpec defines the specification for a Velero backup. 41 properties: 42 defaultVolumesToRestic: 43 description: DefaultVolumesToRestic specifies whether restic should 44 be used to take a backup of all pod volumes by default. 45 type: boolean 46 excludedNamespaces: 47 description: ExcludedNamespaces contains a list of namespaces that 48 are not included in the backup. 49 items: 50 type: string 51 nullable: true 52 type: array 53 excludedResources: 54 description: ExcludedResources is a slice of resource names that are 55 not included in the backup. 56 items: 57 type: string 58 nullable: true 59 type: array 60 hooks: 61 description: Hooks represent custom behaviors that should be executed 62 at different phases of the backup. 63 properties: 64 resources: 65 description: Resources are hooks that should be executed when 66 backing up individual instances of a resource. 67 items: 68 description: BackupResourceHookSpec defines one or more BackupResourceHooks 69 that should be executed based on the rules defined for namespaces, 70 resources, and label selector. 71 properties: 72 excludedNamespaces: 73 description: ExcludedNamespaces specifies the namespaces 74 to which this hook spec does not apply. 75 items: 76 type: string 77 nullable: true 78 type: array 79 excludedResources: 80 description: ExcludedResources specifies the resources to 81 which this hook spec does not apply. 82 items: 83 type: string 84 nullable: true 85 type: array 86 includedNamespaces: 87 description: IncludedNamespaces specifies the namespaces 88 to which this hook spec applies. If empty, it applies 89 to all namespaces. 90 items: 91 type: string 92 nullable: true 93 type: array 94 includedResources: 95 description: IncludedResources specifies the resources to 96 which this hook spec applies. If empty, it applies to 97 all resources. 98 items: 99 type: string 100 nullable: true 101 type: array 102 labelSelector: 103 description: LabelSelector, if specified, filters the resources 104 to which this hook spec applies. 105 nullable: true 106 properties: 107 matchExpressions: 108 description: matchExpressions is a list of label selector 109 requirements. The requirements are ANDed. 110 items: 111 description: A label selector requirement is a selector 112 that contains values, a key, and an operator that 113 relates the key and values. 114 properties: 115 key: 116 description: key is the label key that the selector 117 applies to. 118 type: string 119 operator: 120 description: operator represents a key's relationship 121 to a set of values. Valid operators are In, 122 NotIn, Exists and DoesNotExist. 123 type: string 124 values: 125 description: values is an array of string values. 126 If the operator is In or NotIn, the values array 127 must be non-empty. If the operator is Exists 128 or DoesNotExist, the values array must be empty. 129 This array is replaced during a strategic merge 130 patch. 131 items: 132 type: string 133 type: array 134 required: 135 - key 136 - operator 137 type: object 138 type: array 139 matchLabels: 140 additionalProperties: 141 type: string 142 description: matchLabels is a map of {key,value} pairs. 143 A single {key,value} in the matchLabels map is equivalent 144 to an element of matchExpressions, whose key field 145 is "key", the operator is "In", and the values array 146 contains only "value". The requirements are ANDed. 147 type: object 148 type: object 149 name: 150 description: Name is the name of this hook. 151 type: string 152 post: 153 description: PostHooks is a list of BackupResourceHooks 154 to execute after storing the item in the backup. These 155 are executed after all "additional items" from item actions 156 are processed. 157 items: 158 description: BackupResourceHook defines a hook for a resource. 159 properties: 160 exec: 161 description: Exec defines an exec hook. 162 properties: 163 command: 164 description: Command is the command and arguments 165 to execute. 166 items: 167 type: string 168 minItems: 1 169 type: array 170 container: 171 description: Container is the container in the 172 pod where the command should be executed. If 173 not specified, the pod's first container is 174 used. 175 type: string 176 onError: 177 description: OnError specifies how Velero should 178 behave if it encounters an error executing this 179 hook. 180 enum: 181 - Continue 182 - Fail 183 type: string 184 timeout: 185 description: Timeout defines the maximum amount 186 of time Velero should wait for the hook to complete 187 before considering the execution a failure. 188 type: string 189 required: 190 - command 191 type: object 192 required: 193 - exec 194 type: object 195 type: array 196 pre: 197 description: PreHooks is a list of BackupResourceHooks to 198 execute prior to storing the item in the backup. These 199 are executed before any "additional items" from item actions 200 are processed. 201 items: 202 description: BackupResourceHook defines a hook for a resource. 203 properties: 204 exec: 205 description: Exec defines an exec hook. 206 properties: 207 command: 208 description: Command is the command and arguments 209 to execute. 210 items: 211 type: string 212 minItems: 1 213 type: array 214 container: 215 description: Container is the container in the 216 pod where the command should be executed. If 217 not specified, the pod's first container is 218 used. 219 type: string 220 onError: 221 description: OnError specifies how Velero should 222 behave if it encounters an error executing this 223 hook. 224 enum: 225 - Continue 226 - Fail 227 type: string 228 timeout: 229 description: Timeout defines the maximum amount 230 of time Velero should wait for the hook to complete 231 before considering the execution a failure. 232 type: string 233 required: 234 - command 235 type: object 236 required: 237 - exec 238 type: object 239 type: array 240 required: 241 - name 242 type: object 243 nullable: true 244 type: array 245 type: object 246 includeClusterResources: 247 description: IncludeClusterResources specifies whether cluster-scoped 248 resources should be included for consideration in the backup. 249 nullable: true 250 type: boolean 251 includedNamespaces: 252 description: IncludedNamespaces is a slice of namespace names to include 253 objects from. If empty, all namespaces are included. 254 items: 255 type: string 256 nullable: true 257 type: array 258 includedResources: 259 description: IncludedResources is a slice of resource names to include 260 in the backup. If empty, all resources are included. 261 items: 262 type: string 263 nullable: true 264 type: array 265 labelSelector: 266 description: LabelSelector is a metav1.LabelSelector to filter with 267 when adding individual objects to the backup. If empty or nil, all 268 objects are included. Optional. 269 nullable: true 270 properties: 271 matchExpressions: 272 description: matchExpressions is a list of label selector requirements. 273 The requirements are ANDed. 274 items: 275 description: A label selector requirement is a selector that 276 contains values, a key, and an operator that relates the key 277 and values. 278 properties: 279 key: 280 description: key is the label key that the selector applies 281 to. 282 type: string 283 operator: 284 description: operator represents a key's relationship to 285 a set of values. Valid operators are In, NotIn, Exists 286 and DoesNotExist. 287 type: string 288 values: 289 description: values is an array of string values. If the 290 operator is In or NotIn, the values array must be non-empty. 291 If the operator is Exists or DoesNotExist, the values 292 array must be empty. This array is replaced during a strategic 293 merge patch. 294 items: 295 type: string 296 type: array 297 required: 298 - key 299 - operator 300 type: object 301 type: array 302 matchLabels: 303 additionalProperties: 304 type: string 305 description: matchLabels is a map of {key,value} pairs. A single 306 {key,value} in the matchLabels map is equivalent to an element 307 of matchExpressions, whose key field is "key", the operator 308 is "In", and the values array contains only "value". The requirements 309 are ANDed. 310 type: object 311 type: object 312 metadata: 313 properties: 314 labels: 315 additionalProperties: 316 type: string 317 type: object 318 type: object 319 orLabelSelectors: 320 description: OrLabelSelectors is list of metav1.LabelSelector to filter 321 with when adding individual objects to the backup. If multiple provided 322 they will be joined by the OR operator. LabelSelector as well as 323 OrLabelSelectors cannot co-exist in backup request, only one of 324 them can be used. 325 items: 326 description: A label selector is a label query over a set of resources. 327 The result of matchLabels and matchExpressions are ANDed. An empty 328 label selector matches all objects. A null label selector matches 329 no objects. 330 properties: 331 matchExpressions: 332 description: matchExpressions is a list of label selector requirements. 333 The requirements are ANDed. 334 items: 335 description: A label selector requirement is a selector that 336 contains values, a key, and an operator that relates the 337 key and values. 338 properties: 339 key: 340 description: key is the label key that the selector applies 341 to. 342 type: string 343 operator: 344 description: operator represents a key's relationship 345 to a set of values. Valid operators are In, NotIn, Exists 346 and DoesNotExist. 347 type: string 348 values: 349 description: values is an array of string values. If the 350 operator is In or NotIn, the values array must be non-empty. 351 If the operator is Exists or DoesNotExist, the values 352 array must be empty. This array is replaced during a 353 strategic merge patch. 354 items: 355 type: string 356 type: array 357 required: 358 - key 359 - operator 360 type: object 361 type: array 362 matchLabels: 363 additionalProperties: 364 type: string 365 description: matchLabels is a map of {key,value} pairs. A single 366 {key,value} in the matchLabels map is equivalent to an element 367 of matchExpressions, whose key field is "key", the operator 368 is "In", and the values array contains only "value". The requirements 369 are ANDed. 370 type: object 371 type: object 372 nullable: true 373 type: array 374 orderedResources: 375 additionalProperties: 376 type: string 377 description: OrderedResources specifies the backup order of resources 378 of specific Kind. The map key is the Kind name and value is a list 379 of resource names separated by commas. Each resource name has format 380 "namespace/resourcename". For cluster resources, simply use "resourcename". 381 nullable: true 382 type: object 383 snapshotVolumes: 384 description: SnapshotVolumes specifies whether to take cloud snapshots 385 of any PV's referenced in the set of objects included in the Backup. 386 nullable: true 387 type: boolean 388 storageLocation: 389 description: StorageLocation is a string containing the name of a 390 BackupStorageLocation where the backup should be stored. 391 type: string 392 ttl: 393 description: TTL is a time.Duration-parseable string describing how 394 long the Backup should be retained for. 395 type: string 396 volumeSnapshotLocations: 397 description: VolumeSnapshotLocations is a list containing names of 398 VolumeSnapshotLocations associated with this backup. 399 items: 400 type: string 401 type: array 402 type: object 403 status: 404 description: BackupStatus captures the current status of a Velero backup. 405 properties: 406 completionTimestamp: 407 description: CompletionTimestamp records the time a backup was completed. 408 Completion time is recorded even on failed backups. Completion time 409 is recorded before uploading the backup object. The server's time 410 is used for CompletionTimestamps 411 format: date-time 412 nullable: true 413 type: string 414 csiVolumeSnapshotsAttempted: 415 description: CSIVolumeSnapshotsAttempted is the total number of attempted 416 CSI VolumeSnapshots for this backup. 417 type: integer 418 csiVolumeSnapshotsCompleted: 419 description: CSIVolumeSnapshotsCompleted is the total number of successfully 420 completed CSI VolumeSnapshots for this backup. 421 type: integer 422 errors: 423 description: Errors is a count of all error messages that were generated 424 during execution of the backup. The actual errors are in the backup's 425 log file in object storage. 426 type: integer 427 expiration: 428 description: Expiration is when this Backup is eligible for garbage-collection. 429 format: date-time 430 nullable: true 431 type: string 432 failureReason: 433 description: FailureReason is an error that caused the entire backup 434 to fail. 435 type: string 436 formatVersion: 437 description: FormatVersion is the backup format version, including 438 major, minor, and patch version. 439 type: string 440 phase: 441 description: Phase is the current state of the Backup. 442 enum: 443 - New 444 - FailedValidation 445 - InProgress 446 - Completed 447 - PartiallyFailed 448 - Failed 449 - Deleting 450 type: string 451 progress: 452 description: Progress contains information about the backup's execution 453 progress. Note that this information is best-effort only -- if Velero 454 fails to update it during a backup for any reason, it may be inaccurate/stale. 455 nullable: true 456 properties: 457 itemsBackedUp: 458 description: ItemsBackedUp is the number of items that have actually 459 been written to the backup tarball so far. 460 type: integer 461 totalItems: 462 description: TotalItems is the total number of items to be backed 463 up. This number may change throughout the execution of the backup 464 due to plugins that return additional related items to back 465 up, the velero.io/exclude-from-backup label, and various other 466 filters that happen as items are processed. 467 type: integer 468 type: object 469 startTimestamp: 470 description: StartTimestamp records the time a backup was started. 471 Separate from CreationTimestamp, since that value changes on restores. 472 The server's time is used for StartTimestamps 473 format: date-time 474 nullable: true 475 type: string 476 validationErrors: 477 description: ValidationErrors is a slice of all validation errors 478 (if applicable). 479 items: 480 type: string 481 nullable: true 482 type: array 483 version: 484 description: 'Version is the backup format major version. Deprecated: 485 Please see FormatVersion' 486 type: integer 487 volumeSnapshotsAttempted: 488 description: VolumeSnapshotsAttempted is the total number of attempted 489 volume snapshots for this backup. 490 type: integer 491 volumeSnapshotsCompleted: 492 description: VolumeSnapshotsCompleted is the total number of successfully 493 completed volume snapshots for this backup. 494 type: integer 495 warnings: 496 description: Warnings is a count of all warning messages that were 497 generated during execution of the backup. The actual warnings are 498 in the backup's log file in object storage. 499 type: integer 500 type: object 501 type: object 502 served: true 503 storage: true 504 status: 505 acceptedNames: 506 kind: "" 507 plural: "" 508 conditions: [] 509 storedVersions: []