Backup Operator

Kubernetes Go operator that creates and restores any backups.

Operator controls creation and restoration of backups. You create BackupStorage that will be used for storing backups generated by BackupRuns, while BackupRuns are created on schedule according to BackupSchedule.

Getting started

Helm

helm repo add backup-operator https://helm-charts.backup-operator.io/
helm repo update
helm install backup-operator backup-operator/backup-operator

Manifest

kubectl apply -f https://github.com/universal-backup-operator/backup-operator/releases/latest/download/install.yaml

CLI args

There is a list of CLI args you can append to manager args in the deployment to tune the behaviour.

--health-probe-bind-address string
    The address the probe endpoint binds to. (default ":8081")
--kubeconfig string
    Paths to a kubeconfig. Only required if out-of-cluster.
--leader-elect
    Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.
--zap-devel
    Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error) (default true)
--zap-encoder value
    Zap log encoding (one of 'json' or 'console')
--zap-log-level value
    Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
--zap-stacktrace-level value
    Zap Level at and above which stacktraces are captured (one of 'info', 'error', 'panic').
--zap-time-encoding value
    Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'.

Example kustomization to add arguments.

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
  - https://github.com/universal-backup-operator/backup-operator/releases/latest/download/install.yaml
patches:
  - patch: |-
      - op: add
        path: /spec/template/spec/containers/0/args
        value:
          - --leader-elect=true
          - --zap-devel=false
          - --zap-log-level=debug
          - --zap-encoder=console
          - --zap-stacktrace-level=panic
          - --health-probe-bind-address=:8081
          - --metrics-bind-address=127.0.0.1:8080
    target:
      kind: Deployment
      name: backup-operator.+
## Uncomment if you want to disable creation of custom namespace and plan to use system one instead
#  - patch: |-
#      $patch: delete
#      apiVersion: v1
#      kind: Namespace
#      metadata:
#        name: _
#    target:
#      kind: Namespace
#namespace: kube-system

Annotations

BackupRun

Name	Description
backup-operator.io/keep	Set to any value and BackupSchedule won't delete this run during the rotation
backup-operator.io/restored-at	It is set by operator after the restoration is completed successfully
backup-operator.io/restore	Set to any value in case if you want to restore the backup

BackupSchedule

Name	Description
backup-operator.io/trigger	Can be set to any value to trigger schedule manually

BackupStorage

Name	Description
backup-operator.io/deletion-protection	Is set automatically and prevents accidental storage deletion

Monitoring

Grafana dashboard is located at here.

Contributing

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

If you already have KIND installed, you can easily create and delete cluster using task.

task src:kind:create

Here you will find other tasks available

task --list-all

After you run kind_create, kubeconfig.yaml will be created in current directory.

Ports Map

Service	Port
Minio (S3 API)	9000
Minio (Web UI)	9001
Chart Museum	9002
Grafana	9003
Docker Registry	5000

Running the operator

Choose one of the options below.

1. Installing from manifests

task src:manifest:run

2. Running Go locally

Now, you can install CRDs.

task src:crds:install

Now you can either launch the application with go (but without webhooks)...

task src:go:run

3. Deploying in Helm chart

task src:chart:run

Examples

Once both database and storage are ready, continue with deploying our CRD. Check samples for more details.

kubectl apply -f config/samples/99_common
kubectl apply -f config/samples/10_encryption_compression

Description

// TODO(user): An in-depth paragraph about your project and overview of use

Running on the cluster

1. Install Instances of Custom Resources:

   kubectl apply -f config/samples/

2. Build and push your image to the location specified by IMG:

   make docker-build docker-push IMG=<some-registry>/backup-operator:tag

3. Deploy the controller to the cluster with the image specified by IMG:

   make deploy IMG=<some-registry>/backup-operator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

1. Install the CRDs into the cluster:

   make install

2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

   make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation