Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

resources

package

Go to main page

Versions in this module

v21

v21.11.1

Apr 26, 2022

Changes in this version

type Cluster

+ ListEligibleFeatures func(ctx context.Context) ([]Feature, fail.Error)

type Feature

+ Applicable func(Targetable) (bool, fail.Error)

+ Dependencies func() (map[string]struct{}, fail.Error)

+ ListParametersWithControl func() []string

type Host

+ ListEligibleFeatures func(ctx context.Context) ([]Feature, fail.Error)

+ ListInstalledFeatures func(ctx context.Context) ([]Feature, fail.Error)

type Metadata

+ Sdump func() (string, fail.Error)

+ Service func() iaas.Service

type Subnet

+ GetCIDR func() (string, fail.Error)

type Targetable

+ Service func() iaas.Service

v21.11.0

Feb 17, 2022

Changes in this version

+ const KeepCurrentSecurityGroupMark

+ const MarkSecurityGroupAsDefault

+ const MarkSecurityGroupAsSupplemental

+ type Bucket interface

+ Browse func(ctx context.Context, ...) fail.Error

+ Create func(ctx context.Context, name string) fail.Error

+ Delete func(ctx context.Context) fail.Error

+ Mount func(ctx context.Context, hostname string, path string) fail.Error

+ ToProtocol func() (*protocol.BucketResponse, fail.Error)

+ Unmount func(ctx context.Context, hostname string) fail.Error

+ type Callback = func(data.Clonable, *serialize.JSONProperties) fail.Error

+ type Cluster interface

+ AddFeature func(ctx context.Context, name string, vars data.Map, settings FeatureSettings) (Results, fail.Error)

+ AddNodes func(ctx context.Context, count uint, def abstract.HostSizingRequirements, ...) ([]Host, fail.Error)

+ Browse func(ctx context.Context, callback func(*abstract.ClusterIdentity) fail.Error) fail.Error

+ CheckFeature func(ctx context.Context, name string, vars data.Map, settings FeatureSettings) (Results, fail.Error)

+ CountNodes func(ctx context.Context) (uint, fail.Error)

+ Create func(ctx context.Context, req abstract.ClusterRequest) fail.Error

+ Delete func(ctx context.Context, force bool) fail.Error

+ DeleteSpecificNode func(ctx context.Context, hostID string, selectedMasterID string) fail.Error

+ FindAvailableMaster func(ctx context.Context) (Host, fail.Error)

+ FindAvailableNode func(ctx context.Context) (Host, fail.Error)

+ GetAdminPassword func() (string, fail.Error)

+ GetComplexity func() (clustercomplexity.Enum, fail.Error)

+ GetFlavor func() (clusterflavor.Enum, fail.Error)

+ GetIdentity func() (abstract.ClusterIdentity, fail.Error)

+ GetKeyPair func() (abstract.KeyPair, fail.Error)

+ GetNetworkConfig func() (*propertiesv3.ClusterNetwork, fail.Error)

+ GetState func() (clusterstate.Enum, fail.Error)

+ IsFeatureInstalled func(ctx context.Context, name string) (found bool, xerr fail.Error)

+ ListInstalledFeatures func(ctx context.Context) ([]Feature, fail.Error)

+ ListMasterIDs func(ctx context.Context) (data.IndexedListOfStrings, fail.Error)

+ ListMasterIPs func(ctx context.Context) (data.IndexedListOfStrings, fail.Error)

+ ListMasterNames func(ctx context.Context) (data.IndexedListOfStrings, fail.Error)

+ ListMasters func(ctx context.Context) (IndexedListOfClusterNodes, fail.Error)

+ ListNodeIDs func(ctx context.Context) (data.IndexedListOfStrings, fail.Error)

+ ListNodeIPs func(ctx context.Context) (data.IndexedListOfStrings, fail.Error)

+ ListNodeNames func(ctx context.Context) (data.IndexedListOfStrings, fail.Error)

