Sign inSign up
Velero Helm chart

dhi.io/velero-chart

Velero Helm chart

Velero is an open source tool to safely back up and restore, perform disaster recovery, and migrate Kubernetes cluster resources and persistent volumes.

OverviewGuidesTags

Installing the chart

Prerequisites
  • Kubernetes 1.16+
  • Helm 3.0+
Installation steps

All examples in this guide use the public chart and images. If you've mirrored the repository for your own use (for example, to your Docker Hub namespace), update your commands to reference the mirrored chart instead of the public one.

For example:

  • Public chart: dhi.io/<repository>:<tag>
  • Mirrored chart: <your-namespace>/dhi-<repository>:<tag>

For more details about customizing the chart to reference other images, see the documentation⁠.

Step 1: Optional. Mirror the Helm chart and/or its images to your own registry

To optionally mirror a chart to your own third-party registry, you can follow the instructions in How to mirror an image ⁠ for either the chart, the image, or both.

The same regctl tool that is used for mirroring container images can also be used for mirroring Helm charts, as Helm charts are OCI artifacts.

For example:

 regctl image copy \
     "${SRC_CHART_REPO}:${TAG}" \
     "${DEST_REG}/${DEST_CHART_REPO}:${TAG}" \
     --referrers \
     --referrers-src "${SRC_ATT_REPO}" \
     --referrers-tgt "${DEST_REG}/${DEST_CHART_REPO}" \
     --force-recursive
Step 2: Create a Kubernetes secret for pulling images

The Docker Hardened Images that the chart uses require authentication. To allow your Kubernetes cluster to pull those images, you need to create a Kubernetes secret with your Docker Hub credentials or with the credentials for your own registry.

Follow the authentication instructions for DHI in Kubernetes⁠.

For example:

kubectl create secret docker-registry helm-pull-secret \
  --docker-server=dhi.io \
  --docker-username=<Docker username> \
  --docker-password=<Docker token> \
  --docker-email=<Docker email>
Step 3: Install the Helm chart

To install the chart, use helm install. Make sure you use helm login to log in before running helm install. Optionally, you can also use the --dry-run flag to test the installation without actually installing anything.

helm install velero oci://dhi.io/velero-chart --version <version> \
  --set "image.imagePullSecrets[0]=helm-pull-secret" \

Replace <version> accordingly. If the chart is in your own registry or repository, replace dhi.io with your own registry and namespace. Replace helm-pull-secret with the name of the image pull secret you created earlier.

Step 4: Verify the installation

After installing, Velero runs an Upgrade CRDs job that takes care of creating and/or upgrading the CRDs in the cluster. This is part of the standard Velero installation process.

$ kubectl get all
NAME                                         READY   STATUS    RESTARTS   AGE
pod/velero-velero-chart-upgrade-crds-zbx4t   1/1     Running   0          7s

NAME                 TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)   AGE
service/kubernetes   ClusterIP   10.96.0.1    <none>        443/TCP   4d4h

NAME                                         STATUS    COMPLETIONS   DURATION   AGE
job.batch/velero-velero-chart-upgrade-crds   Running   0/1           7s         7s

Once that job finishes, the installation process should start Velero:

$ kubectl get all
NAME                          READY   STATUS    RESTARTS   AGE
pod/velero-76d668b7b6-8l6bv   1/1     Running   0          89s

NAME                          TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
service/kubernetes            ClusterIP   10.96.0.1        <none>        443/TCP    4d4h
service/velero-velero-chart   ClusterIP   10.107.113.158   <none>        8085/TCP   89s

NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/velero   1/1     1            1           89s

NAME                                DESIRED   CURRENT   READY   AGE
replicaset.apps/velero-76d668b7b6   1         1         1       89s

The above shows the DHI image and Helm chart are functional but it will not be enough to get a proper Velero system as that needs setting up node or cloud backup storage. This for example could be done like follows:

$ helm install oci://dhi.io/velero-chart --version <version> \
--namespace <YOUR NAMESPACE> \
--create-namespace \
--set-file credentials.secretContents.cloud=<FULL PATH TO FILE> \
--set configuration.backupStorageLocation[0].name=<BACKUP STORAGE LOCATION NAME> \
--set configuration.backupStorageLocation[0].provider=<PROVIDER NAME> \
--set configuration.backupStorageLocation[0].bucket=<BUCKET NAME> \
--set configuration.backupStorageLocation[0].config.region=<REGION> \
--set configuration.volumeSnapshotLocation[0].name=<VOLUME SNAPSHOT LOCATION NAME> \
--set configuration.volumeSnapshotLocation[0].provider=<PROVIDER NAME> \
--set configuration.volumeSnapshotLocation[0].config.region=<REGION> \
--set initContainers[0].name=velero-plugin-for-<PROVIDER NAME> \
--set initContainers[0].image=velero/velero-plugin-for-<PROVIDER NAME>:<PROVIDER PLUGIN TAG> \
--set initContainers[0].volumeMounts[0].mountPath=/target \
--set initContainers[0].volumeMounts[0].name=plugins

More information on how to setup Velero can be found on https://velero.io⁠.

On this page

Installing the chartPrerequisitesInstallation stepsStep 1: Optional. Mirror the Helm chart and/or its images to your own registryStep 2: Create a Kubernetes secret for pulling imagesStep 3: Install the Helm chartStep 4: Verify the installation