clients

Documentation

Index

• func IronicClient(ironicEndpoint string, auth AuthConfig, tls TLSConfig) (client *gophercloud.ServiceClient, err error)
• type AuthConfig
  • func ConfigFromEndpointURL(endpointURL string) (endpoint string, auth AuthConfig, err error)
  • func LoadAuth() (auth AuthConfig, err error)
• type AuthType
• type AvailableFeatures
  • func GetAvailableFeatures(client *gophercloud.ServiceClient) (features AvailableFeatures, err error)
  • func (af AvailableFeatures) ChooseMicroversion() string
  • func (af AvailableFeatures) HasFirmwareUpdates() bool
  • func (af AvailableFeatures) Log(logger logr.Logger)
• type TLSConfig

Functions

func IronicClient

func IronicClient(ironicEndpoint string, auth AuthConfig, tls TLSConfig) (client *gophercloud.ServiceClient, err error)

IronicClient creates a client for Ironic

Types

type AuthConfig

type AuthConfig struct {
	Type     AuthType
	Username string
	Password string
}

AuthConfig contains data needed to configure authentication in the client

func ConfigFromEndpointURL

func ConfigFromEndpointURL(endpointURL string) (endpoint string, auth AuthConfig, err error)

ConfigFromEndpointURL returns an endpoint and an auth config from an endpoint URL that may contain HTTP basic auth credentials.

func LoadAuth

func LoadAuth() (auth AuthConfig, err error)

LoadAuth loads the Ironic configuration from the environment

type AuthType

type AuthType string

AuthType is the method of authenticating requests to the server

const (
	// NoAuth uses no authentication
	NoAuth AuthType = "noauth"
	// HTTPBasicAuth uses HTTP Basic Authentication
	HTTPBasicAuth AuthType = "http_basic"
)

type AvailableFeatures

type AvailableFeatures struct {
	MaxVersion int
}

AvailableFeatures represents features that Ironic API provides. See https://docs.openstack.org/ironic/latest/contributor/webapi-version-history.html

func GetAvailableFeatures

func GetAvailableFeatures(client *gophercloud.ServiceClient) (features AvailableFeatures, err error)

func (AvailableFeatures) ChooseMicroversion

func (af AvailableFeatures) ChooseMicroversion() string

func (AvailableFeatures) HasFirmwareUpdates

func (af AvailableFeatures) HasFirmwareUpdates() bool

func (AvailableFeatures) Log

func (af AvailableFeatures) Log(logger logr.Logger)

type TLSConfig

type TLSConfig struct {
	TrustedCAFile         string
	ClientCertificateFile string
	ClientPrivateKeyFile  string
	InsecureSkipVerify    bool
	SkipClientSANVerify   bool
}

TLSConfig contains the TLS configuration for the Ironic connection. Using Go default values for this will result in no additional trusted CA certificates and a secure connection. When specifying Certificate and Private key, TLS connection will use client certificate authentication.