Skip to content

Commit ec12467

Browse files
committed
remove all references to Config from docs/examples
Signed-off-by: Steve Kriss <steve@heptio.com>
1 parent c36131a commit ec12467

17 files changed

+44
-308
lines changed

docs/about.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How Ark Works
22

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.
44

55
You can back up or restore all objects in your cluster, or you can filter objects by type, namespace, and/or label.
66

@@ -66,8 +66,9 @@ This allows restore functionality to work in a cluster migration scenario, where
6666

6767
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.
6868

69+
[10]: hooks.md
6970
[19]: /docs/img/backup-process.png
7071
[20]: https://kubernetes.io/docs/concepts/api-extension/custom-resources/#customresourcedefinitions
7172
[21]: https://kubernetes.io/docs/concepts/api-extension/custom-resources/#custom-controllers
7273
[22]: https://github.com/coreos/etcd
73-
[10]: hooks.md
74+

docs/aws-config.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,15 @@ kubectl create secret generic cloud-credentials \
139139
140140
Specify the following values in the example files:
141141
142-
* In `examples/aws/00-ark-config.yaml`:
143-
144-
* Replace `<YOUR_REGION>`. See the [Config definition][6] for details.
145-
146142
* In `examples/aws/05-ark-backupstoragelocation.yaml`:
147143
148144
* 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.
149145
146+
* In `examples/aws/06-ark-volumesnapshotlocation.yaml`:
147+
148+
* Replace `<YOUR_REGION>`. See the [VolumeSnapshotLocation definition][6] for details.
149+
150+
150151
* (Optional) If you run the nginx example, in file `examples/nginx-app/with-pv.yaml`:
151152
152153
* 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:
181182
In the root of your Ark directory, run:
182183
183184
```bash
184-
kubectl apply -f examples/aws/00-ark-config.yaml
185+
kubectl apply -f examples/aws/05-ark-backupstoragelocation.yaml
186+
kubectl apply -f examples/aws/06-ark-volumesnapshotlocation.yaml
185187
kubectl apply -f examples/aws/10-deployment.yaml
186188
```
187189
@@ -300,7 +302,7 @@ It can be set up for Ark by creating a role that will have required permissions,
300302
301303
[0]: namespace.md
302304
[5]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html
303-
[6]: config-definition.md#aws
305+
[6]: api-types/volumesnapshotlocation.md#aws
304306
[14]: http://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html
305307
[20]: faq.md
306308
[21]: api-types/backupstoragelocation.md#aws

docs/azure-config.md

+5-22
Original file line numberDiff line numberDiff line change
@@ -125,31 +125,14 @@ kubectl create secret generic cloud-credentials \
125125

126126
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:
127127

128-
* In file `examples/azure/10-ark-config.yaml`:
129-
130-
* Replace `<YOUR_TIMEOUT>`. See the [Config definition][8] for details.
131-
132128
* In file `examples/azure/05-ark-backupstoragelocation.yaml`:
133129

134130
* Replace `<YOUR_BLOB_CONTAINER>`, `<YOUR_STORAGE_RESOURCE_GROUP>`, and `<YOUR_STORAGE_ACCOUNT>`. See the [BackupStorageLocation definition][21] for details.
135131

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+
153136

154137
## Start the server
155138

@@ -160,7 +143,7 @@ In the root of your Ark directory, run:
160143
```
161144

162145
[0]: namespace.md
163-
[8]: config-definition.md#azure
146+
[8]: docs/api-types/volumesnapshotlocation.md#azure
164147
[17]: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects
165148
[18]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli
166149
[19]: https://docs.microsoft.com/en-us/azure/architecture/best-practices/naming-conventions#storage

docs/config-definition.md

-146
This file was deleted.

docs/faq.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ across multiple Ark instances can lead to numerous problems - failed backups, ov
3131
inadvertently deleted backups, etc., all of which can be avoided by using a separate bucket per Ark
3232
instance.
3333

34-
Related to this, if you need to restore a backup from cluster A into cluster B, please use [restore-only][1]
35-
mode in cluster B's Ark instance while it's configured to use cluster A's bucket. This will ensure no
34+
Related to this, if you need to restore a backup from cluster A into cluster B, please use restore-only
35+
mode in cluster B's Ark instance (via the `--restore-only` flag on the `ark server` command specified
36+
in your Ark deployment) while it's configured to use cluster A's bucket. This will ensure no
3637
new backups are created, and no existing backups are deleted or overwritten.
37-
38-
39-
[1]: config-definition.md#main-config-parameters

docs/gcp-config.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,8 @@ Specify the following values in the example files:
124124
In the root of your Ark directory, run:
125125

126126
```bash
127-
kubectl apply -f examples/gcp/00-ark-config.yaml
127+
kubectl apply -f examples/gcp/05-ark-backupstoragelocation.yaml
128+
kubectl apply -f examples/gcp/06-ark-volumesnapshotlocation.yaml
128129
kubectl apply -f examples/gcp/10-deployment.yaml
129130
```
130131

docs/ibm-config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Specify the following values in the example files:
6868
In the root of your Ark directory, run:
6969

7070
```bash
71-
kubectl apply -f examples/ibm/00-ark-config.yaml
71+
kubectl apply -f examples/ibm/05-ark-backupstoragelocation.yaml
7272
kubectl apply -f examples/ibm/10-deployment.yaml
7373
```
7474

docs/namespace.md

+17-13
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ you run Ark client commands.
77
## Edit the example files
88

99
The Ark repository includes [a set of examples][0] that you can use to set up your Ark server. The
10-
examples place the server and backup/schedule/restore/config data in the `heptio-ark` namespace.
10+
examples place the server and backup/schedule/restore/etc. data in the `heptio-ark` namespace.
1111

1212
To run the server in another namespace, you edit the relevant files, changing `heptio-ark` to
1313
your desired namespace.
@@ -18,9 +18,9 @@ files, changing `heptio-ark` to your desired namespace. You also need to create
1818

1919
For all cloud providers, edit `https://github.com/heptio/ark/blob/master/examples/common/00-prereqs.yaml`. This file defines:
2020

