mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-01-07 05:46:37 +00:00
Add cross-references between node-agent config documents
Co-authored-by: kaovilai <11228024+kaovilai@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
@@ -3,6 +3,8 @@ title: "BackupPVC Configuration for Data Movement Backup"
|
||||
layout: docs
|
||||
---
|
||||
|
||||
> **📖 For a comprehensive guide** covering all node-agent configuration options, see [Node-agent Configuration](node-agent-config.md).
|
||||
|
||||
`BackupPVC` is an intermediate PVC to access data from during the data movement backup operation.
|
||||
|
||||
In some scenarios users may need to configure some advanced options of the backupPVC so that the data movement backup
|
||||
@@ -69,3 +71,11 @@ timeout (data movement prepare timeout value is 30m by default).
|
||||
if the volume is not readOnly.
|
||||
- If any of the above problems occur, then the DataUpload CR is `canceled` after timeout, and the backupPod and backupPVC will be deleted, and the backup
|
||||
will be marked as `PartiallyFailed`.
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Node-agent Configuration](node-agent-config.md) - Complete reference for all configuration options
|
||||
- [Node-agent Concurrency](node-agent-concurrency.md) - Configure concurrent operations per node
|
||||
- [Node Selection for Data Movement](data-movement-node-selection.md) - Configure which nodes run data movement
|
||||
- [Data Movement Pod Resource Configuration](data-movement-pod-resource-configuration.md) - Configure pod resources
|
||||
- [RestorePVC Configuration](data-movement-restore-pvc-configuration.md) - Configure restore storage
|
||||
|
||||
@@ -3,6 +3,8 @@ title: "Node Selection for Data Movement"
|
||||
layout: docs
|
||||
---
|
||||
|
||||
> **📖 For a comprehensive guide** covering all node-agent configuration options, see [Node-agent Configuration](node-agent-config.md).
|
||||
|
||||
Velero node-agent is a DaemonSet hosting the data movement modules to complete the concrete work of backups/restores.
|
||||
Varying from the data size, data complexity, resource availability, the data movement may take a long time and remarkable resources (CPU, memory, network bandwidth, etc.) during the backup and restore.
|
||||
|
||||
@@ -258,3 +260,11 @@ volumeBindingMode: Immediate
|
||||
Because the StorageClass volumeBindingMode is `Immediate`, although `ignoreDelayBinding` is set to `false`, restorePVC will not be created according to the target Pod.
|
||||
|
||||
The restorePod will be assigned to nodes, which instance type is `Standard_B4ms`.
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Node-agent Configuration](node-agent-config.md) - Complete reference for all configuration options
|
||||
- [Node-agent Concurrency](node-agent-concurrency.md) - Configure concurrent operations per node
|
||||
- [Data Movement Pod Resource Configuration](data-movement-pod-resource-configuration.md) - Configure pod resources
|
||||
- [BackupPVC Configuration](data-movement-backup-pvc-configuration.md) - Configure backup storage
|
||||
- [RestorePVC Configuration](data-movement-restore-pvc-configuration.md) - Configure restore storage
|
||||
|
||||
@@ -3,6 +3,8 @@ title: "Data Movement Pod Resource Configuration"
|
||||
layout: docs
|
||||
---
|
||||
|
||||
> **📖 For a comprehensive guide** covering all node-agent configuration options, see [Node-agent Configuration](node-agent-config.md).
|
||||
|
||||
During [CSI Snapshot Data Movement][1], Velero built-in data mover launches data mover pods to run the data transfer.
|
||||
During [fs-backup][2], Velero also launches data mover pods to run the data transfer.
|
||||
The data transfer is a time and resource consuming activity.
|
||||
@@ -123,6 +125,14 @@ kubectl create cm node-agent-config -n velero --from-file=node-agent-config.json
|
||||
|
||||
**Note**: If the specified priority class doesn't exist in the cluster when data mover pods are created, the pods will fail to schedule. Velero validates the priority class at startup and logs a warning if it doesn't exist, but the pods will still attempt to use it.
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Node-agent Configuration](node-agent-config.md) - Complete reference for all configuration options
|
||||
- [Node-agent Concurrency](node-agent-concurrency.md) - Configure concurrent operations per node
|
||||
- [Node Selection for Data Movement](data-movement-node-selection.md) - Configure which nodes run data movement
|
||||
- [BackupPVC Configuration](data-movement-backup-pvc-configuration.md) - Configure backup storage
|
||||
- [RestorePVC Configuration](data-movement-restore-pvc-configuration.md) - Configure restore storage
|
||||
|
||||
[1]: csi-snapshot-data-movement.md
|
||||
[2]: file-system-backup.md
|
||||
[3]: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/
|
||||
|
||||
@@ -3,6 +3,8 @@ title: "RestorePVC Configuration for Data Movement Restore"
|
||||
layout: docs
|
||||
---
|
||||
|
||||
> **📖 For a comprehensive guide** covering all node-agent configuration options, see [Node-agent Configuration](node-agent-config.md).
|
||||
|
||||
`RestorePVC` is an intermediate PVC to write data during the data movement restore operation.
|
||||
|
||||
In some scenarios users may need to configure some advanced options of the `restorePVC` so that the data movement restore operation could perform better. Specifically:
|
||||
@@ -28,3 +30,11 @@ A sample of `restorePVC` config as part of the ConfigMap would look like:
|
||||
**Note:**
|
||||
- If `ignoreDelayBinding` is set, the restored volume is provisioned in the storage areas associated to an arbitrary node, if the restored pod cannot be scheduled to that node, e.g., because of topology constraints, the data mover restore still completes, but the workload is not usable since the restored pod cannot mount the restored volume
|
||||
- At present, node selection is not supported for data mover restore, so the restored volume may be attached to any node in the cluster; once node selection is supported and enabled, the restored volume will be attached to one of the selected nodes only. In this way, node selection and `ignoreDelayBinding` can work together even though the environment is with topology constraints
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Node-agent Configuration](node-agent-config.md) - Complete reference for all configuration options
|
||||
- [Node-agent Concurrency](node-agent-concurrency.md) - Configure concurrent operations per node
|
||||
- [Node Selection for Data Movement](data-movement-node-selection.md) - Configure which nodes run data movement
|
||||
- [Data Movement Pod Resource Configuration](data-movement-pod-resource-configuration.md) - Configure pod resources
|
||||
- [BackupPVC Configuration](data-movement-backup-pvc-configuration.md) - Configure backup storage
|
||||
|
||||
@@ -3,6 +3,8 @@ title: "Node-agent Concurrency"
|
||||
layout: docs
|
||||
---
|
||||
|
||||
> **📖 For a comprehensive guide** covering all node-agent configuration options, see [Node-agent Configuration](node-agent-config.md).
|
||||
|
||||
Velero node-agent is a daemonset hosting modules to complete the concrete tasks of backups/restores, i.e., file system backup/restore, CSI snapshot data movement.
|
||||
Varying from the data size, data complexity, resource availability, the tasks may take a long time and remarkable resources (CPU, memory, network bandwidth, etc.). These tasks make the loads of node-agent.
|
||||
|
||||
@@ -23,7 +25,7 @@ You can specify different concurrent number per node, for example, you can set 3
|
||||
The range of Per-node concurrent number is the same with Global concurrent number. Per-node concurrent number is preferable to Global concurrent number, so it will overwrite the Global concurrent number for that node.
|
||||
|
||||
Per-node concurrent number is implemented through ```perNodeConfig``` field in ```loadConcurrency```.
|
||||
```perNodeConfig``` is a list of ```RuledConfigs``` each item of which matches one or more nodes by label selectors and specify the concurrent number for the matched nodes.
|
||||
`perNodeConfig` is a list of `RuledConfigs` each item of which matches one or more nodes by label selectors and specify the concurrent number for the matched nodes.
|
||||
Here is an example of the ```perNodeConfig``:
|
||||
```
|
||||
"nodeSelector: kubernetes.io/hostname=node1; number: 3"
|
||||
@@ -79,3 +81,11 @@ spec:
|
||||
- args:
|
||||
- --node-agent-configmap=<ConfigMap name>
|
||||
```
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Node-agent Configuration](node-agent-config.md) - Complete reference for all configuration options
|
||||
- [Node Selection for Data Movement](data-movement-node-selection.md) - Configure which nodes run data movement
|
||||
- [Data Movement Pod Resource Configuration](data-movement-pod-resource-configuration.md) - Configure pod resources
|
||||
- [BackupPVC Configuration](data-movement-backup-pvc-configuration.md) - Configure backup storage
|
||||
- [RestorePVC Configuration](data-movement-restore-pvc-configuration.md) - Configure restore storage
|
||||
|
||||
@@ -3,6 +3,8 @@ title: "Node-agent Prepare Queue Length"
|
||||
layout: docs
|
||||
---
|
||||
|
||||
> **📖 For a comprehensive guide** covering all node-agent configuration options, see [Node-agent Configuration](node-agent-config.md).
|
||||
|
||||
During [CSI Snapshot Data Movement][1], Velero built-in data mover launches data mover pods to run the data transfer.
|
||||
During [fs-backup][2], Velero also launches data mover pods to run the data transfer.
|
||||
Other intermediate resources may also be created along with the data mover pods, i.e., PVCs, VolumeSnapshots, VolumeSnapshotContents, etc.
|
||||
@@ -42,6 +44,15 @@ spec:
|
||||
- --node-agent-config=<configMap name>
|
||||
```
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Node-agent Configuration](node-agent-config.md) - Complete reference for all configuration options
|
||||
- [Node-agent Concurrency](node-agent-concurrency.md) - Configure concurrent operations per node
|
||||
- [Node Selection for Data Movement](data-movement-node-selection.md) - Configure which nodes run data movement
|
||||
- [Data Movement Pod Resource Configuration](data-movement-pod-resource-configuration.md) - Configure pod resources
|
||||
- [BackupPVC Configuration](data-movement-backup-pvc-configuration.md) - Configure backup storage
|
||||
- [RestorePVC Configuration](data-movement-restore-pvc-configuration.md) - Configure restore storage
|
||||
|
||||
[1]: csi-snapshot-data-movement.md
|
||||
[2]: file-system-backup.md
|
||||
[3]: node-agent-concurrency.md
|
||||
|
||||
Reference in New Issue
Block a user