server

Documentation

Index

• func GetDebugEnabled() bool
• func RegisterClusterConfig(cmd *cobra.Command)
• func RegisterConfig(cmd *cobra.Command)
• func RegisterDebugConfig(cmd *cobra.Command)
• func RegisterMetricProviderConfig(cmd *cobra.Command)
• func RegisterTLSConfig(cmd *cobra.Command)
• func RegisterTelemetryConfig(cmd *cobra.Command)
• type ClusterConfig
  • func GetClusterConfig() ClusterConfig
  • func (c *ClusterConfig) MarshalZerologObject(e *zerolog.Event)
• type Config
  • func GetConfig() Config
  • func (c *Config) MarshalZerologObject(e *zerolog.Event)
• type MetricProviderConfig
  • func GetMetricProviderConfig() *MetricProviderConfig
  • func (mpc *MetricProviderConfig) MarshalZerologObject(e *zerolog.Event)
• type MetricProviderPrometheusConfig
• type TLSConfig
  • func GetTLSConfig() TLSConfig
  • func (c *TLSConfig) MarshalZerologObject(e *zerolog.Event)
• type TelemetryConfig
  • func GetTelemetryConfig() TelemetryConfig
  • func (c *TelemetryConfig) MarshalZerologObject(e *zerolog.Event)

Functions

func GetDebugEnabled

func GetDebugEnabled() bool

GetDebugEnabled is used to identify whether the operator has enabled the server debug API endpoints.

func RegisterClusterConfig

func RegisterClusterConfig(cmd *cobra.Command)

func RegisterConfig

func RegisterConfig(cmd *cobra.Command)

func RegisterDebugConfig

func RegisterDebugConfig(cmd *cobra.Command)

RegisterDebugConfig registers the CLI flags used to alter the server debug API endpoints.

func RegisterMetricProviderConfig

func RegisterMetricProviderConfig(cmd *cobra.Command)

func RegisterTLSConfig

func RegisterTLSConfig(cmd *cobra.Command)

func RegisterTelemetryConfig

func RegisterTelemetryConfig(cmd *cobra.Command)

RegisterTelemetryConfig is used by a Cobra command to register the Telemetry CLI flags.

Types

type ClusterConfig

type ClusterConfig struct {
	Addr string
	Name string
}

func GetClusterConfig

func GetClusterConfig() ClusterConfig

func (*ClusterConfig) MarshalZerologObject

func (c *ClusterConfig) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject is the Zerolog marshaller which allow us to log the object.

type Config

type Config struct {
	Bind                         string
	ConsulStorageBackendPath     string
	Port                         uint16
	APIPolicyEngine              bool
	NomadMetaPolicyEngine        bool
	StrictPolicyChecking         bool
	InternalAutoScaler           bool
	ConsulStorageBackend         bool
	UI                           bool
	InternalAutoScalerEvalPeriod int
	InternalAutoScalerNumThreads int
}

func GetConfig

func GetConfig() Config

func (*Config) MarshalZerologObject

func (c *Config) MarshalZerologObject(e *zerolog.Event)

type MetricProviderConfig

type MetricProviderConfig struct {
	Prometheus *MetricProviderPrometheusConfig
}

func GetMetricProviderConfig

func GetMetricProviderConfig() *MetricProviderConfig

func (*MetricProviderConfig) MarshalZerologObject

func (mpc *MetricProviderConfig) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject is the Zerolog marshaller which allow us to log the object.

type MetricProviderPrometheusConfig

type MetricProviderPrometheusConfig struct {
	Addr string
}

type TLSConfig

type TLSConfig struct {
	CertPath    string
	CertKeyPath string
}

func GetTLSConfig

func GetTLSConfig() TLSConfig

func (*TLSConfig) MarshalZerologObject

func (c *TLSConfig) MarshalZerologObject(e *zerolog.Event)

type TelemetryConfig

type TelemetryConfig struct {
	Prometheus   bool
	StatsiteAddr string
	StatsdAddr   string
}

TelemetryConfig is the server Telemetry configuration struct.

func GetTelemetryConfig

func GetTelemetryConfig() TelemetryConfig

GetTelemetryConfig hydrates the telemetry config struct.

func (*TelemetryConfig) MarshalZerologObject

func (c *TelemetryConfig) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject is the Zerolog marshaller which allow us to log the object.