Documentation
¶
Index ¶
Constants ¶
View Source
const BuilderId = "packer.gridscale"
The unique id for the builder
View Source
const CharSetAlphaNum = "abcdefghijklmnopqrstuvwxyz012346789"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Artifact ¶
type Artifact struct {
// The name of the template
TemplateName string
// The UUID of the template
TemplateUUID string
// The client for making API calls
Client gsclient.TemplateOperator
}
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
func (*Builder) ConfigSpec ¶
func (b *Builder) ConfigSpec() hcldec.ObjectSpec
type Config ¶
type Config struct {
common.PackerConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"`
// The client TOKEN to use to access your account. Environment variable `GRIDSCALE_TOKEN` can be set instead.
APIToken string `mapstructure:"api_token" required:"true"`
// The client KEY to use to access your account. Environment variable `GRIDSCALE_UUID` can be set instead.
APIKey string `mapstructure:"api_key" required:"true"`
// The server URL to use to access your account. Default: "https://api.gridscale.io". Environment variable `GRIDSCALE_URL` can be set instead.
APIURL string `mapstructure:"api_url" required:"false"`
// APIRequestHeaders is for debug purpose only. Format: "key1:val1,key2:val2"
APIRequestHeaders string `mapstructure:"api_request_headers" required:"false"`
// The name of the new template.
TemplateName string `mapstructure:"template_name" required:"false"`
// Name of the host.
Hostname string `mapstructure:"hostname" required:"false"`
// Name of the server used for producing the template.
ServerName string `mapstructure:"server_name" required:"false"`
// Number of server cores
ServerCores int `mapstructure:"server_cores" required:"true"`
// Server memory capacity (in GB)
ServerMemory int `mapstructure:"server_memory" required:"true"`
// Storage capacity (in GB)
StorageCapacity int `mapstructure:"storage_capacity" required:"true"`
// UserData is a string that will be passed to the server instance as user data.
UserData string `mapstructure:"user_data" required:"false"`
// SecondaryStorage is set to true when the server needs a secondary storage
// during producing template process.
// **NOTE**: If `secondary_storage=true`, the template will be built from the second storage.
SecondaryStorage bool `mapstructure:"secondary_storage" required:"false"`
// A pre-built template UUID. This template is used to produce another template. E.g: Ubuntu template.
// **NOTE**: One of these fields has to be set: `isoimage_uuid`, `isoimage_url`, `base_template_uuid`.
BaseTemplateUUID string `mapstructure:"base_template_uuid" required:"false"`
// A pre-built ISO image is used by the given ISO image UUID. If IsoImageUUID is set, IsoImageURL is ignored.
// **NOTE**: One of these fields has to be set: `isoimage_uuid`, `isoimage_url`, `base_template_uuid`.
IsoImageUUID string `mapstructure:"isoimage_uuid" required:"false"`
// An URL is used to download the image. If IsoImageUUID is set, IsoImageURL is ignored.
// **NOTE**: One of these fields has to be set: `isoimage_uuid`, `isoimage_url`, `base_template_uuid`.
IsoImageURL string `mapstructure:"isoimage_url" required:"false"`
// This is an array of commands to type when the server instance is first
// booted. The goal of these commands should be to type just enough to
// initialize the operating system installer. Special keys can be typed as
// well, and are covered in the section below on the boot command. If this
// is not specified, it is assumed the installer will start itself.
BootCommand []string `mapstructure:"boot_command" required:"false"`
// The time to wait after booting the initial virtual machine before typing
// the `boot_command`. The value of this should be a duration. Examples are
// `5s` and `1m30s` which will cause Packer to wait five seconds and one
// minute 30 seconds, respectively. If this isn't specified, the default is
// `10s` or 10 seconds. To set boot_wait to 0s, use a negative number, such
// as "-1s"
BootWait time.Duration `mapstructure:"boot_wait" required:"false"`
// Time in ms to wait between each key press
BootKeyInterval time.Duration `mapstructure:"boot_key_interval" required:"false"`
// A list of files' relative paths that need to be served on a HTTP server.
// Put this address ({{__HTTP__ADDRESS__}} is a placeholder, do not edit) http://{{__HTTP__ADDRESS__}}/path/to/file
// to `boot_command` to use http-served files in boot commands.
Files []string `mapstructure:"files" required:"false"`
// contains filtered or unexported fields
}
type FlatConfig ¶
type FlatConfig struct {
PackerBuildName *string `mapstructure:"packer_build_name" cty:"packer_build_name" hcl:"packer_build_name"`
PackerBuilderType *string `mapstructure:"packer_builder_type" cty:"packer_builder_type" hcl:"packer_builder_type"`
PackerCoreVersion *string `mapstructure:"packer_core_version" cty:"packer_core_version" hcl:"packer_core_version"`
PackerDebug *bool `mapstructure:"packer_debug" cty:"packer_debug" hcl:"packer_debug"`
PackerForce *bool `mapstructure:"packer_force" cty:"packer_force" hcl:"packer_force"`
PackerOnError *string `mapstructure:"packer_on_error" cty:"packer_on_error" hcl:"packer_on_error"`
PackerUserVars map[string]string `mapstructure:"packer_user_variables" cty:"packer_user_variables" hcl:"packer_user_variables"`
PackerSensitiveVars []string `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables" hcl:"packer_sensitive_variables"`
Type *string `mapstructure:"communicator" cty:"communicator" hcl:"communicator"`
PauseBeforeConnect *string `mapstructure:"pause_before_connecting" cty:"pause_before_connecting" hcl:"pause_before_connecting"`
SSHHost *string `mapstructure:"ssh_host" cty:"ssh_host" hcl:"ssh_host"`
SSHPort *int `mapstructure:"ssh_port" cty:"ssh_port" hcl:"ssh_port"`
SSHUsername *string `mapstructure:"ssh_username" cty:"ssh_username" hcl:"ssh_username"`
SSHPassword *string `mapstructure:"ssh_password" cty:"ssh_password" hcl:"ssh_password"`
SSHKeyPairName *string `mapstructure:"ssh_keypair_name" undocumented:"true" cty:"ssh_keypair_name" hcl:"ssh_keypair_name"`
SSHTemporaryKeyPairName *string `mapstructure:"temporary_key_pair_name" undocumented:"true" cty:"temporary_key_pair_name" hcl:"temporary_key_pair_name"`
SSHTemporaryKeyPairType *string `mapstructure:"temporary_key_pair_type" cty:"temporary_key_pair_type" hcl:"temporary_key_pair_type"`
SSHTemporaryKeyPairBits *int `mapstructure:"temporary_key_pair_bits" cty:"temporary_key_pair_bits" hcl:"temporary_key_pair_bits"`
SSHCiphers []string `mapstructure:"ssh_ciphers" cty:"ssh_ciphers" hcl:"ssh_ciphers"`
SSHClearAuthorizedKeys *bool `mapstructure:"ssh_clear_authorized_keys" cty:"ssh_clear_authorized_keys" hcl:"ssh_clear_authorized_keys"`
SSHKEXAlgos []string `mapstructure:"ssh_key_exchange_algorithms" cty:"ssh_key_exchange_algorithms" hcl:"ssh_key_exchange_algorithms"`
SSHPrivateKeyFile *string `mapstructure:"ssh_private_key_file" undocumented:"true" cty:"ssh_private_key_file" hcl:"ssh_private_key_file"`
SSHCertificateFile *string `mapstructure:"ssh_certificate_file" cty:"ssh_certificate_file" hcl:"ssh_certificate_file"`
SSHPty *bool `mapstructure:"ssh_pty" cty:"ssh_pty" hcl:"ssh_pty"`
SSHTimeout *string `mapstructure:"ssh_timeout" cty:"ssh_timeout" hcl:"ssh_timeout"`
SSHWaitTimeout *string `mapstructure:"ssh_wait_timeout" undocumented:"true" cty:"ssh_wait_timeout" hcl:"ssh_wait_timeout"`
SSHAgentAuth *bool `mapstructure:"ssh_agent_auth" undocumented:"true" cty:"ssh_agent_auth" hcl:"ssh_agent_auth"`
SSHDisableAgentForwarding *bool `mapstructure:"ssh_disable_agent_forwarding" cty:"ssh_disable_agent_forwarding" hcl:"ssh_disable_agent_forwarding"`
SSHHandshakeAttempts *int `mapstructure:"ssh_handshake_attempts" cty:"ssh_handshake_attempts" hcl:"ssh_handshake_attempts"`
SSHBastionHost *string `mapstructure:"ssh_bastion_host" cty:"ssh_bastion_host" hcl:"ssh_bastion_host"`
SSHBastionPort *int `mapstructure:"ssh_bastion_port" cty:"ssh_bastion_port" hcl:"ssh_bastion_port"`
SSHBastionAgentAuth *bool `mapstructure:"ssh_bastion_agent_auth" cty:"ssh_bastion_agent_auth" hcl:"ssh_bastion_agent_auth"`
SSHBastionUsername *string `mapstructure:"ssh_bastion_username" cty:"ssh_bastion_username" hcl:"ssh_bastion_username"`
SSHBastionPassword *string `mapstructure:"ssh_bastion_password" cty:"ssh_bastion_password" hcl:"ssh_bastion_password"`
SSHBastionInteractive *bool `mapstructure:"ssh_bastion_interactive" cty:"ssh_bastion_interactive" hcl:"ssh_bastion_interactive"`
SSHBastionPrivateKeyFile *string `mapstructure:"ssh_bastion_private_key_file" cty:"ssh_bastion_private_key_file" hcl:"ssh_bastion_private_key_file"`
SSHBastionCertificateFile *string `mapstructure:"ssh_bastion_certificate_file" cty:"ssh_bastion_certificate_file" hcl:"ssh_bastion_certificate_file"`
SSHFileTransferMethod *string `mapstructure:"ssh_file_transfer_method" cty:"ssh_file_transfer_method" hcl:"ssh_file_transfer_method"`
SSHProxyHost *string `mapstructure:"ssh_proxy_host" cty:"ssh_proxy_host" hcl:"ssh_proxy_host"`
SSHProxyPort *int `mapstructure:"ssh_proxy_port" cty:"ssh_proxy_port" hcl:"ssh_proxy_port"`
SSHProxyUsername *string `mapstructure:"ssh_proxy_username" cty:"ssh_proxy_username" hcl:"ssh_proxy_username"`
SSHProxyPassword *string `mapstructure:"ssh_proxy_password" cty:"ssh_proxy_password" hcl:"ssh_proxy_password"`
SSHKeepAliveInterval *string `mapstructure:"ssh_keep_alive_interval" cty:"ssh_keep_alive_interval" hcl:"ssh_keep_alive_interval"`
SSHReadWriteTimeout *string `mapstructure:"ssh_read_write_timeout" cty:"ssh_read_write_timeout" hcl:"ssh_read_write_timeout"`
SSHRemoteTunnels []string `mapstructure:"ssh_remote_tunnels" cty:"ssh_remote_tunnels" hcl:"ssh_remote_tunnels"`
SSHLocalTunnels []string `mapstructure:"ssh_local_tunnels" cty:"ssh_local_tunnels" hcl:"ssh_local_tunnels"`
SSHPublicKey []byte `mapstructure:"ssh_public_key" undocumented:"true" cty:"ssh_public_key" hcl:"ssh_public_key"`
SSHPrivateKey []byte `mapstructure:"ssh_private_key" undocumented:"true" cty:"ssh_private_key" hcl:"ssh_private_key"`
WinRMUser *string `mapstructure:"winrm_username" cty:"winrm_username" hcl:"winrm_username"`
WinRMPassword *string `mapstructure:"winrm_password" cty:"winrm_password" hcl:"winrm_password"`
WinRMHost *string `mapstructure:"winrm_host" cty:"winrm_host" hcl:"winrm_host"`
WinRMNoProxy *bool `mapstructure:"winrm_no_proxy" cty:"winrm_no_proxy" hcl:"winrm_no_proxy"`
WinRMPort *int `mapstructure:"winrm_port" cty:"winrm_port" hcl:"winrm_port"`
WinRMTimeout *string `mapstructure:"winrm_timeout" cty:"winrm_timeout" hcl:"winrm_timeout"`
WinRMUseSSL *bool `mapstructure:"winrm_use_ssl" cty:"winrm_use_ssl" hcl:"winrm_use_ssl"`
WinRMInsecure *bool `mapstructure:"winrm_insecure" cty:"winrm_insecure" hcl:"winrm_insecure"`
WinRMUseNTLM *bool `mapstructure:"winrm_use_ntlm" cty:"winrm_use_ntlm" hcl:"winrm_use_ntlm"`
APIToken *string `mapstructure:"api_token" required:"true" cty:"api_token" hcl:"api_token"`
APIKey *string `mapstructure:"api_key" required:"true" cty:"api_key" hcl:"api_key"`
APIURL *string `mapstructure:"api_url" required:"false" cty:"api_url" hcl:"api_url"`
APIRequestHeaders *string `mapstructure:"api_request_headers" required:"false" cty:"api_request_headers" hcl:"api_request_headers"`
TemplateName *string `mapstructure:"template_name" required:"false" cty:"template_name" hcl:"template_name"`
Hostname *string `mapstructure:"hostname" required:"false" cty:"hostname" hcl:"hostname"`
ServerName *string `mapstructure:"server_name" required:"false" cty:"server_name" hcl:"server_name"`
ServerCores *int `mapstructure:"server_cores" required:"true" cty:"server_cores" hcl:"server_cores"`
ServerMemory *int `mapstructure:"server_memory" required:"true" cty:"server_memory" hcl:"server_memory"`
StorageCapacity *int `mapstructure:"storage_capacity" required:"true" cty:"storage_capacity" hcl:"storage_capacity"`
UserData *string `mapstructure:"user_data" required:"false" cty:"user_data" hcl:"user_data"`
SecondaryStorage *bool `mapstructure:"secondary_storage" required:"false" cty:"secondary_storage" hcl:"secondary_storage"`
BaseTemplateUUID *string `mapstructure:"base_template_uuid" required:"false" cty:"base_template_uuid" hcl:"base_template_uuid"`
IsoImageUUID *string `mapstructure:"isoimage_uuid" required:"false" cty:"isoimage_uuid" hcl:"isoimage_uuid"`
IsoImageURL *string `mapstructure:"isoimage_url" required:"false" cty:"isoimage_url" hcl:"isoimage_url"`
BootCommand []string `mapstructure:"boot_command" required:"false" cty:"boot_command" hcl:"boot_command"`
BootWait *string `mapstructure:"boot_wait" required:"false" cty:"boot_wait" hcl:"boot_wait"`
BootKeyInterval *string `mapstructure:"boot_key_interval" required:"false" cty:"boot_key_interval" hcl:"boot_key_interval"`
Files []string `mapstructure:"files" required:"false" cty:"files" hcl:"files"`
}
FlatConfig is an auto-generated flat version of Config. Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.
type StepExecuteBootCommand ¶
type StepExecuteBootCommand struct {
// contains filtered or unexported fields
}
func (StepExecuteBootCommand) Cleanup ¶
func (s StepExecuteBootCommand) Cleanup(state multistep.StateBag)
func (StepExecuteBootCommand) Run ¶
func (s StepExecuteBootCommand) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction
type StepVNCConnect ¶
type StepVNCConnect struct {
// contains filtered or unexported fields
}
func (StepVNCConnect) Cleanup ¶
func (s StepVNCConnect) Cleanup(state multistep.StateBag)
func (StepVNCConnect) Run ¶
func (s StepVNCConnect) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction
Source Files
¶
- artifact.go
- builder.go
- common.go
- config.go
- config.hcl2spec.go
- step_cleanup_isoimage_installation.go
- step_create_boot_storage.go
- step_create_ip.go
- step_create_isoimage.go
- step_create_secondary_storage.go
- step_create_server.go
- step_create_snapshot.go
- step_create_ssh_key.go
- step_create_template.go
- step_execute_boot_command.go
- step_get_public_network.go
- step_link_server_boot_storage.go
- step_link_server_ip.go
- step_link_server_isoimage.go
- step_link_server_secondary_storage.go
- step_link_sever_public_network.go
- step_serve_files.go
- step_shutdown_server.go
- step_start_server.go
- step_vnc_connect.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Note this easyssh package is a copy of "github.com/hypersleep/easyssh" repository It was copied for being modified to be compatible with gridscale packer.
|
Note this easyssh package is a copy of "github.com/hypersleep/easyssh" repository It was copied for being modified to be compatible with gridscale packer. |
Click to show internal directories.
Click to hide internal directories.