sakuracloud

package
v0.9.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 12, 2023 License: MPL-2.0 Imports: 37 Imported by: 0

Documentation

Index

Constants

View Source
const BuilderId = "packer.sakuracloud"

BuilderId is the unique id for the builder

Variables

This section is empty.

Functions

This section is empty.

Types

type Artifact

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

Artifact is the result of a build and is the metadata that documents what a builder actually created.

func (*Artifact) BuilderId

func (*Artifact) BuilderId() string

BuilderId returns the ID of the builder that was used to create this artifact.

func (*Artifact) Destroy

func (a *Artifact) Destroy() error

Destroy deletes the artifact.

func (*Artifact) Files

func (*Artifact) Files() []string

Files returns the set of files that comprise this artifact. If an artifact is not made up of files, then this will be empty.

func (*Artifact) Id

func (a *Artifact) Id() string

Id for the artifact, if it has one.

func (*Artifact) State

func (a *Artifact) State(name string) interface{}

State allows the caller to ask for builder specific state information relating to the artifact instance.

func (*Artifact) String

func (a *Artifact) String() string

String returns human-readable output that describes the artifact created.

type Builder

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

Builder implements packer.Builder interface for handling actions for SakuraCloud

func (*Builder) ConfigSpec added in v0.7.0

func (b *Builder) ConfigSpec() hcldec.ObjectSpec

func (*Builder) Prepare

func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error)

Prepare is responsible for configuring the builder and validating that configuration.

func (*Builder) Run

func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (packer.Artifact, error)

Run is where the actual build should take place.

type Config

type Config struct {
	common.PackerConfig `mapstructure:",squash"`
	Comm                communicator.Config `mapstructure:",squash"`

	// for API Auth
	AccessToken       string   `mapstructure:"access_token"`
	AccessTokenSecret string   `mapstructure:"access_token_secret"`
	Zone              string   `mapstructure:"zone"`
	Zones             []string `mapstructure:"zones"`

	// for Communication
	UserName      string `mapstructure:"user_name"`
	Password      string `mapstructure:"password"`
	UseUSKeyboard bool   `mapstructure:"us_keyboard"`

	// for Disk
	DiskSize       int    `mapstructure:"disk_size"`
	DiskConnection string `mapstructure:"disk_connection"`
	DiskPlan       string `mapstructure:"disk_plan"`

	// for Server
	Core                int  `mapstructure:"core"`
	MemorySize          int  `mapstructure:"memory_size"`
	DisableVirtIONetPCI bool `mapstructure:"disable_virtio_net"`
	ForceShutdown       bool `mapstructure:"force_shutdown"`

	// for Source
	OSType        string   `mapstructure:"os_type"`
	SourceArchive types.ID `mapstructure:"source_archive"`
	SourceDisk    types.ID `mapstructure:"source_disk"`

	// for ISO
	ISOImageID            types.ID `mapstructure:"iso_id"`
	commonsteps.ISOConfig `mapstructure:",squash"`
	ISOImageSizeGB        int    `mapstructure:"iso_size"`
	ISOImageName          string `mapstructure:"iso_name"`

	// for artifact
	ArchiveName        string        `mapstructure:"archive_name"`
	ArchiveTags        []string      `mapstructure:"archive_tags"`
	ArchiveDescription string        `mapstructure:"archive_description"`
	APIClientTimeout   time.Duration `mapstructure:"api_client_timeout"`

	DisableGeneratePublicKey bool `mapstructure:"disable_generate_public_key"`

	BootWait    time.Duration `mapstructure:"boot_wait"`
	BootCommand []string      `mapstructure:"boot_command"`
	// contains filtered or unexported fields
}

Config represents SakuraCloud builder config

func NewConfig

func NewConfig(raws ...interface{}) (*Config, []string, error)

NewConfig returns new *Config

func (*Config) FlatMapstructure added in v0.7.0

func (*Config) FlatMapstructure() interface{ HCL2Spec() map[string]hcldec.Spec }

FlatMapstructure returns a new FlatConfig. FlatConfig is an auto-generated flat version of Config. Where the contents a fields with a `mapstructure:,squash` tag are bubbled up.

