Documentation questions and clarification

[NobleMajo]

1. General usage

The swift object store is used as the backup endpoint and the cinder can create backups for openstack cinder volumes?
So the plugin has a different use case than the cinder csi and can trigger backups in openstack clusters in conjunction with the k8s cluster.

2. Checks?

How can I check if the plugin has been successfully installed/configured and can connect to the openstack?
I think the plugin is configured correctly, but I am not sure.

3. Trigger a cinder backup

Can i trigger the backup easily with velero backup create <name>?
(3.2.) What are the trigger conditions?
(3.3.) How can I check the status and whether a cinder backup has been started?
(3.4.) If I only want to create backups of openstack volumes, how can I prevent velero from backing up the whole k8s cluster?

Btw i use a s3 for my k8s endpoints and its configures like this:

...
deployNodeAgent: true
configuration:
  features: EnableCSI
  defaultSnapshotMoveData: true
  backupStorageLocation:
    - name: s3minio
      provider: aws
      default: true
      ...

(The answers to this questions could be added or revised in the docs.)

Helm cloud.yaml example

Please add the following helm auth example anywhere to the docs (if still up-to-date):
#49 (comment)
(or update your existing example and explain how to mount the cloud.yaml)

The first sentence in this issue by mgcrea should be reason enough to update the documentation.

Question context

I use helm to install velero in a 3 node k8s cluster.
I want to create openstack backups of cinder volumes (it supports backups).

Helm Version: v3.16.x (go1.23.x)
Client Version: v1.31.x
Kustomize Version: v5.4.x
Server Version: v1.28.x+rke2r1
Velero Client Version: v1.15.0
Velero Client Version: v1.13.2 (because v0.8.x maps to it)

[Lirt]

Hi @NobleMajo,

I will try to update docs where possible based on your questions. Some of the questions are related general to Velero and documentation for this plugin will not answer them.

Examples of questions related to Velero:

• Can i trigger the backup easily with velero backup create <name>?
  • https://velero.io/docs/main/examples/
• (3.2.) What are the trigger conditions?
  • https://velero.io/docs/main/backup-reference/
• (3.3.) How can I check the status and whether a cinder backup has been started?
  • I can't find proper documentation link, but velero describe backup and velero backup logs can help. To improve this please fill issue in Velero.
• (3.4.) If I only want to create backups of openstack volumes, how can I prevent velero from backing up the whole k8s cluster?
  • Probably you need to read more about general velero concepts, schedules and possible parameters that can be configured in CRDs or that are supported in command line tool (based on how do you plan to perform backups).
  • Generally Velero does backup of all resources by default. It could be possible to circumvent this using "IncludeResources", "IncludeNamespaces" and similar, but AFAIK there is no direct argument to skip cluster backup. Also to backup volume, Velero has to perform a backup of PVC/PV in order to restore it again.