instance

Documentation

Index

• func FormatSSHKeyToTag(publicKey string) string
• func GetCommands() *core.Commands
• func GetGeneratedCommands() *core.Commands
• func SizeValue(s *scw.Size) scw.Size
• type PostServerCreationSetupFunc
• 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) AddDynamicIPRequired(dynamicIPRequired *bool) *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) BuildPostCreationSetup() PostServerCreationSetupFunc
  • func (sb *ServerBuilder) Validate() error
  • func (sb *ServerBuilder) ValidateVolumes() error
• type ServerGetRdpPasswordResponse
• type VolumeBuilder
  • func NewVolumeBuilder(zone scw.Zone, flagV string) (*VolumeBuilder, error)
  • func (vb *VolumeBuilder) BuildVolumeServerTemplate(apiInstance *instance.API, apiBlock *block.API) (*instance.VolumeServerTemplate, error)
  • func (vb *VolumeBuilder) ExecutePostCreationSetup(ctx context.Context, apiBlock *block.API, volumeID string)

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

func SizeValue

func SizeValue(s *scw.Size) scw.Size

Types

type PostServerCreationSetupFunc

type PostServerCreationSetupFunc func(ctx context.Context, server *instance.Server) error

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

NewServerBuilder creates a new builder for a server with requested commercialType in given zone. commercialType will be used to validate that added components are supported.

func (*ServerBuilder) AddAdminPasswordEncryptionSSHKeyID

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

func (*ServerBuilder) AddBootType

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

func (*ServerBuilder) AddDynamicIPRequired

func (sb *ServerBuilder) AddDynamicIPRequired(dynamicIPRequired *bool) *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) BuildPostCreationSetup

func (sb *ServerBuilder) BuildPostCreationSetup() PostServerCreationSetupFunc

func (*ServerBuilder) Validate

func (sb *ServerBuilder) Validate() error

func (*ServerBuilder) ValidateVolumes

func (sb *ServerBuilder) ValidateVolumes() error

ValidateVolumes validates that the volumes are valid and sanitize the prepared template. Server creation should fail if ValidateVolumes is not ran before.

type ServerGetRdpPasswordResponse

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

type VolumeBuilder

type VolumeBuilder struct {
	Zone       scw.Zone
	VolumeType instance.VolumeVolumeType

	// SnapshotID is the ID of the snapshot the volume should be created from.
	SnapshotID *string
	// VolumeID is the ID of the volume if one should be imported.
	VolumeID *string
	// Size is the size of the created Volume. If used, the volume should be created from scratch.
	Size *scw.Size
	// IOPS is the io per second to be configured for a created volume.
	IOPS *uint32
}

func NewVolumeBuilder

func NewVolumeBuilder(zone scw.Zone, flagV string) (*VolumeBuilder, error)

NewVolumeBuilder creates a volume builder from a 'volumes' argument item.

Volumes definition must be through multiple arguments (eg: volumes.0="l:20GB" volumes.1="b:100GB" volumes.2="sbs:50GB:15000)

A valid volume format is either - a "creation" format: ^((local|l|block|b|scratch|s|sbs):)?\d+GB?(:\d+)?$ (size is handled by go-humanize, so other sizes are supported) - a "creation" format with a snapshot id: l:<uuid> b:<uuid> - a UUID format

func (*VolumeBuilder) BuildVolumeServerTemplate

func (vb *VolumeBuilder) BuildVolumeServerTemplate(apiInstance *instance.API, apiBlock *block.API) (*instance.VolumeServerTemplate, error)

BuildVolumeServerTemplate builds the requested volume template to be used in a CreateServerRequest

func (*VolumeBuilder) ExecutePostCreationSetup

func (vb *VolumeBuilder) ExecutePostCreationSetup(ctx context.Context, apiBlock *block.API, volumeID string)

ExecutePostCreationSetup executes requests that are required after volume creation.