client

Documentation

Index

• Constants
• func CreateAuthProvider(authInfo AuthInfo, insecure bool) (login.AuthProvider, error)
• func CreateTLSConfigFromConfig(config *Config) (*tls.Config, error)
• func DefaultFlightctlClientConfigPath() (string, error)
• func GetAccessToken(config *Config, configFilePath string) string
• func NewFromConfig(config *Config, configFilePath string) (*client.ClientWithResponses, error)
• func NewFromConfigFile(filename string) (*client.ClientWithResponses, error)
• func NewGRPCClientFromConfig(config *Config, endpoint string) (grpc_v1.RouterServiceClient, error)
• func NewGrpcClientFromConfigFile(filename string, endpoint string) (grpc_v1.RouterServiceClient, error)
• func NewHTTPClientFromConfig(config *Config) (*http.Client, error)
• func WriteConfig(filename string, server string, tlsServerName string, caCertPEM []byte, ...) error
• type AuthInfo
  • func (a *AuthInfo) DeepCopy() *AuthInfo
  • func (a *AuthInfo) Equal(a2 *AuthInfo) bool
• type AuthProviderConfig
  • func (a *AuthProviderConfig) DeepCopy() *AuthProviderConfig
  • func (a *AuthProviderConfig) Equal(a2 *AuthProviderConfig) bool
• type Config
  • func NewDefault() *Config
  • func ParseConfigFile(filename string) (*Config, error)
  • func (c *Config) DeepCopy() *Config
  • func (c *Config) Equal(c2 *Config) bool
  • func (c *Config) Flatten() error
  • func (c *Config) GetClientCertificatePath() string
  • func (c *Config) GetClientKeyPath() string
  • func (c *Config) HasCredentials() bool
  • func (c *Config) Persist(filename string) error
  • func (c *Config) SetBaseDir(baseDir string)
  • func (c *Config) Validate() error
• type Service
  • func (s *Service) DeepCopy() *Service
  • func (s *Service) Equal(s2 *Service) bool

Constants

const (
	AuthUrlKey               = "server"
	AuthCAFileKey            = "certificate-authority"
	AuthRefreshTokenKey      = "refresh-token"
	AuthAccessTokenExpiryKey = "access-token-expiry"
	AuthClientIdKey          = "client-id"
)

const (
	// TestRootDirEnvKey is the environment variable key used to set the file system root when testing.
	TestRootDirEnvKey = "FLIGHTCTL_TEST_ROOT_DIR"
)

Functions

func CreateAuthProvider

func CreateAuthProvider(authInfo AuthInfo, insecure bool) (login.AuthProvider, error)

func CreateTLSConfigFromConfig

func CreateTLSConfigFromConfig(config *Config) (*tls.Config, error)

func DefaultFlightctlClientConfigPath

func DefaultFlightctlClientConfigPath() (string, error)

DefaultFlightctlClientConfigPath returns the default path to the Flight Control client config file.

func GetAccessToken

func GetAccessToken(config *Config, configFilePath string) string

func NewFromConfig

func NewFromConfig(config *Config, configFilePath string) (*client.ClientWithResponses, error)

NewFromConfig returns a new Flight Control API client from the given config.

func NewFromConfigFile

func NewFromConfigFile(filename string) (*client.ClientWithResponses, error)

NewFromConfigFile returns a new Flight Control API client using the config read from the given file.

func NewGRPCClientFromConfig

func NewGRPCClientFromConfig(config *Config, endpoint string) (grpc_v1.RouterServiceClient, error)

NewGRPCClientFromConfig returns a new gRPC Client from the given config.

func NewGrpcClientFromConfigFile

func NewGrpcClientFromConfigFile(filename string, endpoint string) (grpc_v1.RouterServiceClient, error)

NewFromConfigFile returns a new Flight Control API client using the config read from the given file.

func NewHTTPClientFromConfig

func NewHTTPClientFromConfig(config *Config) (*http.Client, error)