+ ListNodes func(ctx context.Context) (IndexedListOfClusterNodes, fail.Error)

+ LookupNode func(ctx context.Context, ref string) (bool, fail.Error)

+ RemoveFeature func(ctx context.Context, name string, vars data.Map, settings FeatureSettings) (Results, fail.Error)

+ Shrink func(ctx context.Context, count uint) ([]*propertiesv3.ClusterNode, fail.Error)

+ Start func(ctx context.Context) fail.Error

+ Stop func(ctx context.Context) fail.Error

+ ToProtocol func() (*protocol.ClusterResponse, fail.Error)

+ type Feature interface

+ Add func(ctx context.Context, t Targetable, v data.Map, fs FeatureSettings) (Results, fail.Error)

+ Applyable func(Targetable) bool

+ Check func(ctx context.Context, t Targetable, v data.Map, fs FeatureSettings) (Results, fail.Error)

+ GetDisplayFilename func() string

+ GetFilename func() string

+ GetRequirements func() (map[string]struct{}, fail.Error)

+ Remove func(ctx context.Context, t Targetable, v data.Map, fs FeatureSettings) (Results, fail.Error)

+ ToProtocol func() *protocol.FeatureResponse

+ type FeatureSettings struct

+ AddUnconditionally bool

+ IgnoreSuitability bool

+ Serialize bool

+ SkipFeatureRequirements bool

+ SkipProxy bool

+ SkipSizingRequirements bool

+ type Host interface

+ BindSecurityGroup func(ctx context.Context, sg SecurityGroup, enable SecurityGroupActivation) fail.Error

+ Browse func(ctx context.Context, callback func(*abstract.HostCore) fail.Error) fail.Error

+ Create func(ctx context.Context, hostReq abstract.HostRequest, ...) (*userdata.Content, fail.Error)

+ Delete func(ctx context.Context) fail.Error

+ DisableSecurityGroup func(ctx context.Context, sg SecurityGroup) fail.Error

+ EnableSecurityGroup func(ctx context.Context, sg SecurityGroup) fail.Error

+ ForceGetState func(ctx context.Context) (hoststate.Enum, fail.Error)

+ GetAccessIP func() (string, fail.Error)

+ GetDefaultSubnet func() (Subnet, fail.Error)

+ GetMounts func() (*propertiesv1.HostMounts, fail.Error)

+ GetPrivateIP func() (ip string, err fail.Error)

+ GetPrivateIPOnSubnet func(subnetID string) (ip string, err fail.Error)

+ GetPublicIP func() (ip string, err fail.Error)

+ GetSSHConfig func() (*system.SSHConfig, fail.Error)

+ GetShare func(shareRef string) (*propertiesv1.HostShare, fail.Error)

+ GetShares func() (*propertiesv1.HostShares, fail.Error)

+ GetState func() hoststate.Enum

+ GetVolumes func() (*propertiesv1.HostVolumes, fail.Error)

+ IsClusterMember func() (bool, fail.Error)

+ IsFeatureInstalled func(f string) (bool, fail.Error)

+ IsGateway func() (bool, fail.Error)

+ IsSingle func() (bool, fail.Error)

+ ListSecurityGroups func(state securitygroupstate.Enum) ([]*propertiesv1.SecurityGroupBond, fail.Error)

+ Pull func(ctx context.Context, target, source string, timeout time.Duration) (int, string, string, fail.Error)

+ Push func(ctx context.Context, source, target, owner, mode string, timeout time.Duration) (int, string, string, fail.Error)

+ PushStringToFile func(ctx context.Context, content string, filename string) fail.Error

+ PushStringToFileWithOwnership func(ctx context.Context, content string, filename string, owner, mode string) fail.Error

+ Reboot func(ctx context.Context, soft bool) fail.Error

+ Resize func(ctx context.Context, hostSize abstract.HostSizingRequirements) fail.Error

+ Run func(ctx context.Context, cmd string, outs outputs.Enum, ...) (int, string, string, fail.Error)

