Merge pull request #76 from RobotSail/RobotSail/issue40

End-to-end testing

Author: RobotSail

.github/workflows/validate-ipfs.yaml

@@ -122,6 +122,7 @@ jobs:
           ipfs-cluster ./helm/ipfs-operator
 
     - name: run e2e tests
+      shell: bash
       run: |
         mkdir bin
         make test-e2e

.gitignore

@@ -29,7 +29,7 @@ profile.json
 *~
 
 # kubeconfig generated during test-e2e
-test-e2e/kubeconfig
+test-kuttl/kubeconfig
 
 # don't include vendor/
 vendor/*

Makefile

@@ -1,3 +1,4 @@
+# set binary versions
 GOLANGCI_VERSION := v1.46.1
 HELM_VERSION := v3.8.2
 KUTTL_VERSION := 0.10.0
@@ -136,7 +137,7 @@ test: lint manifests generate fmt vet lint envtest ginkgo ## Run tests.
 
 .PHONY: test-e2e
 test-e2e: kuttl ## Run e2e tests. Requires cluster w/ Scribe already installed
-	cd test-kuttl && $(KUTTL) test --namespace test
+	cd test-kuttl && $(KUTTL) test 
 	rm -f test-kuttl/kubeconfig
 
 ##@ Build

api/v1alpha1/groupversion_info.go

@@ -24,9 +24,15 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/scheme"
 )
 
+// Define the version information about this operator.
+const (
+	Group   = "cluster.ipfs.io"
+	Version = "v1alpha1"
+)
+
 var (
 	// GroupVersion is group version used to register these objects
-	GroupVersion = schema.GroupVersion{Group: "cluster.ipfs.io", Version: "v1alpha1"}
+	GroupVersion = schema.GroupVersion{Group: Group, Version: Version}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

api/v1alpha1/ipfscluster_types.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha1
 
 import (
+	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -59,20 +60,34 @@ type followParams struct {
 	Template string `json:"template"`
 }
 
+// networkConfig defines the configuration structure used for networking.
 type networkConfig struct {
 	CircuitRelays int32 `json:"circuitRelays"`
 }
 
+// IpfsClusterSpec defines the desired state of the IpfsCluster.
 type IpfsClusterSpec struct {
+	// url defines the URL to be using as an ingress controller.
 	// +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
+	URL string `json:"url"`
+	// public determines whether or not we should be exposing this IPFS Cluster to the public.
+	Public bool `json:"public"`
+	// ipfsStorage defines the total storage to be allocated by this resource.
+	IpfsStorage resource.Quantity `json:"ipfsStorage"`
+	// clusterStorage defines the amount of storage to be used by IPFS Cluster.
+	ClusterStorage resource.Quantity `json:"clusterStorage"`
+	// replicas sets the number of replicas of IPFS Cluster nodes we should be running.
+	Replicas int32 `json:"replicas"`
+	// networking defines network configuration settings.
+	Networking networkConfig `json:"networking"`
+	// follows defines the list of other IPFS Clusters this one should follow.
+	Follows []followParams `json:"follows"`
+	// ipfsResources specifies the resource requirements for each IPFS container. If this
+	// value is omitted, then the operator will automatically determine these settings
+	// based on the storage sizes used.
+	// +optional
+	IPFSResources *corev1.ResourceRequirements `json:"ipfsResources,omitempty"`
+	// reprovider Describes the settings that each IPFS node
 	// should use when reproviding content.
 	// +optional
 	Reprovider ReprovideSettings `json:"reprovider,omitempty"`

api/v1alpha1/zz_generated.deepcopy.go

@@ -33,10 +33,19 @@ spec:
           metadata:
             type: object
           spec:
+            description: IpfsClusterSpec defines the desired state of the IpfsCluster.
             properties:
               clusterStorage:
-                type: string
+                anyOf:
+                - type: integer
+                - type: string
+                description: clusterStorage defines the amount of storage to be used
+                  by IPFS Cluster.
+                pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                x-kubernetes-int-or-string: true
               follows:
+                description: follows defines the list of other IPFS Clusters this
+                  one should follow.
                 items:
                   properties:
                     name:
@@ -48,13 +57,45 @@ spec:
                   - template
                   type: object
                 type: array
+              ipfsResources:
+                description: ipfsResources specifies the resource requirements for
+                  each IPFS container. If this value is omitted, then the operator
+                  will automatically determine these settings based on the storage
+                  sizes used.
+                properties:
+                  limits:
+                    additionalProperties:
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                      x-kubernetes-int-or-string: true
+                    description: 'Limits describes the maximum amount of compute resources
+                      allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+                    type: object
+                  requests:
+                    additionalProperties:
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                      x-kubernetes-int-or-string: true
+                    description: 'Requests describes the minimum amount of compute
+                      resources required. If Requests is omitted for a container,
+                      it defaults to Limits if that is explicitly specified, otherwise
+                      to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/'
+                    type: object
+                type: object
               ipfsStorage:
                 anyOf:
                 - type: integer
                 - type: string
+                description: ipfsStorage defines the total storage to be allocated
+                  by this resource.
                 pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                 x-kubernetes-int-or-string: true
               networking:
+                description: networking defines network configuration settings.
                 properties:
                   circuitRelays:
                     format: int32
@@ -63,12 +104,16 @@ spec:
                 - circuitRelays
                 type: object
               public:
+                description: public determines whether or not we should be exposing
+                  this IPFS Cluster to the public.
                 type: boolean
               replicas:
+                description: replicas sets the number of replicas of IPFS Cluster
+                  nodes we should be running.
                 format: int32
                 type: integer
               reprovider:
-                description: Reprovider Describes the settings that each IPFS node
+                description: reprovider Describes the settings that each IPFS node
                   should use when reproviding content.
                 properties:
                   interval:
@@ -85,6 +130,7 @@ spec:
                     type: string
                 type: object
               url:
+                description: url defines the URL to be using as an ingress controller.
                 type: string
             required:
             - clusterStorage

config/crd/bases/cluster.ipfs.io_ipfsclusters.yaml

@@ -91,7 +91,7 @@ func (r *CircuitRelayReconciler) Reconcile(ctx context.Context, req ctrl.Request
 	if len(rsvc.Status.LoadBalancer.Ingress) == 0 {
 		log.Info("still waiting for service ingress addresses", "name", instance.Name)
 		return ctrl.Result{
-			RequeueAfter: time.Minute,
+			RequeueAfter: time.Second * 15,
 		}, err
 	}
 
@@ -111,7 +111,7 @@ func (r *CircuitRelayReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		if err != nil {
 			log.Error(err, "error generating new identity")
 			return ctrl.Result{
-				RequeueAfter: time.Minute,
+				RequeueAfter: time.Second * 15,
 			}, err
 		}
 		sec := corev1.Secret{}

controllers/circuitrelay_controller.go

@@ -113,7 +113,7 @@ func (r *IpfsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		}
 		if relay.Status.AddrInfo.ID == "" {
 			log.Info("relay is not ready yet. Will continue waiting.", "relay", relayName)
-			return ctrl.Result{RequeueAfter: time.Minute}, nil
+			return ctrl.Result{RequeueAfter: time.Second * 15}, nil
 		}
 	}
 	if err = r.Status().Update(ctx, instance); err != nil {
@@ -137,23 +137,27 @@ func (r *IpfsClusterReconciler) createTrackedObjects(
 	sa := corev1.ServiceAccount{}
 	svc := corev1.Service{}
 	cmScripts := corev1.ConfigMap{}
-	cmConfig := corev1.ConfigMap{}
 	secConfig := corev1.Secret{}
 	sts := appsv1.StatefulSet{}
 
 	mutsa := r.serviceAccount(instance, &sa)
 	mutsvc, svcName := r.serviceCluster(instance, &svc)
 
 	mutCmScripts, cmScriptName := r.ConfigMapScripts(ctx, instance, &cmScripts)
-	mutSecConfig, secConfigName := r.SecretConfig(ctx, instance, &secConfig, []byte(clusterSecret), []byte(privateString))
-	mutCmConfig, cmConfigName := r.configMapConfig(instance, &cmConfig, peerID.String())
-	mutSts := r.statefulSet(instance, &sts, svcName, secConfigName, cmConfigName, cmScriptName)
+	mutSecConfig, secConfigName := r.SecretConfig(
+		ctx,
+		instance,
+		&secConfig,
+		[]byte(clusterSecret),
+		[]byte(privateString),
+		peerID.String(),
+	)
+	mutSts := r.StatefulSet(instance, &sts, svcName, secConfigName, cmScriptName)
 
 	trackedObjects := map[client.Object]controllerutil.MutateFn{
 		&sa:        mutsa,
 		&svc:       mutsvc,
 		&cmScripts: mutCmScripts,
-		&cmConfig:  mutCmConfig,
 		&secConfig: mutSecConfig,
 		&sts:       mutSts,
 	}