Integrate wrestic into k8up

.dockerignore

@@ -1,3 +1,4 @@
 .*
 *
 !k8up
+!wrestic/wrestic.sh

.github/workflows/e2e.yml

@@ -11,9 +11,9 @@ jobs:
     strategy:
       matrix:
         include:
-        - kind-node-version: v1.20.0
+        - kind-node-version: v1.21.2
           crd-spec-version: v1
-        - kind-node-version: v1.13.12 # we cannot go lower than that because of Kind, see https://github.com/kubernetes-sigs/kind/issues/1853
+        - kind-node-version: v1.18.19
           crd-spec-version: v1beta1
     steps:
     - uses: actions/checkout@v2
@@ -28,6 +28,10 @@ jobs:
         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
         restore-keys: |
           ${{ runner.os }}-go-
+    - uses: azure/setup-kubectl@v1
+      with:
+        version: ${{ matrix.kind-node-version }}
+      id: install
     - name: Run e2e tests
       run: make crd e2e-test -e CRD_SPEC_VERSION=${{ matrix.crd-spec-version }} -e KIND_NODE_VERSION=${{ matrix.kind-node-version }} -e KIND_KUBECTL_ARGS=--validate=false -e bats_args="--report-formatter junit"
     - name: Publish Test Report

.gitignore

@@ -1,48 +1,34 @@
-# Created by .ignore support plugin (hsz.mobi)
-### Example user template template
-### Example user template
-
-# VSCode configs
-.vscode/
-
-# IntelliJ project files
-.idea
-*.iml
-out
-gen### Go template
 # Binaries for programs and plugins
 *.exe
 *.dll
 *.so
 *.dylib
+__debug_bin
 
 # Test binary, build with `go test -c`
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
-
-# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
-.glide/
+coverage/
 
 # Antora related
 .asciidoctor
 .cache
 _public/
 _archive/
 
