instance

Documentation

Index

• func FormatSSHKeyToTag(publicKey string) string
• func GetCommands() *core.Commands
• func GetGeneratedCommands() *core.Commands
• type SSHKeyFormat
• type ServerBuilder
  • func NewServerBuilder(client *scw.Client, name string, zone scw.Zone, commercialType string) *ServerBuilder
  • func (sb *ServerBuilder) AddAdminPasswordEncryptionSSHKeyID(adminPasswordEncryptionSSHKeyID *string) *ServerBuilder
  • func (sb *ServerBuilder) AddBootType(bootType string) *ServerBuilder
  • func (sb *ServerBuilder) AddEnableIPv6(enableIPv6 *bool) *ServerBuilder
  • func (sb *ServerBuilder) AddIP(ip string) (*ServerBuilder, error)
  • func (sb *ServerBuilder) AddImage(image string) (*ServerBuilder, error)
  • func (sb *ServerBuilder) AddOrganizationID(orgID *string) *ServerBuilder
  • func (sb *ServerBuilder) AddPlacementGroup(placementGroupID string) *ServerBuilder
  • func (sb *ServerBuilder) AddProjectID(projectID *string) *ServerBuilder
  • func (sb *ServerBuilder) AddRoutedIPEnabled(routedIPEnabled *bool) *ServerBuilder
  • func (sb *ServerBuilder) AddSecurityGroup(securityGroupID string) *ServerBuilder
  • func (sb *ServerBuilder) AddTags(tags []string) *ServerBuilder
  • func (sb *ServerBuilder) AddVolumes(rootVolume string, additionalVolumes []string) (*ServerBuilder, error)
  • func (sb *ServerBuilder) Build() (*instance.CreateServerRequest, *instance.CreateIPRequest)
  • func (sb *ServerBuilder) Validate() error
  • func (sb *ServerBuilder) ValidateVolumes() error
• type ServerGetRdpPasswordResponse

Functions

func FormatSSHKeyToTag

func FormatSSHKeyToTag(publicKey string) string

func GetCommands

func GetCommands() *core.Commands

GetCommands returns instance commands.

This function: - Gets the generated commands - Register handwritten marshalers - Apply handwritten overrides (of Command.Run and Command.View) - Merge handwritten commands

func GetGeneratedCommands

func GetGeneratedCommands() *core.Commands

Types

type SSHKeyFormat

type SSHKeyFormat struct {
	Name string `json:"name"`
	Type string `json:"type"`
	Key  string `json:"key"`
}

type ServerBuilder

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

func NewServerBuilder

func NewServerBuilder(client *scw.Client, name string, zone scw.Zone, commercialType string) *ServerBuilder

func (*ServerBuilder) AddAdminPasswordEncryptionSSHKeyID

func (sb *ServerBuilder) AddAdminPasswordEncryptionSSHKeyID(adminPasswordEncryptionSSHKeyID *string) *ServerBuilder

func (*ServerBuilder) AddBootType

func (sb *ServerBuilder) AddBootType(bootType string) *ServerBuilder

func (*ServerBuilder) AddEnableIPv6

func (sb *ServerBuilder) AddEnableIPv6(enableIPv6 *bool) *ServerBuilder

func (*ServerBuilder) AddIP

func (sb *ServerBuilder) AddIP(ip string) (*ServerBuilder, error)

AddIP takes an ip argument and change requests accordingly. ip could be:

• "new"
• A flexible IP UUID
• A flexible IP address
• "dynamic"
• "none"

func (*ServerBuilder) AddImage

func (sb *ServerBuilder) AddImage(image string) (*ServerBuilder, error)

AddImage handle a custom image argument. image could be:

• A local image UUID.
• An image label.

func (*ServerBuilder) AddOrganizationID

func (sb *ServerBuilder) AddOrganizationID(orgID *string) *ServerBuilder

func (*ServerBuilder) AddPlacementGroup

func (sb *ServerBuilder) AddPlacementGroup(placementGroupID string) *ServerBuilder

func (*ServerBuilder) AddProjectID

func (sb *ServerBuilder) AddProjectID(projectID *string) *ServerBuilder

func (*ServerBuilder) AddRoutedIPEnabled

func (sb *ServerBuilder) AddRoutedIPEnabled(routedIPEnabled *bool) *ServerBuilder

func (*ServerBuilder) AddSecurityGroup

func (sb *ServerBuilder) AddSecurityGroup(securityGroupID string) *ServerBuilder

func (*ServerBuilder) AddTags

func (sb *ServerBuilder) AddTags(tags []string) *ServerBuilder

func (*ServerBuilder) AddVolumes

func (sb *ServerBuilder) AddVolumes(rootVolume string, additionalVolumes []string) (*ServerBuilder, error)

AddVolumes build volume templates from arguments.

More format details in buildVolumeTemplate function.

Also add default volumes to server, ex: scratch storage for GPU servers

func (*ServerBuilder) Build

func (sb *ServerBuilder) Build() (*instance.CreateServerRequest, *instance.CreateIPRequest)

func (*ServerBuilder) Validate

func (sb *ServerBuilder) Validate() error

func (*ServerBuilder) ValidateVolumes

func (sb *ServerBuilder) ValidateVolumes() error

type ServerGetRdpPasswordResponse

type ServerGetRdpPasswordResponse struct {
	Username          string
	Password          string
	SSHKeyID          *string
	SSHKeyDescription string
}