Merge pull request #713 from arangodb/rclone-configuration-special-params

hint to examine rclone configuration using standalone binary

Author: kvahed

3.6/backup-restore.md

@@ -192,7 +192,7 @@ of that of the single server installation.
 - **Remote Upload and Download**
 
  We have fully integrated the
- [Rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
+ [rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
  versatile inter site sync facility, which opens up a vast field of transport
  protocols and remote syncing APIs from Amazon's S3 over Dropbox, WebDAV,
  all the way to the local file system and network storage.

3.6/programs-arangobackup-examples.md

@@ -188,7 +188,7 @@ The output will look like this:
 2019-07-30T08:11:09Z [17465] INFO [68cc8] {backup} Last progress update 2019-07-30T08:10:10Z: 5/5 files done
 ```
 
-See [Rclone Configuration](#rclone-configuration) for details about the `remote.json`
+See [rclone Configuration](#rclone-configuration) for details about the `remote.json`
 file to configure the remote site for `rclone` for different protocols than S3.
 
 Download
@@ -237,7 +237,7 @@ Rclone Configuration
 [Rclone](https://rclone.org/){:target="_blank"} is a versatile open-source
 remote file sync program that can deal with over 30 different remote file
 IO protocols. Enterprise Editions of ArangoDB come with a bundled version
-of Rclone, which is distributed under the MIT license. It is used to
+of rclone, which is distributed under the MIT license. It is used to
 both download and upload hot backup sets to and from local and cloud
 operated storage resources.
 
@@ -246,11 +246,11 @@ Hot backup directories, which are subject to an ongoing download cannot
 be used for restores until the download has finished.
 {% endhint %}
 
-To configure Rclone, use the `rclone-config-file` startup option to
+To configure rclone, use the `rclone-config-file` startup option to
 point arangobackup to a JSON configuration file. The expected format
 is an object with user-chosen remote names as attribute keys, and the
 actual configuration as attribute value (a nested object). The option
-names and values in the [Rclone documentation](https://rclone.org/docs/){:target="_blank"}
+names and values in the [rclone documentation](https://rclone.org/docs/){:target="_blank"}
 directly translate into attribute/value pairs in the JSON file.
 Note that `"true"` and `"false"` must be enclosed by double quotes.
 
@@ -268,6 +268,18 @@ The syntax for remote paths is `remote:path`, where `remote` is the
 name of a top-level attribute in the configuration file, `path` is a
 remote path, and both are separated by a colon (e.g. `my-remote:/a/b/c`).
 
+{% hint 'info' %}
+Some cloud vendors require rclone configuration parameters, which are very
+specific. It is helpful to download a standalone version of rclone and try to
+upload and download files to verify that one has a working configuration for
+the cloud storage in question. The exhaustive documentation parameters of `S3`
+for example are found at [rclone.org/s3/](https://rclone.org/s3/){:target="_blank"}.
+Every parameter can be executed as an option to the program invocation, say
+`--s3-upload-cutoff=0`, as an environment variable like
+`export RCLONE_S3_UPLOAD_CUTOFF=0`, or most importantly, for use with ArangoDB,
+as a key value pair for the JSON files below, `{ ..., "upload_cutoff": 0, ... }`.
+{% endhint %}
+
 ### S3
 
 ```bash 

3.7/backup-restore.md

@@ -192,7 +192,7 @@ of that of the single server installation.
 - **Remote Upload and Download**
 
  We have fully integrated the
- [Rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
+ [rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
  versatile inter site sync facility, which opens up a vast field of transport
  protocols and remote syncing APIs from Amazon's S3 over Dropbox, WebDAV,
  all the way to the local file system and network storage.

3.7/deployment-kubernetes-backup-resource.md

@@ -234,7 +234,7 @@ metadata:
 type: Opaque
 ```
 
-`JSON Token` options are described on the [Rclone](https://rclone.org/){:target="_blank"} page.
+`JSON Token` options are described on the [rclone](https://rclone.org/){:target="_blank"} page.
 We can define more than one protocols at same time in one secret.
 
 This field is defined in json format:
@@ -248,7 +248,7 @@ This field is defined in json format:
 }
 ```
 
-AWS S3 example - based on [Rclone S3](https://rclone.org/s3/){:target="_blank"} documentation and interactive process:
+AWS S3 example - based on [rclone S3](https://rclone.org/s3/){:target="_blank"} documentation and interactive process:
 
 ```json
 {

3.7/programs-arangobackup-examples.md

@@ -188,7 +188,7 @@ The output will look like this:
 2019-07-30T08:11:09Z [17465] INFO [68cc8] {backup} Last progress update 2019-07-30T08:10:10Z: 5/5 files done
 ```
 
-See [Rclone Configuration](#rclone-configuration) for details about the `remote.json`
+See [rclone Configuration](#rclone-configuration) for details about the `remote.json`
 file to configure the remote site for `rclone` for different protocols than S3.
 
 Download
@@ -237,7 +237,7 @@ Rclone Configuration
 [Rclone](https://rclone.org/){:target="_blank"} is a versatile open-source
 remote file sync program that can deal with over 30 different remote file
 IO protocols. Enterprise Editions of ArangoDB come with a bundled version
-of Rclone, which is distributed under the MIT license. It is used to
+of rclone, which is distributed under the MIT license. It is used to
 both download and upload hot backup sets to and from local and cloud
 operated storage resources.
 
@@ -246,11 +246,11 @@ Hot backup directories, which are subject to an ongoing download cannot
 be used for restores until the download has finished.
 {% endhint %}
 
-To configure Rclone, use the `rclone-config-file` startup option to
+To configure rclone, use the `rclone-config-file` startup option to
 point arangobackup to a JSON configuration file. The expected format
 is an object with user-chosen remote names as attribute keys, and the
 actual configuration as attribute value (a nested object). The option
-names and values in the [Rclone documentation](https://rclone.org/docs/){:target="_blank"}
+names and values in the [rclone documentation](https://rclone.org/docs/){:target="_blank"}
 directly translate into attribute/value pairs in the JSON file.
 Note that `"true"` and `"false"` must be enclosed by double quotes.
 
@@ -268,6 +268,18 @@ The syntax for remote paths is `remote:path`, where `remote` is the
 name of a top-level attribute in the configuration file, `path` is a
 remote path, and both are separated by a colon (e.g. `my-remote:/a/b/c`).
 
+{% hint 'info' %}
+Some cloud vendors require rclone configuration parameters, which are very
+specific. It is helpful to download a standalone version of rclone and try to
+upload and download files to verify that one has a working configuration for
+the cloud storage in question. The exhaustive documentation parameters of `S3`
+for example are found at [rclone.org/s3/](https://rclone.org/s3/){:target="_blank"}.
+Every parameter can be executed as an option to the program invocation, say
+`--s3-upload-cutoff=0`, as an environment variable like
+`export RCLONE_S3_UPLOAD_CUTOFF=0`, or most importantly, for use with ArangoDB,
+as a key value pair for the JSON files below, `{ ..., "upload_cutoff": 0, ... }`.
+{% endhint %}
+
 ### S3
 
 ```bash 

3.8/backup-restore.md

@@ -192,7 +192,7 @@ of that of the single server installation.
 - **Remote Upload and Download**
 
  We have fully integrated the
- [Rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
+ [rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
  versatile inter site sync facility, which opens up a vast field of transport
  protocols and remote syncing APIs from Amazon's S3 over Dropbox, WebDAV,
  all the way to the local file system and network storage.

3.8/programs-arangobackup-examples.md

@@ -188,7 +188,7 @@ The output will look like this:
 2019-07-30T08:11:09Z [17465] INFO [68cc8] {backup} Last progress update 2019-07-30T08:10:10Z: 5/5 files done
 ```
 
-See [Rclone Configuration](#rclone-configuration) for details about the `remote.json`
+See [rclone Configuration](#rclone-configuration) for details about the `remote.json`
 file to configure the remote site for `rclone` for different protocols than S3.
 
 Download
@@ -237,7 +237,7 @@ Rclone Configuration
 [Rclone](https://rclone.org/){:target="_blank"} is a versatile open-source
 remote file sync program that can deal with over 30 different remote file
 IO protocols. Enterprise Editions of ArangoDB come with a bundled version
-of Rclone, which is distributed under the MIT license. It is used to
+of rclone, which is distributed under the MIT license. It is used to
 both download and upload hot backup sets to and from local and cloud
 operated storage resources.
 
@@ -246,11 +246,11 @@ Hot backup directories, which are subject to an ongoing download cannot
 be used for restores until the download has finished.
 {% endhint %}
 
-To configure Rclone, use the `rclone-config-file` startup option to
+To configure rclone, use the `rclone-config-file` startup option to
 point arangobackup to a JSON configuration file. The expected format
 is an object with user-chosen remote names as attribute keys, and the
 actual configuration as attribute value (a nested object). The option
-names and values in the [Rclone documentation](https://rclone.org/docs/){:target="_blank"}
+names and values in the [rclone documentation](https://rclone.org/docs/){:target="_blank"}
 directly translate into attribute/value pairs in the JSON file.
 Note that `"true"` and `"false"` must be enclosed by double quotes.
 
@@ -268,6 +268,18 @@ The syntax for remote paths is `remote:path`, where `remote` is the
 name of a top-level attribute in the configuration file, `path` is a
 remote path, and both are separated by a colon (e.g. `my-remote:/a/b/c`).
 
+{% hint 'info' %}
+Some cloud vendors require rclone configuration parameters, which are very
+specific. It is helpful to download a standalone version of rclone and try to
+upload and download files to verify that one has a working configuration for
+the cloud storage in question. The exhaustive documentation parameters of `S3`
+for example are found at [rclone.org/s3/](https://rclone.org/s3/){:target="_blank"}.
+Every parameter can be executed as an option to the program invocation, say
+`--s3-upload-cutoff=0`, as an environment variable like
+`export RCLONE_S3_UPLOAD_CUTOFF=0`, or most importantly, for use with ArangoDB,
+as a key value pair for the JSON files below, `{ ..., "upload_cutoff": 0, ... }`.
+{% endhint %}
+
 ### S3
 
 ```bash 

3.9/backup-restore.md

@@ -192,7 +192,7 @@ of that of the single server installation.
 - **Remote Upload and Download**
 
  We have fully integrated the
- [Rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
+ [rclone](https://rclone.org/) sync for cloud storage. Rclone is a very
  versatile inter site sync facility, which opens up a vast field of transport
  protocols and remote syncing APIs from Amazon's S3 over Dropbox, WebDAV,
  all the way to the local file system and network storage.

3.9/programs-arangobackup-examples.md

@@ -188,7 +188,7 @@ The output will look like this:
 2019-07-30T08:11:09Z [17465] INFO [68cc8] {backup} Last progress update 2019-07-30T08:10:10Z: 5/5 files done
 ```
 
-See [Rclone Configuration](#rclone-configuration) for details about the `remote.json`
+See [rclone Configuration](#rclone-configuration) for details about the `remote.json`
 file to configure the remote site for `rclone` for different protocols than S3.
 
 Download
@@ -237,7 +237,7 @@ Rclone Configuration
 [Rclone](https://rclone.org/){:target="_blank"} is a versatile open-source
 remote file sync program that can deal with over 30 different remote file
 IO protocols. Enterprise Editions of ArangoDB come with a bundled version
-of Rclone, which is distributed under the MIT license. It is used to
+of rclone, which is distributed under the MIT license. It is used to
 both download and upload hot backup sets to and from local and cloud
 operated storage resources.
 
@@ -246,11 +246,11 @@ Hot backup directories, which are subject to an ongoing download cannot
 be used for restores until the download has finished.
 {% endhint %}
 
-To configure Rclone, use the `rclone-config-file` startup option to
+To configure rclone, use the `rclone-config-file` startup option to
 point arangobackup to a JSON configuration file. The expected format
 is an object with user-chosen remote names as attribute keys, and the
 actual configuration as attribute value (a nested object). The option
-names and values in the [Rclone documentation](https://rclone.org/docs/){:target="_blank"}
+names and values in the [rclone documentation](https://rclone.org/docs/){:target="_blank"}
 directly translate into attribute/value pairs in the JSON file.
 Note that `"true"` and `"false"` must be enclosed by double quotes.
 
@@ -268,6 +268,18 @@ The syntax for remote paths is `remote:path`, where `remote` is the
 name of a top-level attribute in the configuration file, `path` is a
 remote path, and both are separated by a colon (e.g. `my-remote:/a/b/c`).
 
+{% hint 'info' %}
+Some cloud vendors require rclone configuration parameters, which are very
+specific. It is helpful to download a standalone version of rclone and try to
+upload and download files to verify that one has a working configuration for
+the cloud storage in question. The exhaustive documentation parameters of `S3`
+for example are found at [rclone.org/s3/](https://rclone.org/s3/){:target="_blank"}.
+Every parameter can be executed as an option to the program invocation, say
+`--s3-upload-cutoff=0`, as an environment variable like
+`export RCLONE_S3_UPLOAD_CUTOFF=0`, or most importantly, for use with ArangoDB,
+as a key value pair for the JSON files below, `{ ..., "upload_cutoff": 0, ... }`.
+{% endhint %}
+
 ### S3
 
 ```bash