NewHTTPClientFromConfig returns a new HTTP Client from the given config.

func WriteConfig

func WriteConfig(filename string, server string, tlsServerName string, caCertPEM []byte, client *crypto.TLSCertificateConfig) error

WriteConfig writes a client config file using the given parameters.

Types

type AuthInfo

type AuthInfo struct {
	// ClientCertificate is the path to a client cert file for TLS.
	// +optional
	ClientCertificate string `json:"client-certificate,omitempty"`
	// ClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate.
	// +optional
	ClientCertificateData []byte `json:"client-certificate-data,omitempty"`
	// ClientKey is the path to a client key file for TLS.
	// +optional
	ClientKey string `json:"client-key,omitempty"`
	// ClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKey.
	// +optional
	ClientKeyData []byte `json:"client-key-data,omitempty" datapolicy:"security-key"`
	// Bearer token for authentication
	// +optional
	Token string `json:"token,omitempty"`
	// The authentication provider (i.e. k8s, OIDC)
	// +optional
	AuthProvider *AuthProviderConfig `json:"auth-provider,omitempty"`
}

AuthInfo contains information for authenticating Flight Control API clients.

func (*AuthInfo) DeepCopy

func (a *AuthInfo) DeepCopy() *AuthInfo

func (*AuthInfo) Equal

func (a *AuthInfo) Equal(a2 *AuthInfo) bool

type AuthProviderConfig

type AuthProviderConfig struct {
	// Name is the name of the authentication provider
	Name string `json:"name"`
	// Config is a map of authentication provider-specific configuration
	Config map[string]string `json:"config,omitempty"`
}

func (*AuthProviderConfig) DeepCopy

func (a *AuthProviderConfig) DeepCopy() *AuthProviderConfig

func (*AuthProviderConfig) Equal

func (a *AuthProviderConfig) Equal(a2 *AuthProviderConfig) bool

type Config

type Config struct {
	Service  Service  `json:"service"`
	AuthInfo AuthInfo `json:"authentication"`
	// contains filtered or unexported fields
}

Config holds the information needed to connect to a Flight Control API server

func NewDefault

func NewDefault() *Config

func ParseConfigFile

func ParseConfigFile(filename string) (*Config, error)

func (*Config) DeepCopy

func (c *Config) DeepCopy() *Config

func (*Config) Equal

func (c *Config) Equal(c2 *Config) bool

func (*Config) Flatten

func (c *Config) Flatten() error

Reads the contents of all referenced files and embeds them in the config.

func (*Config) GetClientCertificatePath

func (c *Config) GetClientCertificatePath() string

func (*Config) GetClientKeyPath

func (c *Config) GetClientKeyPath() string

func (*Config) HasCredentials

func (c *Config) HasCredentials() bool

func (*Config) Persist

func (c *Config) Persist(filename string) error

func (*Config) SetBaseDir

func (c *Config) SetBaseDir(baseDir string)

func (*Config) Validate

func (c *Config) Validate() error

type Service

type Service struct {
	// Server is the URL of the Flight Control API server (the part before /api/v1/...).
	Server string `json:"server,omitempty"`
	// TLSServerName is passed to the server for SNI and is used in the client to check server certificates against.
	// If TLSServerName is empty, the hostname used to contact the server is used.
	// +optional
	TLSServerName string `json:"tls-server-name,omitempty"`
	// CertificateAuthority is the path to a cert file for the certificate authority.
	CertificateAuthority string `json:"certificate-authority,omitempty"`
	// CertificateAuthorityData contains PEM-encoded certificate authority certificates. Overrides CertificateAuthority
	CertificateAuthorityData []byte `json:"certificate-authority-data,omitempty"`
	InsecureSkipVerify       bool   `json:"insecureSkipVerify,omitempty"`
}

Service contains information how to connect to and authenticate the Flight Control API server.

func (*Service) DeepCopy

func (s *Service) DeepCopy() *Service

func (*Service) Equal

func (s *Service) Equal(s2 *Service) bool