apis

Documentation

Overview

Package apis is the main package for provider specific APIs

Package apis is the main package for provider specific APIs

Package apis is the main package for provider specific APIs

Index

• func GetClientForToken(token string) *hcloud.Client
• func GetRegionFromZone(zone string) string
• func SetClientForToken(token string, client *hcloud.Client)
• func WaitForActionsAndGetFloatingIP(ctx context.Context, client *hcloud.Client, ip *hcloud.FloatingIP) (*hcloud.FloatingIP, error)
• func WaitForActionsAndGetServer(ctx context.Context, client *hcloud.Client, server *hcloud.Server) (*hcloud.Server, error)
• type ProviderSpec

Functions

func GetClientForToken

func GetClientForToken(token string) *hcloud.Client

GetClientForToken returns an underlying HCloud client for the given token.

PARAMETERS token string Token to look up client instance for

func GetRegionFromZone

func GetRegionFromZone(zone string) string

GetRegionFromZone returns the region for a given zone string

PARAMETERS zone string Datacenter zone

func SetClientForToken

func SetClientForToken(token string, client *hcloud.Client)

SetClientForToken sets a preconfigured HCloud client for the given token.

PARAMETERS token string Token to look up client instance for client *hcloud.Client Preconfigured HCloud client

func WaitForActionsAndGetFloatingIP

func WaitForActionsAndGetFloatingIP(ctx context.Context, client *hcloud.Client, ip *hcloud.FloatingIP) (*hcloud.FloatingIP, error)

WaitForActionsAndGetFloatingIP waits for all actions to complete for the floating IP given and returns it afterwards.

PARAMETERS ctx context.Context Execution context client *hcloud.Client HCloud client ip *hcloud.FloatingIP HCloud floating IP struct

func WaitForActionsAndGetServer

func WaitForActionsAndGetServer(ctx context.Context, client *hcloud.Client, server *hcloud.Server) (*hcloud.Server, error)

WaitForActionsAndGetServer waits for all actions to complete for the server given and returns it afterwards.

PARAMETERS ctx context.Context Execution context client *hcloud.Client HCloud client ip *hcloud.Server HCloud server struct

Types

type ProviderSpec

type ProviderSpec struct {
	Cluster        string `json:"cluster"`
	Zone           string `json:"zone"`
	ServerType     string `json:"serverType"`
	ImageName      string `json:"imageName"`
	SSHFingerprint string `json:"sshFingerprint"`

	PlacementGroupID string `json:"placementGroupID,omitempty"`
	FloatingPoolName string `json:"floatingPoolName,omitempty"`
	NetworkName      string `json:"networkName,omitempty"`
}

ProviderSpec is the spec to be used while parsing the calls.