robotclient

Documentation

Overview

Package robotclient contains the interface to speak to Hetzner robot API.

Index

• type Client
• type Credentials
  • func (creds Credentials) Validate() error
• type Factory
  • func NewFactory() Factory

Types

type Client

type Client interface {
	ValidateCredentials() error

	RebootBMServer(int, infrav1.RebootType) (*models.ResetPost, error)
	ListBMServers() ([]models.Server, error)
	SetBMServerName(int, string) (*models.Server, error)
	GetBMServer(int) (*models.Server, error)
	ListSSHKeys() ([]models.Key, error)
	SetSSHKey(name, publickey string) (*models.Key, error)
	SetBootRescue(id int, fingerprint string) (*models.Rescue, error)
	GetBootRescue(id int) (*models.Rescue, error)
	DeleteBootRescue(id int) (*models.Rescue, error)
	GetReboot(int) (*models.Reset, error)
}

Client collects all methods used by the controller in the robot API.

type Credentials

type Credentials struct {
	Username string
	Password string
}

Credentials holds the information for authenticating with the Hetzner robot api.

func (Credentials) Validate

func (creds Credentials) Validate() error

Validate returns an error if the credentials are invalid.

type Factory

type Factory interface {
	NewClient(Credentials) Client
}

Factory is the interface for creating new Client objects.

func NewFactory

func NewFactory() Factory

NewFactory creates a new factory for HCloud clients.