Custom Resource Definitions (CRDs) API Reference

This page provides a detailed reference for the available Custom Resource Definitions (CRDs) in Cosmopilot. Each CRD defines the specifications and configuration options for managing Cosmos-based blockchain nodes in Kubernetes.

Custom Resources

• ChainNode
• ChainNodeSet

Sub Resources

• ChainNodeList
• ChainNodeSpec
• ChainNodeStatus
• ValidatorConfig
• ChainNodeSetList
• ChainNodeSetNodeStatus
• ChainNodeSetSpec
• ChainNodeSetStatus
• GlobalIngressConfig
• IngressConfig
• NodeGroupSpec
• NodeSetValidatorConfig
• AccountAssets
• AppSpec
• ChainNodeAssets
• Config
• CosmoGuardConfig
• CreateValidatorConfig
• ExportTarballConfig
• ExposeConfig
• FromNodeRPCConfig
• GcsExportConfig
• GenesisConfig
• GenesisInitConfig
• InitCommand
• Peer
• Persistence
• PvcSnapshot
• SidecarSpec
• StateSyncConfig
• TmKMS
• TmKmsHashicorpProvider
• TmKmsKeyFormat
• TmKmsProvider
• Upgrade
• UpgradeSpec
• ValidatorInfo
• VolumeSnapshotsConfig
• VolumeSpec

ChainNode

ChainNode is the Schema for the chainnodes API.

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec		ChainNodeSpec	false
status		ChainNodeStatus	false

Back to Custom Resources

ChainNodeList

ChainNodeList contains a list of ChainNode.

Field	Description	Scheme	Required
metadata		metav1.ListMeta	false
items		[]ChainNode	true

Back to Custom Resources

ChainNodeSpec

ChainNodeSpec defines the desired state of ChainNode.

Field	Description	Scheme	Required
genesis	Indicates where this node will get the genesis from. Can be omitted when .spec.validator.init is specified.	*GenesisConfig	true
app	Specifies image, version and binary name of the chain application to run. It also allows to schedule upgrades, or setting/updating the image for an on-chain upgrade.	AppSpec	true
config	Allows setting specific configurations for this node.	*Config	false
persistence	Configures PVC for persisting data. Automated data snapshots can also be configured in this section.	*Persistence	false
validator	Indicates this node is going to be a validator and allows configuring it.	*ValidatorConfig	false
autoDiscoverPeers	Ensures peers with same chain ID are connected with each other. Enabled by default.	*bool	false
stateSyncRestore	Configures this node to find a state-sync snapshot on the network and restore from it. This is disabled by default.	*bool	false
peers	Additional persistent peers that should be added to this node.	[]Peer	false
expose	Allows exposing P2P traffic to public.	*ExposeConfig	false
resources	Compute Resources required by the app container.	corev1.ResourceRequirements	false
nodeSelector	Selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node.	map[string]string	false
affinity	If specified, the pod's scheduling constraints.	*corev1.Affinity	false
ignoreGroupOnDisruptionChecks	Whether ChainNodeSet group label should be ignored on pod disruption checks. This is useful to ensure no downtime globally or per global ingress, instead of just per group. Defaults to false.	*bool	false

Back to Custom Resources

ChainNodeStatus

ChainNodeStatus defines the observed state of ChainNode

Field	Description	Scheme	Required
phase	Indicates the current phase for this ChainNode.	ChainNodePhase	false
conditions	Conditions to track state of the ChainNode.	[]metav1.Condition	false
nodeID	Indicates this node's ID.	string	false
ip	Internal IP address of this node.	string	false
publicAddress	Public address for P2P when enabled.	string	false
chainID	Indicates the chain ID.	string	false
pvcSize	Current size of the data PVC for this node.	string	false
dataUsage	Usage percentage of data volume.	string	false
validator	Indicates if this node is a validator.	bool	true
accountAddress	Account address of this validator. Omitted when not a validator.	string	false
validatorAddress	Validator address is the valoper address of this validator. Omitted when not a validator.	string	false
jailed	Indicates if this validator is jailed. Always false if not a validator node.	bool	false
appVersion	Application version currently deployed.	string	false
latestHeight	Last height read on the node by cosmopilot.	int64	false
seedMode	Indicates if this node is running with seed mode enabled.	bool	false
upgrades	All scheduled/completed upgrades performed by cosmopilot on this ChainNode.	[]Upgrade	false
pubKey	Public key of the validator.	string	false
validatorStatus	Indicates the current status of validator if this node is one.	ValidatorStatus	false

