Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

common

package

Go to main page

Versions in this module

v1

v1.4.0

Jan 30, 2025

v1.3.0

Sep 19, 2024

Changes in this version

type OMIConfig

+ RootDeviceName string

v1.2.0

Apr 8, 2024

v1.1.5

Feb 23, 2024

v1.1.4

Feb 22, 2024

Changes in this version

+ const RunSourceVmBSUExpectedRootDevice

+ const VolumeTypeGp2

+ const VolumeTypeIo1

+ const VolumeTypeSc1

+ const VolumeTypeSt1

+ const VolumeTypeStandard

+ var StopShutdownBehavior string = "stop"

+ var TemplateFuncs = template.FuncMap

+ var TerminateShutdownBehavior string = "terminate"

+ func CreateOSCTags(conn *OscClient, resourceID string, ui packersdk.Ui, tags OSCTags) error

+ func OscSSHHost(conn *OscClient, sshInterface string) func(multistep.StateBag) (string, error)

+ func SSHHost(conn *OscClient, sshInterface string) func(multistep.StateBag) (string, error)

+ func WaitUntilOscImageAvailable(conn *OscClient, imageID string) error

+ func WaitUntilOscSnapshotCompleted(conn *OscClient, id string) error

+ func WaitUntilOscSnapshotDone(conn *OscClient, snapshotID string) error

+ func WaitUntilOscVolumeAvailable(conn *OscClient, volumeID string) error

+ func WaitUntilOscVolumeIsLinked(conn *OscClient, volumeID string) error

+ func WaitUntilOscVolumeIsUnlinked(conn *OscClient, volumeID string) error

+ type AccessConfig struct

+ AccessKey string

+ CustomEndpointOAPI string

+ InsecureSkipTLSVerify bool

+ MFACode string

+ ProfileName string

+ RawRegion string

+ SecretKey string

+ SkipMetadataApiCheck bool

+ Token string

+ X509certPath string

+ X509keyPath string

+ func (c *AccessConfig) GetRegion() string

+ func (c *AccessConfig) NewOSCClient() (*OscClient, error)

+ func (c *AccessConfig) NewOSCClientByRegion(region string) *OscClient

+ func (c *AccessConfig) Prepare(ctx *interpolate.Context) []error

+ type Artifact struct

+ BuilderIdValue string

+ Omis map[string]string

+ StateData map[string]interface{}

+ func (*Artifact) Files() []string

+ func (a *Artifact) BuilderId() string

+ func (a *Artifact) Destroy() error

+ func (a *Artifact) Id() string

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

+ func (a *Artifact) String() string

+ type BlockDevice struct

+ DeleteOnVmDeletion bool

+ DeviceName string

+ IOPS int64

+ NoDevice bool

+ SnapshotId string

+ VirtualName string

+ VolumeSize int64

+ VolumeType string

+ func (*BlockDevice) FlatMapstructure() interface{ ... }

+ func (b *BlockDevice) Prepare(ctx *interpolate.Context) error

+ type BlockDevices struct

+ func (b *BlockDevices) Prepare(ctx *interpolate.Context) (errs []error)

+ type BuildInfoTemplate struct

+ BuildRegion string

+ SourceOMI string

+ SourceOMIName string

+ SourceOMITags map[string]string

+ type FlatBlockDevice struct

+ DeleteOnVmDeletion *bool

+ DeviceName *string

+ IOPS *int64

+ NoDevice *bool

+ SnapshotId *string

+ VirtualName *string

+ VolumeSize *int64

+ VolumeType *string

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

+ type FlatNetFilterOptions struct

+ Filter []config.FlatNameValue

+ Filters map[string]string

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

+ type FlatOmiFilterOptions struct

+ Filter []config.FlatNameValue

+ Filters map[string]string

+ MostRecent *bool

+ Owners []string

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

+ type FlatSecurityGroupFilterOptions struct

+ Filter []config.FlatNameValue

