metadata

Documentation

Index

• Constants
• type AgentStatus
• type Metadata
• type SSHInfo
• type SSHKeyParser
  • func NewSSHKeyParser() *SSHKeyParser
  • func (p *SSHKeyParser) FromDOTTYKey(key string) (*sysaccess.SSHKey, error)
  • func (p *SSHKeyParser) FromPublicKey(key string) (*sysaccess.SSHKey, error)

Constants

const (
	// BaseURL address of the droplet's metadata service
	BaseURL = "http://169.254.169.254/metadata"
)

Types

type AgentStatus

type AgentStatus string

AgentStatus is a string type used to identify the current status of the agent

const (
	// InstalledStatus indicates that the agent has been installed but is not yet running
	InstalledStatus AgentStatus = "installed"
	// RunningStatus indicates that the agent is running on the droplet and should be functioning properly
	RunningStatus AgentStatus = "running"
	// StoppedStatus indicates the agent is stopping or has stopped. The agent will be stopped for shutdown and restarts
	// as well as agent updates
	StoppedStatus AgentStatus = "stopped"
)

type Metadata

type Metadata struct {
	// PublicKeys contains all SSH Keys configured for this droplet
	PublicKeys []string `json:"public_keys,omitempty"`
	// DOTTYKeys contains temporary ssh keys used in cases such as web console access
	DOTTYKeys []string `json:"dotty_keys,omitempty"`
	// DOTTYStatus represents the state of the dotty agent valid states are "installed", "running", or "stopped"
	DOTTYStatus        AgentStatus `json:"dotty_status,omitempty"`
	SSHInfo            *SSHInfo    `json:"ssh_info,omitempty"`
	ManagedKeysEnabled *bool       `json:"managed_keys_enabled,omitempty"`
}

Metadata is part of the object returned by the metadata/v1.json.

type SSHInfo

type SSHInfo struct {
	// Port is the port that the sshd is listening to
	Port int `json:"port,omitempty"`
	// HostKeys is the public ssh keys of the droplet, needed for identifying the droplet
	HostKeys []string `json:"host_keys,omitempty"`
}

SSHInfo contains the information of the sshd service running on the droplet

type SSHKeyParser

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

SSHKeyParser is used for parsing different type of SSH Keys from metadata

func NewSSHKeyParser

func NewSSHKeyParser() *SSHKeyParser

NewSSHKeyParser returns a new SSH Key parser

func (*SSHKeyParser) FromDOTTYKey

func (p *SSHKeyParser) FromDOTTYKey(key string) (*sysaccess.SSHKey, error)

FromDOTTYKey parses a string dotty key and converts it into a SSHKey object

func (*SSHKeyParser) FromPublicKey

func (p *SSHKeyParser) FromPublicKey(key string) (*sysaccess.SSHKey, error)

FromPublicKey parses a string public key and attempts to convert it to a SSHKey object