21-
* CustomResourceDefinitions for the Ark objects (backups, schedules, restores, configs, downloadrequests)
21+
* CustomResourceDefinitions for the Ark objects (backups, schedules, restores, downloadrequests, etc.)
2222
* The namespace where the Ark server runs
23-
* The namespace where backups, schedules, restores, and the config are stored
23+
* The namespace where backups, schedules, restores, etc. are stored
2424
* The Ark service account
2525
* The RBAC rules to grant permissions to the Ark service account
2626

@@ -29,31 +29,35 @@ For all cloud providers, edit `https://github.com/heptio/ark/blob/master/example
2929

3030
For AWS, edit:
3131

32+
* `https://github.com/heptio/ark/blob/master/examples/aws/05-ark-backupstoragelocation.yaml`
33+
* `https://github.com/heptio/ark/blob/master/examples/aws/06-ark-volumesnapshotlocation.yaml`
3234
* `https://github.com/heptio/ark/blob/master/examples/aws/10-deployment.yaml`
33-
* `https://github.com/heptio/ark/blob/master/examples/aws/00-ark-config.yaml`
3435

3536

36-
### GCP
37+
### Azure
3738

38-
For GCP, edit:
39+
For Azure, edit:
3940

40-
* `https://github.com/heptio/ark/blob/master/examples/gcp/10-deployment.yaml`
41-
* `https://github.com/heptio/ark/blob/master/examples/gcp/00-ark-config.yaml`
41+
* `https://github.com/heptio/ark/blob/master/examples/azure/00-ark-deployment.yaml`
42+
* `https://github.com/heptio/ark/blob/master/examples/azure/05-ark-backupstoragelocation.yaml`
43+
* `https://github.com/heptio/ark/blob/master/examples/azure/06-ark-volumesnapshotlocation.yaml`
4244

45+
### GCP
4346

44-
### Azure
47+
For GCP, edit:
4548

46-
For Azure, edit:
49+
* `https://github.com/heptio/ark/blob/master/examples/gcp/05-ark-backupstoragelocation.yaml`
50+
* `https://github.com/heptio/ark/blob/master/examples/gcp/06-ark-volumesnapshotlocation.yaml`
51+
* `https://github.com/heptio/ark/blob/master/examples/gcp/10-deployment.yaml`
4752

48-
* `https://github.com/heptio/ark/blob/master/examples/azure/00-ark-deployment.yaml`
49-
* `https://github.com/heptio/ark/blob/master/examples/azure/10-ark-config.yaml`
5053

5154
### IBM
5255

5356
For IBM, edit:
5457

58+
* `https://github.com/heptio/ark/blob/master/examples/ibm/05-ark-backupstoragelocation.yaml`
5559
* `https://github.com/heptio/ark/blob/master/examples/ibm/10-deployment.yaml`
56-
* `https://github.com/heptio/ark/blob/master/examples/ibm/00-ark-config.yaml`
60+
5761

5862
## Specify the namespace in client commands
5963

docs/quickstart.md

-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ NOTE: Make sure to check out the appropriate version. We recommend that you chec
3333
kubectl apply -f examples/minio/
3434
```
3535

36-
NOTE: If you get an error about Config creation, wait for a minute, then run the commands again.
37-
3836
1. Deploy the example nginx application:
3937

4038
```bash

docs/use-cases.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you periodically back up your cluster's resources, you are able to return to
3030
3131
*Using Backups and Restores*
3232
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.**
3434
3535
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):
3636
@@ -39,7 +39,7 @@ Heptio Ark can help you port your resources from one cluster to another, as long
3939
```
4040
The default TTL is 30 days (720 hours); you can use the `--ttl` flag to change this as necessary.
4141
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.
4343
4444
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.
4545
@@ -49,4 +49,4 @@ ark restore create --from-backup <BACKUP-NAME>
4949
```
5050
5151
[0]: #disaster-recovery
52-
[1]: #cluster-migration
52+
[1]: #cluster-migration

0 commit comments

Comments
 (0)