+ Filters map[string]string

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

+ type FlatSubnetFilterOptions struct

+ Filter []config.FlatNameValue

+ Filters map[string]string

+ MostFree *bool

+ Random *bool

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

+ type LaunchBlockDevices struct

+ LaunchMappings []BlockDevice

+ func (b *LaunchBlockDevices) BuildOSCLaunchDevices() []oscgo.BlockDeviceMappingVmCreation

+ type NetFilterOptions struct

+ func (*NetFilterOptions) FlatMapstructure() interface{ ... }

+ type OMIBlockDevices struct

+ OMIMappings []BlockDevice

+ func (b *OMIBlockDevices) BuildOscOMIDevices() []oscgo.BlockDeviceMappingImage

+ type OMIConfig struct

+ GlobalPermission bool

+ OMIAccountIDs []string

+ OMIDescription string

+ OMIForceDeleteSnapshot bool

+ OMIForceDeregister bool

+ OMIGroups []string

+ OMIName string

+ OMIProductCodes []string

+ OMIRegions []string

+ OMISkipRegionValidation bool

+ OMITags TagMap

+ ProductCodes []string

+ SnapshotAccountIDs []string

+ SnapshotTags TagMap

+ func (c *OMIConfig) Prepare(accessConfig *AccessConfig, ctx *interpolate.Context) []error

+ type OSCTags []oscgo.ResourceTag

+ func (t OSCTags) Report(ui packersdk.Ui)

+ type OmiFilterOptions struct

+ MostRecent bool

+ Owners []string

+ func (*OmiFilterOptions) FlatMapstructure() interface{ ... }

+ func (d *OmiFilterOptions) Empty() bool

+ func (d *OmiFilterOptions) GetFilteredImage(params oscgo.ReadImagesRequest, oscconn *OscClient) (*oscgo.Image, error)

+ func (d *OmiFilterOptions) GetOwners() []*string

+ func (d *OmiFilterOptions) NoOwner() bool

+ type OscClient struct

+ Api *oscgo.APIClient

+ Auth context.Context

+ type RunConfig struct

+ AssociatePublicIpAddress bool

+ BlockDurationMinutes int64

+ BsuOptimized bool

+ Comm communicator.Config

+ DisableStopVm bool

+ EnableT2Unlimited bool

+ IamVmProfile string

+ NetFilter NetFilterOptions

+ NetId string

+ RunTags map[string]string

+ SSHInterface string

+ SecurityGroupFilter SecurityGroupFilterOptions

+ SecurityGroupId string

+ SecurityGroupIds []string

+ SourceOmi string

+ SourceOmiFilter OmiFilterOptions

+ SubnetFilter SubnetFilterOptions

+ SubnetId string

+ Subregion string

+ TemporarySGSourceCidr string

+ UserData string

+ UserDataFile string

+ VmInitiatedShutdownBehavior string

+ VmType string

+ WindowsPasswordTimeout time.Duration

+ func (c *RunConfig) Prepare(ctx *interpolate.Context) []error

+ type SecurityGroupFilterOptions struct

+ func (*SecurityGroupFilterOptions) FlatMapstructure() interface{ ... }

+ type StepCleanupVolumes struct

+ BlockDevices BlockDevices

+ func (s *StepCleanupVolumes) Cleanup(state multistep.StateBag)

+ func (s *StepCleanupVolumes) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepCreateTags struct

+ Ctx interpolate.Context

+ SnapshotTags TagMap

+ Tags TagMap

+ func (s *StepCreateTags) Cleanup(state multistep.StateBag)

+ func (s *StepCreateTags) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepDeregisterOMI struct

+ AccessConfig *AccessConfig

+ ForceDeleteSnapshot bool

+ ForceDeregister bool

+ OMIName string

+ Regions []string

+ func (s *StepDeregisterOMI) Cleanup(state multistep.StateBag)

+ func (s *StepDeregisterOMI) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepGetPassword struct

