sui_cookbooks

README

NVMe Setup Instructions for Kubernetes:

Our platform already handles this for you, but if you want to install it in your own cluster, here are the instructions:

See cloud provider specific setup instructions for NVMe setup:

zeus/cluster_resources/nvme

Kubernetes Local Persistent Volume Setup Notes:

• You must set a PersistentVolume nodeAffinity when using local volumes.

https://kubernetes.io/docs/concepts/storage/volumes/#local

Cloud Provider Specific Setup Notes:

Recommend machines are for mainnet, testnet machines can be smaller, but should remain the same machine type class at minimum, to ensure NVMe disk compatibility.

AWS

storageClass: fast-disks

Recommended machine types:

3rd gen: i3.8xlarge (32 vCPUs, 244 GB RAM, 4 x 1.9 TB NVMe SSD)
4th gen recommended instance type: i4i.8xlarge (32 vCPUs, 256 GB RAM, 2 x 3750 TB Nitro SSD*)

*Nitro SSDs are NVMe-based and custom-designed by AWS

GCP

UPDATE: we're currently out of quota for NVMe disks, so please use the AWS or DigitalOcean setup for now, or contact us at support@zeus.fyi. We can work with you to get you to set up on GCP. We're working on getting more quota.

storageClass: nvme-ssd-block

Recommended machine types:

We're currently increasing our n2d availability. Currently limited supply & may be out of stock via our Platform for a short while

n2d-highmem-16 n2d-highmem-32

We have a good supply of n1 machines

n1-highmem-16 n1-highmem-32

We config 16 nvme disks (~6Ti) in a Raid-0 config for these machines when a sui-prefixed cluster is deployed with these machine types.

For 16 cpu machines, you'll need to adjust your cpu size on your k8s config to ~15-15.5 to prevent scheduling issues.

More info: https://cloud.google.com/compute/docs/disks/local-ssd

DigitalOcean

storageClass: nvme-ssd-block

Recommended machine types:

Storage-Optimized Droplet. SSD x1.5 (24 vCPUs, 192 GiB RAM, 5.27 TB NVMe SSD)

Sui Recommended Specs:

CPUs: 8 physical cores / 16 vCPUs
RAM: 128 GB
Storage (SSD): 4 TB NVMe drive

Additional Info: https://docs.sui.io/build/fullnode

Snapshots: https://docs.sui.io/build/snapshot

Testnet Seed Nodes:

p2p-config:
  seed-peers:
    - address: /dns/ewr-tnt-ssfn-00.testnet.sui.io/udp/8084
      peer-id: df8a8d128051c249e224f95fcc463f518a0ebed8986bbdcc11ed751181fecd38
    - address: /dns/lax-tnt-ssfn-00.testnet.sui.io/udp/8084
      peer-id: f9a72a0a6c17eed09c27898eab389add704777c03e135846da2428f516a0c11d
    - address: /dns/lhr-tnt-ssfn-00.testnet.sui.io/udp/8084
      peer-id: 9393d6056bb9c9d8475a3cf3525c747257f17c6a698a7062cbbd1875bc6ef71e
    - address: /dns/mel-tnt-ssfn-00.testnet.sui.io/udp/8084
      peer-id: c88742f46e66a11cb8c84aca488065661401ef66f726cb9afeb8a5786d83456e

Mainnet Seed Nodes:

