Documentation
¶
Overview ¶
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2023, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.
Index ¶
- Constants
- Variables
- func HostAnsibleIDToCloudID(hostAnsibleID string) (string, string, error)
- func HostCloudIDToAnsibleID(cloudService string, hostCloudID string) (string, error)
- func NewHostConnection(h *Host) (*goph.Client, error)
- func SplitHTTPResponse(response []byte) ([]byte, []byte)
- type AvagoCompatiblity
- type ClusterConfig
- type ClustersConfig
- type ClustersConfigV0
- type ElasticSubnet
- type ElasticSubnetConfig
- type Exportable
- type GCPConfig
- type Host
- func (h *Host) Command(script string, env []string, timeout time.Duration) ([]byte, error)
- func (h *Host) Connect() error
- func (h *Host) Connected() bool
- func (h *Host) Disconnect() error
- func (h *Host) Download(remoteFile string, localFile string, timeout time.Duration) error
- func (h *Host) Forward(httpRequest string, timeout time.Duration) ([]byte, []byte, error)
- func (h *Host) GetAnsibleInventoryRecord() string
- func (h *Host) GetCloudID() string
- func (h *Host) MkdirAll(remoteDir string, timeout time.Duration) error
- func (h *Host) UntimedForward(httpRequest string) ([]byte, []byte, error)
- func (h *Host) UntimedMkdirAll(remoteDir string) error
- func (h *Host) Upload(localFile string, remoteFile string, timeout time.Duration) error
- func (h *Host) WaitForSSHPort(timeout time.Duration) error
- func (h *Host) WaitForSSHShell(timeout time.Duration) error
- type Network
- type NetworkData
- type NetworkKind
- type NodeConfig
- type NodeResult
- type NodeResults
- func (nr *NodeResults) AddResult(nodeID string, value interface{}, err error)
- func (nr *NodeResults) GetErrorHostMap() map[string]error
- func (nr *NodeResults) GetErrorHosts() []string
- func (nr *NodeResults) GetNodeList() []string
- func (nr *NodeResults) GetResultMap() map[string]interface{}
- func (nr *NodeResults) GetResults() []NodeResult
- func (nr *NodeResults) HasErrors() bool
- func (nr *NodeResults) HasNodeIDWithError(nodeID string) bool
- func (nr *NodeResults) Len() int
- type PermissionlessValidators
- type Sidecar
- type VMCompatibility
- type VMType
Constants ¶
const ( SubnetEvm = "Subnet-EVM" BlobVM = "Blob VM" TimestampVM = "Timestamp VM" CustomVM = "Custom" )
Variables ¶
var ( UndefinedNetwork = NewNetwork(Undefined, 0, "") LocalNetwork = NewNetwork(Local, constants.LocalNetworkID, constants.LocalAPIEndpoint) DevnetNetwork = NewNetwork(Devnet, constants.DevnetNetworkID, constants.DevnetAPIEndpoint) FujiNetwork = NewNetwork(Fuji, avagoconstants.FujiID, constants.FujiAPIEndpoint) MainnetNetwork = NewNetwork(Mainnet, avagoconstants.MainnetID, constants.MainnetAPIEndpoint) )
Functions ¶
func HostAnsibleIDToCloudID ¶ added in v1.3.4
func HostCloudIDToAnsibleID ¶ added in v1.3.4
func SplitHTTPResponse ¶ added in v1.3.4
splitHTTPResponse splits an HTTP response into headers and body.
Types ¶
type AvagoCompatiblity ¶ added in v1.0.1
type ClusterConfig ¶ added in v1.2.7
type ClustersConfig ¶ added in v1.3.4
type ClustersConfigV0 ¶ added in v1.3.4
type ElasticSubnet ¶ added in v1.2.0
type ElasticSubnetConfig ¶ added in v1.2.0
type ElasticSubnetConfig struct {
SubnetID ids.ID
AssetID ids.ID
InitialSupply uint64
MaxSupply uint64
MinConsumptionRate uint64
MaxConsumptionRate uint64
MinValidatorStake uint64
MaxValidatorStake uint64
MinStakeDuration time.Duration
MaxStakeDuration time.Duration
MinDelegationFee uint32
MinDelegatorStake uint64
MaxValidatorWeightFactor byte
UptimeRequirement uint32
}
type Exportable ¶ added in v0.2.0
type Host ¶ added in v1.3.3
type Host struct {
NodeID string
IP string
SSHUser string
SSHPrivateKeyPath string
SSHCommonArgs string
Connection *goph.Client
}
func (*Host) Connect ¶ added in v1.3.4
Connect starts a new SSH connection with the provided private key.
func (*Host) Disconnect ¶ added in v1.3.4
func (*Host) Download ¶ added in v1.3.4
Download downloads a file from the remote server to the local machine.
func (*Host) GetAnsibleInventoryRecord ¶ added in v1.3.3
func (*Host) GetCloudID ¶ added in v1.3.4
GetCloudID returns the node ID of the host.
func (*Host) UntimedForward ¶ added in v1.3.4
UntimedForward forwards the TCP connection to a remote address. Does not support timeouts on the operation.
func (*Host) UntimedMkdirAll ¶ added in v1.3.4
UntimedMkdirAll creates a folder on the remote server. Does not support timeouts on the operation.
func (*Host) WaitForSSHPort ¶ added in v1.3.4
WaitForSSHPort waits for the SSH port to become available on the host.
type Network ¶
type Network struct {
Kind NetworkKind
ID uint32
Endpoint string
}
func NetworkFromNetworkID ¶ added in v1.0.0
func NetworkFromString ¶
func NewDevnetNetwork ¶ added in v1.3.4
func NewNetwork ¶ added in v1.3.4
func NewNetwork(kind NetworkKind, id uint32, endpoint string) Network
func (Network) CChainEndpoint ¶ added in v1.3.4
func (Network) NetworkIDFlagValue ¶ added in v1.3.4
type NetworkData ¶ added in v0.2.0
type NetworkKind ¶ added in v1.3.4
type NetworkKind int64
const ( Undefined NetworkKind = iota Mainnet Fuji Local Devnet )
func (NetworkKind) String ¶ added in v1.3.4
func (nk NetworkKind) String() string
type NodeConfig ¶ added in v1.2.7
type NodeConfig struct {
NodeID string // instance id on cloud server
Region string // region where cloud server instance is deployed
AMI string // image id for cloud server dependent on its os (e.g. ubuntu )and region deployed (e.g. us-east-1)
KeyPair string // key pair name used on cloud server
CertPath string // where the cert is stored in user's local machine ssh directory
SecurityGroup string // security group used on cloud server
ElasticIP string // public IP address of the cloud server
CloudService string // which cloud service node is hosted on (AWS / GCP)
}
type NodeResult ¶ added in v1.3.4
type NodeResults ¶ added in v1.3.4
type NodeResults struct {
Results []NodeResult
Lock sync.Mutex
}
func (*NodeResults) AddResult ¶ added in v1.3.4
func (nr *NodeResults) AddResult(nodeID string, value interface{}, err error)
func (*NodeResults) GetErrorHostMap ¶ added in v1.3.4
func (nr *NodeResults) GetErrorHostMap() map[string]error
func (*NodeResults) GetErrorHosts ¶ added in v1.3.4
func (nr *NodeResults) GetErrorHosts() []string
func (*NodeResults) GetNodeList ¶ added in v1.3.4
func (nr *NodeResults) GetNodeList() []string
func (*NodeResults) GetResultMap ¶ added in v1.3.4
func (nr *NodeResults) GetResultMap() map[string]interface{}
func (*NodeResults) GetResults ¶ added in v1.3.4
func (nr *NodeResults) GetResults() []NodeResult
func (*NodeResults) HasErrors ¶ added in v1.3.4
func (nr *NodeResults) HasErrors() bool
func (*NodeResults) HasNodeIDWithError ¶ added in v1.3.4
func (nr *NodeResults) HasNodeIDWithError(nodeID string) bool
func (*NodeResults) Len ¶ added in v1.3.4
func (nr *NodeResults) Len() int
type PermissionlessValidators ¶ added in v1.2.1
type Sidecar ¶
type Sidecar struct {
Name string
VM VMType
VMVersion string
RPCVersion int
Subnet string
TokenName string
ChainID string
Version string
Networks map[string]NetworkData
ElasticSubnet map[string]ElasticSubnet
ImportedFromAPM bool
ImportedVMID string
CustomVMRepoURL string
CustomVMBranch string
CustomVMBuildScript string
}