Merge COSI API monorepo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug Report
+about: Use this template for reporting bugs or issues.
+title: "[DATE] - Title"
+labels: bug
+---
+# Bug Report
+
+<!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!
+
+If the matter is security related, please disclose it privately via https://kubernetes.io/security/
+-->
+
+**What happened**:
+
+**What you expected to happen**:
+
+**How to reproduce this bug (as minimally and precisely as possible)**:
+
+**Anything else relevant for this bug report?**:
+
+**Environment**:
+
+- Kubernetes version (use `kubectl version`), please list client and server:
+- Sidecar version (provide the release tag or commit hash):
+- Provisoner name and version (provide the release tag or commit hash):
+- Cloud provider or hardware configuration:
+- OS (e.g: `cat /etc/os-release`):
+- Kernel (e.g. `uname -a`):
+- Install tools:
+- Network plugin and version (if this is a network-related bug):
+- Others:

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,18 @@
+---
+name: Enhancement/Feature Request
+about: Use this template to request a new feature or enhancement for the COSI API
+title: "[DATE] - Title"
+---
+# Enhancement
+
+**Is your feature request related to a problem?/Why is this needed**
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+**Describe the solution you'd like in detail**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+**Additional context**
+<!-- Add any other context or screenshots about the feature request or enhancement here. -->

.github/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Information about supported Kubernetes versions can be found on the
+[Kubernetes version and version skew support policy] page on the Kubernetes website.
+
+## Reporting a Vulnerability
+
+Instructions for reporting a vulnerability can be found on the
+[Kubernetes Security and Disclosure Information] page.
+
+[Kubernetes version and version skew support policy]: https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions
+[Kubernetes Security and Disclosure Information]: https://kubernetes.io/docs/reference/issues-security/security/#report-a-vulnerability

.gitignore

@@ -0,0 +1,8 @@
+*.tmp
+.DS_Store
+.build
+*.swp
+release-tools
+.idea
+travis.yml
+.cache

.golangci.yaml

@@ -0,0 +1,47 @@
+run:
+  timeout: 5m
+  allow-parallel-runners: true
+
+issues:
+  # don't skip warning about doc comments
+  # don't exclude the default set of lint
+  exclude-use-default: false
+  # restore some of the defaults
+  # (fill in the rest as needed)
+  exclude-rules:
+    - path: "apis/*"
+      linters:
+        - lll
+    - path: "internal/*"
+      linters:
+        - dupl
+        - lll
+linters:
+  disable-all: true
+  enable:
+    - copyloopvar
+    - dupl
+    - errcheck
+    - ginkgolinter
+    - goconst
+    - gocyclo
+    - gofmt
+    - goimports
+    - gosimple
+    - govet
+    - ineffassign
+    - lll
+    - misspell
+    - nakedret
+    - prealloc
+    - revive
+    - staticcheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+
+linters-settings:
+  revive:
+    rules:
+      - name: comment-spacings

CHANGELOG/CHANGELOG-0.1.md

@@ -0,0 +1,16 @@
+# First Release v0.1.0
+
+ ### New Features
+
+ - API v1alpha1 for Bucket* resources and respective controllers
+
+### Thanks to our contributors
+
+- wlan0
+- krishchow
+- mukhoakash
+- brahmaroutu
+- tparikh
+- thotz
+
+and others

Makefile

