canoe

README

canoe

Documentation

Index

• func Deploy() error
• type Client
  • func NewClient(cfg Config) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) CopyDockerImageToRemote(ctx context.Context, imageID string) error
  • func (c *Client) GetLocatImageID(ctx context.Context, image string) (string, error)
  • func (c *Client) GetRemoteContainerByPort(ctx context.Context, port int) (string, error)
  • func (c *Client) StartRemoteContainer(ctx context.Context, imageName, containerName string, ...) error
  • func (c *Client) StopRemoteContainer(ctx context.Context, containerID string) error
• type Config
  • func LoadConfig(sshhost string) (Config, error)
  • func (cfg Config) SSHURL() string
• type SSHConfig
  • func LoadSSHConfig(host string) (SSHConfig, error)

Functions

func Deploy

func Deploy() error

Types

type Client

type Client struct {
	DockerLocal  *docker.Client
	DockerRemote *docker.Client
	SSH          *ssh.Client
	SFTP         *sftp.Client
}

func NewClient

func NewClient(cfg Config) (*Client, error)

func (*Client) Close

func (c *Client) Close()

func (*Client) CopyDockerImageToRemote

func (c *Client) CopyDockerImageToRemote(ctx context.Context, imageID string) error

func (*Client) GetLocatImageID

func (c *Client) GetLocatImageID(ctx context.Context, image string) (string, error)

func (*Client) GetRemoteContainerByPort

func (c *Client) GetRemoteContainerByPort(ctx context.Context, port int) (string, error)

func (*Client) StartRemoteContainer

func (c *Client) StartRemoteContainer(ctx context.Context, imageName, containerName string, privatePort, publishPort int) error

func (*Client) StopRemoteContainer

func (c *Client) StopRemoteContainer(ctx context.Context, containerID string) error

type Config

type Config struct {
	SSH SSHConfig
}

func LoadConfig

func LoadConfig(sshhost string) (Config, error)

func (Config) SSHURL

func (cfg Config) SSHURL() string

type SSHConfig

type SSHConfig struct {
	Host           string
	User           string
	Port           string
	PrivateKeyPath string
}

func LoadSSHConfig

func LoadSSHConfig(host string) (SSHConfig, error)