hyperlane-monorepo/rust/helm/hyperlane-agent/README.md

Hyperlane-Agent Helm Chart

A Helm Chart that encapsulates the deployment of the Hyperlane Rust Agent(s). It is currently designed to be deployed against a Google Kubernetes Engine cluster, but specification of another PVC Storage Class should be sufficient to make it compatible with other cloud providers.

Additional documentation is present in comments in yalues.yaml.

Values

Key	Type	Default	Description
affinity	object	{}
fullnameOverride	string	""
image.pullPolicy	string	"Always"
image.repository	string	"gcr.io/clabs-optics/optics-agent"	Main repository for Hyperlane Agent binaries, provided by cLabs
image.tag	string	"latest"	Overrides the image tag whose default is the chart appVersion.
imagePullSecrets	list	[]
nameOverride	string	""
nodeSelector	object	{}
hyperlane	object	{"baseConfig":"base.json","outboxChain":{"address":null,"connectionType":null,"connectionUrl":null,"domain":null,"name":"goerli","protocol":null},enabled":false,"messageInterval":null,"signers":[{"key":"","name":"goerli"},{"key":"","name":"alfajores"}]},"processor":{"enabled":false,"pollingInterval":null,"signers":[{"key":"","name":"goerli"},{"key":"","name":"alfajores"}]},"relayer":{"enabled":false,"pollingInterval":null,"signers":[{"key":"","name":"goerli"},{"key":"","name":"alfajores"}]},"inboxChains":[{"address":null,"connectionType":null,"connectionUrl":null,"domain":null,"name":"alfajores","protocol":null}],"runEnv":"default","validator":{"signer":"","enabled":false,"pollingInterval":null,"signers":[{"key":"","name":"goerli"},{"key":"","name":"alfajores"}],"updatePause":null}}	Hyperlane Overrides By Default, Hyperlane Agents load the config baked into the Docker Image Pass values here in order to override the values in the config Note: For successful operation, one must pass signer keys as they are not baked into the image for security reasons.
hyperlane.outboxChain.address	string	nil	The contract address for the home contract
hyperlane.outboxChain.connectionUrl	string	nil	Connection string pointing to an RPC endpoint for the home chain
hyperlane.outboxChain.domain	string	nil	The hard-coded domain corresponding to this blockchain
hyperlane.outboxChain.protocol	string	nil	RPC Style
hyperlane.relayer.enabled	bool	false	Enables or disables the relayer
hyperlane.inboxChains	list	[{"address":null,"connectionType":null,"connectionUrl":null,"domain":null,"name":"alfajores","protocol":null}]	Replica chain overrides, a sequence
hyperlane.inboxChains[0].address	string	nil	The contract address for the replica contract
hyperlane.inboxChains[0].connectionUrl	string	nil	Connection string pointing to an RPC endpoint for the replica chain
hyperlane.validator.signer	string	""	Specialized key used by validator and watcher used to sign attestations, separate from validator.keys
hyperlane.validator.enabled	bool	false	Enables or disables the validator
hyperlane.validator.pollingInterval	string	nil	How long to wait between checking for updates
hyperlane.validator.signers	list	[{"key":"","name":"goerli"},{"key":"","name":"alfajores"}]	Trnsaction Signing keys for home and replica(s)
podAnnotations	object	{}
podSecurityContext	object	{}
replicaCount	int	1
resources	object	{}
securityContext	object	{}
tolerations	list	[]
volumeStorageClass	string	"standard"	Default to standard storageclass provided by GKE

---

Autogenerated from chart metadata using helm-docs v1.5.0