platform

Mar 29, 2017

Changes in this version

type LinuxOptions

+ ScrubEphemeralDisk bool

Apr 8, 2021

Changes in this version

+ const ArpInterfaceCheckDelay

+ const ArpIterationDelay

+ const ArpIterations

+ const CredentialFileName

+ const EtcHostsFileName

+ const EtcHostsTemplate

+ const OsErrorFileInUse

+ const OsErrorFileNotFound2

+ const OsErrorFileNotFound3

+ const SigarStatsCollectionInterval

+ var ErrNotImplemented = errors.New("not implemented") — darwin/amd64, js/wasm, linux/amd64

+ func DummyWrapFs(fs boshsys.FileSystem) boshsys.FileSystem

+ func NewMonitRetryable(cmdRunner boshsys.CmdRunner) boshretry.Retryable

+ type AuditLogger interface

+ Debug func(string)

+ Err func(string)

+ StartLogging func()

+ func NewDelayedAuditLogger(auditLoggerProvider AuditLoggerProvider, logger boshlog.Logger) AuditLogger

+ type AuditLoggerProvider interface

+ ProvideDebugLogger func() (*log.Logger, error)

+ ProvideErrorLogger func() (*log.Logger, error)

+ func NewAuditLoggerProvider() AuditLoggerProvider

+ type BootstrapState struct

+ Linux LinuxState

+ func NewBootstrapState(fs boshsys.FileSystem, path string) (*BootstrapState, error)

+ func (s *BootstrapState) SaveState() (err error)

+ type DelayedAuditLogger struct — darwin/amd64, js/wasm, linux/amd64

+ func NewDelayedAuditLogger(auditLoggerProvider AuditLoggerProvider, logger boshlog.Logger) *DelayedAuditLogger

+ func (l *DelayedAuditLogger) Debug(msg string)

+ func (l *DelayedAuditLogger) Err(msg string)

+ func (l *DelayedAuditLogger) StartLogging()

+ type DummyFs struct

+ func (d *DummyFs) Chown(path string, username string) error

+ type LinuxOptions struct

+ BindMountPersistentDisk bool

+ CreatePartitionIfNoEphemeralDisk bool

+ DevicePathResolutionType string

+ PartitionerType string

+ SkipDiskSetup bool

+ UseDefaultTmpDir bool

+ UsePreformattedPersistentDisk bool

+ type LinuxState struct

+ HostsConfigured bool

+ type Options struct

+ Linux LinuxOptions

+ Windows WindowsOptions

+ type Platform interface

+ AddUserToGroups func(username string, groups []string) (err error)

+ AssociateDisk func(name string, settings boshsettings.DiskSettings) error

+ CreateUser func(username, basePath string) (err error)

+ DeleteARPEntryWithIP func(ip string) error

+ DeleteEphemeralUsersMatching func(regex string) (err error)

+ GetAgentSettingsPath func(tmpfs bool) string

+ GetAuditLogger func() AuditLogger

+ GetCertManager func() cert.Manager

+ GetCompressor func() boshcmd.Compressor

+ GetConfiguredNetworkInterfaces func() ([]string, error)

+ GetCopier func() boshcmd.Copier

+ GetDefaultNetwork func() (boshsettings.Network, error)

+ GetDevicePathResolver func() (devicePathResolver boshdpresolv.DevicePathResolver)

+ GetDirProvider func() boshdir.Provider

+ GetEphemeralDiskPath func(diskSettings boshsettings.DiskSettings) (string, error)

+ GetFileContentsFromCDROM func(filePath string) (contents []byte, err error)

+ GetFilesContentsFromDisk func(diskPath string, fileNames []string) (contents [][]byte, err error)

+ GetFs func() boshsys.FileSystem

+ GetHostPublicKey func() (string, error)

+ GetMonitCredentials func() (username, password string, err error)

+ GetPersistentDiskSettingsPath func(tmpfs bool) string

+ GetRunner func() boshsys.CmdRunner

+ GetVitalsService func() boshvitals.Service

+ IsMountPoint func(path string) (partitionPath string, result bool, err error)

+ IsPersistentDiskMountable func(diskSettings boshsettings.DiskSettings) (bool, error)

+ IsPersistentDiskMounted func(diskSettings boshsettings.DiskSettings) (result bool, err error)

