You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/about.md
+3-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# How Ark Works
2
2
3
-
Each Ark operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. The config custom resource specifies core information and options such as cloud provider settings. Ark also includes controllers that process the custom resources to perform backups, restores, and all related operations.
3
+
Each Ark operation -- on-demand backup, scheduled backup, restore -- is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. Ark also includes controllers that process the custom resources to perform backups, restores, and all related operations.
4
4
5
5
You can back up or restore all objects in your cluster, or you can filter objects by type, namespace, and/or label.
6
6
@@ -66,8 +66,9 @@ This allows restore functionality to work in a cluster migration scenario, where
66
66
67
67
Likewise, if a backup object exists in Kubernetes but not in object storage, it will be deleted from Kubernetes since the backup tarball no longer exists.
Specify the following values in the example files:
141
141
142
-
* In `examples/aws/00-ark-config.yaml`:
143
-
144
-
* Replace `<YOUR_REGION>`. See the [Config definition][6] for details.
145
-
146
142
* In `examples/aws/05-ark-backupstoragelocation.yaml`:
147
143
148
144
* Replace `<YOUR_BUCKET>` and `<YOUR_REGION>` (for S3 backup storage, region is optional and will be queried from the AWS S3 API if not provided). See the [BackupStorageLocation definition][21] for details.
149
145
146
+
* In `examples/aws/06-ark-volumesnapshotlocation.yaml`:
147
+
148
+
* Replace `<YOUR_REGION>`. See the [VolumeSnapshotLocation definition][6] for details.
149
+
150
+
150
151
* (Optional) If you run the nginx example, in file `examples/nginx-app/with-pv.yaml`:
151
152
152
153
* Replace `<YOUR_STORAGE_CLASS_NAME>` with `gp2`. This is AWS's default `StorageClass` name.
@@ -181,7 +182,8 @@ Specify the following values in the example files:
Now that you have your Azure credentials stored in a Secret, you need to replace some placeholder values in the template files. Specifically, you need to change the following:
127
127
128
-
* In file `examples/azure/10-ark-config.yaml`:
129
-
130
-
* Replace `<YOUR_TIMEOUT>`. See the [Config definition][8] for details.
131
-
132
128
* In file `examples/azure/05-ark-backupstoragelocation.yaml`:
133
129
134
130
* Replace `<YOUR_BLOB_CONTAINER>`, `<YOUR_STORAGE_RESOURCE_GROUP>`, and `<YOUR_STORAGE_ACCOUNT>`. See the [BackupStorageLocation definition][21] for details.
135
131
136
-
Here is an example of a completed config file.
137
-
138
-
```yaml
139
-
apiVersion: ark.heptio.com/v1
140
-
kind: Config
141
-
metadata:
142
-
namespace: heptio-ark
143
-
name: default
144
-
persistentVolumeProvider:
145
-
name: azure
146
-
config:
147
-
apiTimeout: 15m
148
-
backupSyncPeriod: 30m
149
-
gcSyncPeriod: 30m
150
-
scheduleSyncPeriod: 1m
151
-
restoreOnlyMode: false
152
-
```
132
+
* In file `examples/azure/06-ark-volumesnapshotlocation.yaml`:
133
+
134
+
* Replace `<YOUR_TIMEOUT>`. See the [VolumeSnapshotLocation definition][8] for details.
135
+
153
136
154
137
## Start the server
155
138
@@ -160,7 +143,7 @@ In the root of your Ark directory, run:
Copy file name to clipboardexpand all lines: docs/use-cases.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ If you periodically back up your cluster's resources, you are able to return to
30
30
31
31
*Using Backups and Restores*
32
32
33
-
Heptio Ark can help you port your resources from one cluster to another, as long as you point each Ark Config to the same cloud object storage. In this scenario, we are also assuming that your clusters are hosted by the same cloud provider. **Note that Heptio Ark does not support the migration of persistent volumes across cloud providers.**
33
+
Heptio Ark can help you port your resources from one cluster to another, as long as you point each Ark instance to the same cloud object storage location. In this scenario, we are also assuming that your clusters are hosted by the same cloud provider. **Note that Heptio Ark does not support the migration of persistent volumes across cloud providers.**
34
34
35
35
1. *(Cluster 1)* Assuming you haven't already been checkpointing your data with the Ark `schedule` operation, you need to first back up your entire cluster (replacing `<BACKUP-NAME>` as desired):
36
36
@@ -39,7 +39,7 @@ Heptio Ark can help you port your resources from one cluster to another, as long
39
39
```
40
40
The default TTL is 30 days (720 hours); you can use the `--ttl` flag to change this as necessary.
41
41
42
-
2. *(Cluster 2)* Make sure that the `persistentVolumeProvider` and `backupStorageProvider` fields in the Ark Config match the ones from *Cluster 1*, so that your new Ark server instance is pointing to the same bucket.
42
+
2. *(Cluster 2)* Make sure that the `BackupStorageLocation` and `VolumeSnapshotLocation` CRDs match the ones from *Cluster 1*, so that your new Ark server instance is pointing to the same bucket.
43
43
44
44
3. *(Cluster 2)* Make sure that the Ark Backup object has been created. Ark resources are synced with the backup files available in cloud storage.
0 commit comments