+ BuildName string

+ Comm *communicator.Config

+ Debug bool

+ Timeout time.Duration

+ func (s *StepGetPassword) Cleanup(multistep.StateBag)

+ func (s *StepGetPassword) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepKeyPair struct

+ Comm *communicator.Config

+ Debug bool

+ DebugKeyPath string

+ func (s *StepKeyPair) Cleanup(state multistep.StateBag)

+ func (s *StepKeyPair) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepNetworkInfo struct

+ NetFilter NetFilterOptions

+ NetId string

+ SecurityGroupFilter SecurityGroupFilterOptions

+ SecurityGroupIds []string

+ SubnetFilter SubnetFilterOptions

+ SubnetId string

+ SubregionName string

+ func (s *StepNetworkInfo) Cleanup(multistep.StateBag)

+ func (s *StepNetworkInfo) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepPreValidate struct

+ API string

+ DestOmiName string

+ ForceDeregister bool

+ func (s *StepPreValidate) Cleanup(multistep.StateBag)

+ func (s *StepPreValidate) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepPublicIp struct

+ AssociatePublicIpAddress bool

+ Comm *communicator.Config

+ Debug bool

+ func (s *StepPublicIp) Cleanup(state multistep.StateBag)

+ func (s *StepPublicIp) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepRunSourceVm struct

+ BlockDevices BlockDevices

+ BsuOptimized bool

+ Comm *communicator.Config

+ Ctx interpolate.Context

+ Debug bool

+ EnableT2Unlimited bool

+ ExpectedRootDevice string

+ IamVmProfile string

+ IsRestricted bool

+ RawRegion string

+ SourceOMI string

+ Tags TagMap

+ UserData string

+ UserDataFile string

+ VmInitiatedShutdownBehavior string

+ VmType string

+ VolumeTags TagMap

+ func (s *StepRunSourceVm) Cleanup(state multistep.StateBag)

+ func (s *StepRunSourceVm) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction

+ type StepSecurityGroup struct

+ CommConfig *communicator.Config

+ SecurityGroupFilter SecurityGroupFilterOptions

+ SecurityGroupIds []string

+ TemporarySGSourceCidr string

+ func (s *StepSecurityGroup) Cleanup(state multistep.StateBag)

+ func (s *StepSecurityGroup) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepSourceOMIInfo struct

+ OmiFilters OmiFilterOptions

+ SourceOmi string

+ func (s *StepSourceOMIInfo) Cleanup(multistep.StateBag)

+ func (s *StepSourceOMIInfo) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepStopBSUBackedVm struct

+ DisableStopVm bool

+ Skip bool

+ func (s *StepStopBSUBackedVm) Cleanup(multistep.StateBag)

+ func (s *StepStopBSUBackedVm) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction

+ type StepUpdateBSUBackedVm struct

+ EnableAMIENASupport *bool

+ EnableAMISriovNetSupport bool

+ func (s *StepUpdateBSUBackedVm) Cleanup(state multistep.StateBag)

+ func (s *StepUpdateBSUBackedVm) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type StepUpdateOMIAttributes struct

+ AccountIds []string

+ Ctx interpolate.Context

+ GlobalPermission bool

+ RawRegion string

+ SnapshotAccountIds []string

+ func (s *StepUpdateOMIAttributes) Cleanup(state multistep.StateBag)

+ func (s *StepUpdateOMIAttributes) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

+ type SubnetFilterOptions struct

+ MostFree bool

+ Random bool

+ func (*SubnetFilterOptions) FlatMapstructure() interface{ ... }

+ type TagMap map[string]string

+ func (t TagMap) IsSet() bool

+ func (t TagMap) OSCTags(ctx interpolate.Context, region string, state multistep.StateBag) (OSCTags, error)

+ type Transport struct

+ func NewTransport(accessKey, accessSecret, region string, t http.RoundTripper) *Transport

+ func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)