ipfs

Documentation

Index

• Constants
• type GoIPFSClusterClient
  • func (c *GoIPFSClusterClient) Args() (args []string)
  • func (c *GoIPFSClusterClient) Command() []string
  • func (c *GoIPFSClusterClient) Env() []corev1.EnvVar
  • func (c *GoIPFSClusterClient) HomeDir() string
• type IPFSClient
  • func NewClient(obj runtime.Object) (IPFSClient, error)
• type KuboClient
  • func (c *KuboClient) Args() (args []string)
  • func (c *KuboClient) Command() []string
  • func (c *KuboClient) Env() []corev1.EnvVar
  • func (c *KuboClient) HomeDir() string

Constants

const (
	// EnvIPFSPath is the environment variable used for kubo path
	EnvIPFSPath = "IPFS_PATH"
	// EnvIPFSLogging is the environment variable used for logging verbosity level
	EnvIPFSLogging = "IPFS_LOGGING"
	// EnvSecretsPath is the environment variable used for secrets path
	EnvSecretsPath = "SECRETS_PATH"
	// EnvIPFSAPIPort is the environment variable used for api port
	EnvIPFSAPIPort = "IPFS_API_PORT"
	// EnvIPFSAPIHost is the environment variable used for api host
	EnvIPFSAPIHost = "IPFS_API_HOST"
	// EnvIPFSGatewayPort is the environment variable used for local gateway port
	EnvIPFSGatewayPort = "IPFS_GATEWAY_PORT"
	// EnvIPFSGatewayHost is the environment variable used for local gateway host
	EnvIPFSGatewayHost = "IPFS_GATEWAY_HOST"
	// EnvIPFSInitProfiles is the environment variables used for initial profiles
	EnvIPFSInitProfiles = "IPFS_INIT_PROFILES"
	// EnvIPFSProfiles is the environment variables used for configuration profiles after peer intialization
	EnvIPFSProfiles = "IPFS_PROFILES"

	// EnvIPFSClusterPath is the environment variables used for ipfs-cluster-service path
	EnvIPFSClusterPath = "IPFS_CLUSTER_PATH"
	// EnvIPFSClusterConsensus is the environment variables used for ipfs cluster consnsus
	EnvIPFSClusterConsensus = "IPFS_CLUSTER_CONSENSUS"
	// EnvIPFSClusterPeerEndpoint is the environment variables used for ipfs cluster peer API endpoint
	EnvIPFSClusterPeerEndpoint = "CLUSTER_IPFSHTTP_NODEMULTIADDRESS"
	// EnvIPFSClusterPeerName is the environment variables used for ipfs cluster peer name
	EnvIPFSClusterPeerName = "CLUSTER_PEERNAME"
	// EnvIPFSClusterSecret is the environment variables used for ipfs cluster secret
	EnvIPFSClusterSecret = "CLUSTER_SECRET"
	// EnvIPFSClusterTrustedPeers is the environment variables used for ipfs cluster trusted peers
	EnvIPFSClusterTrustedPeers = "CLUSTER_CRDT_TRUSTEDPEERS"
	// EnvIPFSClusterId is the environment variables used for ipfs cluster id
	EnvIPFSClusterId = "CLUSTER_ID"
	// EnvIPFSClusterPrivateKey is the environment variables used for ipfs cluster private key
	EnvIPFSClusterPrivateKey = "CLUSTER_PRIVATEKEY"
)

const (
	// GoIPFSDaemonArg is the argument used to run go ipfs daemon
	GoIPFSDaemonArg = "daemon"
	// GoIPFSRoutingArg is the argument used to set content routing mechanism
	GoIPFSRoutingArg = "--routing"

	// GoIPFSClusterDaemonArg is the argument used to run go ipfs cluster daemon
	GoIPFSClusterDaemonArg = "daemon"
	// GoIPFSClusterBootstrapArg is the argument used for go ipfs cluster bootstrap peers
	GoIPFSClusterBootstrapArg = "--bootstrap"
)

const (
	//  GoIPFSClusterHomeDir is go ipfs cluster image home dir
	GoIPFSClusterHomeDir = "/home/ipfs-cluster"
)

const (
	//  GoIPFSHomeDir is go ipfs image home dir
	GoIPFSHomeDir = "/home/ipfs"
)

Images

Types

type GoIPFSClusterClient

type GoIPFSClusterClient struct {
	// contains filtered or unexported fields
}

GoIPFSClusterClient is ipfs cluster service client https://github.com/ipfs/ipfs-cluster

func (*GoIPFSClusterClient) Args

func (c *GoIPFSClusterClient) Args() (args []string)

Arg returns go ipfs cluster arguments

func (*GoIPFSClusterClient) Command

func (c *GoIPFSClusterClient) Command() []string

Command returns go ipfs cluster entrypoint

func (*GoIPFSClusterClient) Env

func (c *GoIPFSClusterClient) Env() []corev1.EnvVar

Command returns environment variables for the client

func (*GoIPFSClusterClient) HomeDir

func (c *GoIPFSClusterClient) HomeDir() string

HomeDir returns go ipfs cluster image home directory

type IPFSClient

type IPFSClient interface {
	clients.Interface
}

IPFSClient is IPFS peer client

func NewClient

func NewClient(obj runtime.Object) (IPFSClient, error)

NewClient creates a new client for ipfs peer or cluster peer

type KuboClient

type KuboClient struct {
	// contains filtered or unexported fields
}

KuboClient is an ipfs implementation in golang https://github.com/ipfs/kubo

func (*KuboClient) Args

func (c *KuboClient) Args() (args []string)

Args returns kubo args

func (*KuboClient) Command

func (c *KuboClient) Command() []string

Command is kubo entrypoint

func (*KuboClient) Env

func (c *KuboClient) Env() []corev1.EnvVar

Command returns environment variables for the client

func (*KuboClient) HomeDir

func (c *KuboClient) HomeDir() string