Documentation
¶
Index ¶
- func SetSSHClientCreator(creator SSHClientCreator)
- func ValidateHostName(name string) bool
- type AuthOptionsV1
- type Host
- func (h *Host) AuthOptions() *auth.Options
- func (h *Host) ConfigureAuth() error
- func (h *Host) CreateSSHClient() (ssh.Client, error)
- func (h *Host) Kill() error
- func (h *Host) Provision() error
- func (h *Host) Restart() error
- func (h *Host) RunSSHCommand(command string) (string, error)
- func (h *Host) Start() error
- func (h *Host) Stop() error
- func (h *Host) URL() (string, error)
- func (h *Host) Upgrade() error
- func (h *Host) WaitForDocker() error
- type Metadata
- type MetadataV0
- type Options
- type OptionsV1
- type RawDataDriver
- type RawHost
- type SSHClientCreator
- type StandardSSHClientCreator
- type V0
- type V1
- type V2
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SetSSHClientCreator ¶ added in v0.6.0
func SetSSHClientCreator(creator SSHClientCreator)
func ValidateHostName ¶
func ValidateHostName(name string) bool
Types ¶
type AuthOptionsV1 ¶
type AuthOptionsV1 struct {
StorePath string
CaCertPath string
CaCertRemotePath string
ServerCertPath string
ServerKeyPath string
ClientKeyPath string
ServerCertRemotePath string
ServerKeyRemotePath string
PrivateKeyPath string
ClientCertPath string
}
type Host ¶
type Host struct {
ConfigVersion int
Driver drivers.Driver
DriverName string
HostOptions *Options
Name string
RawDriver []byte `json:"-"`
}
func MigrateHost ¶
func MigrateHost(h *Host, data []byte) (*Host, bool, error)
func MigrateHostV2ToHostV3 ¶
func MigrateHostV2ToHostV3(hostV2 *V2, data []byte, storePath string) *Host
func (*Host) AuthOptions ¶ added in v0.5.3
func (h *Host) AuthOptions() *auth.Options
func (*Host) ConfigureAuth ¶
func (h *Host) ConfigureAuth() error
func (*Host) CreateSSHClient ¶
func (h *Host) CreateSSHClient() (ssh.Client, error)
func (*Host) RunSSHCommand ¶
func (h *Host) RunSSHCommand(command string) (string, error)
func (*Host) WaitForDocker ¶ added in v0.6.0
func (h *Host) WaitForDocker() error
type Metadata ¶ added in v0.5.1
type Metadata struct {
ConfigVersion int
DriverName string
HostOptions Options
}
func MigrateHostMetadataV0ToHostMetadataV1 ¶
func MigrateHostMetadataV0ToHostMetadataV1(m *MetadataV0) *Metadata
MigrateHostMetadataV0ToHostMetadataV1 fills nested host metadata and modifies if needed this is used for configuration updates
type MetadataV0 ¶ added in v0.5.1
type MetadataV0 struct {
HostOptions Options
DriverName string
ConfigVersion int
StorePath string
CaCertPath string
PrivateKeyPath string
ServerCertPath string
ServerKeyPath string
ClientCertPath string
}
type Options ¶ added in v0.5.1
type Options struct {
Driver string
Memory int
Disk int
EngineOptions *engine.Options
SwarmOptions *swarm.Options
AuthOptions *auth.Options
}
type OptionsV1 ¶ added in v0.5.1
type OptionsV1 struct {
Driver string
Memory int
Disk int
EngineOptions *engine.Options
SwarmOptions *swarm.Options
AuthOptions *AuthOptionsV1
}
type RawDataDriver ¶
type RawDataDriver struct {
*none.Driver
Data []byte // passed directly back when invoking json.Marshal on this type
}
func (*RawDataDriver) MarshalJSON ¶
func (r *RawDataDriver) MarshalJSON() ([]byte, error)
func (*RawDataDriver) UnmarshalJSON ¶ added in v0.5.2
func (r *RawDataDriver) UnmarshalJSON(data []byte) error
type SSHClientCreator ¶ added in v0.6.0
type SSHClientCreator interface {
CreateSSHClient(d drivers.Driver) (ssh.Client, error)
}
type StandardSSHClientCreator ¶ added in v0.6.0
type StandardSSHClientCreator struct {
drivers.Driver
}
func (*StandardSSHClientCreator) CreateSSHClient ¶ added in v0.6.0
func (creator *StandardSSHClientCreator) CreateSSHClient(d drivers.Driver) (ssh.Client, error)
type V0 ¶ added in v0.5.1
type V0 struct {
Name string `json:"-"`
Driver drivers.Driver
DriverName string
ConfigVersion int
HostOptions *Options
StorePath string
CaCertPath string
PrivateKeyPath string
ServerCertPath string
ServerKeyPath string
ClientCertPath string
SwarmHost string
SwarmMaster bool
SwarmDiscovery string
ClientKeyPath string
}
type V1 ¶ added in v0.5.1
type V1 struct {
ConfigVersion int
Driver drivers.Driver
DriverName string
HostOptions *OptionsV1
Name string `json:"-"`
StorePath string
}
func MigrateHostV0ToHostV1 ¶
func MigrateHostV0ToHostV1(hostV0 *V0) *V1
MigrateHostV0ToHostV1 validates host config and modifies if needed this is used for configuration updates
type V2 ¶ added in v0.5.1
type V2 struct {
ConfigVersion int
Driver drivers.Driver
DriverName string
HostOptions *Options
Name string
}
func MigrateHostV1ToHostV2 ¶
func MigrateHostV1ToHostV2(hostV1 *V1) *V2
Click to show internal directories.
Click to hide internal directories.