User Guide
Prerequisites
Before installing the Vidra Operator, make sure you have access to a Kubernetes cluster (version 1.26.0 or higher) and that your kubectl tool is configured to communicate with it. For setup instructions, see the Kubernetes installation guide.
For a development cluster, we recommend using minikube or kind. Refer to the Cluster Setup guide for more details.
Install the Vidra Operator using Helm
Helm is a Kubernetes package manager that simplifies installing and managing applications like Vidra using charts.
Helm is not required to run the Vidra Operator, but it simplifies the installation process. Helm version 3.0.0 or higher is recommended. See the Helm installation guide.
Helm Installation
To install the Vidra Operator using Helm OCI, use the following command:
helm install vidra-operator oci://ghcr.io/infrahub-operator/vidra/helm-charts/vidra-operator --namespace vidra-system --create-namespace
Or, if you prefer to use a Helm repository:
helm repo add infrahub-operator https://infrahub-operator.github.io/vidra
helm repo update
helm install vidra infrahub-operator/vidra-operator --namespace vidra-system --create-namespace
The Helm repository is also released under https://github.com/infrahub-operator/vidra/releases/download/vX.Y.Z if you want to install an older version.
Wait for the Vidra Operator to be installed (this might take a few seconds):
kubectl get pods -n vidra-system -w
Install the Vidra Operator using OLM
OLM (Operator Lifecycle Manager) is a Kubernetes project that helps you manage the lifecycle of operators running on your cluster. It provides a way to install, update, and manage operators in a Kubernetes-native way.
OLM is not required to run the Vidra Operator, but it simplifies the installation process. OLM version 0.32.0 or higher is recommended. See the installation guide.
Alternative OLM installation:
curl -sL https://github.com/operator-framework/operator-lifecycle-manager/releases/download/v0.32.0/install.sh | bash -s v0.32.0
Operator Lifecycle Manager (OLM) Installation
Install the Vidra Operator by creating a CatalogSource and Subscription:
kubectl apply -f https://raw.githubusercontent.com/Infrahub-Operator/Vidra/main/install/catalogsource.yaml -f https://raw.githubusercontent.com/Infrahub-Operator/Vidra/main/install/subscription.yaml
It is also released under https://github.com/infrahub-operator/vidra/releases/download/vX.Y.Z if you want to install an older version.
Wait for the Vidra Operator to be installed (this might take a few seconds):
kubectl get csv -n operators -w
Uninstall Vidra Operator
Before uninstalling the Vidra Operator, ensure that you have removed all VidraResource resources; otherwise, the finalizer could block the uninstall.
To completely remove the Vidra Operator and its resources, follow these steps:
Helm Uninstall
helm uninstall vidra-operator --namespace vidra-system
kubectl delete namespace vidra-system
OLM Uninstall
1. Delete the Subscription and ClusterServiceVersion (CSV)
kubectl delete subscriptions.operators.coreos.com -n operators vidra-operator-subscription
kubectl delete csv -n operators $(kubectl get csv -n operators -o jsonpath="{.items[?(@.metadata.labels['operators.coreos.com/vidra.operators')].metadata.name}")
2. Delete the CRDs
kubectl delete crd infrahubsyncs.infrahub.operators.com vidraresources.infrahub.operators.com
3. Delete the Operator
kubectl delete operator vidra-operator.operators
4. Delete the CatalogSource
kubectl delete catalogsource -n operators vidra-catalog