+ Start func(ctx context.Context) fail.Error

+ Stop func(ctx context.Context) fail.Error

+ ToProtocol func() (*protocol.Host, fail.Error)

+ UnbindSecurityGroup func(ctx context.Context, sg SecurityGroup) fail.Error

+ WaitSSHReady func(ctx context.Context, timeout time.Duration) (status string, err fail.Error)

+ type IndexedListOfClusterNodes map[uint]*propertiesv3.ClusterNode

+ type Metadata interface

+ Alter func(callback Callback, options ...data.ImmutableKeyValue) fail.Error

+ BrowseFolder func(callback func(buf []byte) fail.Error) fail.Error

+ Deserialize func(buf []byte) fail.Error

+ GetService func() iaas.Service

+ Inspect func(callback Callback) fail.Error

+ IsNull func() bool

+ Read func(ref string) fail.Error

+ ReadByID func(id string) fail.Error

+ Reload func() fail.Error

+ Review func(callback Callback) fail.Error

+ Serialize func() ([]byte, fail.Error)

+ type Network interface

+ AbandonSubnet func(ctx context.Context, subnetID string) fail.Error

+ AdoptSubnet func(ctx context.Context, subnet Subnet) fail.Error

+ Browse func(ctx context.Context, callback func(*abstract.Network) fail.Error) fail.Error

+ Create func(ctx context.Context, req abstract.NetworkRequest) fail.Error

+ Delete func(ctx context.Context) fail.Error

+ Import func(ctx context.Context, ref string) fail.Error

+ InspectSubnet func(subnetRef string) (Subnet, fail.Error)

+ ToProtocol func() (*protocol.Network, fail.Error)

+ type Results interface

+ Add func(string, UnitResults) error

+ AddOne func(string, string, UnitResult) error

+ AllErrorMessages func() string

+ ErrorMessagesOfKey func(name string) string

+ ErrorMessagesOfUnit func(name string) string

+ Keys func() []string

+ ResultsOfKey func(key string) UnitResults

+ Successful func() bool

+ type SecurityGroup interface

+ AddRule func(ctx context.Context, _ *abstract.SecurityGroupRule) fail.Error

+ AddRules func(ctx context.Context, _ abstract.SecurityGroupRules) fail.Error

+ BindToHost func(ctx context.Context, host Host, _ SecurityGroupActivation, _ SecurityGroupMark) fail.Error

+ BindToSubnet func(ctx context.Context, _ Subnet, _ SecurityGroupActivation, _ SecurityGroupMark) fail.Error

+ Browse func(ctx context.Context, callback func(*abstract.SecurityGroup) fail.Error) fail.Error

+ Clear func(ctx context.Context) fail.Error

+ Create func(ctx context.Context, networkID, name, description string, ...) fail.Error

+ Delete func(ctx context.Context, force bool) fail.Error

+ DeleteRule func(ctx context.Context, rule *abstract.SecurityGroupRule) fail.Error

+ GetBoundHosts func(ctx context.Context) ([]*propertiesv1.SecurityGroupBond, fail.Error)

+ GetBoundSubnets func(ctx context.Context) ([]*propertiesv1.SecurityGroupBond, fail.Error)

+ Reset func(ctx context.Context) fail.Error

+ ToProtocol func() (*protocol.SecurityGroupResponse, fail.Error)

+ UnbindFromHost func(ctx context.Context, _ Host) fail.Error

+ UnbindFromHostByReference func(ctx context.Context, _ string) fail.Error

+ UnbindFromSubnet func(ctx context.Context, _ Subnet) fail.Error

+ UnbindFromSubnetByReference func(ctx context.Context, _ string) fail.Error

+ type SecurityGroupActivation bool

+ const SecurityGroupDisable

+ const SecurityGroupEnable

+ type SecurityGroupMark bool

+ type Share interface

