Merge pull request #51 from RobotSail/RobotSail/issue32

Template Kubo config file

Author: RobotSail

.golangci.yaml

@@ -119,7 +119,7 @@ linters-settings:
   nakedret:
     # Make an issue if func has more lines of code than this setting, and it has naked returns.
     # Default: 30
-    max-func-lines: 0
+    max-func-lines: 40
 
   nolintlint:
     # Exclude following linters from requiring an explanation.

controllers/scripts.go

@@ -1,152 +1,24 @@
 package controllers
 
 import (
-	"bytes"
 	"context"
-	encjson "encoding/json"
 	"strconv"
-	tmpl "text/template"
 
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/util/json"
 	ctrl "sigs.k8s.io/controller-runtime"
 
+	"github.com/ipfs/kubo/config"
 	"github.com/libp2p/go-libp2p-core/peer"
 	ma "github.com/multiformats/go-multiaddr"
 	clusterv1alpha1 "github.com/redhat-et/ipfs-operator/api/v1alpha1"
+	"github.com/redhat-et/ipfs-operator/controllers/scripts"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-type configureIpfsOpts struct {
-	StorageMax      string
-	RelayClientJSON string
-	PeersJSON       string
-}
-
-var (
-	entrypoint = `
-#!/bin/sh
-user=ipfs
-
-# This is a custom entrypoint for k8s designed to connect to the bootstrap
-# node running in the cluster. It has been set up using a configmap to
-# allow changes on the fly.
-
-######################################
-# Prints out the given message to STDOUT
-# with timestamped formatting.
-# Globals:
-#  None
-# Arguments:
-#  msg: (string) message to print
-# Returns:
-#  None
-######################################
-log() {
-	msg="$1"
-	# get the current time
-	time=$(date +%Y-%m-%dT%H:%M:%S%z)
-	# print the message with printf
-	printf "[%s] %s\n" "${time}" "${msg}"
-}
-
-######################################
-# This is a custom entrypoint for k8s designed to connect to the bootstrap
-# node running in the cluster. It has been set up using a configmap to
-# allow changes on the fly.
-#
-# Globals:
-#  BOOTSTRAP_PEER_ID (string) the peer id of the bootstrap node
-#  BOOTSTRAP_PEER_PRIV_KEY (string) the private key of the bootstrap node
-#  BOOTSTRAP_ADDR (string) the address of the bootstrap node
-#  SVC_NAME (string) the name of the service to connect to
-######################################
-run_ipfs_cluster() {
-	if [ ! -f /data/ipfs-cluster/service.json ]; then
-		log "📰 no service.json found, creating one"
-		ipfs-cluster-service init --consensus crdt
-	fi
-
-	log "🔍 reading hostname"
-	PEER_HOSTNAME=$(cat /proc/sys/kernel/hostname)
-	log "starting ipfs-cluster on ${PEER_HOSTNAME}"
-
-	grep -q ".*-0$" /proc/sys/kernel/hostname
-	if [ $? -eq 0 ]; then
-		log "starting ipfs-cluster using the provided peer ID and private key"
-		CLUSTER_ID="${BOOTSTRAP_PEER_ID}" \
-		CLUSTER_PRIVATEKEY="${BOOTSTRAP_PEER_PRIV_KEY}" \
-		exec ipfs-cluster-service daemon --upgrade
-	else
-		log "building the bootstrap address"
-		BOOTSTRAP_ADDR="/dns4/${SVC_NAME}-0.${SVC_NAME}/tcp/9096/ipfs/${BOOTSTRAP_PEER_ID}"
-		if [ -z "${BOOTSTRAP_ADDR}" ]; then
-			log "no bootstrap address found, exiting"
-			exit 1
-		fi
-		log "starting ipfs-cluster using the bootstrap address"
-		# Only ipfs user can get here
-		exec ipfs-cluster-service daemon --upgrade --bootstrap "${BOOTSTRAP_ADDR}" --leave
-	fi
-}
-
-for op in "${@}"; do
-	case ${op} in
-		"debug")
-			log "💤 Sleeping indefinitely"
-			sleep infinity
-			log "✅ Done"
-			;;
-		"run")
-			log "🏃 Running IPFS Cluster"
-			run_ipfs_cluster
-			log "✅ Done"
-			;;
-		*)
-			log "😕 Operation '${op}' not defined"
-			exit 1
-			;;
-	esac
-done
-`
-
-	// TODO: dockerize kubo and move this script to the container
-	configureIpfs = `
-#!/bin/sh
-set -e
-set -x
-user=ipfs
-# This is a custom entrypoint for k8s designed to run ipfs nodes in an appropriate
-# setup for production scenarios.
-
-if [ -f /data/ipfs/config ]; then
-	if [ -f /data/ipfs/repo.lock ]; then
-		rm /data/ipfs/repo.lock
-	fi
-	exit 0
-fi
-
-ipfs init --profile=badgerds,server
-MYSELF=$(ipfs id -f="<id>")
-
-ipfs config Addresses.API /ip4/0.0.0.0/tcp/5001
-ipfs config Addresses.Gateway /ip4/0.0.0.0/tcp/8080
-ipfs config --json Swarm.ConnMgr.HighWater 2000
-ipfs config --json Datastore.BloomFilterSize 1048576
-ipfs config Datastore.StorageMax {{ .StorageMax }}GB
-ipfs config --json Swarm.RelayClient '{{ .RelayClientJSON }}'
-ipfs config --json Swarm.EnableHolePunching true
-ipfs config --json Peering.Peers '{{ .PeersJSON }}'
-ipfs config Datastore.StorageMax 100GB
-
-chown -R ipfs: /data/ipfs
-`
-)
-
 // 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(
@@ -155,8 +27,8 @@ func (r *IpfsReconciler) configMapScripts(
 	cm *corev1.ConfigMap,
 ) (controllerutil.MutateFn, string) {
 	log := ctrllog.FromContext(ctx)
-	relayPeers := []*peer.AddrInfo{}
-	relayStatic := []*ma.Multiaddr{}
+	relayPeers := []peer.AddrInfo{}
+	relayStatic := []string{}
 	for _, relayName := range m.Status.CircuitRelays {
 		relay := clusterv1alpha1.CircuitRelay{}
 		relay.Name = relayName
@@ -171,19 +43,18 @@ func (r *IpfsReconciler) configMapScripts(
 			continue
 		}
 		ai := relay.Status.AddrInfo.AddrInfo()
-		relayPeers = append(relayPeers, ai)
+		relayPeers = append(relayPeers, *ai)
 		p2ppart, err := ma.NewMultiaddr("/p2p/" + ai.ID.String())
 		if err != nil {
 			log.Error(err, "could not create p2p component during configMapScripts", "relay", relayName)
 		}
 		for _, addr := range ai.Addrs {
-			fullMa := addr.Encapsulate(p2ppart)
-			relayStatic = append(relayStatic, &fullMa)
+			fullMa := addr.Encapsulate(p2ppart).String()
+			relayStatic = append(relayStatic, fullMa)
 		}
 	}
 
 	cmName := "ipfs-cluster-scripts-" + m.Name
-	configureTmpl, _ := tmpl.New("configureIpfs").Parse(configureIpfs)
 	var storageMaxGB string
 	parsed, err := resource.ParseQuantity(m.Spec.IpfsStorage)
 	if err != nil {
@@ -201,29 +72,31 @@ func (r *IpfsReconciler) configMapScripts(
 		storageMaxGB = strconv.Itoa(int(reducedSize))
 	}
 
-	relayClientConfig := map[string]interface{}{
-		"Enabled":      true,
-		"StaticRelays": relayStatic,
+	relayConfig := config.RelayClient{
+		Enabled:      config.True,
+		StaticRelays: relayStatic,
 	}
-	relayClientConfigJSON, _ := json.Marshal(relayClientConfig)
-	peeringConfigJSON, _ := encjson.Marshal(relayPeers)
 
-	configureOpts := configureIpfsOpts{
-		StorageMax:      storageMaxGB,
-		PeersJSON:       string(peeringConfigJSON),
-		RelayClientJSON: string(relayClientConfigJSON),
+	// get the config script
+	configScript, err := scripts.CreateConfigureScript(
+		storageMaxGB,
+		relayPeers,
+		relayConfig,
+	)
+	if err != nil {
+		return func() error {
+			return err
+		}, ""
 	}
-	configureBuf := new(bytes.Buffer)
-	_ = configureTmpl.Execute(configureBuf, configureOpts)
 
 	expected := &corev1.ConfigMap{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      cmName,
 			Namespace: m.Namespace,
 		},
 		Data: map[string]string{
-			"entrypoint.sh":     entrypoint,
-			"configure-ipfs.sh": configureBuf.String(),
+			"entrypoint.sh":     scripts.IPFSClusterEntrypoint,
+			"configure-ipfs.sh": configScript,
 		},
 	}
 	expected.DeepCopyInto(cm)