+ MigratePersistentDisk func(fromMountPoint, toMountPoint string) (err error)

+ MountPersistentDisk func(diskSettings boshsettings.DiskSettings, mountPoint string) error

+ PrepareForNetworkingChange func() error

+ RemoveDevTools func(packageFileListPath string) error

+ RemoveStaticLibraries func(packageFileListPath string) error

+ SaveDNSRecords func(dnsRecords boshsettings.DNSRecords, hostname string) error

+ SetTimeWithNtpServers func(servers []string) (err error)

+ SetUserPassword func(user, encryptedPwd string) (err error)

+ SetupBlobsDir func() (err error)

+ SetupBoshSettingsDisk func() (err error)

+ SetupCanRestartDir func() (err error)

+ SetupDataDir func(boshsettings.JobDir, boshsettings.RunDir) (err error)

+ SetupEphemeralDiskWithPath func(devicePath string, desiredSwapSizeInBytes *uint64, labelPrefix string) (err error)

+ SetupHomeDir func() (err error)

+ SetupHostname func(hostname string) (err error)

+ SetupIPv6 func(boshsettings.IPv6) error

+ SetupLogDir func() (err error)

+ SetupLoggingAndAuditing func() (err error)

+ SetupLogrotate func(groupName, basePath, size string) (err error)

+ SetupMonitUser func() (err error)

+ SetupNetworking func(networks boshsettings.Networks) (err error)

+ SetupRawEphemeralDisks func(devices []boshsettings.DiskSettings) (err error)

+ SetupRecordsJSONPermission func(path string) error

+ SetupRootDisk func(ephemeralDiskPath string) (err error)

+ SetupRuntimeConfiguration func() (err error)

+ SetupSSH func(publicKey []string, username string) (err error)

+ SetupSharedMemory func() (err error)

+ SetupTmpDir func() (err error)

+ Shutdown func() error

+ StartMonit func() (err error)

+ UnmountPersistentDisk func(diskSettings boshsettings.DiskSettings) (didUnmount bool, err error)

+ func NewDummyPlatform(collector boshstats.Collector, fs boshsys.FileSystem, ...) Platform

+ func NewLinuxPlatform(fs boshsys.FileSystem, cmdRunner boshsys.CmdRunner, ...) Platform

+ func NewWindowsPlatform(collector boshstats.Collector, fs boshsys.FileSystem, ...) Platform

+ type Provider interface

+ Get func(name string) (Platform, error)

+ func NewProvider(logger boshlog.Logger, dirProvider boshdirs.Provider, ...) Provider

+ type WindowsAuditLogger struct — windows/amd64

+ func (w *WindowsAuditLogger) Debug(msg string)

+ func (w *WindowsAuditLogger) Err(msg string)

+ func (w *WindowsAuditLogger) StartLogging()

+ type WindowsDiskManager interface

+ GetFormatter func() disk.WindowsDiskFormatter

+ GetLinker func() disk.WindowsDiskLinker

+ GetPartitioner func() disk.WindowsDiskPartitioner

+ GetProtector func() disk.WindowsDiskProtector

+ type WindowsOptions struct

+ EnableEphemeralDiskMounting bool

+ type WindowsPlatform struct

+ func (p WindowsPlatform) AddUserToGroups(username string, groups []string) (err error)

+ func (p WindowsPlatform) AssociateDisk(name string, settings boshsettings.DiskSettings) error

+ func (p WindowsPlatform) CleanIPMacAddressCache(ip string) error

+ func (p WindowsPlatform) CreateUser(username, _ string) error

+ func (p WindowsPlatform) DeleteARPEntryWithIP(ip string) error

+ func (p WindowsPlatform) DeleteEphemeralUsersMatching(pattern string) error

+ func (p WindowsPlatform) GetAgentSettingsPath(tmpfs bool) string

+ func (p WindowsPlatform) GetAuditLogger() AuditLogger

+ func (p WindowsPlatform) GetCertManager() (certManager boshcert.Manager)

+ func (p WindowsPlatform) GetCompressor() (compressor boshcmd.Compressor)

+ func (p WindowsPlatform) GetConfiguredNetworkInterfaces() (interfaces []string, err error)

+ func (p WindowsPlatform) GetCopier() (copier boshcmd.Copier)

+ func (p WindowsPlatform) GetDefaultNetwork() (boshsettings.Network, error)

