V1.1 docs updates (#1704)

* remove docs header about project rename

Signed-off-by: Steve Kriss <krisss@vmware.com>

* remove Upgrade to 1.0 page from master TOC

Signed-off-by: Steve Kriss <krisss@vmware.com>

* standardize TOC titles

Signed-off-by: Steve Kriss <krisss@vmware.com>

* add backup/restore docs for undocumented features

Signed-off-by: Steve Kriss <krisss@vmware.com>
This commit is contained in:
Steve Kriss
2019-07-29 15:37:18 -06:00
committed by Adnan Abdulhussein
parent 248ee89123
commit b24e940399
4 changed files with 58 additions and 12 deletions

View File

@@ -13,9 +13,7 @@ toc:
subfolderitems:
- page: Overview
url: /install-overview
- page: Upgrade to 1.0
url: /upgrade-to-1.0
- page: Quick Start with In-Cluster Minio
- page: Quick start with in-cluster MinIO
url: /get-started
- page: Run on AWS
url: /aws-config
@@ -23,14 +21,18 @@ toc:
url: /azure-config
- page: Run on GCP
url: /gcp-config
- page: Restic Setup
- page: Restic setup
url: /restic
- title: Use
subfolderitems:
- page: Disaster Recovery
- page: Disaster recovery
url: /disaster-case
- page: Cluster migration
url: /migration-case
- page: Backup reference
url: /backup-reference
- page: Restore reference
url: /restore-reference
- title: Troubleshoot
subfolderitems:
- page: Troubleshooting
@@ -41,7 +43,7 @@ toc:
url: /debugging-restores
- page: Troubleshoot Restic
url: /restic#troubleshooting
- title: Customize Velero
- title: Customize
subfolderitems:
- page: Build from source
url: /build-from-source

View File

@@ -22,11 +22,5 @@
For up-to-date documentation, see the <a href="{{latest_url}}">latest version</a>.
</p>
{% endif %}
<p>
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i>
Heptio Ark is now Velero! v0.11 is our first release with the new name. For instructions on
migrating your Ark deployments and data to Velero, please see the Upgrade section in the <a href="{{latest_url}}">latest version</a>.
For more details on the renaming, please read our <a href="https://blogs.vmware.com/cloudnative/2019/02/05/welcoming-heptio-open-source-projects-to-vmware/">blog post</a>.
</p>
</div>
{% endif %}

View File

@@ -0,0 +1,9 @@
# Backup Reference
## Exclude Specific Items from Backup
It is possible to exclude individual items from being backed up, even if they match the resource/namespace/label selectors defined in the backup spec. To do this, label the item as follows:
```bash
kubectl label -n <ITEM_NAMESPACE> <RESOURCE>/<NAME> velero.io/exclude-from-backup=true
```

View File

@@ -0,0 +1,41 @@
# Restore Reference
## Restoring Into a Different Namespace
Velero can restore resources into a different namespace than the one they were backed up from. To do this, use the `--namespace-mappings` flag:
```bash
velero restore create RESTORE_NAME \
--from-backup BACKUP_NAME \
--namespace-mappings old-ns-1:new-ns-1,old-ns-2:new-ns-2
```
## Changing PV/PVC Storage Classes
Velero can change the storage class of persistent volumes and persistent volume claims during restores. To configure a storage class mapping, create a config map in the Velero namespace like the following:
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
# any name can be used; Velero uses the labels (below)
# to identify it rather than the name
name: change-storage-class-config
# must be in the velero namespace
namespace: velero
# the below labels should be used verbatim in your
# ConfigMap.
labels:
# this value-less label identifies the ConfigMap as
# config for a plugin (i.e. the built-in change storage
# class restore item action plugin)
velero.io/plugin-config: ""
# this label identifies the name and kind of plugin
# that this ConfigMap is for.
velero.io/change-storage-class: RestoreItemAction
data:
# add 1+ key-value pairs here, where the key is the old
# storage class name and the value is the new storage
# class name.
<old-storage-class>: <new-storage-class>
```