ClusterPeer resource spec parameters are summrized in the following table:
|id||string||Cluster peer ID|
|privatekeySecretName||string||Name of the k8s secret holding cluster peer privatekey|
|trustedPeers||array||Peer IDs that can manage the pinset in |
|bootstrapPeers||array||Peers to connect to on startup|
|consensus||string||Cluster consensus algorithm|
|peerEndpoint required||string||ipfs peer http API endpoint|
|clusterSecretName required||string||Name of the k8s secret holding cluster secret|
|resources||object||Compute and storage resources|
id is cluster peer id derived from private key.
id is required if
privatekeySecretName is provided.
id can be generated using ipfs-key tool.
privatekeySecretName is the name of the k8s secret holding base64 cluster peer privatekey in a key called
privatekeySecretName is required if
id is provided.
privatekeySecretName can be generated using ipfs-key tool.
trustedPeers is a list of peer IDs that can manage the cluster pinset in
crdt consensus clusters.
trustedPeers is ignored in
raft consensus clusters.
trustedPeers default value is
* which is trust all peers.
bootstrapPeers is a list of peers to connect to on startup.
bootstrapPeers will be trusted peers in
consensus is the cluster consensus algorithm.
peerEndpoint id ipfs peer http API endpoint.
peerEndpoint is required for the cluster peer to function correctly.
clusterSecretName is the k8s secret name holding 32-bit hex-encoded (without 0x) cluster secret in a key called
clusterSecretName can be generated using openssl tool:
resources allocates compute and storage resources to the peer.
resources object has the following fields:
|cpu||string||number of cpu cores this peer requires|
|cpuLimit||string||number of cpu cores this peer is limited to|
|memory||string||memory this peer requires|
|memoryLimit||string||memory this peer is limited to|
|storage||string||disk space this peer requires|
Memory and storage requests and limits must use the pattern
^[1-9][0-9]*[KMGTPE]i$ for example
cpu requests and limits must use the pattern
^[1-9][0-9]*m?$ for example
1000m (which is equal to
1500m which is 1.5 core,
2 cores, and
cpuLimit can't be less than
memoryLimit can't be less than or equal to