Back to Custom Resources

ValidatorConfig

ValidatorConfig contains the configuration for running a node as validator.

Field	Description	Scheme	Required
privateKeySecret	Indicates the secret containing the private key to be used by this validator. Defaults to <chainnode>-priv-key. Will be created if it does not exist.	*string	false
info	Contains information details about this validator.	*ValidatorInfo	false
init	Specifies configs and initialization commands for creating a new genesis.	*GenesisInitConfig	false
tmKMS	TmKMS configuration for signing commits for this validator. When configured, .spec.validator.privateKeySecret will not be mounted on the validator node.	*TmKMS	false
createValidator	Indicates that cosmopilot should run create-validator tx to make this node a validator.	*CreateValidatorConfig	false

Back to Custom Resources

ChainNodeSet

ChainNodeSet is the Schema for the chainnodesets API.

Field	Description	Scheme	Required
metadata		metav1.ObjectMeta	false
spec		ChainNodeSetSpec	false
status		ChainNodeSetStatus	false

Back to Custom Resources

ChainNodeSetList

ChainNodeSetList contains a list of ChainNodeSet.

Field	Description	Scheme	Required
metadata		metav1.ListMeta	false
items		[]ChainNodeSet	true

Back to Custom Resources

ChainNodeSetNodeStatus

ChainNodeSetNodeStatus contains information about a node running on this ChainNodeSet.

Field	Description	Scheme	Required
name	Name of the node.	string	true
public	Whether this node can be accessed publicly.	bool	true
seed	Indicates if this node is running in seed mode.	bool	true
id	ID of this node.	string	true
address	Hostname or IP address to reach this node internally.	string	true
publicAddress	Hostname or IP address to reach this node publicly.	string	false
publicPort	Port to reach this node publicly.	int	false
port	P2P port for connecting to this node.	int	true
group	Group to which this ChainNode belongs.	string	false

Back to Custom Resources

ChainNodeSetSpec

ChainNodeSetSpec defines the desired state of ChainNode.

Field	Description	Scheme	Required
app	Specifies image, version and binary name of the chain application to run. It also allows to schedule upgrades, or setting/updating the image for an on-chain upgrade.	AppSpec	true
genesis	Indicates where this node will get the genesis from. Can be omitted when .spec.validator.init is specified.	*GenesisConfig	true
validator	Indicates this node set will run a validator and allows configuring it.	*NodeSetValidatorConfig	false
nodes	List of groups of ChainNodes to be run.	[]NodeGroupSpec	true
rollingUpdates	Ensures that changes to ChainNodeSet are propagated to ChainNode resources one at a time. Cosmopilot will wait for each ChainNode to be in either Running or Syncing state before proceeding to the next one. Note that this does not apply to upgrades, as those are handled directly by the ChainNode controller. Defaults to false.	*bool	false
ingresses	List of ingresses to create for this ChainNodeSet. This allows to create ingresses targeting multiple groups of nodes.	[]GlobalIngressConfig	false

Back to Custom Resources

ChainNodeSetStatus

ChainNodeSetStatus defines the observed state of ChainNodeSet.

Field	Description	Scheme	Required
phase	Indicates the current phase for this ChainNodeSet.	ChainNodeSetPhase	false
chainID	Indicates the chain ID.	string	false
instances	Indicates the total number of ChainNode instances on this ChainNodeSet.	int	false
appVersion	The application version currently deployed.	string	false
nodes	Nodes available on this nodeset. Excludes validator node.	[]ChainNodeSetNodeStatus	false
validatorAddress	Validator address of the validator in this ChainNodeSet if one is available. Omitted when no validator is present in the ChainNodeSet.	string	false
validatorStatus	Current status of validator if this ChainNodeSet has one.	ValidatorStatus	false
pubKey	Public key of the validator if this ChainNodeSet has one.	string	false
upgrades	All scheduled/completed upgrades performed by cosmopilot on ChainNodes of this CHainNodeSet.	[]Upgrade	false
latestHeight	Last height read on the nodes by cosmopilot.	int64	false

