Merge branch 'main' into feat/configure-resources-for-volume-size

Author: Cory Schwartz

Makefile

@@ -130,8 +130,9 @@ vet: ## Run go vet against code.
 
 .PHONY: test
 GINKGO_ARGS ?= --progress --fail-on-pending --keep-going --cover --coverprofile=cover.profile --race --trace --json-report=report.json --timeout=3m
+GINKGO_TARGETS ?= ./...
 test: lint manifests generate fmt vet lint envtest ginkgo ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" $(GINKGO) run $(GINKGO_ARGS) ./...
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" $(GINKGO) run $(GINKGO_ARGS) $(GINKGO_TARGETS)
 
 .PHONY: test-e2e
 test-e2e: kuttl ## Run e2e tests. Requires cluster w/ Scribe already installed
@@ -211,11 +212,38 @@ TMP_DIR=$$(mktemp -d) ;\
 cd $$TMP_DIR ;\
 go mod init tmp ;\
 echo "Downloading $(2)" ;\
-GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
+GOBIN=$(LOCALBIN) go get $(2) ;\
 rm -rf $$TMP_DIR ;\
 }
 endef
 
+# go-install-tool will 'go install' any package $2 and install it to $1.
+define go-install-tool
+@[ -f $(1) ] || { \
+set -e ;\
+TMP_DIR=$$(mktemp -d) ;\
+cd $$TMP_DIR ;\
+go mod init tmp ;\
+echo "Downloading $(2)" ;\
+GOBIN=$(LOCALBIN) go install $(2) ;\
+rm -rf $$TMP_DIR ;\
+}
+endef
+
+# go-install-mod-tool will 'go install' any package $2 and install it to $1.
+define go-install-mod-tool
+@[ -f $(1) ] || { \
+set -e ;\
+TMP_DIR=$$(mktemp -d) ;\
+cd $$TMP_DIR ;\
+go mod init tmp ;\
+echo "Downloading $(2)" ;\
+GOBIN=$(LOCALBIN) go install -mod=mod $(2) ;\
+rm -rf $$TMP_DIR ;\
+}
+endef
+
+
 .PHONY: bundle
 bundle: manifests kustomize ## Generate bundle manifests and metadata, then validate generated files.
 	operator-sdk generate kustomize manifests -q
@@ -273,7 +301,7 @@ catalog-push: ## Push a catalog image.
 	$(MAKE) docker-push IMG=$(CATALOG_IMG)
 
 
-##@ Download Utilities
+##@ Download tools
 
 # download-tool will curl any file $2 and install it to $1.
 define download-tool
@@ -282,32 +310,9 @@ set -e ;\
 echo "📥 Downloading $(2)" ;\
 curl -sSLo "$(1)" "$(2)" ;\
 chmod a+x "$(1)" ;\
-echo "✅ Done" ;\
-}
-endef
-
-# install-go-tool will download any $2 URL and install to $1
-define install-go-tool
-@[ -f $(1) ] || { \
-set -e ;\
-echo "📥 Downloading $(2)" ;\
-GOBIN=$(1) go install $(2) ;\
-echo "✅ Done" ;\
 }
 endef
 
-# install-go-tool will download any $2 URL and install to $1
-define install-go-tool-mod
-@[ -f $(1) ] || { \
-set -e ;\
-echo "📥 Downloading $(2)" ;\
-GOBIN=$(1) go install -mod=mod $(2) ;\
-echo "✅ Done" ;\
-}
-endef
-
-
-
 .PHONY: kuttl
 KUTTL := $(LOCALBIN)/kuttl
 KUTTL_URL := https://github.com/kudobuilder/kuttl/releases/download/v$(KUTTL_VERSION)/kubectl-kuttl_$(KUTTL_VERSION)_linux_x86_64
@@ -319,15 +324,15 @@ GINKGO := $(LOCALBIN)/ginkgo
 GINKGO_URL := github.com/onsi/ginkgo/v2/ginkgo
 ginkgo: $(GINKGO) ## Install ginkgo
 $(GINKGO): $(LOCALBIN)
-	$(call install-go-tool-mod,$(LOCALBIN),$(GINKGO_URL))
+	$(call go-install-mod-tool,$(LOCALBIN),$(GINKGO_URL))
 
 
 .PHONY: kustomize
 KUSTOMIZE = $(LOCALBIN)/kustomize
 KUSTOMIZE_URL := sigs.k8s.io/kustomize/kustomize/$(KUSTOMIZE_MAJOR)@$(KUSTOMIZE_VERSION)
 kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
 $(KUSTOMIZE): $(LOCALBIN)