p2p-config:
  seed-peers:
    - address: /dns/icn-00.mainnet.sui.io/udp/8084
      peer-id: 303f1f35afc9a6f82f8d21724f44e1245f4d8eca0806713a07c525dadda95a66
    - address: /dns/icn-01.mainnet.sui.io/udp/8084
      peer-id: cb7ce193cf7a41e9cc2f99e65dd1487b6314a57c74be42cc8c9225b203301812
    - address: /dns/mel-00.mainnet.sui.io/udp/8084
      peer-id: d32b55bdf1737ec415df8c88b3bf91e194b59ee3127e3f38ea46fd88ba2e7849
    - address: /dns/mel-01.mainnet.sui.io/udp/8084
      peer-id: bbf3be337fc16614a1953da83db729abfdc40596e197f36fe408574f7c9b780e
    - address: /dns/ewr-00.mainnet.sui.io/udp/8084
      peer-id: c7bf6cb93ca8fdda655c47ebb85ace28e6931464564332bf63e27e90199c50ee
    - address: /dns/ewr-01.mainnet.sui.io/udp/8084
      peer-id: 3227f8a05f0faa1a197c075d31135a366a1c6f3d4872cb8af66c14dea3e0eb66
    - address: /dns/sjc-00.mainnet.sui.io/udp/8084
      peer-id: 6f0b25087cd6b2fd2e4329bcf308ac95a37c49277dd7286b72470c124809db5b
    - address: /dns/sjc-01.mainnet.sui.io/udp/8084
      peer-id: af1d5d8468b3612ac2b6ff3ca91e99a71390dbe5b83dea9f6ae2da708d689227
    - address: /dns/lhr-00.mainnet.sui.io/udp/8084
      peer-id: c619a5e0f8f36eac45118c1f8bda28f0f508e2839042781f1d4a9818043f732c
    - address: /dns/lhr-01.mainnet.sui.io/udp/8084
      peer-id: 53dcedf250f73b1ec83250614498947db00d17c0181020fcdb7b6db12afbc175

Documentation

Index

• Constants
• Variables
• func GetArchiveFallback(network string) interface{}
• func GetP2PTable(network string) interface{}
• func GetSuiClientClusterDef(cfg SuiConfigOpts) zeus_cluster_config_drivers.ClusterDefinition
• func GetSuiClientNetworkConfigBase(cfg SuiConfigOpts) zeus_cluster_config_drivers.ComponentBaseDefinition
• func GetSuiConfig(cfg SuiConfigOpts) map[string]zeus_cluster_config_drivers.ComponentBaseDefinition
• func OverrideNodeConfigDataDir(dataDir string, cfg SuiConfigOpts) string
• type SuiConfigOpts

Constants

const (
	Sui       = "sui"
	Full      = "full"
	Validator = "validator"

	SuiIngress        = "suiIngress"
	SuiServiceMonitor = "suiServiceMonitor"
)

const (
	SuiRpcPortName = "http-rpc"

	DownloadMainnet = "downloadMainnetNode"
)

Variables

var (
	SuiMasterChartPath = filepaths.Path{
		PackageName: "",
		DirIn:       "./sui/node/infra",
		DirOut:      "./sui/output",
		FnIn:        Sui,
		FnOut:       "",
		Env:         "",
	}

	SuiIngressChartPath = filepaths.Path{
		PackageName: "",
		DirIn:       "./sui/node/ingress",
		DirOut:      "./sui/output",
		FnIn:        SuiIngress,
		FnOut:       "",
		Env:         "",
	}

	SuiServiceMonitorChartPath = filepaths.Path{
		PackageName: "",
		DirIn:       "./sui/node/servicemonitor",
		DirOut:      "./sui/output",
		FnIn:        SuiServiceMonitor,
		Env:         "",
	}
	RootPath = "."
)

Functions

func GetArchiveFallback

func GetArchiveFallback(network string) interface{}

func GetP2PTable

func GetP2PTable(network string) interface{}

func GetSuiClientClusterDef

func GetSuiClientClusterDef(cfg SuiConfigOpts) zeus_cluster_config_drivers.ClusterDefinition

func GetSuiClientNetworkConfigBase

func GetSuiClientNetworkConfigBase(cfg SuiConfigOpts) zeus_cluster_config_drivers.ComponentBaseDefinition

func GetSuiConfig

func GetSuiConfig(cfg SuiConfigOpts) map[string]zeus_cluster_config_drivers.ComponentBaseDefinition

func OverrideNodeConfigDataDir

func OverrideNodeConfigDataDir(dataDir string, cfg SuiConfigOpts) string

Types

type SuiConfigOpts

type SuiConfigOpts struct {
	DownloadSnapshot bool   `json:"downloadSnapshot"`
	Network          string `json:"network"`

	CloudProvider string `json:"cloudProvider"`
	WithLocalNvme bool   `json:"withLocalNvme"`

	WithIngress          bool `json:"withIngress"`
	WithServiceMonitor   bool `json:"withServiceMonitor"`
	WithArchivalFallback bool `json:"withArchivalFallback"`
	WithHercules         bool `json:"withHercules"`
}