Back to Custom Resources

GlobalIngressConfig

GlobalIngressConfig specifies configurations for ingress to expose API endpoints of several groups of nodes.

Field	Description	Scheme	Required
name	The name of this ingress	string	true
groups	Groups of nodes to which this ingress will point to.	[]string	true
enableRPC	Enable RPC endpoint.	bool	false
enableGRPC	Enable gRPC endpoint.	bool	false
enableLCD	Enable LCD endpoint.	bool	false
enableEvmRPC	Enable EVM RPC endpoint.	bool	false
enableEvmRpcWS	Enable EVM RPC Websocket endpoint.	bool	false
host	Host in which endpoints will be exposed. Endpoints are exposed on corresponding subdomain of this host. An example host nodes.example.com will have endpoints exposed at rpc.nodes.example.com, grpc.nodes.example.com and lcd.nodes.example.com.	string	true
annotations	Annotations to be appended to the ingress.	map[string]string	false
disableTLS	Whether to disable TLS on ingress resource.	bool	false
tlsSecretName	Name of the secret containing TLS certificate.	*string	false

Back to Custom Resources

IngressConfig

IngressConfig specifies configurations for ingress to expose API endpoints.

Field	Description	Scheme	Required
enableRPC	Enable RPC endpoint.	bool	false
enableGRPC	Enable gRPC endpoint.	bool	false
enableLCD	Enable LCD endpoint.	bool	false
enableEvmRPC	Enable EVM RPC endpoint.	bool	false
enableEvmRpcWS	Enable EVM RPC Websocket endpoint.	bool	false
host	Host in which endpoints will be exposed. Endpoints are exposed on corresponding subdomain of this host. An example host nodes.example.com will have endpoints exposed at rpc.nodes.example.com, grpc.nodes.example.com and lcd.nodes.example.com.	string	true
annotations	Annotations to be appended to the ingress.	map[string]string	false
disableTLS	Whether to disable TLS on ingress resource.	bool	false
tlsSecretName	Name of the secret containing TLS certificate.	*string	false

Back to Custom Resources

NodeGroupSpec

NodeGroupSpec sets chainnode configurations for a group.

Field	Description	Scheme	Required
name	Name of this group.	string	true
instances	Number of ChainNode instances to run on this group.	*int	false
config	Specific configurations for these nodes.	*Config	false
persistence	Configures PVC for persisting data. Automated data snapshots can also be configured in this section.	*Persistence	false
peers	Additional persistent peers that should be added to these nodes.	[]Peer	false
expose	Allows exposing P2P traffic to public.	*ExposeConfig	false
ingress	Indicates if an ingress should be created to access API endpoints of these nodes and configures it.	*IngressConfig	false
resources	Compute Resources required by the app container.	corev1.ResourceRequirements	false
nodeSelector	Selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node.	map[string]string	false
affinity	If specified, the pod's scheduling constraints.	*corev1.Affinity	false
stateSyncRestore	Configures these nodes to find state-sync snapshots on the network and restore from it. This is disabled by default.	*bool	false
inheritValidatorGasPrice	Whether these nodes should inherit gas price from validator (if there is not configured on this ChainNodeSet) Defaults to true.	*bool	false
ignoreGroupOnDisruptionChecks	Whether ChainNodeSet group label should be ignored on pod disruption checks. This is useful to ensure no downtime globally or per global ingress, instead of just per group. Defaults to false.	*bool	false

Back to Custom Resources

NodeSetValidatorConfig

NodeSetValidatorConfig contains validator configurations.

