Merge pull request #676 from ktock/registry-context

ipfs registry: allow timeout and retry

Author: AkihiroSuda

README.md

@@ -1216,6 +1216,8 @@ Usage: `nerdctl ipfs registry up [OPTIONS]`
 
 Flags:
 - :nerd_face: `--listen-registry`: Address to listen (default `localhost:5050`)
+- :nerd_face: `--read-retry-num`: Times to retry query on IPFS (default 0 (no retry))
+- :nerd_face: `--read-timeout`: Timeout duration of a read request to IPFS (defualt 0 (no timeout))
 
 ### :nerd_face: nerdctl ipfs registry down
 Stop and remove read-only local registry backed by IPFS.
@@ -1232,6 +1234,8 @@ Usage: `nerdctl ipfs registry serve [OPTIONS]`
 Flags:
 - :nerd_face: `--ipfs-address`: Multiaddr of IPFS API (default is pulled from `$IPFS_PATH/api` file. If `$IPFS_PATH` env var is not present, it defaults to `~/.ipfs`).
 - :nerd_face: `--listen-registry`: Address to listen (default `localhost:5050`).
+- :nerd_face: `--read-retry-num`: Times to retry query on IPFS (default 0 (no retry))
+- :nerd_face: `--read-timeout`: Timeout duration of a read request to IPFS (defualt 0 (no timeout))
 
 ## Global flags
 - :nerd_face: :blue_square: `--address`:  containerd address, optionally with "unix://" prefix

cmd/nerdctl/ipfs_registry_serve.go

@@ -26,7 +26,11 @@ import (
 	"github.com/spf13/cobra"
 )
 
-const defaultIPFSRegistry = "localhost:5050"
+const (
+	defaultIPFSRegistry            = "localhost:5050"
+	defaultIPFSReadRetryNum        = 0
+	defaultIPFSReadTimeoutDuration = 0
+)
 
 func newIPFSRegistryServeCommand() *cobra.Command {
 	var ipfsRegistryServeCommand = &cobra.Command{
@@ -39,6 +43,8 @@ func newIPFSRegistryServeCommand() *cobra.Command {
 
 	ipfsRegistryServeCommand.PersistentFlags().String("listen-registry", defaultIPFSRegistry, "address to listen")
 	ipfsRegistryServeCommand.PersistentFlags().String("ipfs-address", "", "multiaddr of IPFS API (default is pulled from $IPFS_PATH/api file. If $IPFS_PATH env var is not present, it defaults to ~/.ipfs)")
+	ipfsRegistryServeCommand.PersistentFlags().Int("read-retry-num", defaultIPFSReadRetryNum, "times to retry query on IPFS. Zero or lower means no retry.")
+	ipfsRegistryServeCommand.PersistentFlags().Duration("read-timeout", defaultIPFSReadTimeoutDuration, "timeout duration of a read request to IPFS. Zero means no timeout.")
 
 	return ipfsRegistryServeCommand
 }
@@ -52,6 +58,14 @@ func ipfsRegistryServeAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
+	readTimeout, err := cmd.Flags().GetDuration("read-timeout")
+	if err != nil {
+		return err
+	}
+	readRetryNum, err := cmd.Flags().GetInt("read-retry-num")
+	if err != nil {
+		return err
+	}
 	var ipfsClient *httpapi.HttpApi
 	if ipfsAddressStr != "" {
 		a, err := multiaddr.NewMultiaddr(ipfsAddressStr)
@@ -68,7 +82,14 @@ func ipfsRegistryServeAction(cmd *cobra.Command, args []string) error {
 			return err
 		}
 	}
+	h, err := ipfs.NewRegistry(ipfsClient, ipfs.RegistryOptions{
+		ReadRetryNum: readRetryNum,
+		ReadTimeout:  readTimeout,
+	})
+	if err != nil {
+		return err
+	}
 	logrus.Infof("serving on %v", listenAddress)
-	http.Handle("/", ipfs.NewRegistry(ipfsClient))
+	http.Handle("/", h)
 	return http.ListenAndServe(listenAddress, nil)
 }

cmd/nerdctl/ipfs_registry_up.go

@@ -44,6 +44,8 @@ func newIPFSRegistryUpCommand() *cobra.Command {
 	}
 
 	ipfsRegistryUpCommand.PersistentFlags().String("listen-registry", defaultIPFSRegistry, "address to listen")
+	ipfsRegistryUpCommand.PersistentFlags().Int("read-retry-num", defaultIPFSReadRetryNum, "times to retry query on IPFS. Zero or lower means no retry.")
+	ipfsRegistryUpCommand.PersistentFlags().Duration("read-timeout", defaultIPFSReadTimeoutDuration, "timeout duration of a read request to IPFS. Zero means no timeout.")
 
 	return ipfsRegistryUpCommand
 }
@@ -82,6 +84,14 @@ func runRegistryAsContainer(cmd *cobra.Command) error {
 	if err != nil {
 		return err
 	}
+	readTimeout, err := cmd.Flags().GetDuration("read-timeout")
+	if err != nil {
+		return err
+	}
+	readRetryNum, err := cmd.Flags().GetInt("read-retry-num")
+	if err != nil {
+		return err
+	}
 	dataStore, err := getDataStore(cmd)
 	if err != nil {
 		return err
@@ -108,6 +118,7 @@ func runRegistryAsContainer(cmd *cobra.Command) error {
 		"run", "-d", "--name", ipfsRegistryContainerName, "--net=host", "--entrypoint", "/mnt/nerdctl",
 		"--read-only", "-v", nerdctlCmd+":/mnt/nerdctl:ro", "--rootfs", registryRoot,
 		"ipfs", "registry", "serve", "--ipfs-address", ipfsAPIAddr.String(), "--listen-registry", listenAddress,
+		"--read-retry-num", fmt.Sprintf("%d", readRetryNum), "--read-timeout", fmt.Sprintf("%s", readTimeout),
 	)...).CombinedOutput(); err != nil {
 		return fmt.Errorf("failed to execute registry: %v: %v", string(out), err)
 	}