-	$(call install-go-tool,$(LOCALBIN),$(KUSTOMIZE_URL))
+	$(call go-install-tool,$(LOCALBIN),$(KUSTOMIZE_URL))
 
 .PHONY: helm
 HELM := $(LOCALBIN)/helm
@@ -344,4 +349,4 @@ golangci-lint: $(GOLANGCILINT) ## Download golangci-lint
 $(GOLANGCILINT): $(LOCALBIN)
 	@ echo "📥 Downloading helm"
 	curl -sSfL $(GOLANGCI_URL) | sh -s -- -b $(LOCALBIN) $(GOLANGCI_VERSION)
-	@ echo "✅ Done"
+	@ echo "✅ Done"

PROJECT

@@ -13,7 +13,7 @@ resources:
   controller: true
   domain: ipfs.io
   group: cluster
-  kind: Ipfs
+  kind: CircuitRelay
   path: github.com/redhat-et/ipfs-operator/api/v1alpha1
   version: v1alpha1
 - api:
@@ -22,7 +22,7 @@ resources:
   controller: true
   domain: ipfs.io
   group: cluster
-  kind: CircuitRelay
+  kind: IpfsCluster
   path: github.com/redhat-et/ipfs-operator/api/v1alpha1
   version: v1alpha1
 version: "3"

api/v1alpha1/groupversion_info.go

@@ -15,8 +15,8 @@ limitations under the License.
 */
 
 // Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group
-//+kubebuilder:object:generate=true
-//+groupName=cluster.ipfs.io
+// +kubebuilder:object:generate=true
+// +groupName=cluster.ipfs.io
 package v1alpha1
 
 import (

api/v1alpha1/ipfs_types.go

@@ -0,0 +1,109 @@
+/*
+Copyright 2022.
+
+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.
+*/
+
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/api/resource"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const (
+	// ConditionReconciled is a status condition type that indicates whether the
+	// CR has been successfully reconciled.
+	ConditionReconciled string = "Reconciled"
+	// ReconciledReasonComplete indicates the CR was successfully reconciled.
+	ReconciledReasonComplete string = "ReconcileComplete"
+	// ReconciledReasonError indicates an error was encountered while
+	// reconciling the CR.
+	ReconciledReasonError string = "ReconcileError"
+)
+
+type ReproviderStrategy string
+
+const (
+	// ReproviderStrategyAll Announces the CID of every stored block.
+	ReproviderStrategyAll ReproviderStrategy = "all"
+	// ReproviderStrategyPinned Only announces the pinned CIDs recursively.
+	ReproviderStrategyPinned ReproviderStrategy = "pinned"
+	// ReproviderStrategyRoots Only announces the root block of explicitly pinned CIDs.
+	ReproviderStrategyRoots ReproviderStrategy = "roots"
+)
+
+type ReprovideSettings struct {
+	// Strategy specifies the reprovider strategy, defaults to 'all'.
+	// +kubebuilder:validation:Enum={all,pinned,roots}
+	// +optional
+	Strategy ReproviderStrategy `json:"strategy,omitempty"`
+	// Interval sets the time between rounds of reproviding
+	// local content to the routing system. Defaults to '12h'.
+	// +optional
+	Interval string `json:"interval,omitempty"`
+}
+
+type followParams struct {
+	Name     string `json:"name"`
+	Template string `json:"template"`
+}
+
+type networkConfig struct {
+	CircuitRelays int32 `json:"circuitRelays"`
+}
+
+type IpfsClusterSpec struct {
+	// +kubebuilder:validation:Optional
+	URL            string            `json:"url"`
+	Public         bool              `json:"public"`
+	IpfsStorage    resource.Quantity `json:"ipfsStorage"`
+	ClusterStorage string            `json:"clusterStorage"`
+	Replicas       int32             `json:"replicas"`
+	Networking     networkConfig     `json:"networking"`
+	Follows        []followParams    `json:"follows"`
+	// Reprovider Describes the settings that each IPFS node
+	// should use when reproviding content.
+	// +optional
+	Reprovider ReprovideSettings `json:"reprovider,omitempty"`
+}
+
+type IpfsClusterStatus struct {
+	Conditions    []metav1.Condition `json:"conditions,omitempty"`
+	CircuitRelays []string           `json:"circuitRelays,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// IpfsCluster is the Schema for the ipfs API.
+type IpfsCluster struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   IpfsClusterSpec   `json:"spec,omitempty"`
+	Status IpfsClusterStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// IpfsList contains a list of Ipfs.
+type IpfsClusterList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []IpfsCluster `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&IpfsCluster{}, &IpfsClusterList{})
+}