Field	Description	Scheme	Required
privateKeySecret	Secret containing the private key to be used by this validator. Defaults to <chainnode>-priv-key. Will be created if it does not exist.	*string	false
info	Contains information details about the validator.	*ValidatorInfo	false
init	Specifies configs and initialization commands for creating a new genesis.	*GenesisInitConfig	false
config	Allows setting specific configurations for the validator.	*Config	false
persistence	Configures PVC for persisting data. Automated data snapshots can also be configured in this section.	*Persistence	false
resources	Compute Resources required by the app container.	corev1.ResourceRequirements	false
nodeSelector	Selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node.	map[string]string	false
affinity	If specified, the pod's scheduling constraints.	*corev1.Affinity	false
tmKMS	TmKMS configuration for signing commits for this validator. When configured, .spec.validator.privateKeySecret will not be mounted on the validator node.	*TmKMS	false
stateSyncRestore	Configures this node to find a state-sync snapshot on the network and restore from it. This is disabled by default.	*bool	false
createValidator	Indicates cosmopilot should run create-validator tx to make this node a validator.	*CreateValidatorConfig	false

Back to Custom Resources

AccountAssets

AccountAssets represents the assets associated with an account.

Field	Description	Scheme	Required
address	Address of the account.	string	true
assets	Assets assigned to this account.	[]string	true

Back to Custom Resources

AppSpec

AppSpec specifies the source image, version and binary name of the app to run. Also allows specifying upgrades for the app and enabling automatic check of upgrade proposals on chain.

Field	Description	Scheme	Required
image	Container image to be used.	string	true
version	Image tag to be used. Once there are completed or skipped upgrades this will be ignored. For a new node that will be state-synced, this will be the version used during state-sync. Only after that, the cosmopilot will switch to the version of last upgrade. Defaults to latest.	*string	false
imagePullPolicy	Indicates the desired pull policy when creating nodes. Defaults to Always if version is latest and IfNotPresent otherwise.	corev1.PullPolicy	false
app	Binary name of the application to be run.	string	true
sdkVersion	SdkVersion specifies the version of cosmos-sdk used by this app. Valid options are: - "v0.47" (default) - "v0.45"	*SdkVersion	false
checkGovUpgrades	Whether cosmopilot should query gov proposals to find and schedule upgrades. Defaults to true.	*bool	false
upgrades	List of upgrades to schedule for this node.	[]UpgradeSpec	false

Back to Custom Resources

ChainNodeAssets

ChainNodeAssets represents the assets associated with an account from another ChainNode.

Field	Description	Scheme	Required
chainNode	Name of the ChainNode.	string	true
assets	Assets assigned to this account.	[]string	true

Back to Custom Resources

Config

Config allows setting specific configurations for a node, including overriding configs in app.toml and config.toml.

Field	Description	Scheme	Required
override	Allows overriding configs on .toml configuration files.	*map[string]runtime.RawExtension	false
sidecars	Allows configuring additional containers to run alongside the node.	[]SidecarSpec	false
imagePullSecrets	Optional list of references to secrets in the same namespace to use for pulling any of the images used by this node.	[]corev1.LocalObjectReference	false
blockThreshold	The time to wait for a block before considering node unhealthy. Defaults to 15s.	*string	false
reconcilePeriod	Period at which a reconcile loop will happen for this ChainNode. Defaults to 15s.	*string	false
stateSync	Allows configuring this node to perform state-sync snapshots.	*StateSyncConfig	false
seedMode	Configures this node to run on seed mode. Defaults to false.	*bool	false
env	List of environment variables to set in the app container.	[]corev1.EnvVar	false
safeToEvict	SafeToEvict sets cluster-autoscaler.kubernetes.io/safe-to-evict annotation to the given value. It allows/disallows cluster-autoscaler to evict this node's pod.	*bool	false
cosmoGuard	Deploys CosmoGuard to protect API endpoints of the node.	*CosmoGuardConfig	false
nodeUtilsLogLevel	Log level for node-utils container. Defaults to info.	*string	false
startupTime	The time after which a node will be restarted if it does not start properly. Defaults to 1h.	*string	false
ignoreSyncing	Marks the node as ready even when it is catching up. This is useful when a chain is halted, but you still need the node to be ready for querying existing data. Defaults to false.	*bool	false
nodeUtilsResources	Compute Resources for node-utils container.	*corev1.ResourceRequirements	false
persistAddressBook	Whether to persist address book file in data directory. Defaults to false.	*bool	false
terminationGracePeriodSeconds	Optional duration in seconds the pod needs to terminate gracefully.	*int64	false
evmEnabled	Whether EVM is enabled on this node. Will add evm-rpc port to services. Defaults to false.	*bool	false
runFlags	List of flags to be appended to app container when starting the node.	[]string	false
volumes	Additional volumes to be created and mounted on this node.	[]VolumeSpec	false
dashedConfigToml	Whether field naming in config.toml should use dashes instead of underscores. Defaults to false.	*bool	false
haltHeight	The block height at which the node should stop. Cosmopilot will not attempt to restart the node beyond this height.	*int64	false

