Feat: ipfs-cluster-follow

This adds a new cluster command: ipfs-cluster-follow.

This command allows initializing and running follower peers as configured by a
remote-source configuration. The command can list configured peers
and obtain information for each of them.

Peers are launched with the rest API listening on a local unix socket. The
command can be run to list the items in the cluster pinset using this
endpoint. Alternatively, if no socket is present, the peer will be assumed to
be offline and the pin list will be directly read from the datastore.

Cluster peers launched with this command (and their configurations) are
compatible with ipfs-cluster-ctl and ipfs-cluster-service. We purposely do not
support most configuration options here. Using ipfs-cluster-ctl or launching
the peers using ipfs-cluster-service is always an option when the usecase
deviates from that supported by ipfs-cluster-follow.

Examples:

$ ipfs-cluster-follow -> list configured peers
$ ipfs-cluster-follow --help
$ ipfs-cluster-follow <clusterName> init <url>
$ ipfs-cluster-follow <clusterName> info
$ ipfs-cluster-follow <clusterName> run
$ ipfs-cluster-follow <clusterName> list

.gitignore

@@ -2,6 +2,7 @@ tag_annotation
 coverage.out
 cmd/ipfs-cluster-service/ipfs-cluster-service
 cmd/ipfs-cluster-ctl/ipfs-cluster-ctl
+cmd/ipfs-cluster-follow/ipfs-cluster-follow
 sharness/lib/sharness
 sharness/test-results
 sharness/trash*

Makefile

@@ -6,21 +6,26 @@ all: build
 clean: rwundo clean_sharness
 	$(MAKE) -C cmd/ipfs-cluster-service clean
 	$(MAKE) -C cmd/ipfs-cluster-ctl clean
+	$(MAKE) -C cmd/ipfs-cluster-follow clean
 	@rm -rf ./test/testingData
 	@rm -rf ./compose
 
 install:
 	$(MAKE) -C cmd/ipfs-cluster-service install
 	$(MAKE) -C cmd/ipfs-cluster-ctl install
+	$(MAKE) -C cmd/ipfs-cluster-follow install
 
 build:
 	$(MAKE) -C cmd/ipfs-cluster-service build
 	$(MAKE) -C cmd/ipfs-cluster-ctl build
+	$(MAKE) -C cmd/ipfs-cluster-follow build
 
 service:
 	$(MAKE) -C cmd/ipfs-cluster-service ipfs-cluster-service
 ctl:
 	$(MAKE) -C cmd/ipfs-cluster-ctl ipfs-cluster-ctl
+follow:
+	$(MAKE) -C cmd/ipfs-cluster-follow ipfs-cluster-follow
 
 check:
 	go vet ./...
@@ -53,13 +58,13 @@ docker:
 	docker exec tmp-make-cluster sh -c "ipfs-cluster-ctl version"
 	docker exec tmp-make-cluster sh -c "ipfs-cluster-service -v"
 	docker kill tmp-make-cluster
+
 	docker build -t cluster-image-test -f Dockerfile-test .
-	docker run --name tmp-make-cluster-test -d --rm cluster-image && sleep 8
+	docker run --name tmp-make-cluster-test -d --rm cluster-image && sleep 4
 	docker exec tmp-make-cluster-test sh -c "ipfs-cluster-ctl version"
 	docker exec tmp-make-cluster-test sh -c "ipfs-cluster-service -v"
 	docker kill tmp-make-cluster-test
 
-
 docker-compose:
 	mkdir -p compose/ipfs0 compose/ipfs1 compose/cluster0 compose/cluster1
 	chmod -R 0777 compose
@@ -69,6 +74,6 @@ docker-compose:
 	docker exec cluster1 ipfs-cluster-ctl peers ls | grep -o "Sees 2 other peers" | uniq -c | grep 3
 	docker-compose down
 
-prcheck: check service ctl test
+prcheck: check service ctl follow test
 
 .PHONY: all test test_sharness clean_sharness rw rwundo publish service ctl install clean docker

cmd/ipfs-cluster-follow/Makefile

@@ -0,0 +1,17 @@
+# go source files
+SRC := $(shell find .. -type f -name '*.go')
+
+all: ipfs-cluster-service
+
+ipfs-cluster-follow: $(SRC)
+	go build -mod=readonly -ldflags "-X main.commit=$(shell git rev-parse HEAD)"
+
+build: ipfs-cluster-follow
+
+install:
+	go install -ldflags "-X main.commit=$(shell git rev-parse HEAD)"
+
+clean:
+	rm -f ipfs-cluster-follow
+
+.PHONY: clean install build