Merge pull request #1008 from Bradamant3/0.10-doc-994

add content for issue 994

docs/aws-config.md

@@ -147,6 +147,9 @@ Specify the following values in the example files:
 
   * Replace `<YOUR_REGION>`. See the [VolumeSnapshotLocation definition][6] for details.
 
+* (Optional, use only to specify multiple volume snapshot locations) In `examples/aws/10-deployment.yaml` (or `examples/aws/10-deployment-kube2iam.yaml`, as appropriate):
+
+  * Uncomment the `--default-volume-snapshot-locations` and replace provider locations with the values for your environment.
 
 * (Optional) If you run the nginx example, in file `examples/nginx-app/with-pv.yaml`:
 

docs/azure-config.md

@@ -133,6 +133,9 @@ Now that you have your Azure credentials stored in a Secret, you need to replace
 
   * Replace `<YOUR_TIMEOUT>`. See the [VolumeSnapshotLocation definition][8] for details.
 
+* (Optional, use only if you need to specify multiple volume snapshot locations) In `examples/azure/00-ark-deployment.yaml`:
+
+  * Uncomment the `--default-volume-snapshot-locations` and replace provider locations with the values for your environment.
 
 ## Start the server
 

docs/gcp-config.md

@@ -107,7 +107,7 @@ kubectl create secret generic cloud-credentials \
     --from-file cloud=credentials-ark
 ```
 
-_Note: If you use a custom namespace, replace `heptio-ark` with the name of the custom namespace_
+**Note: If you use a custom namespace, replace `heptio-ark` with the name of the custom namespace**
 
 Specify the following values in the example files:
 
@@ -119,6 +119,10 @@ Specify the following values in the example files:
 
     * Replace `<YOUR_STORAGE_CLASS_NAME>` with `standard`. This is GCP's default `StorageClass` name.
 
+* (Optional, use only if you need to specify multiple volume snapshot locations) In `examples/gcp/10-deployment.yaml`:
+
+  * Uncomment the `--default-volume-snapshot-locations` and replace provider locations with the values for your environment.
+
 ## Start the server
 
 In the root of your Ark directory, run:

docs/ibm-config.md

@@ -57,8 +57,6 @@ Specify the following values in the example files:
 
   * Replace `<YOUR_BUCKET>`, `<YOUR_REGION>` and `<YOUR_URL_ACCESS_POINT>`. See the [BackupStorageLocation definition][6] for details.
 
-
-
 * (Optional) If you run the nginx example, in file `examples/nginx-app/with-pv.yaml`:
 
     * Replace `<YOUR_STORAGE_CLASS_NAME>` with your `StorageClass` name.

docs/install-overview.md

@@ -6,6 +6,12 @@ In version 0.7.0 and later, you can run Ark in any namespace, which requires add
 
 In version 0.9.0 and later, you can use Ark's integration with restic, which requires additional setup. See [restic instructions][20].
 
+## Customize configuration
+
+Whether you run Ark on a cloud provider or on-premises, if you have more than one volume snapshot location for a given volume provider, you can specify its default location for backups by setting a server flag in your Ark deployment YAML.
+
+For details, see the documentation topics for individual cloud providers.
+
 ## Cloud provider
 
 The Ark repository includes a set of example YAML files that specify the settings for each supported cloud provider. For provider-specific instructions, see:

examples/aws/10-deployment.yaml

@@ -38,6 +38,8 @@ spec:
             - /ark
           args:
             - server
+            ## uncomment following line and specify values if needed for multiple provider snapshot locations
+            # - --default-volume-snapshot-locations=<provider-1:location-1,provider-2:location-2,...>
           volumeMounts:
             - name: cloud-credentials
               mountPath: /credentials

examples/azure/00-ark-deployment.yaml

@@ -41,6 +41,8 @@ spec:
             - /ark
           args:
             - server
+            ## uncomment following line and specify values if needed for multiple provider snapshot locations
+            # - --default-volume-snapshot-locations=<provider-1:location-1,provider-2:location-2,...>
           envFrom:
             - secretRef:
                 name: cloud-credentials

examples/gcp/10-deployment.yaml

@@ -41,6 +41,8 @@ spec:
             - /ark
           args:
             - server
+            ## uncomment following line and specify values if needed for multiple provider snapshot locations
+            # - --default-volume-snapshot-locations=<provider-1:location-1,provider-2:location-2,...>
           volumeMounts:
             - name: cloud-credentials
               mountPath: /credentials