Back to Custom Resources

CosmoGuardConfig

CosmoGuardConfig allows configuring CosmoGuard rules.

Field	Description	Scheme	Required
enable	Whether to enable CosmoGuard on this node.	bool	true
config	ConfigMap which CosmoGuard configuration for this node.	*corev1.ConfigMapKeySelector	true
restartPodOnFailure	Whether the node's pod should be restarted when CosmoGuard fails.	*bool	false
resources	Compute Resources for CosmoGuard container.	*corev1.ResourceRequirements	false

Back to Custom Resources

CreateValidatorConfig

CreateValidatorConfig holds configuration for cosmopilot to submit a create-validator transaction.

Field	Description	Scheme	Required
accountMnemonicSecret	Name of the secret containing the mnemonic of the account to be used by this validator. Defaults to <chainnode>-account. Will be created if it does not exist.	*string	false
accountHDPath	HD path of accounts. Defaults to m/44'/118'/0'/0/0.	*string	false
accountPrefix	Prefix for accounts. Defaults to nibi.	*string	false
valPrefix	Prefix for validator operator accounts. Defaults to nibivaloper.	*string	false
commissionMaxChangeRate	Maximum commission change rate percentage (per day). Defaults to 0.1.	*string	false
commissionMaxRate	Maximum commission rate percentage. Defaults to 0.1.	*string	false
commissionRate	Initial commission rate percentage. Defaults to 0.1.	*string	false
minSelfDelegation	Minimum self delegation required on the validator. Defaults to 1.	*string	false
stakeAmount	Amount to be staked by this validator.	string	true
gasPrices	Gas prices in decimal format to determine the transaction fee.	string	true

Back to Custom Resources

ExportTarballConfig

ExportTarballConfig holds config options for tarball upload.

Field	Description	Scheme	Required
suffix	Suffix to add to archive name. The name of the tarball will be <chain-id>-<timestamp>-<suffix>.	*string	false
deleteOnExpire	Whether to delete the tarball when the snapshot expires. Default is false.	*bool	false
gcs	Configuration to upload tarballs to a GCS bucket.	*GcsExportConfig	false

Back to Custom Resources

ExposeConfig

ExposeConfig allows configuring how P2P endpoint is exposed to public.

Field	Description	Scheme	Required
p2p	Whether to expose p2p endpoint for this node. Defaults to false.	*bool	false
p2pServiceType	P2pServiceType indicates how P2P port will be exposed. Valid values are: - LoadBalancer - NodePort (default)	*corev1.ServiceType	false
annotations	Annotations to be appended to the p2p service.	map[string]string	false

Back to Custom Resources

FromNodeRPCConfig

FromNodeRPCConfig holds configuration to retrieve genesis from an existing node using RPC endpoint.

Field	Description	Scheme	Required
secure	Defines protocol to use. Defaults to false.	bool	false
hostname	Hostname or IP address of the RPC server	string	true
port	TCP port used for RPC queries on the RPC server. Defaults to 26657.	*int	false

Back to Custom Resources

GcsExportConfig

GcsExportConfig holds required settings to upload to GCS.

Field	Description	Scheme	Required
bucket	Name of the bucket to upload tarballs to.	string	true
credentialsSecret	Secret with the JSON credentials to upload to bucket.	*corev1.SecretKeySelector	true
sizeLimit	Size limit at which the file will be split into multiple parts. Defaults to 5TB.	*string	false
partSize	Size of each part when size-limit is crossed. Defaults to 500GB.	*string	false
chunkSize	Size of each chunk uploaded in parallel to GCS. Defaults to 250MB.	*string	false
bufferSize	Size of the buffer when streaming data to GCS. Defaults to 32MB.	*string	false
concurrentJobs	Number of concurrent upload or delete jobs. Defaults to 10.	*int	false

Back to Custom Resources

GenesisConfig

GenesisConfig specifies how genesis will be retrieved.

Field	Description	Scheme	Required
url	URL to download the genesis from.	*string	false
fromNodeRPC	Get the genesis from an existing node using its RPC endpoint.	*FromNodeRPCConfig	false
genesisSHA	SHA256 to validate the genesis.	*string	false
configMap	ConfigMap specifies a configmap to load the genesis from. It can also be used to specify the name of the configmap to store the genesis when retrieving genesis using other methods.	*string	false
useDataVolume	UseDataVolume indicates that cosmopilot should save the genesis in the same volume as node data instead of a ConfigMap. This is useful for genesis whose size is bigger than ConfigMap limit of 1MiB. Ignored when genesis source is a ConfigMap. Defaults to false.	*bool	false
chainID	The chain-id of the network. This is only used when useDataVolume is true. If not set, cosmopilot will download the genesis and extract chain-id from it. If set, cosmopilot will not download it and use a container to download the genesis directly into the volume instead. This is useful for huge genesis that might kill cosmopilot container for using too much memory.	*string	false

Back to Custom Resources

GenesisInitConfig

GenesisInitConfig specifies configs and initialization commands for creating a new genesis.

Field	Description	Scheme	Required
chainID	ChainID of the chain to initialize.	string	true
accountMnemonicSecret	Name of the secret containing the mnemonic of the account to be used by this validator. Defaults to <chainnode>-account. Will be created if it does not exist.	*string	false
accountHDPath	HD path of accounts. Defaults to m/44'/118'/0'/0/0.	*string	false
accountPrefix	Prefix for accounts. Defaults to nibi.	*string	false
valPrefix	Prefix for validator operator accounts. Defaults to nibivaloper.	*string	false
commissionMaxChangeRate	Maximum commission change rate percentage (per day). Defaults to 0.1.	*string	false
commissionMaxRate	Maximum commission rate percentage. Defaults to 0.1.	*string	false
commissionRate	Initial commission rate percentage. Defaults to 0.1.	*string	false
minSelfDelegation	Minimum self delegation required on the validator. Defaults to 1. NOTE: In most chains this is a required flag. However, in a few other chains (Cosmos Hub for example), this flag does not even exist anymore. In those cases, set it to an empty string and cosmopilot will skip it.	*string	false
assets	Assets is the list of tokens and their amounts to be assigned to this validators account.	[]string	true
stakeAmount	Amount to be staked by this validator.	string	true
accounts	Accounts specify additional accounts and respective assets to be added to this chain.	[]AccountAssets	false
chainNodeAccounts	List of ChainNodes whose accounts should be included in genesis. NOTE: Cosmopilot will wait for the ChainNodes to exist and have accounts before proceeding.	[]ChainNodeAssets	false
unbondingTime	Time required to totally unbond delegations. Defaults to 1814400s (21 days).	*string	false
votingPeriod	Voting period for this chain. Defaults to 120h.	*string	false
additionalInitCommands	Additional commands to run on genesis initialization. Note: App home is at /home/app and /temp is a temporary volume shared by all init containers.	[]InitCommand	false

Back to Custom Resources

InitCommand

InitCommand represents an initialization command. It may be used for running additional commands on genesis or volume initialization.

Field	Description	Scheme	Required
image	Image to be used to run this command. Defaults to app image.	*string	false
command	Command to be used. Defaults to image entrypoint.	[]string	false
args	Args to be passed to this command.	[]string	true