type FlatConfig added in v0.7.0

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"`
	AccessToken               *string           `mapstructure:"access_token" cty:"access_token" hcl:"access_token"`
	AccessTokenSecret         *string           `mapstructure:"access_token_secret" cty:"access_token_secret" hcl:"access_token_secret"`
	Zone                      *string           `mapstructure:"zone" cty:"zone" hcl:"zone"`
	Zones                     []string          `mapstructure:"zones" cty:"zones" hcl:"zones"`
	UserName                  *string           `mapstructure:"user_name" cty:"user_name" hcl:"user_name"`
	Password                  *string           `mapstructure:"password" cty:"password" hcl:"password"`
	UseUSKeyboard             *bool             `mapstructure:"us_keyboard" cty:"us_keyboard" hcl:"us_keyboard"`
	DiskSize                  *int              `mapstructure:"disk_size" cty:"disk_size" hcl:"disk_size"`
	DiskConnection            *string           `mapstructure:"disk_connection" cty:"disk_connection" hcl:"disk_connection"`
	DiskPlan                  *string           `mapstructure:"disk_plan" cty:"disk_plan" hcl:"disk_plan"`
	Core                      *int              `mapstructure:"core" cty:"core" hcl:"core"`
	MemorySize                *int              `mapstructure:"memory_size" cty:"memory_size" hcl:"memory_size"`
	DisableVirtIONetPCI       *bool             `mapstructure:"disable_virtio_net" cty:"disable_virtio_net" hcl:"disable_virtio_net"`
	ForceShutdown             *bool             `mapstructure:"force_shutdown" cty:"force_shutdown" hcl:"force_shutdown"`
	OSType                    *string           `mapstructure:"os_type" cty:"os_type" hcl:"os_type"`
	SourceArchive             *types.ID         `mapstructure:"source_archive" cty:"source_archive" hcl:"source_archive"`
	SourceDisk                *types.ID         `mapstructure:"source_disk" cty:"source_disk" hcl:"source_disk"`
	ISOImageID                *types.ID         `mapstructure:"iso_id" cty:"iso_id" hcl:"iso_id"`
	ISOChecksum               *string           `mapstructure:"iso_checksum" required:"true" cty:"iso_checksum" hcl:"iso_checksum"`
	RawSingleISOUrl           *string           `mapstructure:"iso_url" required:"true" cty:"iso_url" hcl:"iso_url"`
	ISOUrls                   []string          `mapstructure:"iso_urls" cty:"iso_urls" hcl:"iso_urls"`
	TargetPath                *string           `mapstructure:"iso_target_path" cty:"iso_target_path" hcl:"iso_target_path"`
	TargetExtension           *string           `mapstructure:"iso_target_extension" cty:"iso_target_extension" hcl:"iso_target_extension"`
	ISOImageSizeGB            *int              `mapstructure:"iso_size" cty:"iso_size" hcl:"iso_size"`
	ISOImageName              *string           `mapstructure:"iso_name" cty:"iso_name" hcl:"iso_name"`
	ArchiveName               *string           `mapstructure:"archive_name" cty:"archive_name" hcl:"archive_name"`
	ArchiveTags               []string          `mapstructure:"archive_tags" cty:"archive_tags" hcl:"archive_tags"`
	ArchiveDescription        *string           `mapstructure:"archive_description" cty:"archive_description" hcl:"archive_description"`
	APIClientTimeout          *string           `mapstructure:"api_client_timeout" cty:"api_client_timeout" hcl:"api_client_timeout"`
	DisableGeneratePublicKey  *bool             `mapstructure:"disable_generate_public_key" cty:"disable_generate_public_key" hcl:"disable_generate_public_key"`
	BootWait                  *string           `mapstructure:"boot_wait" cty:"boot_wait" hcl:"boot_wait"`
	BootCommand               []string          `mapstructure:"boot_command" cty:"boot_command" hcl:"boot_command"`
}

FlatConfig is an auto-generated flat version of Config. Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.

func (*FlatConfig) HCL2Spec added in v0.7.0

func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec

HCL2Spec returns the hcl spec of a Config. This spec is used by HCL to read the fields of Config. The decoded values from this spec will then be applied to a FlatConfig.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL