Merge pull request #127 from BlaineEXE/sync-main-release-0.2

Sync main -> release-0.2

Author: BlaineEXE

.github/dependabot.yml

@@ -0,0 +1,39 @@
+version: 2
+enable-beta-ecosystems: true
+updates:
+
+  - package-ecosystem: "gomod"
+    directories:
+      - "**/*"
+    schedule:
+      interval: "weekly"
+    groups:
+      golang-dependencies:
+        patterns:
+          - "github.com/golang*"
+          - "golang.org/x*"
+      k8s-dependencies:
+        patterns:
+          - "k8s.io*"
+          - "sigs.k8s.io*"
+        exclude-patterns:
+          # controller-runtime has history of breaking API changes more often than other k8s projects
+          - "sigs.k8s.io/controller-runtime"
+    labels:
+      - ok-to-test
+
+  - package-ecosystem: "docker"
+    directories:
+      - "**/*"
+    schedule:
+      interval: "weekly"
+    labels:
+      - ok-to-test
+
+  - package-ecosystem: "github-actions"
+    directories:
+      - "**/*"
+    schedule:
+      interval: "weekly"
+    labels:
+      - ok-to-test

.github/workflows/docs.yaml

@@ -0,0 +1,68 @@
+# Sample workflow for building and deploying a mdBook site to GitHub Pages
+#
+# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html
+#
+name: Deploy mdBook site to Pages
+
+on:
+  # Runs on only core version tags
+  push:
+    tags:
+      - 'v*'
+      - '!v*-alpha*'
+      - '!v*-beta*'
+      - '!v*-pre*'
+      - '!v*-rc*'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install mdBook
+        run: |
+          make mdbook
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: ./client/go.mod
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+        with:
+          enablement: true
+      - name: Build with mdBook
+        run: |
+          make build-docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/book
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Makefile

@@ -48,9 +48,14 @@ SIDECAR_TAG ?= cosi-provisioner-sidecar:latest
 ##@ Development
 
 .PHONY: generate
-generate: controller/Dockerfile sidecar/Dockerfile ## Generate files
+generate: crd-ref-docs controller/Dockerfile sidecar/Dockerfile ## Generate files
 	$(MAKE) -C client crds
 	$(MAKE) -C proto generate
+	$(CRD_REF_DOCS) \
+		--config=./docs/.crd-ref-docs.yaml \
+		--source-path=./client/apis \
+		--renderer=markdown \
+		--output-path=./docs/src/api/
 %/Dockerfile: hack/Dockerfile.in hack/gen-dockerfile.sh
 	hack/gen-dockerfile.sh $* > "$@"
 
@@ -82,14 +87,16 @@ test-e2e: chainsaw # Run e2e tests against the K8s cluster specified in ~/.kube/
 	$(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`)
+lint: golangci-lint.client golangci-lint.controller golangci-lint.sidecar spell-lint ## Run all linters (suggest `make -k`)
 golangci-lint.%: golangci-lint
-	cd $* && $(GOLANGCI_LINT) run --config $(CURDIR)/.golangci.yaml --new
+	cd $* && $(GOLANGCI_LINT) run $(GOLANGCI_LINT_RUN_OPTS) --config $(CURDIR)/.golangci.yaml --new
+spell-lint:
+	git ls-files | grep -v -e CHANGELOG -e go.mod -e go.sum -e vendor | xargs $(SPELL_LINT) -i "Creater,creater,ect" -error -o stderr
 
 .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`)
 golangci-lint-fix.%: golangci-lint
-	cd $* && $(GOLANGCI_LINT) run --config $(CURDIR)/.golangci.yaml --new --fix
+	cd $* && $(GOLANGCI_LINT) run $(GOLANGCI_LINT_RUN_OPTS) --config $(CURDIR)/.golangci.yaml --new --fix
 
 ##@ Build
 