Back to Custom Resources

Peer

Peer represents a persistent peer.

Field	Description	Scheme	Required
id	Tendermint node ID for this node.	string	true
address	Hostname or IP address of this peer.	string	true
port	P2P port to be used. Defaults to 26656.	*int	false
unconditional	Indicates this peer is unconditional.	*bool	false
private	Indicates this peer is private.	*bool	false

Back to Custom Resources

Persistence

Persistence configuration for a node.

Field	Description	Scheme	Required
size	Size of the persistent volume for storing data. Can't be updated when autoResize is enabled. Defaults to 50Gi.	*string	false
storageClass	Name of the storage class to use for the PVC. Uses the default class if not specified. to create persistent volumes.	*string	false
autoResize	Automatically resize PVC. Defaults to true.	*bool	false
autoResizeThreshold	Percentage of data usage at which an auto-resize event should occur. Defaults to 80.	*int	false
autoResizeIncrement	Increment size on each auto-resize event. Defaults to 50Gi.	*string	false
autoResizeMaxSize	Size at which auto-resize will stop incrementing PVC size. Defaults to 2Ti.	*string	false
additionalInitCommands	Additional commands to run on data initialization. Useful for downloading and extracting snapshots. App home is at /home/app and data dir is at /home/app/data. There is also /temp, a temporary volume shared by all init containers.	[]InitCommand	false
snapshots	Whether cosmopilot should create volume snapshots according to this config.	*VolumeSnapshotsConfig	false
restoreFromSnapshot	Restore from the specified snapshot when creating the PVC for this node.	*PvcSnapshot	false
initTimeout	Time to wait for data initialization pod to be successful. Defaults to 5m.	*string	false

Back to Custom Resources

PvcSnapshot

PvcSnapshot represents a snapshot to be used to restore a PVC.

Field	Description	Scheme	Required
name	Name of the volume snapshot being referenced.	string	true

Back to Custom Resources

SidecarSpec

SidecarSpec allows configuring additional containers to run alongside the node.

Field	Description	Scheme	Required
name	Name to be assigned to the container.	string	true
image	Container image to be used.	string	true
imagePullPolicy	Indicates the desired pull policy when creating nodes. Defaults to Always if version is latest and IfNotPresent otherwise.	corev1.PullPolicy	false
mountDataVolume	Where data volume will be mounted on this container. It is not mounted if not specified.	*string	false
mountConfig	Directory where config files from ConfigMap will be mounted on this container. They are not mounted if not specified.	*string	false
command	Command to be run by this container. Defaults to entrypoint defined in image.	[]string	false
args	Args to be passed to this container. Defaults to cmd defined in image.	[]string	false
env	Environment variables to be passed to this container.	[]corev1.EnvVar	false
securityContext	Security options the container should be run with.	*corev1.SecurityContext	false
resources	Compute Resources for the sidecar container.	corev1.ResourceRequirements	false
restartPodOnFailure	Whether the pod of this node should be restarted when this sidecar container fails. Defaults to false.	*bool	false
runBeforeNode	When enabled, this container turns into an init container instead of a sidecar as it will have to finish before the node container starts. Defaults to false.	*bool	false

Back to Custom Resources

StateSyncConfig

StateSyncConfig holds configurations for enabling state-sync snapshots on a node.

Field	Description	Scheme	Required
snapshotInterval	Block interval at which local state sync snapshots are taken (0 to disable).	int	true
snapshotKeepRecent	Number of recent snapshots to keep and serve (0 to keep all). Defaults to 2.	*int	false

Back to Custom Resources

TmKMS

TmKMS allows configuring tmkms for signing for this validator node instead of using plaintext private key file.

