1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/resticconfig-type.adoc
Shruti Deshpande 142b23f21f Dita vale fixes for OADP API
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
2025-09-04 10:23:08 +00:00

37 lines
1.3 KiB
Plaintext

// Module included in the following assemblies:
//
// backup_and_restore/application_backup_and_restore/oadp-api.adoc
:_mod-docs-content-type: REFERENCE
[id="resticconfig-type_{context}"]
= ResticConfig type
[role="_abstract"]
The following are `ResticConfig` {oadp-short} APIs:
.ResticConfig
[options="header"]
|===
|Property|Type|Description
|`enable`
|*link:https://pkg.go.dev/builtin#bool[bool]
|If set to `true`, enables backup and restore using Restic. If set to `false`, snapshots are needed.
|`supplementalGroups`
|[]link:https://pkg.go.dev/builtin#int64[int64]
|Defines the Linux groups to be applied to the `Restic` pod.
|`timeout`
|link:https://pkg.go.dev/builtin#string[string]
|A user-supplied duration string that defines the Restic timeout. Default value is `1hr` (1 hour). A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h`, or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, and `h`.
|`podConfig`
|*link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#PodConfig[`PodConfig`]
|Defines the configuration of the `Restic` pod.
|===
[role="_additional-resources"]
.Additional resources
* link:https://pkg.go.dev/github.com/openshift/oadp-operator/api/v1alpha1#ResticConfig[Complete schema definitions for the type `ResticConfig`]