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

Author: Cory Schwartz

.gitignore

@@ -6,13 +6,17 @@
 *.so
 *.dylib
 bin
+!docs/build/
+docs/build/*
 testbin/*
 
 # Test binary, build with `go test -c`
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+*.profile
+profile.json
 
 # Kubernetes Generated files - skip generated files, except for vendored files
 
@@ -31,4 +35,4 @@ test-e2e/kubeconfig
 vendor/*
 
 # use this directory for files during development that shouldn't be pushed
-temp/*
+temp/*

.readthedocs.yaml

@@ -0,0 +1,18 @@
+---
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+# Optionally set the version of Python and requirements required to build your
+# docs
+python:
+  # version: 3.7
+  install:
+    - requirements: docs/source/requirements.txt

Makefile

@@ -129,8 +129,9 @@ vet: ## Run go vet against code.
 	go vet ./...
 
 .PHONY: test
-test: lint manifests generate fmt vet lint helm-lint envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
+GINKGO_ARGS ?= --progress --fail-on-pending --keep-going --cover --coverprofile=cover.profile --race --trace --json-report=report.json --timeout=3m
+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) ./...
 
 .PHONY: test-e2e
 test-e2e: kuttl ## Run e2e tests. Requires cluster w/ Scribe already installed
@@ -194,32 +195,6 @@ $(CONTROLLER_GEN): $(LOCALBIN)
 	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
 	@ echo "✅ Done"
 
-.PHONY: kustomize
-KUSTOMIZE = $(LOCALBIN)/kustomize
-kustomize: $(KUSTOMIZE)## Download kustomize locally if necessary.
-$(KUSTOMIZE): $(LOCALBIN)
-	@ echo "📥 Downloading kustomize"
-	GOBIN=$(LOCALBIN) go install sigs.k8s.io/kustomize/kustomize/$(KUSTOMIZE_MAJOR)@$(KUSTOMIZE_VERSION)
-	@ echo "✅ Done"
-
-.PHONY: helm
-HELM := $(LOCALBIN)/helm
-HELM_URL := https://get.helm.sh/helm-$(HELM_VERSION)-$(OS)-$(ARCH).tar.gz
-helm: $(HELM)
-$(HELM): $(LOCALBIN)
-	@ echo "📥 Downloading helm"
-	curl -sSL "$(HELM_URL)" | tar xzf - -C $(LOCALBIN) --strip-components=1 --wildcards '*/helm'
-	@ echo "✅ Done"
-
-
-.PHONY: golangci-lint
-GOLANGCILINT := $(LOCALBIN)/golangci-lint
-GOLANGCI_URL := https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh
-golangci-lint: $(GOLANGCILINT) ## Download golangci-lint
-$(GOLANGCILINT): $(LOCALBIN)
-	@ echo "📥 Downloading helm"
-	curl -sSfL $(GOLANGCI_URL) | sh -s -- -b $(LOCALBIN) $(GOLANGCI_VERSION)
-	@ echo "✅ Done"
 
 .PHONY: envtest
 ENVTEST = $(LOCALBIN)/setup-envtest
@@ -297,18 +272,76 @@ catalog-build: opm ## Build a catalog image.
 catalog-push: ## Push a catalog image.
 	$(MAKE) docker-push IMG=$(CATALOG_IMG)
 
+
+##@ Download Utilities
+
 # download-tool will curl any file $2 and install it to $1.
 define download-tool
 @[ -f $(1) ] || { \
 set -e ;\
-echo "Downloading $(2)" ;\
+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 := $(PROJECT_DIR)/bin/kuttl
+KUTTL := $(LOCALBIN)/kuttl
 KUTTL_URL := https://github.com/kudobuilder/kuttl/releases/download/v$(KUTTL_VERSION)/kubectl-kuttl_$(KUTTL_VERSION)_linux_x86_64
 kuttl: ## Download kuttl
 	$(call download-tool,$(KUTTL),$(KUTTL_URL))
+
+.PHONY: ginkgo
+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))
+
+
+.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))
+
+.PHONY: helm
+HELM := $(LOCALBIN)/helm
+HELM_URL := https://get.helm.sh/helm-$(HELM_VERSION)-$(OS)-$(ARCH).tar.gz
+helm: $(HELM) ## Install helm
+$(HELM): $(LOCALBIN)
+	$(call download-tool,$(HELM),$(HELM_URL))
+
+
+.PHONY: golangci-lint
+GOLANGCILINT := $(LOCALBIN)/golangci-lint
+GOLANGCI_URL := https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh
+golangci-lint: $(GOLANGCILINT) ## Download golangci-lint
+$(GOLANGCILINT): $(LOCALBIN)
+	@ echo "📥 Downloading helm"
+	curl -sSfL $(GOLANGCI_URL) | sh -s -- -b $(LOCALBIN) $(GOLANGCI_VERSION)
+	@ echo "✅ Done"

controllers/ipfs_controller.go