@@ -0,0 +1,212 @@
+# Copyright 2020 The Kubernetes Authors.
+#
+# 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.
+
+.DEFAULT_GOAL := help
+.SUFFIXES: # remove legacy builtin suffixes to allow easier make debugging
+SHELL = /usr/bin/env bash
+
+.PHONY: help
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+# If GOARCH is not set in the env, find it
+GOARCH ?= $(shell go env GOARCH)
+
+##
+## ==== ARGS ===== #
+
+## Container build tool compatible with `docker` API
+DOCKER ?= docker
+
+## Platform for 'build'
+PLATFORM ?= linux/$(GOARCH)
+
+## Additional args for 'build'
+BUILD_ARGS ?=
+
+## Image tag for controller image build
+CONTROLLER_TAG ?= cosi-controller:latest
+
+## Image tag for sidecar image build
+SIDECAR_TAG ?= cosi-provisioner-sidecar:latest
+
+## Location to install dependencies to
+TOOLBIN ?= $(CURDIR)/.cache/tools
+$(TOOLBIN):
+	mkdir -p $(TOOLBIN)
+
+##@ Development
+
+.PHONY: all .gen
+.gen: generate codegen # can be done in parallel with 'make -j'
+.NOTPARALLEL: all # codegen must be finished before fmt/vet
+all: .gen fmt vet build ## Build all targets, plus their prerequisites (faster with 'make -j')
+
+.PHONY: generate
+generate: controller/Dockerfile sidecar/Dockerfile ## Generate files
+	$(MAKE) -C client crds
+	$(MAKE) -C proto generate
+
+.PHONY: codegen
+codegen: codegen.client codegen.proto ## Generate code
+
+.PHONY: fmt
+fmt: fmt.client fmt.controller fmt.sidecar ## Format code
+
+.PHONY: vet
+vet: vet.client vet.controller vet.sidecar ## Vet code
+
+.PHONY: test
+test: .test.proto test.client test.controller test.sidecar ## Run tests including unit tests
+
+.PHONY: test-e2e
+test-e2e: chainsaw # Run e2e tests against the K8s cluster specified in ~/.kube/config. It requires both controller and driver deployed. If you need to create a cluster beforehand, consider using 'cluster' and 'deploy' targets.
+	$(CHAINSAW) test --values ./test/e2e/values.yaml
+
+.PHONY: lint
+lint: golangci-lint.client golangci-lint.controller golangci-lint.sidecar ## Run all linters (suggest `make -k`)
+
+.PHONY: lint-fix
+lint-fix: golangci-lint-fix.client golangci-lint-fix.controller golangci-lint-fix.sidecar ## Run all linters and perform fixes where possible (suggest `make -k`)
+
+##@ Build
+
+.PHONY: build
+build: build.controller build.sidecar ## Build all container images for development
+
+.PHONY: build.controller build.sidecar
+build.controller: controller/Dockerfile ## Build only the controller container image
+	$(DOCKER) build --file controller/Dockerfile --platform $(PLATFORM) $(BUILD_ARGS) --tag $(CONTROLLER_TAG) .
+build.sidecar: sidecar/Dockerfile ## Build only the sidecar container image
+	$(DOCKER) build --file sidecar/Dockerfile --platform $(PLATFORM) $(BUILD_ARGS) --tag $(SIDECAR_TAG) .
+
+.PHONY: clean
+## Clean build environment
+clean:
+	$(MAKE) -C proto clean
+
+.PHONY: clobber
+## Clean build environment and cached tools
+clobber:
+	$(MAKE) -C proto clobber
+	rm -rf $(TOOLBIN)
+	rm -rf $(CURDIR)/.cache
+
+##
+## === INTERMEDIATES === #
+
+%/Dockerfile: hack/Dockerfile.in hack/gen-dockerfile.sh
+	hack/gen-dockerfile.sh $* > "$@"
+
+codegen.%: FORCE
+	$(MAKE) -C $* codegen
+
+fmt.%: FORCE
+	cd $* && go fmt ./...
+
+vet.%: FORCE
+	cd $* && go vet ./...
+
+test.%: fmt.% vet.% FORCE
+	cd $* && go test ./...
+
+# golangci-lint --new flag only complains about new code
+golangci-lint.%: $(GOLANGCI_LINT)
+	cd $* && $(GOLANGCI_LINT) run --config $(CURDIR)/.golangci.yaml --new
+
+golangci-lint-fix.%: $(GOLANGCI_LINT)
+	cd $* && $(GOLANGCI_LINT) run --config $(CURDIR)/.golangci.yaml --new --fix
+
+.PHONY: .test.proto
+.test.proto: # gRPC proto has a special unit test
+	$(MAKE) -C proto check
+
+.PHONY: FORCE # use this to force phony behavior for targets with pattern rules
+FORCE:
+
+##@ Deployment
+
+.PHONY: cluster
+cluster: kind ctlptl ## Create Kind cluster and local registry
+	$(CTLPTL) apply -f ctlptl.yaml
+
+.PHONY: cluster-reset
+cluster-reset: kind ctlptl ## Delete Kind cluster
+	$(CTLPTL) delete -f ctlptl.yaml
+
+.PHONY: deploy
+deploy: kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. The 'generate' and 'codegen' targets should be run manually, and are expected to be run at least once before the 'deploy' target, as those are not cached.
+	$(KUSTOMIZE) build . | $(KUBECTL) apply -f -
+
+.PHONY: undeploy
+undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build . | $(KUBECTL) delete --ignore-not-found=true -f -
+
+##@ Tools
+
+## Tool Binaries
+CHAINSAW ?= $(TOOLBIN)/chainsaw
+CTLPTL ?= $(TOOLBIN)/ctlptl
+GOLANGCI_LINT ?= $(LOCALBIN)/golangci-lint
+KIND ?= $(TOOLBIN)/kind
+KUBECTL ?= kubectl ## Special case, we do not manage it via tools.go
+KUSTOMIZE ?= $(TOOLBIN)/kustomize
+
+## Tool Versions
+CHAINSAW_VERSION ?= $(shell grep 'github.com/kyverno/chainsaw ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+CTLPTL_VERSION ?= $(shell grep 'github.com/tilt-dev/ctlptl ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+GOLANGCI_LINT_VERSION ?= $(shell grep 'github.com/golangci/golangci-lint ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+KIND_VERSION ?= $(shell grep 'sigs.k8s.io/kind ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+KUSTOMIZE_VERSION ?= $(shell grep 'sigs.k8s.io/kustomize/kustomize/v5 ' ./hack/tools/go.mod | cut -d ' ' -f 2)
+
+.PHONY: chainsaw
+chainsaw: $(CHAINSAW)$(CHAINSAW_VERSION) ## Download chainsaw locally if necessary.
+$(CHAINSAW)$(CHAINSAW_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(CHAINSAW),github.com/kyverno/chainsaw,$(CHAINSAW_VERSION))
+
+.PHONY: ctlptl
+ctlptl: $(CTLPTL)$(CTLPTL_VERSION) ## Download ctlptl locally if necessary.
+$(CTLPTL)$(CTLPTL_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(CTLPTL),github.com/tilt-dev/ctlptl/cmd/ctlptl,$(CTLPTL_VERSION))
+
+.PHONY: golangci-lint
+golangci-lint: $(GOLANGCI_LINT)$(GOLANGCI_LINT_VERSION) ## Download golangci-lint locally if necessary.
+$(GOLANGCI_LINT)$(GOLANGCI_LINT_VERSION): $(LOCALBIN)
+	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+.PHONY: kind
+kind: $(KIND)$(KIND_VERSION) ## Download kind locally if necessary.
+$(KIND)$(KIND_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(KIND),sigs.k8s.io/kind,$(KIND_VERSION))
+
+.PHONY: kustomize
+kustomize: $(KUSTOMIZE)$(KUSTOMIZE_VERSION) ## Download kustomize locally if necessary.
+$(KUSTOMIZE)$(KUSTOMIZE_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION))
+
+# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
+# $1 - target path with name of binary
+# $2 - package url which can be installed
+# $3 - specific version of package
+define go-install-tool
+@[ -f "$(1)-$(3)" ] || { \
+set -e; \
+package=$(2)@$(3) ;\
+echo "Downloading $${package}" ;\
+rm -f $(1) || true ;\
+GOBIN=$(TOOLBIN) go install $${package} ;\
+mv $(1) $(1)-$(3) ;\
+} ;\
+ln -sf $(1)-$(3) $(1)
+endef

OWNERS

@@ -7,3 +7,6 @@ approvers:
   - saad-ali
   - shanduur
   - xing-yang
+emeritus_approvers:
+  - wlan0 # 2024-11-22
+  - mukhoakash # 2024-11-22