Documentation
¶
Overview ¶
Package ssh provides SSH client utilities for remote node management.
Package ssh provides SSH operations for remote host management.
Index ¶
- func ComposeSSHSetupWarpRelayer(host *models.Host, relayerVersion string) error
- func PostOverSSH(host *models.Host, path string, requestBody string) ([]byte, error)
- func RunOverSSH(scriptDesc string, host *models.Host, timeout time.Duration, scriptPath string, ...) error
- func RunSSHBuildLoadTestCode(host *models.Host, ...) error
- func RunSSHBuildLoadTestDependencies(host *models.Host) error
- func RunSSHCheckBootstrapped(host *models.Host) ([]byte, error)
- func RunSSHCheckHealthy(host *models.Host) ([]byte, error)
- func RunSSHCheckLuxdVersion(host *models.Host) ([]byte, error)
- func RunSSHCopyMonitoringDashboards(host *models.Host, monitoringDashboardPath string) error
- func RunSSHCopyYAMLFile(host *models.Host, yamlFilePath string) error
- func RunSSHCreatePlugin(host *models.Host, sc models.Sidecar) error
- func RunSSHDownloadFile(host *models.Host, filePath string, localFilePath string) error
- func RunSSHDownloadNodePrometheusConfig(host *models.Host, nodeInstanceDirPath string) error
- func RunSSHGetNewEVMRelease(host *models.Host, evmReleaseURL, evmArchive string) error
- func RunSSHGetNodeID(host *models.Host) ([]byte, error)
- func RunSSHRenderLuxNodeConfig(app *application.Lux, host *models.Host, network models.Network, ...) error
- func RunSSHRenderLuxdAliasConfigFile(host *models.Host, blockchainID string, subnetAliases []string) error
- func RunSSHRestartNode(host *models.Host) error
- func RunSSHRunLoadTest(host *models.Host, loadTestCommand, loadTestName string) error
- func RunSSHSetupDevNet(host *models.Host, nodeInstanceDirPath string) error
- func RunSSHSetupDockerService(host *models.Host) error
- func RunSSHSetupLokiConfig(host *models.Host, port int) error
- func RunSSHSetupMonitoringFolders(host *models.Host) error
- func RunSSHSetupNode(host *models.Host, configPath string) error
- func RunSSHSetupPrometheusConfig(host *models.Host, luxdPorts, machinePorts, loadTestPorts []string) error
- func RunSSHSetupPromtailConfig(host *models.Host, lokiIP string, lokiPort int, cloudID string, nodeID string, ...) error
- func RunSSHStartNode(host *models.Host) error
- func RunSSHStartWarpRelayerService(host *models.Host) error
- func RunSSHStopNode(host *models.Host) error
- func RunSSHStopWarpRelayerService(host *models.Host) error
- func RunSSHSubnetSyncStatus(host *models.Host, blockchainID string) ([]byte, error)
- func RunSSHSyncSubnetData(app *application.Lux, host *models.Host, network models.Network, ...) error
- func RunSSHUpdateMonitoringDashboards(host *models.Host, ...) error
- func RunSSHUpgradeLuxgo(host *models.Host, luxdVersion string) error
- func RunSSHUploadNodeWarpRelayerConfig(host *models.Host, nodeInstanceDirPath string) error
- func RunSSHUploadStakingFiles(host *models.Host, nodeInstanceDirPath string) error
- func RunSSHUpsizeRootDisk(host *models.Host) error
- func RunSSHWhitelistPubKey(host *models.Host, sshPubKey string) error
- func StreamOverSSH(scriptDesc string, host *models.Host, timeout time.Duration, scriptPath string, ...) error
- type HostInstaller
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ComposeSSHSetupWarpRelayer ¶
ComposeSSHSetupWarpRelayer used docker compose to setup AWM Relayer
func PostOverSSH ¶
PostOverSSH sends a POST request over SSH to the specified path.
func RunOverSSH ¶
func RunOverSSH( scriptDesc string, host *models.Host, timeout time.Duration, scriptPath string, templateVars scriptInputs, ) error
RunOverSSH runs provided script path over ssh. This script can be template as it will be rendered using scriptInputs vars
func RunSSHBuildLoadTestCode ¶
func RunSSHBuildLoadTestCode(host *models.Host, loadTestRepo, loadTestPath, loadTestGitCommit, repoDirName, loadTestBranch string, checkoutCommit bool) error
RunSSHBuildLoadTestCode builds load test code on the remote host.
func RunSSHBuildLoadTestDependencies ¶
RunSSHBuildLoadTestDependencies builds load test dependencies on the remote host.
func RunSSHCheckBootstrapped ¶
RunSSHCheckBootstrapped checks if node is bootstrapped to primary network
func RunSSHCheckHealthy ¶
RunSSHCheckHealthy checks if node is healthy
func RunSSHCheckLuxdVersion ¶
RunSSHCheckLuxdVersion checks node luxd version
func RunSSHCopyMonitoringDashboards ¶
RunSSHCopyMonitoringDashboards copies monitoring dashboards to the remote host.
func RunSSHCopyYAMLFile ¶
RunSSHCopyYAMLFile copies a YAML file to the remote host.
func RunSSHCreatePlugin ¶
RunSSHCreatePlugin runs script to create plugin
func RunSSHDownloadFile ¶
RunSSHDownloadFile downloads specified file from the specified host
func RunSSHDownloadNodePrometheusConfig ¶
RunSSHDownloadNodePrometheusConfig downloads Prometheus config from the remote host.
func RunSSHGetNewEVMRelease ¶ added in v1.21.40
RunSSHGetNewEVMRelease runs script to download new subnet evm
func RunSSHGetNodeID ¶
RunSSHGetNodeID reads nodeID from luxd
func RunSSHRenderLuxNodeConfig ¶
func RunSSHRenderLuxNodeConfig( app *application.Lux, host *models.Host, network models.Network, trackSubnets []string, isAPIHost bool, ) error
RunSSHRenderLuxNodeConfig renders lux node config to a remote host via SSH.
func RunSSHRenderLuxdAliasConfigFile ¶
func RunSSHRenderLuxdAliasConfigFile( host *models.Host, blockchainID string, subnetAliases []string, ) error
RunSSHRenderLuxdAliasConfigFile renders lux alias config to a remote host via SSH.
func RunSSHRestartNode ¶
RunSSHRestartNode runs script to restart luxd
func RunSSHRunLoadTest ¶
RunSSHRunLoadTest runs a load test on the remote host.
func RunSSHSetupDevNet ¶
RunSSHSetupDevNet runs script to setup devnet
func RunSSHSetupDockerService ¶
RunSSHSetupDockerService runs script to setup docker compose service for CLI
func RunSSHSetupLokiConfig ¶
RunSSHSetupLokiConfig sets up Loki configuration on the remote host.
func RunSSHSetupMonitoringFolders ¶
RunSSHSetupMonitoringFolders creates monitoring folders on the remote host.
func RunSSHSetupNode ¶
RunSSHSetupNode runs script to setup node
func RunSSHSetupPrometheusConfig ¶
func RunSSHSetupPrometheusConfig(host *models.Host, luxdPorts, machinePorts, loadTestPorts []string) error
RunSSHSetupPrometheusConfig sets up Prometheus configuration on the remote host.
func RunSSHSetupPromtailConfig ¶
func RunSSHSetupPromtailConfig(host *models.Host, lokiIP string, lokiPort int, cloudID string, nodeID string, chainID string) error
RunSSHSetupPromtailConfig sets up Promtail configuration on the remote host.
func RunSSHStartNode ¶
RunSSHStartNode runs script to start luxd
func RunSSHStartWarpRelayerService ¶
RunSSHStartWarpRelayerService runs script to start an AWM Relayer Service
func RunSSHStopNode ¶
RunSSHStopNode runs script to stop luxd
func RunSSHStopWarpRelayerService ¶
RunSSHStopWarpRelayerService runs script to start an AWM Relayer Service
func RunSSHSubnetSyncStatus ¶
RunSSHSubnetSyncStatus checks if node is synced to subnet.
func RunSSHSyncSubnetData ¶
func RunSSHSyncSubnetData(app *application.Lux, host *models.Host, network models.Network, subnetName string) error
RunSSHSyncSubnetData syncs subnet data required
func RunSSHUpdateMonitoringDashboards ¶
func RunSSHUpdateMonitoringDashboards(host *models.Host, monitoringDashboardPath, customGrafanaDashboardPath, chainID string) error
RunSSHUpdateMonitoringDashboards updates monitoring dashboards on the remote host.
func RunSSHUpgradeLuxgo ¶
RunSSHUpgradeLuxgo runs script to upgrade luxd
func RunSSHUploadNodeWarpRelayerConfig ¶
RunSSHUploadNodeWarpRelayerConfig uploads warp relayer config to the remote host.
func RunSSHUploadStakingFiles ¶
RunSSHUploadStakingFiles uploads staking files to a remote host via SSH.
func RunSSHUpsizeRootDisk ¶
RunSSHUpsizeRootDisk resizes the root disk on the remote host.
func RunSSHWhitelistPubKey ¶
RunSSHWhitelistPubKey downloads the authorized_keys file from the specified host, appends the provided sshPubKey to it, and uploads the file back to the host.
Types ¶
type HostInstaller ¶
HostInstaller handles installation operations on remote hosts.
func NewHostInstaller ¶
func NewHostInstaller(host *models.Host) *HostInstaller
NewHostInstaller creates a new host installer.
func (*HostInstaller) GetArch ¶
func (h *HostInstaller) GetArch() (string, string)
GetArch returns the architecture and OS of the remote host.
Source Files