feat: add the initial version of the plugin

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Tell us about a problem you are experiencing
+
+---
+
+**What steps did you take and what happened:**
+[A clear and concise description of what the bug is.]
+
+
+**What did you expect to happen:**
+
+
+**Anything else you would like to add:**
+[Miscellaneous information that will assist in solving the issue.]
+
+
+**Environment:**
+
+- Velero version: (use `velero version`):
+- Kubernetes version: (use `kubectl version`):
+- Kubernetes installer & version:
+- Cloud provider or hardware configuration:
+- OS (e.g. from `/etc/os-release`):

.github/ISSUE_TEMPLATE/feature_enhancement_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature enhancement request
+about: Suggest an idea for this project
+
+---
+
+**Describe the solution you'd like**
+[A clear and concise description of what you want to happen.]
+
+
+**Anything else you would like to add:**
+[Miscellaneous information that will assist in solving the issue.]
+
+
+**Environment:**
+
+- Velero version: (use `velero version`):
+- Kubernetes version: (use `kubectl version`):
+- Kubernetes installer & version:
+- Cloud provider or hardware configuration:
+- OS (e.g. from `/etc/os-release`):

.github/workflows/continuous-integration.yml

@@ -0,0 +1,24 @@
+name: Continuous Integration
+on: [pull_request, push]
+jobs:
+  build:
+    name: Build & test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.21
+      id: go
+    - name: Check out the code
+      uses: actions/checkout@v2
+    - name: Run make ci
+      run: make ci
+  build-container:
+    name: Build container image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the code
+        uses: actions/checkout@v2
+      - name: Run make container
+        run: VERSION=ci-build make container

.gitignore

@@ -0,0 +1,9 @@
+_output
+velero-plugin-example
+
+.go
+
+_tiltbuild
+
+# JetBrains IDE metadata
+.idea

Dockerfile

@@ -0,0 +1,27 @@
+# Copyright 2017, 2019, 2020 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM golang:1.21-bookworm AS build
+ENV GOPROXY=https://proxy.golang.org
+WORKDIR /go/src/github.com/vmware-tanzu/velero-plugin-example
+COPY . .
+RUN CGO_ENABLED=0 go build -o /go/bin/velero-plugin-example .
+
+FROM busybox:1.33.1 AS busybox
+
+FROM scratch
+COPY --from=build /go/bin/velero-plugin-example /plugins/
+COPY --from=busybox /bin/cp /bin/cp
+USER 65532:65532
+ENTRYPOINT ["cp", "/plugins/velero-plugin-suspend-cronjobs", "/target/."]

Makefile

@@ -0,0 +1,74 @@
+# Copyright 2017, 2019, 2020 the Velero contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+PKG := github.com/tuusberg/velero-plugin-suspend-cronjobs
+BIN := velero-plugin-suspend-cronjobs
+
+REGISTRY ?= tuusberg
+IMAGE    ?= $(REGISTRY)/velero-plugin-suspend-cronjobs
+VERSION  ?= latest
+
+GOOS   ?= $(shell go env GOOS)
+GOARCH ?= $(shell go env GOARCH)
+
+# local builds the binary using 'go build' in the local environment.
+.PHONY: local
+local: build-dirs
+	CGO_ENABLED=0 go build -v -o _output/bin/$(GOOS)/$(GOARCH) .
+
+# test runs unit tests using 'go test' in the local environment.
+.PHONY: test
+test:
+	CGO_ENABLED=0 go test -v -timeout 60s ./...
+
+# ci is a convenience target for CI builds.
+.PHONY: ci
+ci: verify-modules local test
+
+# container builds a Docker image containing the binary.
+.PHONY: container
+container:
+	docker build -t $(IMAGE):$(VERSION) .
+
+# push pushes the Docker image to its registry.
+.PHONY: push
+push:
+	@docker push $(IMAGE):$(VERSION)
+ifeq ($(TAG_LATEST), true)
+	docker tag $(IMAGE):$(VERSION) $(IMAGE):latest
+	docker push $(IMAGE):latest
+endif
+
+# modules updates Go module files
+.PHONY: modules
+modules:
+	go mod tidy -compat=1.17
+
+# verify-modules ensures Go module files are up to date
+.PHONY: verify-modules
+verify-modules: modules
+	@if !(git diff --quiet HEAD -- go.sum go.mod); then \
+		echo "go module files are out of date, please commit the changes to go.mod and go.sum"; exit 1; \
+	fi
+
+# build-dirs creates the necessary directories for a build in the local environment.
+.PHONY: build-dirs
+build-dirs:
+	@mkdir -p _output/bin/$(GOOS)/$(GOARCH)
+
+# clean removes build artifacts from the local environment.
+.PHONY: clean
+clean:
+	@echo "cleaning"
+	rm -rf _output

