Add resource filtering page (#2771)

* added resource filtering page Signed-off-by: mtritabaugh <mtritabaugh@vmware.com> * added resource filtering page to v1.4 Signed-off-by: mtritabaugh <mtritabaugh@vmware.com> * change to per style guide Signed-off-by: mtritabaugh <mtritabaugh@vmware.com>
2026-02-13 07:11:17 +00:00 · 2020-08-06 17:09:59 -05:00
parent 0e8a7a23cb
commit 4e2f4bb6af
4 changed files with 262 additions and 0 deletions
--- a/site/_data/main-toc.yml
+++ b/site/_data/main-toc.yml
@@ -31,6 +31,8 @@ toc:
        url: /disaster-case
      - page: Cluster migration
        url: /migration-case
+      - page: Resource filtering
+        url: /resource-filtering
      - page: Backup reference
        url: /backup-reference
      - page: Restore reference
--- a/site/_data/v1-4-toc.yml
+++ b/site/_data/v1-4-toc.yml
@@ -31,6 +31,8 @@ toc:
        url: /disaster-case
      - page: Cluster migration
        url: /migration-case
+      - page: Resource filtering
+        url: /resource-filtering
      - page: Backup reference
        url: /backup-reference
      - page: Restore reference
--- a/site/docs/main/resource-filtering.md
+++ b/site/docs/main/resource-filtering.md
@@ -0,0 +1,129 @@
+# Resource Filtering
+
+*Filter objects by namespace, type, or labels.*
+
+Velero includes all objects in a backup or restore when no filtering options are used. 
+
+## Includes
+
+Only specific resources are included, excluding all others.
+
+Wildcard takes precedence when both a wildcard and specific resource are included.
+
+### --include-namespaces
+
+* Backup a namespace and it's objects.
+
+  ```bash
+  velero backup create <backup-name> --include-namespaces <namespace>
+  ```
+
+* Restore two namespaces and their objects.
+
+  ```bash
+  velero restore create <backup-name> --include-namespaces <namespace1>,<namcespace2>
+  ```
+
+### --include-resources 
+
+* Backup all deployments in the cluster.
+
+  ```bash
+  velero backup create <backup-name> --include-resources deployments
+  ```
+
+* Restore all deployments and configmaps in the cluster.
+
+  ```bash
+  velero restore create <backup-name> --include-resources deployments,configmaps
+  ```
+
+* Backup the deployments in a namespace.
+
+  ```bash
+  velero backup create <backup-name> --include-resources deployments --include-namespaces <namespace>
+  ```
+
+### --include-cluster-resources
+
+  This option can have three possible values:
+
+* `true`: all cluster-scoped resources are included.
+
+* `false`: no cluster-scoped resources are included.
+
+* `nil` ("auto" or not supplied):
+
+  - Cluster-scoped resources are included when backing up or restoring all namespaces. Default: `true`.
+
+  - Cluster-scoped resources are not included when namespace filtering is used. Default: `false`.
+
+    * Some related cluster-scoped resources may still be backed/restored up if triggered by a custom action (for example, PVC->PV) unless `--include-cluster-resources=false`.
+
+* Backup entire cluster including cluster-scoped resources.
+
+  ```bash
+  velero backup create <backup-name>
+  ```
+
+* Restore only namespaced resources in the cluster.
+
+  ```bash
+  velero restore create <backup-name> --include-cluster-resources=false
+  ```
+
+* Backup a namespace and include cluster-scoped resources.
+
+  ```bash
+  velero backup create <backup-name> --include-namespaces <namespace> --include-cluster-resources=true 
+  ```
+
+### --selector
+
+* Include resources matching the label selector.
+
+  ```bash
+  velero backup create <backup-name> --selector <key>=<value>
+  ```
+
+
+## Excludes
+
+Exclude specific resources from the backup.
+
+Wildcard excludes are ignored.
+
+### --exclude-namespaces
+
+* Exclude kube-system from the cluster backup.
+
+  ```bash
+  velero backup create <backup-name> --exclude-namespaces kube-system
+  ```
+
+* Exclude two namespaces during a restore.
+
+  ```bash
+  velero restore create <backup-name> --exclude-namespaces <namespace1>,<namcespace2>
+  ```
+
+### --exclude-resources
+
+* Exclude secrets from the backup.
+
+  ```bash
+  velero backup create <backup-name> --exclude-resources secrets
+  ```
+
+* Exclude secrets and rolebindings.
+
+  ```bash
+  velero backup create <backup-name> --exclude-resources secrets,rolebindings
+  ```
+
+### velero.io/exclude-from-backup=true
+
+* Resources with the label `velero.io/exclude-from-backup=true` are not included in backup, even if it contains a matching selector label.
+
+
+
--- a/site/docs/v1.4/resource-filtering.md
+++ b/site/docs/v1.4/resource-filtering.md
@@ -0,0 +1,129 @@
+# Resource Filtering
+
+*Filter objects by namespace, type, or labels.*
+
+Velero includes all objects in a backup or restore when no filtering options are used. 
+
+## Includes
+
+Only specific resources are included, excluding all others.
+
+Wildcard takes precedence when both a wildcard and specific resource are included.
+
+### --include-namespaces
+
+* Backup a namespace and it's objects.
+
+  ```bash
+  velero backup create <backup-name> --include-namespaces <namespace>
+  ```
+
+* Restore two namespaces and their objects.
+
+  ```bash
+  velero restore create <backup-name> --include-namespaces <namespace1>,<namcespace2>
+  ```
+
+### --include-resources 
+
+* Backup all deployments in the cluster.
+
+  ```bash
+  velero backup create <backup-name> --include-resources deployments
+  ```
+
+* Restore all deployments and configmaps in the cluster.
+
+  ```bash
+  velero restore create <backup-name> --include-resources deployments,configmaps
+  ```
+
+* Backup the deployments in a namespace.
+
+  ```bash
+  velero backup create <backup-name> --include-resources deployments --include-namespaces <namespace>
+  ```
+
+### --include-cluster-resources
+
+  This option can have three possible values:
+
+* `true`: all cluster-scoped resources are included.
+
+* `false`: no cluster-scoped resources are included.
+
+* `nil` ("auto" or not supplied):
+
+  - Cluster-scoped resources are included when backing up or restoring all namespaces. Default: `true`.
+
+  - Cluster-scoped resources are not included when namespace filtering is used. Default: `false`.
+
+    * Some related cluster-scoped resources may still be backed/restored up if triggered by a custom action (for example, PVC->PV) unless `--include-cluster-resources=false`.
+
+* Backup entire cluster including cluster-scoped resources.
+
+  ```bash
+  velero backup create <backup-name>
+  ```
+
+* Restore only namespaced resources in the cluster.
+
+  ```bash
+  velero restore create <backup-name> --include-cluster-resources=false
+  ```
+
+* Backup a namespace and include cluster-scoped resources.
+
+  ```bash
+  velero backup create <backup-name> --include-namespaces <namespace> --include-cluster-resources=true 
+  ```
+
+### --selector
+
+* Include resources matching the label selector.
+
+  ```bash
+  velero backup create <backup-name> --selector <key>=<value>
+  ```
+
+
+## Excludes
+
+Exclude specific resources from the backup.
+
+Wildcard excludes are ignored.
+
+### --exclude-namespaces
+
+* Exclude kube-system from the cluster backup.
+
+  ```bash
+  velero backup create <backup-name> --exclude-namespaces kube-system
+  ```
+
+* Exclude two namespaces during a restore.
+
+  ```bash
+  velero restore create <backup-name> --exclude-namespaces <namespace1>,<namcespace2>
+  ```
+
+### --exclude-resources
+
+* Exclude secrets from the backup.
+
+  ```bash
+  velero backup create <backup-name> --exclude-resources secrets
+  ```
+
+* Exclude secrets and rolebindings.
+
+  ```bash
+  velero backup create <backup-name> --exclude-resources secrets,rolebindings
+  ```
+
+### velero.io/exclude-from-backup=true
+
+* Resources with the label `velero.io/exclude-from-backup=true` are not included in backup, even if it contains a matching selector label.
+
+
+