ssh

Documentation

Index

• Constants
• type OutputFormatType
• type SshDeployer
  • func New(config *SshDeployerConfig) (*SshDeployer, error)
  • func NewWithLogger(config *SshDeployerConfig, logger deployer.Logger) (*SshDeployer, error)
  • func (d *SshDeployer) Deploy(ctx context.Context, certPem string, privkeyPem string) (*deployer.DeployResult, error)
• type SshDeployerConfig

Constants

const (
	OUTPUT_FORMAT_PEM = OutputFormatType("PEM")
	OUTPUT_FORMAT_PFX = OutputFormatType("PFX")
	OUTPUT_FORMAT_JKS = OutputFormatType("JKS")
)

Types

type OutputFormatType

type OutputFormatType string

type SshDeployer

type SshDeployer struct {
	// contains filtered or unexported fields
}

func New

func New(config *SshDeployerConfig) (*SshDeployer, error)

func NewWithLogger

func NewWithLogger(config *SshDeployerConfig, logger deployer.Logger) (*SshDeployer, error)

func (*SshDeployer) Deploy

func (d *SshDeployer) Deploy(ctx context.Context, certPem string, privkeyPem string) (*deployer.DeployResult, error)

type SshDeployerConfig

type SshDeployerConfig struct {
	// SSH 主机。
	// 零值时默认为 "localhost"。
	SshHost string `json:"sshHost,omitempty"`
	// SSH 端口。
	// 零值时默认为 22。
	SshPort int32 `json:"sshPort,omitempty"`
	// SSH 登录用户名。
	SshUsername string `json:"sshUsername,omitempty"`
	// SSH 登录密码。
	SshPassword string `json:"sshPassword,omitempty"`
	// SSH 登录私钥。
	SshKey string `json:"sshKey,omitempty"`
	// SSH 登录私钥口令。
	SshKeyPassphrase string `json:"sshKeyPassphrase,omitempty"`
	// 前置命令。
	PreCommand string `json:"preCommand,omitempty"`
	// 后置命令。
	PostCommand string `json:"postCommand,omitempty"`
	// 输出证书格式。
	OutputFormat OutputFormatType `json:"outputFormat,omitempty"`
	// 输出证书文件路径。
	OutputCertPath string `json:"outputCertPath,omitempty"`
	// 输出私钥文件路径。
	OutputKeyPath string `json:"outputKeyPath,omitempty"`
	// PFX 导出密码。
	// 证书格式为 PFX 时必填。
	PfxPassword string `json:"pfxPassword,omitempty"`
	// JKS 别名。
	// 证书格式为 JKS 时必填。
	JksAlias string `json:"jksAlias,omitempty"`
	// JKS 密钥密码。
	// 证书格式为 JKS 时必填。
	JksKeypass string `json:"jksKeypass,omitempty"`
	// JKS 存储密码。
	// 证书格式为 JKS 时必填。
	JksStorepass string `json:"jksStorepass,omitempty"`
}