+ Browse func(ctx context.Context, callback func(hostName string, shareID string) fail.Error) fail.Error

+ Create func(ctx context.Context, shareName string, host Host, path string, options string) fail.Error

+ Delete func(ctx context.Context) fail.Error

+ GetServer func() (Host, fail.Error)

+ Mount func(ctx context.Context, host Host, path string, withCache bool) (*propertiesv1.HostRemoteMount, fail.Error)

+ ToProtocol func() (*protocol.ShareMountList, fail.Error)

+ Unmount func(ctx context.Context, host Host) fail.Error

+ type Subnet interface

+ AttachHost func(ctx context.Context, _ Host) fail.Error

+ BindSecurityGroup func(ctx context.Context, _ SecurityGroup, _ SecurityGroupActivation) fail.Error

+ Browse func(ctx context.Context, callback func(*abstract.Subnet) fail.Error) fail.Error

+ Create func(ctx context.Context, req abstract.SubnetRequest, gwname string, ...) fail.Error

+ Delete func(ctx context.Context) fail.Error

+ DetachHost func(ctx context.Context, hostID string) fail.Error

+ DisableSecurityGroup func(ctx context.Context, _ SecurityGroup) fail.Error

+ EnableSecurityGroup func(ctx context.Context, _ SecurityGroup) fail.Error

+ GetDefaultRouteIP func() (string, fail.Error)

+ GetEndpointIP func() (string, fail.Error)

+ GetGatewayPublicIP func(primary bool) (string, fail.Error)

+ GetGatewayPublicIPs func() ([]string, fail.Error)

+ GetState func() (subnetstate.Enum, fail.Error)

+ HasVirtualIP func() (bool, fail.Error)

+ InspectGateway func(primary bool) (Host, fail.Error)

+ InspectGatewaySecurityGroup func() (SecurityGroup, fail.Error)

+ InspectInternalSecurityGroup func() (SecurityGroup, fail.Error)

+ InspectNetwork func() (Network, fail.Error)

+ InspectPublicIPSecurityGroup func() (SecurityGroup, fail.Error)

+ ListHosts func(ctx context.Context) ([]Host, fail.Error)

+ ListSecurityGroups func(ctx context.Context, state securitygroupstate.Enum) ([]*propertiesv1.SecurityGroupBond, fail.Error)

+ ToProtocol func() (*protocol.Subnet, fail.Error)

+ UnbindSecurityGroup func(ctx context.Context, _ SecurityGroup) fail.Error

+ type Targetable interface

+ ComplementFeatureParameters func(ctx context.Context, v data.Map) fail.Error

+ InstallMethods func() map[uint8]installmethod.Enum

+ InstalledFeatures func() []string

+ RegisterFeature func(f Feature, requiredBy Feature, clusterContext bool) fail.Error

+ TargetType func() featuretargettype.Enum

+ UnregisterFeature func(f string) fail.Error

+ type UnitResult interface

+ Completed func() bool

+ Error func() error

+ ErrorMessage func() string

+ Successful func() bool

+ type UnitResults interface

+ AddOne func(string, UnitResult)

+ Completed func() bool

+ ErrorMessages func() string

+ Keys func() []string

+ ResultOfKey func(key string) UnitResult

+ Successful func() bool

+ Uncompleted func() []string

+ type Volume interface

+ Attach func(ctx context.Context, host Host, path, format string, ...) fail.Error

+ Browse func(ctx context.Context, callback func(*abstract.Volume) fail.Error) fail.Error

+ Create func(ctx context.Context, req abstract.VolumeRequest) fail.Error

+ Delete func(ctx context.Context) fail.Error

+ Detach func(ctx context.Context, host Host) fail.Error

+ GetAttachments func() (*propertiesv1.VolumeAttachments, fail.Error)

+ GetSize func() (int, fail.Error)

+ GetSpeed func() (volumespeed.Enum, fail.Error)

+ ToProtocol func() (*protocol.VolumeInspectResponse, fail.Error)