@@ -107,6 +114,16 @@ build.controller: controller/Dockerfile ## Build only the controller container i
 build.sidecar: sidecar/Dockerfile ## Build only the sidecar container image
 	$(DOCKER) build --file sidecar/Dockerfile --platform $(PLATFORM) $(BUILD_ARGS) --tag $(SIDECAR_TAG) .
 
+.PHONY: build-docs
+build-docs: generate mdbook
+	cd docs; $(MDBOOK) build
+
+MDBOOK_PORT ?= 3000
+
+.PHONY: serve-docs
+serve-docs: generate mdbook build-docs
+	cd docs; $(MDBOOK) serve --port $(MDBOOK_PORT)
+
 .PHONY: clean
 clean: ## Clean build environment
 	$(MAKE) -C proto clean
@@ -121,11 +138,11 @@ clobber: ## Clean build environment and cached tools
 
 .PHONY: cluster
 cluster: kind ctlptl ## Create Kind cluster and local registry
-	$(CTLPTL) apply -f ctlptl.yaml
+	PATH=$(TOOLBIN):$(PATH) $(CTLPTL) apply -f ctlptl.yaml
 
 .PHONY: cluster-reset
 cluster-reset: kind ctlptl ## Delete Kind cluster
-	$(CTLPTL) delete -f ctlptl.yaml
+	PATH=$(TOOLBIN):$(PATH) $(CTLPTL) delete -f ctlptl.yaml
 
 .PHONY: deploy
 deploy: kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config
@@ -145,44 +162,65 @@ $(TOOLBIN):
 	mkdir -p $(TOOLBIN)
 
 # Tool Binaries
-CHAINSAW ?= $(TOOLBIN)/chainsaw
-CTLPTL ?= $(TOOLBIN)/ctlptl
+CHAINSAW      ?= $(TOOLBIN)/chainsaw
+CRD_REF_DOCS  ?= $(TOOLBIN)/crd-ref-docs
+CTLPTL        ?= $(TOOLBIN)/ctlptl
 GOLANGCI_LINT ?= $(TOOLBIN)/golangci-lint
-KIND ?= $(TOOLBIN)/kind
-KUSTOMIZE ?= $(TOOLBIN)/kustomize
+KIND          ?= $(TOOLBIN)/kind
+KUSTOMIZE     ?= $(TOOLBIN)/kustomize
+MDBOOK        ?= $(TOOLBIN)/mdbook
+SPELL_LINT    ?= $(TOOLBIN)/spell-lint
 
 # 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)
+CHAINSAW_VERSION      ?= v0.2.12
+CRD_REF_DOCS_VERSION  ?= v0.1.0
+CTLPTL_VERSION        ?= v0.8.39
+GOLANGCI_LINT_VERSION ?= v1.64.7
+KIND_VERSION          ?= v0.27.0
+KUSTOMIZE_VERSION     ?= v5.6.0
+MDBOOK_VERSION        ?= v0.4.47
+SPELL_LINT_VERSION    ?= v0.6.0
 
 .PHONY: chainsaw
-chainsaw: $(CHAINSAW)$(CHAINSAW_VERSION)
-$(CHAINSAW)$(CHAINSAW_VERSION): $(TOOLBIN)
+chainsaw: $(CHAINSAW)-$(CHAINSAW_VERSION)
+$(CHAINSAW)-$(CHAINSAW_VERSION): $(TOOLBIN)
 	$(call go-install-tool,$(CHAINSAW),github.com/kyverno/chainsaw,$(CHAINSAW_VERSION))
 
+.PHONY: crd-ref-docs
+crd-ref-docs: $(CRD_REF_DOCS)-$(CRD_REF_DOCS_VERSION)
+$(CRD_REF_DOCS)-$(CRD_REF_DOCS_VERSION): $(TOOLBIN)
+	$(call go-install-tool,$(CRD_REF_DOCS),github.com/elastic/crd-ref-docs,$(CRD_REF_DOCS_VERSION))
+
 .PHONY: ctlptl