-*.DS_Store
-cmd/*/debug
-cmd/operator/operator
-cmd/restic/restic
-
-bin/
-dist/
 .github/release-notes.md
+
 k8up-crd*.yaml
+
 /k8up
-testbin/
+
+# Go releaser
+dist/
+
+# Test related
 node_modules/
 e2e/debug
-__debug_bin
-coverage/
+.integration-test/
+.e2e-test/

.goreleaser.yml

@@ -2,7 +2,9 @@
 # Make sure to check the documentation at http://goreleaser.com
 
 builds:
-- env:
+- main: ./cmd/k8up
+  binary: k8up
+  env:
   - CGO_ENABLED=0 # this is needed otherwise the Docker image build is faulty
   goarch:
   - amd64
@@ -13,10 +15,9 @@ checksum:
   name_template: 'checksums.txt'
 
 snapshot:
-  name_template: "{{ .Tag }}-snapshot"
+  name_template: "{{ incpatch .Version }}-snapshot"
 
 dockers:
-
 - image_templates:
   - "docker.io/vshn/k8up:v{{ .Version }}"
   - "quay.io/vshn/k8up:v{{ .Version }}"
@@ -29,6 +30,42 @@ dockers:
 
   - "{{ if not .Prerelease }}docker.io/vshn/k8up:latest{{ end }}"
   - "{{ if not .Prerelease }}quay.io/vshn/k8up:latest{{ end }}"
+  build_flag_templates:
+  - "--target=k8up"
+  extra_files:
+    - wrestic/wrestic.sh
+- image_templates:
+  - "docker.io/vshn/wrestic:v{{ .Version }}-nonroot"
+  - "quay.io/vshn/wrestic:v{{ .Version }}-nonroot"
+
+  # For prereleases, updating `latest` and the floating tags of the major
+  # version does not make sense. Only the image for the exact version should
+  # be pushed.
+  - "{{ if not .Prerelease }}docker.io/vshn/wrestic:v{{ .Major }}-nonroot{{ end }}"
+  - "{{ if not .Prerelease }}quay.io/vshn/wrestic:v{{ .Major }}-nonroot{{ end }}"
+
+  - "{{ if not .Prerelease }}docker.io/vshn/wrestic:latest-nonroot{{ end }}"
+  - "{{ if not .Prerelease }}quay.io/vshn/wrestic:latest-nonroot{{ end }}"
+  build_flag_templates:
+  - "--target=wrestic"
+  extra_files:
+  - wrestic/wrestic.sh
+- image_templates:
+  - "docker.io/vshn/wrestic:v{{ .Version }}"
+  - "quay.io/vshn/wrestic:v{{ .Version }}"
+
+  # For prereleases, updating `latest` and the floating tags of the major
+  # version does not make sense. Only the image for the exact version should
+  # be pushed.
+  - "{{ if not .Prerelease }}docker.io/vshn/wrestic:v{{ .Major }}{{ end }}"
+  - "{{ if not .Prerelease }}quay.io/vshn/wrestic:v{{ .Major }}{{ end }}"
+
+  - "{{ if not .Prerelease }}docker.io/vshn/wrestic:latest{{ end }}"
+  - "{{ if not .Prerelease }}quay.io/vshn/wrestic:latest{{ end }}"
+  build_flag_templates:
+  - "--target=wrestic-root"
+  extra_files:
+  - wrestic/wrestic.sh
 
 release:
   prerelease: auto

Dockerfile

@@ -1,9 +1,37 @@
-FROM docker.io/library/alpine:3.14 as runtime
+FROM docker.io/library/alpine:3.14 as k8up
 
 ENTRYPOINT ["k8up"]
 
-RUN \
-    apk add --no-cache curl bash tzdata
+RUN mkdir /.cache && chmod -R g=u /.cache
 
-COPY k8up /usr/bin/
-USER 65532:65532
+RUN apk add --update --no-cache \
+    bash \
+    ca-certificates \
+    curl \
+    fuse \
+    openssh-client \
+    tzdata
+
+ENV RESTIC_BINARY=/usr/local/bin/restic
+
+COPY wrestic/wrestic.sh /app/wrestic
+COPY --from=restic/restic:0.12.1 /usr/bin/restic $RESTIC_BINARY
+COPY k8up /usr/local/bin/
+
+RUN chmod a+x /usr/local/bin/k8up /usr/local/bin/restic /app/wrestic
+
+USER 65532
+
+## wrestic compatibility shim
+FROM k8up as wrestic
+
+WORKDIR /app
+ENTRYPOINT ["./wrestic"]
+
+## wrestic root compatibility shim
+FROM wrestic as wrestic-root
+
+USER 0
+
+## Default build shall not contain the wrestic compatibility stuff
+FROM k8up as default

Makefile

@@ -6,48 +6,56 @@ MAKEFLAGS += --no-builtin-rules
 MAKEFLAGS += --no-builtin-variables
 .SUFFIXES:
 .SECONDARY:
+.DEFAULT_GOAL := help
 
 PROJECT_ROOT_DIR = .
 include Makefile.vars.mk
+include Makefile.restic-integration.mk
 
 e2e_make := $(MAKE) -C e2e
-go_build ?= go build -o $(BIN_FILENAME) cmd/operator/main.go
-
-setup-envtest ?= go run sigs.k8s.io/controller-runtime/tools/setup-envtest $(ENVTEST_ADDITIONAL_FLAGS)
-
-# Run tests (see https://sdk.operatorframework.io/docs/building-operators/golang/references/envtest-setup)
-ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
+go_build ?= go build -o $(BIN_FILENAME) cmd/k8up/main.go
 
 all: build ## Invokes the build target
 
 .PHONY: test
 test: ## Run tests
 	go test ./... -coverprofile cover.out
 
+.PHONY: integration-test
+# operator module {
 # See https://storage.googleapis.com/kubebuilder-tools/ for list of supported K8s versions
-#
-# A note on 1.20.2:
-# 1.20.2 is not (yet) supported, because starting the Kubernetes API controller with
-# `--insecure-port` and `--insecure-bind-address` flags is now deprecated,
-# but envtest was not updated accordingly.
-#integration-test: export ENVTEST_K8S_VERSION = 1.20.x
-integration-test: export ENVTEST_K8S_VERSION = 1.19.x
+integration-test: export ENVTEST_K8S_VERSION = 1.21.x
 integration-test: export KUBEBUILDER_ATTACH_CONTROL_PLANE_OUTPUT = $(INTEGRATION_TEST_DEBUG_OUTPUT)
-integration-test: generate $(testbin_created) ## Run integration tests with envtest
+# }
+# restic module {
+integration-test: export RESTIC_PATH = $(restic_path)
+integration-test: export RESTIC_BINARY = $(restic_path)
+integration-test: export RESTIC_PASSWORD = $(restic_password)
+integration-test: export RESTIC_REPOSITORY = s3:http://$(minio_address)/test
+integration-test: export RESTORE_S3ENDPOINT = http://$(minio_address)/restore
+integration-test: export AWS_ACCESS_KEY_ID = $(minio_root_user)
+integration-test: export AWS_SECRET_ACCESS_KEY = $(minio_root_password)
+integration-test: export RESTORE_ACCESSKEYID = $(minio_root_user)
+integration-test: export RESTORE_SECRETACCESSKEY = $(minio_root_password)
+integration-test: export BACKUP_DIR = $(backup_dir)
+integration-test: export RESTORE_DIR = $(restore_dir)
+integration-test: export STATS_URL = $(stats_url)
+# }
+integration-test: generate $(integrationtest_dir_created) restic-integration-test-setup ## Run integration tests with envtest
 	$(setup-envtest) use '$(ENVTEST_K8S_VERSION)!'
 	export KUBEBUILDER_ASSETS="$$($(setup-envtest) use -i -p path '$(ENVTEST_K8S_VERSION)!')"; \
 		env | grep KUBEBUILDER; \
-		go test -tags=integration -v ./... -coverprofile cover.out
+		go test -tags=integration -coverprofile cover.out  ./...
 
 .PHONY: build
 build: generate fmt vet $(BIN_FILENAME) ## Build manager binary
 
 .PHONY: run
 run: export BACKUP_ENABLE_LEADER_ELECTION = $(ENABLE_LEADER_ELECTION)
-run: export BACKUP_LOG_LEVEL = debug
+run: export K8UP_DEBUG = true
 run: export BACKUP_OPERATOR_NAMESPACE = default
-run: fmt vet ## Run against the configured Kubernetes cluster in ~/.kube/config
-	go run ./cmd/operator/main.go
+run: fmt vet ## Run against the configured Kubernetes cluster in ~/.kube/config. Use ARGS to pass arguments to the command, e.g. `make run ARGS="--help"`
+	go run ./cmd/k8up/main.go $(ARGS)
 
 .PHONY: install
 install: generate ## Install CRDs into a cluster
@@ -86,18 +94,20 @@ lint: fmt vet ## Invokes the fmt and vet targets
 	git diff --exit-code
 
 .PHONY: docker-build
-docker-build: export GOOS = linux
 docker-build: $(BIN_FILENAME) ## Build the docker image
-	docker build . -t $(DOCKER_IMG) -t $(QUAY_IMG) -t $(E2E_IMG)
+	docker build . --target=k8up -t $(K8UP_DOCKER_IMG) -t $(K8UP_QUAY_IMG) -t $(K8UP_E2E_IMG)
+	docker build . --target=wrestic -t $(WRESTIC_DOCKER_IMG) -t $(WRESTIC_QUAY_IMG) -t $(WRESTIC_E2E_IMG)
 
 .PHONY: docker-push
 docker-push: ## Push the docker image
-	docker push $(DOCKER_IMG)
-	docker push $(QUAY_IMG)
+	docker push $(K8UP_DOCKER_IMG) $(WRESTIC_DOCKER_IMG) $(K8UP_QUAY_IMG) $(WRESTIC_QUAY_IMG)
 
 clean: export KUBECONFIG = $(KIND_KUBECONFIG)
-clean: e2e-clean kind-clean ## Cleans up the generated resources
-	rm -r testbin/ dist/ bin/ cover.out $(BIN_FILENAME) || true
+clean: restic-integration-test-clean e2e-clean docs-clean ## Cleans up the generated resources
+# setup-envtest removes write permission from the files it generates, so they have to be restored in order to delete the directory
+	chmod +rwx -R -f $(integrationtest_dir) || true
+
+	rm -rf $(e2etest_dir) $(integrationtest_dir) dist/ bin/ cover.out $(BIN_FILENAME) || true
 
 .PHONY: help
 help: ## Show this help
@@ -107,19 +117,20 @@ help: ## Show this help
 ### Assets
 ###
 
-$(testbin_created):
-	mkdir -p $(TESTBIN_DIR)
-	# a marker file must be created, because the date of the
-	# directory may update when content in it is created/updated,
-	# which would cause a rebuild / re-initialization of dependants
-	@touch $(testbin_created)
-
 # Build the binary without running generators
 .PHONY: $(BIN_FILENAME)
 $(BIN_FILENAME): export CGO_ENABLED = 0
+$(BIN_FILENAME): export GOOS = linux
 $(BIN_FILENAME):
 	$(go_build)
 
+$(integrationtest_dir_created):
+	mkdir -p $(integrationtest_dir)
+	# a marker file must be created, because the date of the
+	# directory may update when content in it is created/updated,
+	# which would cause a rebuild / re-initialization of dependants
+	@touch $(integrationtest_dir_created)
+
 ###
 ### KIND
 ###