v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the aptos v1alpha1 API group +kubebuilder:object:generate=true +groupName=aptos.kotal.io

Index

• Constants
• Variables
• type AptosNetwork
• type Node
  • func (in *Node) DeepCopy() *Node
  • func (in *Node) DeepCopyInto(out *Node)
  • func (in *Node) DeepCopyObject() runtime.Object
  • func (r *Node) Default()
  • func (r *Node) DefaultNodeResources()
  • func (r *Node) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *Node) ValidateCreate() (admission.Warnings, error)
  • func (r *Node) ValidateDelete() (admission.Warnings, error)
  • func (r *Node) ValidateUpdate(old runtime.Object) (admission.Warnings, error)
• type NodeList
  • func (in *NodeList) DeepCopy() *NodeList
  • func (in *NodeList) DeepCopyInto(out *NodeList)
  • func (in *NodeList) DeepCopyObject() runtime.Object
• type NodeSpec
  • func (in *NodeSpec) DeepCopy() *NodeSpec
  • func (in *NodeSpec) DeepCopyInto(out *NodeSpec)
• type NodeStatus
  • func (in *NodeStatus) DeepCopy() *NodeStatus
  • func (in *NodeStatus) DeepCopyInto(out *NodeStatus)
• type Peer
  • func (in *Peer) DeepCopy() *Peer
  • func (in *Peer) DeepCopyInto(out *Peer)

Constants

const (
	// DefaultNodeCPURequest is the cpu requested by Aptos node
	DefaultNodeCPURequest = "2"
	// DefaultNodeCPULimit is the cpu limit for Aptos node
	DefaultNodeCPULimit = "4"

	// DefaultNodeMemoryRequest is the memory requested by Aptos node
	DefaultNodeMemoryRequest = "4Gi"
	// DefaultNodeMemoryLimit is the memory limit for Aptos node
	DefaultNodeMemoryLimit = "8Gi"

	// DefaultNodeStorageRequest is the Storage requested by Aptos node
	DefaultNodeStorageRequest = "250Gi"
)

Resources

const (
	// DefaltReplicas is the default replicas
	DefaltReplicas uint = 1
	// DefaultMetricsPort is the default metrics server port
	DefaultMetricsPort uint = 9101
	// DefaultAPIPort is the default API server port
	DefaultAPIPort uint = 8080
	// DefaultFullnodeP2PPort is the default full node p2p port
	DefaultFullnodeP2PPort uint = 6182
	// DefaultValidatorP2PPort is the default validator node p2p port
	DefaultValidatorP2PPort uint = 6180
)

const (
	// DefaultAptosCoreImage is the default Aptos core client image
	DefaultAptosCoreImage = "aptoslabs/validator:aptos-node-v1.11.2"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "aptos.kotal.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type AptosNetwork

type AptosNetwork string

AptosNetwork is Aptos network

const (
	Devnet  AptosNetwork = "devnet"
	Mainnet AptosNetwork = "mainnet"
	Testnet AptosNetwork = "testnet"
)

type Node

type Node struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NodeSpec   `json:"spec,omitempty"`
	Status NodeStatus `json:"status,omitempty"`
}

Node is the Schema for the nodes API

func (*Node) DeepCopy

func (in *Node) DeepCopy() *Node

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Node.

func (*Node) DeepCopyInto

func (in *Node) DeepCopyInto(out *Node)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Node) DeepCopyObject

func (in *Node) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Node) Default

func (r *Node) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*Node) DefaultNodeResources

func (r *Node) DefaultNodeResources()

func (*Node) SetupWebhookWithManager

func (r *Node) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Node) ValidateCreate

func (r *Node) ValidateCreate() (admission.Warnings, error)

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Node) ValidateDelete

func (r *Node) ValidateDelete() (admission.Warnings, error)

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Node) ValidateUpdate

func (r *Node) ValidateUpdate(old runtime.Object) (admission.Warnings, error)

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type NodeList

type NodeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Node `json:"items"`
}

NodeList contains a list of Node

func (*NodeList) DeepCopy

func (in *NodeList) DeepCopy() *NodeList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeList.

func (*NodeList) DeepCopyInto

func (in *NodeList) DeepCopyInto(out *NodeList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NodeList) DeepCopyObject

func (in *NodeList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NodeSpec

type NodeSpec struct {
	// Image is Aptos node client image
	Image string `json:"image,omitempty"`
	// ExtraArgs is extra arguments to pass down to the cli
	ExtraArgs shared.ExtraArgs `json:"extraArgs,omitempty"`
	// Replicas is number of replicas
	// +kubebuilder:validation:Enum=0;1
	Replicas *uint `json:"replicas,omitempty"`
	// Network is Aptos network to join and sync
	// +kubebuilder:validation:Enum=devnet;testnet;mainnet
	Network AptosNetwork `json:"network"`
	// Validator enables validator mode
	Validator bool `json:"validator,omitempty"`
	// Waypoint provides an off-chain mechanism to verify the sync process after restart or epoch change
	Waypoint string `json:"waypoint,omitempty"`
	// GenesisConfigmapName is Kubernetes configmap name holding genesis blob
	GenesisConfigmapName string `json:"genesisConfigmapName,omitempty"`
	// NodePrivateKeySecretName is the secret name holding node private key
	NodePrivateKeySecretName string `json:"nodePrivateKeySecretName,omitempty"`
	// PeerId is the node identity
	PeerId string `json:"peerId,omitempty"`
	// SeedPeers is seed peers
	SeedPeers []Peer `json:"seedPeers,omitempty"`
	// API enables REST API server
	API bool `json:"api,omitempty"`
	// APIPort is api server port
	APIPort uint `json:"apiPort,omitempty"`
	// P2PPort is p2p communications port
	P2PPort uint `json:"p2pPort,omitempty"`
	// MetricsPort is metrics server port
	MetricsPort uint `json:"metricsPort,omitempty"`
	// Resources is node compute and storage resources
	shared.Resources `json:"resources,omitempty"`
}

NodeSpec defines the desired state of Node

func (*NodeSpec) DeepCopy

func (in *NodeSpec) DeepCopy() *NodeSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeSpec.

func (*NodeSpec) DeepCopyInto

func (in *NodeSpec) DeepCopyInto(out *NodeSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NodeStatus

type NodeStatus struct {
}

NodeStatus defines the observed state of Node

func (*NodeStatus) DeepCopy

func (in *NodeStatus) DeepCopy() *NodeStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeStatus.

func (*NodeStatus) DeepCopyInto

func (in *NodeStatus) DeepCopyInto(out *NodeStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Peer

type Peer struct {
	// ID is peer identifier
	ID string `json:"id"`
	// Addresses is array of peer multiaddress
	// +listType=set
	// +kubebuilder:validation:MinItems=1
	Addresses []string `json:"addresses"`
}

Peer is Aptos network peer

func (*Peer) DeepCopy

func (in *Peer) DeepCopy() *Peer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Peer.

func (*Peer) DeepCopyInto

func (in *Peer) DeepCopyInto(out *Peer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.