v1alpha1

Documentation

Overview

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

Index

• Constants
• Variables
• type APICredentials
  • func (in *APICredentials) DeepCopy() *APICredentials
  • func (in *APICredentials) DeepCopyInto(out *APICredentials)
• 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) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *Node) ValidateCreate() error
  • func (r *Node) ValidateDelete() error
  • func (r *Node) ValidateUpdate(old runtime.Object) 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)

Constants

const (
	// DefaultAPIPort is the default API and GUI port
	DefaultAPIPort uint = 6688
	// DefaultTLSPort is the default tls port
	DefaultTLSPort uint = 6689
	// DefaultP2PPort is the default p2p port
	DefaultP2PPort uint = 30303
)

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

	// DefaultNodeMemoryRequest is the memory requested by chainlink node
	DefaultNodeMemoryRequest = "2Gi"
	// DefaultNodeMemoryLimit is the memory limit for chainlink node
	DefaultNodeMemoryLimit = "4Gi"

	// DefaultNodeStorageRequest is the Storage requested by chainlink node
	DefaultNodeStorageRequest = "20Gi"
)

Resources

const (
	// DefaultChainlinkImage is the default chainlink client image
	DefaultChainlinkImage = "kotalco/chainlink:v2.2.0"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "chainlink.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
)

var (
	// DefaultCorsDomains is the default cors domains from which to accept requests
	DefaultCorsDomains = []string{"*"}
)

Types

type APICredentials

type APICredentials struct {
	// Email is user email
	Email string `json:"email"`
	// PasswordSecretName is the k8s secret name that holds password
	PasswordSecretName string `json:"passwordSecretName"`
}

APICredentials is api credentials

func (*APICredentials) DeepCopy

func (in *APICredentials) DeepCopy() *APICredentials

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

func (*APICredentials) DeepCopyInto

func (in *APICredentials) DeepCopyInto(out *APICredentials)

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

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 +kubebuilder:printcolumn:name="Client",type=string,JSONPath=".status.client" +kubebuilder:printcolumn:name="EthereumChainId",type=number,JSONPath=".spec.ethereumChainId" +kubebuilder:printcolumn:name="LinkContractAddress",type=string,JSONPath=".spec.linkContractAddress",priority=10

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) SetupWebhookWithManager

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

func (*Node) ValidateCreate

func (r *Node) ValidateCreate() error

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

func (*Node) ValidateDelete

func (r *Node) ValidateDelete() error

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

func (*Node) ValidateUpdate

func (r *Node) ValidateUpdate(old runtime.Object) 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 Chainlink node client image
	Image string `json:"image,omitempty"`
	// EthereumChainId is ethereum chain id
	EthereumChainId uint `json:"ethereumChainId"`
	// EthereumWSEndpoint is ethereum websocket endpoint
	EthereumWSEndpoint string `json:"ethereumWsEndpoint"`
	// EthereumHTTPEndpoints is ethereum http endpoints
	// +listType=set
	EthereumHTTPEndpoints []string `json:"ethereumHttpEndpoints,omitempty"`
	// LinkContractAddress is link contract address
	LinkContractAddress string `json:"linkContractAddress"`
	// DatabaseURL is postgres database connection URL
	DatabaseURL string `json:"databaseURL"`
	// KeystorePasswordSecretName is k8s secret name that holds keystore password
	KeystorePasswordSecretName string `json:"keystorePasswordSecretName"`
	// APICredentials is api credentials
	APICredentials APICredentials `json:"apiCredentials"`
	// CORSDomains is the domains from which to accept cross origin requests
	// +listType=set
	CORSDomains []string `json:"corsDomains,omitempty"`
	// CertSecretName is k8s secret name that holds tls.key and tls.cert
	CertSecretName string `json:"certSecretName,omitempty"`
	// TLSPort is port used for HTTPS connections
	TLSPort uint `json:"tlsPort,omitempty"`
	// P2PPort is port used for p2p communcations
	P2PPort uint `json:"p2pPort,omitempty"`
	// API enables node API server
	API bool `json:"api,omitempty"`
	// APIPort is port used for node API and GUI
	APIPort uint `json:"apiPort,omitempty"`
	// SecureCookies enables secure cookies for authentication
	SecureCookies bool `json:"secureCookies,omitempty"`
	// Logging is logging verboisty level
	// +kubebuilder:validation:Enum=debug;info;warn;error;panic
	Logging shared.VerbosityLevel `json:"logging,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 {
	Client string `json:"client,omitempty"`
}

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.