@@ -143,7 +143,7 @@ func (r *IpfsReconciler) createTrackedObjects(
 
 	mutsa := r.serviceAccount(instance, &sa)
 	mutsvc, svcName := r.serviceCluster(instance, &svc)
-	mutCmScripts, cmScriptName := r.configMapScripts(ctx, instance, &cmScripts)
+	mutCmScripts, cmScriptName := r.ConfigMapScripts(ctx, instance, &cmScripts)
 	mutCmConfig, cmConfigName := r.configMapConfig(instance, &cmConfig, peerID.String())
 	mutSecConfig, secConfigName := r.secretConfig(instance, &secConfig, []byte(clusterSecret), []byte(privateString))
 	mutSts := r.statefulSet(instance, &sts, svcName, secConfigName, cmConfigName, cmScriptName)

controllers/scripts.go

@@ -19,9 +19,18 @@ import (
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-// configMapScripts Returns a mutate function which loads the given configMap with scripts that
+const (
+	// ScriptConfigureIPFS Defines the script run by the IPFS containers
+	// in order to initialize their state.
+	ScriptConfigureIPFS = "configure-ipfs.sh"
+	// ScriptIPFSClusterEntryPoint Defines a shell script used as the entrypoint
+	// for the IPFS Cluster container.
+	ScriptIPFSClusterEntryPoint = "entrypoint.sh"
+)
+
+// ConfigMapScripts Returns a mutate function which loads the given configMap with scripts that
 // customize the startup of the IPFS containers depending on the values from the given IPFS cluster resource.
-func (r *IpfsReconciler) configMapScripts(
+func (r *IpfsReconciler) ConfigMapScripts(
 	ctx context.Context,
 	m *clusterv1alpha1.Ipfs,
 	cm *corev1.ConfigMap,

controllers/scripts/ipfs.go

@@ -203,6 +203,7 @@ func setFlatfsShardFunc(conf *config.Config, n uint8) error {
 // applyIPFSClusterK8sDefaults Applies settings to the given Kubo configuration
 // which are customized specifically for running within a Kubernetes cluster.
 func applyIPFSClusterK8sDefaults(conf *config.Config, storageMax string, peers []peer.AddrInfo, rc config.RelayClient) {
+	conf.Bootstrap = config.DefaultBootstrapAddresses
 	conf.Addresses.API = config.Strings{"/ip4/0.0.0.0/tcp/5001"}
 	conf.Addresses.Gateway = config.Strings{"/ip4/0.0.0.0/tcp/8080"}
 	conf.Swarm.ConnMgr.HighWater = 2000

controllers/scripts_test.go

@@ -0,0 +1,65 @@
+package controllers_test
+
+import (
+	"context"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	v1 "k8s.io/api/core/v1"
+
+	"github.com/redhat-et/ipfs-operator/api/v1alpha1"
+	"github.com/redhat-et/ipfs-operator/controllers"
+)
+
+var _ = Describe("IPFS Reconciler", func() {
+	var ipfsReconciler *controllers.IpfsReconciler
+	var ipfs *v1alpha1.Ipfs
+	var configMap *v1.ConfigMap
+	var ctx context.Context
+
+	BeforeEach(func() {
+		ctx = context.TODO()
+		ipfsReconciler = &controllers.IpfsReconciler{
+			Scheme: k8sClient.Scheme(),
+			Client: k8sClient,
+		}
+		configMap = &v1.ConfigMap{}
+		ipfs = &v1alpha1.Ipfs{}
+	})
+
+	When("ConfigMapScripts are edited", func() {
+		const myName = "my-fav-ipfs-node"
+		BeforeEach(func() {
+			// uses the name
+			ipfs.Name = myName
+		})
+
+		It("populates the ConfigMap", func() {
+			// configMap is empty
+			Expect(len(configMap.Data)).To(Equal(0))
+			fn, _ := ipfsReconciler.ConfigMapScripts(ctx, ipfs, configMap)
+			// should not have errored
+			Expect(fn()).NotTo(HaveOccurred())
+			// the configmap should be populated with the following scripts
+			Expect(len(configMap.Data)).To(Equal(2))
+
+			expectedKeys := []string{
+				controllers.ScriptConfigureIPFS,
+				controllers.ScriptIPFSClusterEntryPoint,
+			}
+			for _, key := range expectedKeys {
+				data, ok := configMap.Data[key]
+				Expect(ok).To(BeTrue())
+				Expect(data).NotTo(BeEmpty())
+			}
+		})
+
+		It("contains the IPFS resource name", func() {
+			fn, name := ipfsReconciler.ConfigMapScripts(ctx, ipfs, configMap)
+			Expect(fn).NotTo(BeNil())
+			Expect(fn()).NotTo(HaveOccurred())
+			Expect(name).To(ContainSubstring(myName))
+			Expect(name).To(Equal("ipfs-cluster-scripts-" + myName))
+		})
+	})
+})

controllers/suite_test.go

@@ -14,18 +14,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package controllers
+package controllers_test
 
 import (
 	"path/filepath"
 	"testing"
 
-	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	"k8s.io/client-go/kubernetes/scheme"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
-	"sigs.k8s.io/controller-runtime/pkg/envtest/printer"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
@@ -42,9 +41,7 @@ var testEnv *envtest.Environment
 func TestAPIs(t *testing.T) {
 	RegisterFailHandler(Fail)
 
-	RunSpecsWithDefaultAndCustomReporters(t,
-		"Controller Suite",
-		[]Reporter{printer.NewlineReporter{}})
+	RunSpecs(t, "Controller Suite")
 }
 
 var _ = BeforeSuite(func() {
@@ -68,8 +65,7 @@ var _ = BeforeSuite(func() {
 	k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme})
 	Expect(err).NotTo(HaveOccurred())
 	Expect(k8sClient).NotTo(BeNil())
-
-}, 60)
+})
 
 var _ = AfterSuite(func() {
 	By("tearing down the test environment")

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)