docs: add documentation about Velero Operator and infra-backup-operator #1786
Conversation
gabrielcocenza
commented
Aug 22, 2025
gabrielcocenza
commented
- prerequisites and integration steps
- backup/restore examples with juju run-action syntax
- explanations for cluster vs namespaced backups
- prerequisites and integration steps - backup/restore examples with juju run-action syntax - explanations for cluster vs namespaced backups
gabrielcocenza
force-pushed
the
velero-infra-documentation
branch
from
d5abace to
1f815e3
Compare
gabrielcocenza
force-pushed
the
velero-infra-documentation
branch
from
1f815e3 to
8976b45
Compare
gabrielcocenza
force-pushed
the
velero-infra-documentation
branch
from
408869c to
570a4df
Compare
gabrielcocenza
force-pushed
the
velero-infra-documentation
branch
from
570a4df to
f434d1e
Compare
|
adding @nhennigan |
There was a problem hiding this comment.
Thanks @gabrielcocenza for the contribution! I have given my initial review. Final review and merging of this PR should wait until we have internal approval of the spec that goes along with this work. 😸
| and restore for workloads across namespaces, including non-Juju-managed ones. | ||
|
|
||
| This guide shows how to setup Velero Operator with the [s3-integrator charm][] | ||
| as the storage provider and with the [infra-backup-operator][] to backup the |
There was a problem hiding this comment.
| as the storage provider and with the [infra-backup-operator][] to backup the | |
| as the storage provider and the [infra-backup-operator][] to backup the |
| This guide shows how to setup Velero Operator with the [s3-integrator charm][] | ||
| as the storage provider and with the [infra-backup-operator][] to backup the | ||
| configuration of **any** kind of Kubernetes distribution (Canonical Kubernetes, | ||
| MicroK8s, EKS, etc.). |
There was a problem hiding this comment.
While the infra backup operator may be able to back up any config, this is the Canonical Kubernetes docs so I don't think there is a need to mention the other products here
| configuration of **any** kind of Kubernetes distribution (Canonical Kubernetes, | ||
| MicroK8s, EKS, etc.). | ||
|
|
||
| ## What the infra backup operator does |
There was a problem hiding this comment.
Is the infra backup operator capitalized? We should aim for consistency across the page :)
|
|
||
| ## What you will need | ||
|
|
||
| - A kubernetes cluster |
There was a problem hiding this comment.
| - A kubernetes cluster | |
| - A {product} cluster |
|
|
||
| - A kubernetes cluster | ||
| - A bootstrapped K8s controller. See the [Juju documentation] | ||
| - An S3 bucket or a S3 compatible bucket like [MinIO] or [MicroCeph] |
There was a problem hiding this comment.
| - An S3 bucket or a S3 compatible bucket like [MinIO] or [MicroCeph] | |
| - A S3 bucket or a S3 compatible bucket like [MinIO] or [MicroCeph] |
| juju integrate infra-backup-operator:namespaced-infra-backup velero-operator | ||
| ``` | ||
|
|
||
| ### Create the Backup |
There was a problem hiding this comment.
| ### Create the Backup | |
| ### Create the backup |
| ### Restore | ||
|
|
||
| In case of disaster recovery, users can restore the cluster configuration in | ||
| the same cluster or in a different one using the Velero operator juju-action. |
There was a problem hiding this comment.
| the same cluster or in a different one using the Velero operator juju-action. | |
| the same cluster or in a different one using the Velero operator Juju action. |
| This will guarantee that the cluster configuration can be easily restored to | ||
| start receiving the workloads. | ||
|
|
||
| Before restore your cluster must have velero-operator deployed and integrated |
There was a problem hiding this comment.
| Before restore your cluster must have velero-operator deployed and integrated | |
| Before restoration, your cluster must have the Velero Operator deployed and integrated |
| with the same bucket of the backup. | ||
|
|
||
| ```bash | ||
| # example output |
There was a problem hiding this comment.
We try not to put the command with the output in the same code block as our users like to use the copy button provided in the rendered RTD version of our docs. Having them together means they have to edit the copied command and this can be frustrating
| phase: Completed | ||
| start-timestamp: "2025-08-07T18:42:10Z" | ||
|
|
||
| # restore the backups |
There was a problem hiding this comment.
Again I would split this into another code block and explain now that we have verified the backup and we have it installed, we can run the restore command
| - A kubernetes cluster | ||
| - A bootstrapped K8s controller. See the [Juju documentation] | ||
| - An S3 bucket or a S3 compatible bucket like [MinIO] or [MicroCeph] | ||
| - A {product} cluster |
There was a problem hiding this comment.
Sorry I gave you the wrong formatting in my last review, there needs to be double brackets
| - A {product} cluster | |
| - A {{product}} cluster |
| - A bootstrapped K8s controller. See the Juju [add-k8s] documentation | ||
| - A S3 bucket or a S3 compatible bucket like [MinIO] or [MicroCeph] | ||
|
|
||
| ### Deploy and Integrate |
There was a problem hiding this comment.
| ### Deploy and Integrate | |
| ### Deploy and integrate |
