[UPDATE] Update documents because of changing options to tlsOptions

Signed-off-by: poyaz <pooya_azarpour@yahoo.com>
eunames · Apr 10, 2024 · b59589a · b59589a
1 parent 01cb120
commit b59589a
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 43 deletions.
diff --git a/docs/modules/ROOT/examples/usage/operator.txt b/docs/modules/ROOT/examples/usage/operator.txt
@@ -18,7 +18,7 @@ OPTIONS:
    --global-concurrent-check-jobs-limit value          set the limit of concurrent check jobs (default: unlimited) [$BACKUP_GLOBAL_CONCURRENT_CHECK_JOBS_LIMIT]
    --global-concurrent-prune-jobs-limit value          set the limit of concurrent prune jobs (default: unlimited) [$BACKUP_GLOBAL_CONCURRENT_PRUNE_JOBS_LIMIT]
    --global-concurrent-restore-jobs-limit value        set the limit of concurrent restore jobs (default: unlimited) [$BACKUP_GLOBAL_CONCURRENT_RESTORE_JOBS_LIMIT]
-   --globalrestores3accesskeyid value                  set the global restore S3 accessKeyID for restores [$BACKUP_GLOBALRESTORES3ACCESKEYID] / [$BACKUP_GLOBALRESTORES3ACCESSKEYID]
+   --globalrestores3accesskeyid value                  set the global restore S3 accessKeyID for restores [$BACKUP_GLOBALRESTORES3ACCESKEYID, $BACKUP_GLOBALRESTORES3ACCESSKEYID]
    --globalrestores3bucket value                       set the global restore S3 bucket for restores [$BACKUP_GLOBALRESTORES3BUCKET]
    --globalrestores3endpoint value                     set the global restore S3 endpoint for the restores (needs the scheme 'http' or 'https') [$BACKUP_GLOBALRESTORES3ENDPOINT]
    --globalrestores3secretaccesskey value              set the global restore S3 SecretAccessKey for restores [$BACKUP_GLOBALRESTORES3SECRETACCESSKEY]
@@ -46,5 +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 the backup pod (default: /k8up) [$VAR_DIR]
+   --vardir value                                      the var data dir for read/write k8up data or temp file in the backup 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
@@ -50,7 +50,7 @@ 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)
+   --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]

diff --git a/docs/modules/ROOT/pages/references/api-reference.adoc b/docs/modules/ROOT/pages/references/api-reference.adoc
@@ -173,32 +173,13 @@ It is expected that users only configure one storage type.
 | *`swift`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-swiftspec[$$SwiftSpec$$]__ | 
 | *`b2`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-b2spec[$$B2Spec$$]__ | 
 | *`rest`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-restserverspec[$$RestServerSpec$$]__ | 
-| *`options`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-backendopts[$$BackendOpts$$]__ | 
+| *`tlsOptions`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-tlsoptions[$$TLSOptions$$]__ | 
 | *`volumeMounts`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#volumemount-v1-core[$$VolumeMount$$]__ | 
 |===
 
 
 
 
-[id="{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-backendopts"]
-=== BackendOpts 
-
-
-
-.Appears In:
-****
-- xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-backend[$$Backend$$]
-****
-
-[cols="25a,75a", options="header"]
-|===
-| Field | Description
-| *`caCert`* __string__ | 
-| *`clientCert`* __string__ | 
-| *`clientKey`* __string__ | 
-|===
-
-
 [id="{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-backup"]
 === Backup 
 
@@ -763,30 +744,11 @@ all the settings are mutual exclusive.
 | Field | Description
 | *`s3`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-s3spec[$$S3Spec$$]__ | 
 | *`folder`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-folderrestore[$$FolderRestore$$]__ | 
-| *`options`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-restoreopts[$$RestoreOpts$$]__ | 
+| *`tlsOptions`* __xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-tlsoptions[$$TLSOptions$$]__ | 
 | *`volumeMounts`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#volumemount-v1-core[$$VolumeMount$$]__ | 
 |===
 
 
-[id="{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-restoreopts"]
-=== RestoreOpts 
-
-
-
-.Appears In:
-****
-- xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-restoremethod[$$RestoreMethod$$]
-****
-
-[cols="25a,75a", options="header"]
-|===
-| Field | Description
-| *`caCert`* __string__ | 
-| *`clientCert`* __string__ | 
-| *`clientKey`* __string__ | 
-|===
-
-
 [id="{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-restoreschedule"]
 === RestoreSchedule 
 
@@ -1161,3 +1123,23 @@ can be restored.
 |===
 
 
+[id="{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-tlsoptions"]
+=== TLSOptions 
+
+
+
+.Appears In:
+****
+- xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-backend[$$Backend$$]
+- xref:{anchor_prefix}-github-com-k8up-io-k8up-v2-api-v1-restoremethod[$$RestoreMethod$$]
+****
+
+[cols="25a,75a", options="header"]
+|===
+| Field | Description
+| *`caCert`* __string__ | 
+| *`clientCert`* __string__ | 
+| *`clientKey`* __string__ | 
+|===
+
+