README.md

@@ -1,2 +1,63 @@
 # velero-plugin-suspend-cronjobs
-Automatically suspend Kubernetes CronJobs prior to restoring them into a cluster.
+
+Automatically suspend Kubernetes CronJobs prior to restoring them into a cluster
+
+![Build Status][1]
+
+## Building the plugin
+
+To build the plugin, run
+
+```bash
+$ make
+```
+
+To build the image, run
+
+```bash
+$ make container
+```
+
+This builds an image tagged as `velero/velero-plugin-example:main`. If you want to specify a different name or version/tag, run:
+
+```bash
+$ IMAGE=your-repo/your-name VERSION=your-version-tag make container 
+```
+
+## Deploying the plugins
+
+To deploy your plugin image to an Velero server:
+
+1. Make sure your image is pushed to a registry that is accessible to your cluster's nodes.
+2. Run `velero plugin add <registry/image:version>`. Example with a dockerhub image: `velero plugin add velero/velero-plugin-example`.
+
+
+## Creating your own plugin project
+
+1. Create a new directory in your `$GOPATH`, e.g. `$GOPATH/src/github.com/someuser/velero-plugins`
+2. Copy everything from this project into your new project
+
+```bash
+$ cp -a $GOPATH/src/github.com/vmware-tanzu/velero-plugin-example/* $GOPATH/src/github.com/someuser/velero-plugins/.
+```
+
+3. Remove the git history
+
+```bash
+$ cd $GOPATH/src/github.com/someuser/velero-plugins
+$ rm -rf .git
+```
+
+4. Adjust the existing plugin directories and source code as needed.
+
+The `Makefile` is configured to automatically build all directories starting with the prefix `velero-`.
+You most likely won't need to edit this file, as long as you follow this convention.
+
+If you need to pull in additional dependencies to your vendor directory, just run
+
+```bash
+$ make modules
+```
+
+[1]: https://github.com/vmware-tanzu/velero-plugin-example/workflows/Continuous%20Integration/badge.svg
+

go.mod

@@ -0,0 +1,70 @@
+module github.com/vmware-tanzu/velero-plugin-example
+
+go 1.21
+
+toolchain go1.21.3
+
+require (
+	github.com/pkg/errors v0.9.1
+	github.com/sirupsen/logrus v1.8.1
+	github.com/vmware-tanzu/velero v1.7.1
+	k8s.io/api v0.25.6
+	k8s.io/apimachinery v0.25.6
+	k8s.io/client-go v0.25.6
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/emicklei/go-restful/v3 v3.8.0 // indirect
+	github.com/fatih/color v1.13.0 // indirect
+	github.com/go-logr/logr v1.2.3 // indirect
+	github.com/go-openapi/jsonpointer v0.19.5 // indirect
+	github.com/go-openapi/jsonreference v0.20.0 // indirect
+	github.com/go-openapi/swag v0.21.1 // indirect
+	github.com/gobwas/glob v0.2.3 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/google/gnostic v0.6.9 // indirect
+	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/hashicorp/go-hclog v0.14.1 // indirect
+	github.com/hashicorp/go-plugin v1.4.3 // indirect
+	github.com/hashicorp/yamux v0.0.0-20190923154419-df201c70410d // indirect
+	github.com/imdario/mergo v0.3.13 // indirect
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/kopia/kopia v0.10.7 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/mattn/go-colorable v0.1.12 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/mitchellh/go-testing-interface v1.0.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/oklog/run v1.0.0 // indirect
+	github.com/spf13/cobra v1.4.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/net v0.17.0 // indirect
+	golang.org/x/oauth2 v0.7.0 // indirect
+	golang.org/x/sys v0.13.0 // indirect
+	golang.org/x/term v0.13.0 // indirect
+	golang.org/x/text v0.13.0 // indirect
+	golang.org/x/time v0.0.0-20220609170525-579cf78fd858 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 // indirect
+	google.golang.org/grpc v1.56.3 // indirect
+	google.golang.org/protobuf v1.30.0 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/klog/v2 v2.70.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20220803162953-67bda5d908f1 // indirect
+	k8s.io/utils v0.0.0-20220728103510-ee6ede2d64ed // indirect
+	sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 // indirect
+	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
+	sigs.k8s.io/yaml v1.3.0 // indirect
+)
+
+replace github.com/gogo/protobuf => github.com/gogo/protobuf v1.3.2
+
+replace github.com/vmware-tanzu/velero => github.com/vmware-tanzu/velero v1.10.0-rc.1.0.20230321103129-29b5894be6f1