Skip to content

Getting Started

Prerequisites

Before deploying the kubensync operator, ensure you have the following prerequisites:

  • Kubernetes cluster up and running.
  • kubectl CLI tool configured to access your cluster.
  • helm CLI tool installed (if you choose to deploy using Helm).
  • cluster-admin privileges.

Installation

Using kubectl

Install the operator:

kubectl apply -f https://raw.githubusercontent.com/eryalito/kubensync-operator/master/dist/install.yaml

Grant Permissions:

kubectl apply -f https://raw.githubusercontent.com/eryalito/kubensync-operator/master/dist/rbac.yaml

Warning

This permissions will grant the operator cluster-admin permissions. It's a good way of testing the operator, but specific permissions should be defined according to the resources it will manage in each specific case.

Using Helm

Add the kubensync repository and install the chart:

helm repo add kubensync https://kubensync.com/charts
helm repo update
helm install kubensync kubensync/kubensync -n kubensync-system --create-namespace --wait

Helm Chart

To get more information about the Helm chart, check the Helm Chart documentation

OCI registry

The chart is also published to an OCI registry, which is useful for air-gapped environments or registry mirroring:

helm install kubensync oci://ghcr.io/eryalito/kubensync-charts/kubensync --version <version> -n kubensync-system --create-namespace --wait

Uninstallation

With kubectl

Delete the operator:

kubectl delete -f https://raw.githubusercontent.com/eryalito/kubensync-operator/master/dist/install.yaml

Delete Permissions:

kubectl delete -f https://raw.githubusercontent.com/eryalito/kubensync-operator/master/dist/rbac.yaml

With Helm

Uninstall the operator using Helm:

helm uninstall kubensync -n kubensync-system