From 800b8190ac5aaba780d5773c230c62ce8482f1a0 Mon Sep 17 00:00:00 2001 From: poyaz Date: Sat, 23 Mar 2024 13:10:27 +0330 Subject: [PATCH] [UPDATE] Update operator and restic cli help according to new values is added Signed-off-by: poyaz --- docs/modules/ROOT/examples/usage/operator.txt | 1 + docs/modules/ROOT/examples/usage/restic.txt | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/docs/modules/ROOT/examples/usage/operator.txt b/docs/modules/ROOT/examples/usage/operator.txt index 928e124fd..2cb914614 100644 --- a/docs/modules/ROOT/examples/usage/operator.txt +++ b/docs/modules/ROOT/examples/usage/operator.txt @@ -46,4 +46,5 @@ OPTIONS: --skip-pvcs-without-annotation skip selecting PVCs that don't have the BACKUP_ANNOTATION (default: disabled) [$BACKUP_SKIP_WITHOUT_ANNOTATION] --checkschedule value the default check schedule (default: "0 0 * * 0") [$BACKUP_CHECKSCHEDULE] --operator-namespace value set the namespace in which the K8up operator itself runs [$BACKUP_OPERATOR_NAMESPACE] + --vardir value the var data dir for read/write k8up data or temp file in pod (default: /k8up) [$VAR_DIR] --help, -h show help (default: false) diff --git a/docs/modules/ROOT/examples/usage/restic.txt b/docs/modules/ROOT/examples/usage/restic.txt index db955c9c3..6127aff2d 100644 --- a/docs/modules/ROOT/examples/usage/restic.txt +++ b/docs/modules/ROOT/examples/usage/restic.txt @@ -27,6 +27,9 @@ OPTIONS: --restoreS3AccessKey value S3 access key used to connect to the S3 endpoint when restoring [$RESTORE_ACCESSKEYID] --restoreS3SecretKey value S3 secret key used to connect to the S3 endpoint when restoring [$RESTORE_SECRETACCESSKEY] --restoreS3Endpoint value S3 endpoint to connect to when restoring, e.g. 'https://minio.svc:9000/backup [$RESTORE_S3ENDPOINT] + --restoreCaCert value The certificate authority file path using for restore [$RESTORE_CA_CERT_FILE] + --restoreClientCert value The client certificate file path using for restore [$RESTORE_CLIENT_CERT_FILE] + --restoreClientKey value The client private key file path using for restore [$RESTORE_CLIENT_KEY_FILE] --verifyRestore If the restore should get verified, only for PVCs restore (default: false) --trimRestorePath If set, strips the value of --restoreDir from the lefts side of the remote restore path value (default: enabled) [$TRIM_RESTOREPATH] --resticBin value The path to the restic binary. (default: "/usr/local/bin/restic") [$RESTIC_BINARY] @@ -47,4 +50,8 @@ OPTIONS: --keepWithin value While pruning, keep tagged snapshots within the given duration, e.g. '2y5m7d3h' [$KEEP_WITHIN] --targetPods value [ --targetPods value ] Filter list of pods by TARGET_PODS names [$TARGET_PODS] --sleepDuration value Sleep for specified amount until init starts (default: 0s) [$SLEEP_DURATION] + --varDir value The var directory is stored k8up metadata files and temporary files (default: /k8up) + --caCert value The certificate authority file path [$CA_CERT_FILE] + --clientCert value The client certificate file path [$CLIENT_CERT_FILE] + --clientKey value The client private key file path [$CLIENT_KEY_FILE] --help, -h show help (default: false)