+ func (p WindowsPlatform) GetDevicePathResolver() (devicePathResolver boshdpresolv.DevicePathResolver)

+ func (p WindowsPlatform) GetDirProvider() (dirProvider boshdir.Provider)

+ func (p WindowsPlatform) GetEphemeralDiskPath(diskSettings boshsettings.DiskSettings) (diskPath string, err error)

+ func (p WindowsPlatform) GetFileContentsFromCDROM(filePath string) (contents []byte, err error)

+ func (p WindowsPlatform) GetFilesContentsFromDisk(diskPath string, fileNames []string) (contents [][]byte, err error)

+ func (p WindowsPlatform) GetFs() (fs boshsys.FileSystem)

+ func (p WindowsPlatform) GetHostPublicKey() (string, error)

+ func (p WindowsPlatform) GetMonitCredentials() (username, password string, err error)

+ func (p WindowsPlatform) GetPersistentDiskSettingsPath(tmpfs bool) string

+ func (p WindowsPlatform) GetRunner() (runner boshsys.CmdRunner)

+ func (p WindowsPlatform) GetVitalsService() (service boshvitals.Service)

+ func (p WindowsPlatform) IsMountPoint(path string) (string, bool, error)

+ func (p WindowsPlatform) IsPersistentDiskMountable(diskSettings boshsettings.DiskSettings) (bool, error)

+ func (p WindowsPlatform) IsPersistentDiskMounted(diskSettings boshsettings.DiskSettings) (bool, error)

+ func (p WindowsPlatform) MigratePersistentDisk(fromMountPoint, toMountPoint string) (err error)

+ func (p WindowsPlatform) MountPersistentDisk(diskSettings boshsettings.DiskSettings, mountPoint string) (err error)

+ func (p WindowsPlatform) PrepareForNetworkingChange() error

+ func (p WindowsPlatform) RemoveDevTools(packageFileListPath string) error

+ func (p WindowsPlatform) RemoveStaticLibraries(packageFileListPath string) error

+ func (p WindowsPlatform) SaveDNSRecords(dnsRecords boshsettings.DNSRecords, hostname string) (err error)

+ func (p WindowsPlatform) SetTimeWithNtpServers(servers []string) (err error)

+ func (p WindowsPlatform) SetUserPassword(user, encryptedPwd string) (err error)

+ func (p WindowsPlatform) SetupBlobsDir() error

+ func (p WindowsPlatform) SetupBoshSettingsDisk() error

+ func (p WindowsPlatform) SetupCanRestartDir() error

+ func (p WindowsPlatform) SetupDataDir(_ boshsettings.JobDir, _ boshsettings.RunDir) error

+ func (p WindowsPlatform) SetupEphemeralDiskWithPath(devicePath string, desiredSwapSizeInBytes *uint64, labelPrefix string) error

+ func (p WindowsPlatform) SetupHomeDir() error

+ func (p WindowsPlatform) SetupHostname(hostname string) (err error)

+ func (p WindowsPlatform) SetupIPv6(config boshsettings.IPv6) error

+ func (p WindowsPlatform) SetupLogDir() error

+ func (p WindowsPlatform) SetupLoggingAndAuditing() error

+ func (p WindowsPlatform) SetupLogrotate(groupName, basePath, size string) (err error)

+ func (p WindowsPlatform) SetupMonitUser() (err error)

+ func (p WindowsPlatform) SetupNetworking(networks boshsettings.Networks) (err error)

+ func (p WindowsPlatform) SetupRawEphemeralDisks(devices []boshsettings.DiskSettings) (err error)

+ func (p WindowsPlatform) SetupRecordsJSONPermission(path string) error

+ func (p WindowsPlatform) SetupRootDisk(ephemeralDiskPath string) (err error)

+ func (p WindowsPlatform) SetupRuntimeConfiguration() error

+ func (p WindowsPlatform) SetupSSH(publicKey []string, username string) error

+ func (p WindowsPlatform) SetupSharedMemory() error

+ func (p WindowsPlatform) SetupTmpDir() error

+ func (p WindowsPlatform) Shutdown() error

+ func (p WindowsPlatform) StartMonit() (err error)

+ func (p WindowsPlatform) UnmountPersistentDisk(diskSettings boshsettings.DiskSettings) (didUnmount bool, err error)