Node

At least one node is required in IPFS Swarm. A node is ipfs client (go-ipfs) running inside a pod with compute and storage resources and scheduled in a kubernetes node.

SyntaxTypeDescriptionDefault
namenodenode name
idnodeid is the node identifer derived from private key
privateKeystringnode private key from which the id is derived
profilesArraylist of configuration profiles to apply
resourcesObjectnode compute and storage resources to alloacte

name#

name is the node name.

name is required.

name can't be updated (immutable).

id#

id is the node identifier.

id is required.

id can be generated using ipfs-key tool.

privateKey#

privateKey is the node private key, from which id is generated.

privateKey is required.

privateKey can be generated using ipfs-key tool.

# generate RSA key
$ ipfs-key | base64
# generate Ed25519 Key
$ ipfs-key -type Ed25519 | base64

profiles#

profiles is the set of ipfs configuration profiles to apply to this node.

profiles possible values are:

  • server
  • randomports
  • default-datastore
  • local-discovery
  • test
  • default-networking
  • flatfs
  • badgerds
  • lowpower

resources#

resources allocates compute and storage resources to the node.

SyntaxTypeDescriptionDefalt
cpustringnumber of cpu cores this node requires1
cpuLimitstringnumber of cpu cores this node is limited to2
memorystringmemory this node requires2Gi
memoryLimitstringmemory this node is limited to4Gi
storagestringdisk space this node requires10Gi

memory and storage requests and limits must have use the pattern ^[1-9][0-9]*[KMGTPE]i$ for example 1500Mi, 30Gi, and 1Ti.

cpu requests and limits must have use the pattern ^[1-9][0-9]*m?$ for example 1000m (which is equal to 1), 1500m, 2, and 4.

cpuLimit can't be less than cpu.

memoryLimit can't be less than memory.