Field	Description	Scheme	Required
provider	Signing provider to be used by tmkms. Currently only vault is supported.	TmKmsProvider	true
keyFormat	Format and type of key for chain. Defaults to {\"type\": \"bech32\", \"account_key_prefix\": \"nibipub\", \"consensus_key_prefix\": \"nibivalconspub\"}.	*TmKmsKeyFormat	false
validatorProtocol	Tendermint's protocol version to be used. Valid options are: - v0.34 (default) - v0.33 - legacy	*tmkms.ProtocolVersion	false
persistState	Whether to persist "priv_validator_state.json" file on a PVC. Defaults to true.	*bool	false
resources	Compute Resources for tmkms container.	*corev1.ResourceRequirements	false

Back to Custom Resources

TmKmsHashicorpProvider

TmKmsHashicorpProvider holds hashicorp provider specific configurations.

Field	Description	Scheme	Required
address	Full address of the Vault cluster.	string	true
key	Key to be used by this validator.	string	true
certificateSecret	Secret containing the CA certificate of the Vault cluster.	*corev1.SecretKeySelector	false
tokenSecret	Secret containing the token to be used.	*corev1.SecretKeySelector	true
uploadGenerated	UploadGenerated indicates if the controller should upload the generated private key to vault. Defaults to false. Will be set to true if this validator is initializing a new genesis. This should not be used in production.	bool	false
autoRenewToken	Whether to automatically renew vault token. Defaults to false.	bool	false
skipCertificateVerify	Whether to skip certificate verification. Defaults to false.	bool	false

Back to Custom Resources

TmKmsKeyFormat

TmKmsKeyFormat represents key format for tmKMS.

Field	Description	Scheme	Required
type	Key type	string	true
account_key_prefix	Account keys prefixes	string	true
consensus_key_prefix	Consensus keys prefix	string	true

Back to Custom Resources

TmKmsProvider

TmKmsProvider allows configuring providers for tmKMS. Note that only one should be configured.

Field	Description	Scheme	Required
hashicorp	Hashicorp provider.	*TmKmsHashicorpProvider	false

Back to Custom Resources

Upgrade

Upgrade represents an upgrade processed by cosmopilot and added to status.

Field	Description	Scheme	Required
height	Height at which the upgrade should occur.	int64	true
image	Container image replacement to be used in the upgrade.	string	true
status	Upgrade status.	UpgradePhase	true
source	Where cosmopilot got this upgrade from.	UpgradeSource	true

Back to Custom Resources

UpgradeSpec

UpgradeSpec represents a manual upgrade.

Field	Description	Scheme	Required
height	Height at which the upgrade should occur.	int64	true
image	Container image replacement to be used in the upgrade.	string	true
forceOnChain	Whether to force this upgrade to be processed as a gov planned upgrade. Defaults to false.	*bool	false

Back to Custom Resources

ValidatorInfo

ValidatorInfo contains information about this validator.

Field	Description	Scheme	Required
moniker	Moniker to be used by this validator. Defaults to the ChainNode name.	*string	false
details	Details of this validator.	*string	false
website	Website of the validator.	*string	false
identity	Identity signature of this validator.	*string	false

Back to Custom Resources

VolumeSnapshotsConfig

VolumeSnapshotsConfig holds the configuration of snapshotting feature.

Field	Description	Scheme	Required
frequency	How often a snapshot should be created.	string	true
retention	How long a snapshot should be retained. Default is indefinite retention.	*string	false
snapshotClass	Name of the volume snapshot class to be used. Uses the default class if not specified.	*string	false
stopNode	Whether the node should be stopped while the snapshot is taken. Defaults to false.	*bool	false
exportTarball	Whether to create a tarball of data directory in each snapshot and upload it to external storage.	*ExportTarballConfig	false
verify	Whether cosmopilot should verify the snapshot for corruption after it is ready. Defaults to false.	*bool	false
disableWhileSyncing	Whether to disable snapshots while the node is syncing	*bool	false

Back to Custom Resources

VolumeSpec

Field	Description	Scheme	Required
name	The name of the volume.	string	true
size	Size of the volume.	string	true
path	The path at which this volume should be mounted	string	true
storageClass	Name of the storage class to use for this volume. Uses the default class if not specified.	*string	false
deleteWithNode	Whether this volume should be deleted when node is deleted. Defaults to false.	*bool	false

Back to Custom Resources