client

Documentation

Index

• Variables
• type AuthInfo
• type ClientConfig
  • func NewClientConfigFromConfig(config *Config) ClientConfig
• type Config
  • func NewConfig() *Config
• type DirectClientConfig
  • func (config *DirectClientConfig) ClientConfig() (*rest.Config, error)
  • func (config *DirectClientConfig) ConfirmUsable() error
• type Server

Variables

var (
	// ErrEmptyConfig defines no configuration has been provided error.
	ErrEmptyConfig = errors.New(
		"no configuration has been provided, try setting SKT_SERVER_ADDRESS environment variable",
	)

	// ErrEmptyServer defines a no server defined error.
	ErrEmptyServer = errors.New("server has no server defined")
)

Types

type AuthInfo

type AuthInfo struct {
	LocationOfOrigin      string
	ClientCertificate     string `yaml:"client-certificate,omitempty"      mapstructure:"client-certificate,omitempty"`
	ClientCertificateData string `yaml:"client-certificate-data,omitempty" mapstructure:"client-certificate-data,omitempty"` // +optional
	ClientKey             string `yaml:"client-key,omitempty"              mapstructure:"client-key,omitempty"`              // +optional
	ClientKeyData         string `yaml:"client-key-data,omitempty"         mapstructure:"client-key-data,omitempty"`         // +optional
	Token                 string `yaml:"token,omitempty"                   mapstructure:"token,omitempty"`                   // +optional

	Username string `yaml:"username,omitempty" mapstructure:"username,omitempty"`
	Password string `yaml:"password,omitempty" mapstructure:"password,omitempty"`

	SecretID  string `yaml:"secret-id,omitempty"  mapstructure:"secret-id,omitempty"`
	SecretKey string `yaml:"secret-key,omitempty" mapstructure:"secret-key,omitempty"`
}

type ClientConfig

type ClientConfig interface {
	// ClientConfig returns a complete client config
	ClientConfig() (*rest.Config, error)
}

func NewClientConfigFromConfig

func NewClientConfigFromConfig(config *Config) ClientConfig

type Config

type Config struct {
	APIVersion string    `yaml:"apiVersion,omitempty" mapstructure:"apiVersion,omitempty"`
	AuthInfo   *AuthInfo `yaml:"user,omitempty"       mapstructure:"user,omitempty"`
	Server     *Server   `yaml:"server,omitempty"     mapstructure:"server,omitempty"`
}

func NewConfig

func NewConfig() *Config

type DirectClientConfig

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

func (*DirectClientConfig) ClientConfig

func (config *DirectClientConfig) ClientConfig() (*rest.Config, error)

func (*DirectClientConfig) ConfirmUsable

func (config *DirectClientConfig) ConfirmUsable() error

type Server

type Server struct {
	LocationOfOrigin         string
	Timeout                  time.Duration `yaml:"timeout,omitempty"                    mapstructure:"timeout,omitempty"`
	MaxRetries               int           `yaml:"max-retries,omitempty"                mapstructure:"max-retries,omitempty"`
	RetryInterval            time.Duration `yaml:"retry-interval,omitempty"             mapstructure:"retry-interval,omitempty"`
	Address                  string        `yaml:"address,omitempty"                    mapstructure:"address,omitempty"`
	TLSServerName            string        `yaml:"tls-server-name,omitempty"            mapstructure:"tls-server-name,omitempty"`            // +optional
	InsecureSkipTLSVerify    bool          `yaml:"insecure-skip-tls-verify,omitempty"   mapstructure:"insecure-skip-tls-verify,omitempty"`   // +optional
	CertificateAuthority     string        `yaml:"certificate-authority,omitempty"      mapstructure:"certificate-authority,omitempty"`      // +optional
	CertificateAuthorityData string        `yaml:"certificate-authority-data,omitempty" mapstructure:"certificate-authority-data,omitempty"` // +optional
}