docker

package

v1.21.42 Latest Latest Go to latest Published: Dec 24, 2025 License: BSD-3-Clause Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/luxfi/cli

Links

Open Source Insights

Documentation ¶

Index ¶

func BuildDockerImage(host *models.Host, image string, path string, dockerfile string) error
func BuildDockerImageFromGitRepo(host *models.Host, image string, gitRepo string, commit string) error
func ComposeOverSSH(composeDesc string, host *models.Host, timeout time.Duration, ...) error
func ComposeSSHSetupLoadTest(host *models.Host) error
func ComposeSSHSetupMonitoring(host *models.Host) error
func ComposeSSHSetupNode(host *models.Host, network models.Network, luxdVersion string, ...) error
func ComposeSSHSetupWarpRelayer(host *models.Host, relayerVersion string) error
func DockerLocalImageExists(host *models.Host, image string) (bool, error)
func GetRemoteComposeContent(host *models.Host, composeFile string, timeout time.Duration) (string, error)
func HasRemoteComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) (bool, error)
func InitDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error
func ListRemoteComposeServices(host *models.Host, composeFile string, timeout time.Duration) ([]string, error)
func ParseRemoteComposeContent(host *models.Host, composeFile string, pattern string, timeout time.Duration) (string, error)
func PrepareDockerImageWithRepo(host *models.Host, image string, gitRepo string, commit string) error
func PullDockerImage(host *models.Host, image string) error
func RestartDockerCompose(host *models.Host, timeout time.Duration) error
func RestartDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error
func StartDockerCompose(host *models.Host, timeout time.Duration) error
func StartDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error
func StopDockerCompose(host *models.Host, timeout time.Duration) error
func StopDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error
func ValidateComposeFile(host *models.Host, composeFile string, timeout time.Duration) error
func WasNodeSetupWithMonitoring(host *models.Host) (bool, error)
type DockerComposeInputs
type LuxdConfigOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BuildDockerImage ¶

func BuildDockerImage(host *models.Host, image string, path string, dockerfile string) error

BuildDockerImage builds a docker image on a remote host.

func BuildDockerImageFromGitRepo ¶

func BuildDockerImageFromGitRepo(host *models.Host, image string, gitRepo string, commit string) error

BuildDockerImageFromGitRepo builds a docker image from a git repo on a remote host.

func ComposeOverSSH ¶

func ComposeOverSSH(
	composeDesc string,
	host *models.Host,
	timeout time.Duration,
	composePath string,
	composeVars DockerComposeInputs,
) error

ComposeOverSSH sets up a docker-compose file on a remote host over SSH.

func ComposeSSHSetupLoadTest ¶

func ComposeSSHSetupLoadTest(host *models.Host) error

func ComposeSSHSetupMonitoring ¶

func ComposeSSHSetupMonitoring(host *models.Host) error

ComposeSSHSetupMonitoring sets up monitoring using docker-compose.

func ComposeSSHSetupNode ¶

func ComposeSSHSetupNode(
	host *models.Host,
	network models.Network,
	luxdVersion string,
	luxdBootstrapIDs []string,
	luxdBootstrapIPs []string,
	partialSync bool,
	luxdGenesisFilePath string,
	luxdUpgradeFilePath string,
	withMonitoring bool,
	publicAccessToHTTPPort bool,
) error

ComposeSSHSetupNode sets up an Luxd node and dependencies on a remote host over SSH.

func ComposeSSHSetupWarpRelayer ¶

func ComposeSSHSetupWarpRelayer(host *models.Host, relayerVersion string) error

func DockerLocalImageExists ¶

func DockerLocalImageExists(host *models.Host, image string) (bool, error)

DockerLocalImageExists checks if a docker image exists on a remote host.

func GetRemoteComposeContent ¶

func GetRemoteComposeContent(host *models.Host, composeFile string, timeout time.Duration) (string, error)

GetRemoteComposeContent gets the content of a remote docker-compose file.

func HasRemoteComposeService ¶

func HasRemoteComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) (bool, error)

HasRemoteComposeService checks if a service is present in a remote docker-compose file.

func InitDockerComposeService ¶

func InitDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error

func ListRemoteComposeServices ¶

func ListRemoteComposeServices(host *models.Host, composeFile string, timeout time.Duration) ([]string, error)

ListRemoteComposeServices lists the services in a remote docker-compose file.

func ParseRemoteComposeContent ¶

func ParseRemoteComposeContent(host *models.Host, composeFile string, pattern string, timeout time.Duration) (string, error)

ParseRemoteComposeContent extracts a value from a remote docker-compose file.

func PrepareDockerImageWithRepo ¶

func PrepareDockerImageWithRepo(host *models.Host, image string, gitRepo string, commit string) error

func PullDockerImage ¶

func PullDockerImage(host *models.Host, image string) error

PullDockerImage pulls a docker image on a remote host.

func RestartDockerCompose ¶

func RestartDockerCompose(host *models.Host, timeout time.Duration) error

func RestartDockerComposeService ¶

func RestartDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error

func StartDockerCompose ¶

func StartDockerCompose(host *models.Host, timeout time.Duration) error

func StartDockerComposeService ¶

func StartDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error

func StopDockerCompose ¶

func StopDockerCompose(host *models.Host, timeout time.Duration) error

func StopDockerComposeService ¶

func StopDockerComposeService(host *models.Host, composeFile string, service string, timeout time.Duration) error

func ValidateComposeFile ¶

func ValidateComposeFile(host *models.Host, composeFile string, timeout time.Duration) error

ValidateComposeFile validates a docker-compose file on a remote host.

func WasNodeSetupWithMonitoring ¶

func WasNodeSetupWithMonitoring(host *models.Host) (bool, error)

WasNodeSetupWithMonitoring checks if an Luxd node was setup with monitoring on a remote host.

Types ¶

type DockerComposeInputs ¶

type DockerComposeInputs struct {
	WithMonitoring     bool
	WithLuxgo          bool
	LuxgoVersion       string
	WarpRelayerVersion string
	E2E                bool
	E2EIP              string
	E2ESuffix          string
}

type LuxdConfigOptions ¶

type LuxdConfigOptions struct {
	BootstrapIPs      []string
	BootstrapIDs      []string
	PartialSync       bool
	GenesisPath       string
	UpgradePath       string
	AllowPublicAccess bool
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL