settings

Documentation

Index

• Constants
• type Blobstore
• type BoshEnv
• type DefaultNetworkResolver
• type DiskSettings
• type Disks
• type Env
  • func (e Env) GetKeepRootPassword() bool
  • func (e Env) GetPassword() string
  • func (e Env) GetRemoveDevTools() bool
• type Network
  • func (n Network) IsDHCP() bool
  • func (n Network) IsDefaultFor(category string) bool
  • func (n Network) IsVIP() bool
  • func (n Network) String() string
• type NetworkType
• type Networks
  • func (n Networks) DefaultIP() (ip string, found bool)
  • func (n Networks) DefaultNetworkFor(category string) (Network, bool)
  • func (n Networks) IPs() (ips []string)
  • func (n Networks) IsPreconfigured() bool
  • func (n Networks) NetworkForMac(mac string) (Network, bool)
• type Service
  • func NewService(fs boshsys.FileSystem, settingsPath string, settingsSource Source, ...) (service Service)
• type Settings
  • func (s Settings) EphemeralDiskSettings() DiskSettings
  • func (s Settings) PersistentDiskSettings(diskID string) (DiskSettings, bool)
  • func (s Settings) RawEphemeralDiskSettings() (devices []DiskSettings)
• type Source
• type VM

Constants

const (
	RootUsername        = "root"
	VCAPUsername        = "vcap"
	AdminGroup          = "admin"
	SudoersGroup        = "bosh_sudoers"
	EphemeralUserPrefix = "bosh_"
)

Types

type Blobstore

type Blobstore struct {
	Type    string                 `json:"provider"`
	Options map[string]interface{} `json:"options"`
}

type BoshEnv

type BoshEnv struct {
	Password         string `json:"password"`
	KeepRootPassword bool   `json:"keep_root_password"`
	RemoveDevTools   bool   `json:"remove_dev_tools"`
}

type DefaultNetworkResolver

type DefaultNetworkResolver interface {
	// Ideally we would find a network based on a MAC address
	// but current CPI implementations do not include it
	GetDefaultNetwork() (Network, error)
}

type DiskSettings

type DiskSettings struct {
	ID             string
	DeviceID       string
	VolumeID       string
	Path           string
	FileSystemType disk.FileSystemType
}

type Disks

type Disks struct {
	// e.g "/dev/sda", "1"
	System string `json:"system"`

	// Older CPIs returned disk settings as string
	// e.g "/dev/sdb", "2"
	// Newer CPIs will populate it in a hash
	// e.g {"path" => "/dev/sdc", "volume_id" => "3"}
	Ephemeral interface{} `json:"ephemeral"`

	// Older CPIs returned disk settings as strings
	// e.g {"disk-3845-43758-7243-38754" => "/dev/sdc"}
	//     {"disk-3845-43758-7243-38754" => "3"}
	// Newer CPIs will populate it in a hash:
	// e.g {"disk-3845-43758-7243-38754" => {"path" => "/dev/sdc"}}
	//     {"disk-3845-43758-7243-38754" => {"volume_id" => "3"}}
	Persistent map[string]interface{} `json:"persistent"`

	RawEphemeral []DiskSettings `json:"raw_ephemeral"`
}

type Env

type Env struct {
	Bosh             BoshEnv             `json:"bosh"`
	PersistentDiskFS disk.FileSystemType `json:"persistent_disk_fs"`
}

func (Env) GetKeepRootPassword

func (e Env) GetKeepRootPassword() bool

func (Env) GetPassword

func (e Env) GetPassword() string

func (Env) GetRemoveDevTools

func (e Env) GetRemoveDevTools() bool

type Network

type Network struct {
	Type NetworkType `json:"type"`

	IP       string `json:"ip"`
	Netmask  string `json:"netmask"`
	Gateway  string `json:"gateway"`
	Resolved bool   `json:"resolved"` // was resolved via DHCP
	UseDHCP  bool   `json:"use_dhcp"`

	Default []string `json:"default"`
	DNS     []string `json:"dns"`

	Mac string `json:"mac"`

	Preconfigured bool `json:"preconfigured"`
}

func (Network) IsDHCP

func (n Network) IsDHCP() bool

func (Network) IsDefaultFor

func (n Network) IsDefaultFor(category string) bool

func (Network) IsVIP

func (n Network) IsVIP() bool

func (Network) String

func (n Network) String() string

type NetworkType

type NetworkType string

const (
	NetworkTypeDynamic NetworkType = "dynamic"
	NetworkTypeVIP     NetworkType = "vip"
)

type Networks

type Networks map[string]Network

func (Networks) DefaultIP

func (n Networks) DefaultIP() (ip string, found bool)

func (Networks) DefaultNetworkFor

func (n Networks) DefaultNetworkFor(category string) (Network, bool)

func (Networks) IPs

func (n Networks) IPs() (ips []string)

func (Networks) IsPreconfigured

func (n Networks) IsPreconfigured() bool

func (Networks) NetworkForMac

func (n Networks) NetworkForMac(mac string) (Network, bool)

type Service

type Service interface {
	LoadSettings() error

	// GetSettings does not return error because without settings Agent cannot start.
	GetSettings() Settings

	PublicSSHKeyForUsername(string) (string, error)

	InvalidateSettings() error
}

func NewService

func NewService(
	fs boshsys.FileSystem,
	settingsPath string,
	settingsSource Source,
	defaultNetworkResolver DefaultNetworkResolver,
	logger boshlog.Logger,
) (service Service)

type Settings

type Settings struct {
	AgentID      string    `json:"agent_id"`
	Blobstore    Blobstore `json:"blobstore"`
	Disks        Disks     `json:"disks"`
	Env          Env       `json:"env"`
	Networks     Networks  `json:"networks"`
	Ntp          []string  `json:"ntp"`
	Mbus         string    `json:"mbus"`
	VM           VM        `json:"vm"`
	TrustedCerts string    `json:"trusted_certs"`
}

func (Settings) EphemeralDiskSettings

func (s Settings) EphemeralDiskSettings() DiskSettings

func (Settings) PersistentDiskSettings

func (s Settings) PersistentDiskSettings(diskID string) (DiskSettings, bool)

func (Settings) RawEphemeralDiskSettings

func (s Settings) RawEphemeralDiskSettings() (devices []DiskSettings)

type Source

type Source interface {
	PublicSSHKeyForUsername(string) (string, error)
	Settings() (Settings, error)
}

type VM

type VM struct {
	Name string `json:"name"`
}