-ctlptl: $(CTLPTL)$(CTLPTL_VERSION)
-$(CTLPTL)$(CTLPTL_VERSION): $(TOOLBIN)
+ctlptl: $(CTLPTL)-$(CTLPTL_VERSION)
+$(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)
-$(GOLANGCI_LINT)$(GOLANGCI_LINT_VERSION): $(TOOLBIN)
-	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+golangci-lint: $(GOLANGCI_LINT)-$(GOLANGCI_LINT_VERSION)
+$(GOLANGCI_LINT)-$(GOLANGCI_LINT_VERSION): $(TOOLBIN)
+	./hack/tools/install-golangci-lint.sh $(TOOLBIN) $(GOLANGCI_LINT) $(GOLANGCI_LINT_VERSION)
 
 .PHONY: kind
-kind: $(KIND)$(KIND_VERSION)
-$(KIND)$(KIND_VERSION): $(TOOLBIN)
+kind: $(KIND)-$(KIND_VERSION)
+$(KIND)-$(KIND_VERSION): $(TOOLBIN)
 	$(call go-install-tool,$(KIND),sigs.k8s.io/kind,$(KIND_VERSION))
 
 .PHONY: kustomize
-kustomize: $(KUSTOMIZE)$(KUSTOMIZE_VERSION)
-$(KUSTOMIZE)$(KUSTOMIZE_VERSION): $(TOOLBIN)
+kustomize: $(KUSTOMIZE)-$(KUSTOMIZE_VERSION)
+$(KUSTOMIZE)-$(KUSTOMIZE_VERSION): $(TOOLBIN)
 	$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION))
 
+.PHONY: mdbook
+mdbook: $(MDBOOK)-$(MDBOOK_VERSION)
+$(MDBOOK)-$(MDBOOK_VERSION): $(TOOLBIN)
+	./hack/tools/install-mdbook.sh $(MDBOOK) $(MDBOOK_VERSION)
+
+.PHONY: spell-lint
+spell-lint: $(SPELL_LINT)-$(SPELL_LINT_VERSION)
+$(SPELL_LINT)-$(SPELL_LINT_VERSION): $(TOOLBIN)
+	./hack/tools/install-misspell-lint.sh $(TOOLBIN) $(SPELL_LINT) $(SPELL_LINT_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

README.md

@@ -29,7 +29,7 @@ Create a new issue raising a RFC for the changes following this format:
 **Description:**
 > 1. Protocol:
 > 2. Fields Added:
-> 3. Why is this change neccessary?
+> 3. Why is this change necessary?
 >    ...(describe why here)...
 > 4. Which other COSI projects are affected by this change?
 > 5. Upgrade plan

sidecar/pkg/consts/consts.go …ient/apis/objectstorage/consts/consts.gosidecar/pkg/consts/consts.go renamed to client/apis/objectstorage/consts/consts.go sidecar/pkg/consts/consts.go renamed to client/apis/objectstorage/consts/consts.go

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.4
+    controller-gen.kubebuilder.io/version: v0.17.3
   name: bucketaccessclasses.objectstorage.k8s.io
 spec:
   group: objectstorage.k8s.io

client/config/crd/objectstorage.k8s.io_bucketaccessclasses.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.4
+    controller-gen.kubebuilder.io/version: v0.17.3
   name: bucketaccesses.objectstorage.k8s.io
 spec:
   group: objectstorage.k8s.io

client/config/crd/objectstorage.k8s.io_bucketaccesses.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.4
+    controller-gen.kubebuilder.io/version: v0.17.3
   name: bucketclaims.objectstorage.k8s.io
 spec:
   group: objectstorage.k8s.io

client/config/crd/objectstorage.k8s.io_bucketclaims.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.4
+    controller-gen.kubebuilder.io/version: v0.17.3
   name: bucketclasses.objectstorage.k8s.io
 spec:
   group: objectstorage.k8s.io

client/config/crd/objectstorage.k8s.io_bucketclasses.yaml

@@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.16.4
+    controller-gen.kubebuilder.io/version: v0.17.3
   name: buckets.objectstorage.k8s.io
 spec:
   group: objectstorage.k8s.io