config

Documentation

Overview

SPDX-FileCopyrightText: Copyright (c) 2016-2024, CloudZero, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

SPDX-FileCopyrightText: Copyright (c) 2016-2024, CloudZero, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Index

• Constants
• func IsValidDiagnostic(d string) bool
• func IsValidStage(m string) bool
• type Cloudzero
  • func (s *Cloudzero) Validate() error
• type Context
  • func (s *Context) Validate() error
• type Deployment
  • func (s *Deployment) Validate() error
• type Diagnostics
  • func (s *Diagnostics) Validate() error
• type Flags
• type Logging
  • func (s *Logging) Validate() error
• type Prometheus
  • func (s *Prometheus) Validate() error
• type Settings
  • func NewSettings(configFiles ...string) (*Settings, error)
  • func (s *Settings) Validate() error
• type Stage
  • func (s *Stage) Validate() error
• type Versions
  • func (s *Versions) Validate() error

Constants

const (
	ContextStageNone  string = "none"
	ContextStageInit  string = "pre-start"
	ContextStageStart string = "post-start"
	ContextStageStop  string = "pre-stop"
)

const (
	DiagnosticAPIKey            string = "api_key_valid" //nolint:gosec
	DiagnosticK8sVersion        string = "k8s_version"
	DiagnosticEgressAccess      string = "egress_reachable"
	DiagnosticKMS               string = "kube_state_metrics_reachable"
	DiagnosticPrometheusVersion string = "prometheus_version"
	DiagnosticScrapeConfig      string = "scrape_cfg"
)

const (
	DiagnosticInternalInitStart  string = "init_start"
	DiagnosticInternalInitStop   string = "init_ok"
	DiagnosticInternalInitFailed string = "init_failed"
	DiagnosticInternalPodStart   string = "pod_start"
	DiagnosticInternalPodStop    string = "pod_stop"
)

const (
	ErrNoLifecycleStageMsg                  = "missing Lifecycle Stage"
	ErrNoEnvFileMsg                         = "missing Env File"
	ErrNoKeyFileMsg                         = "missing Key File"
	ErrNoCloudZeroHostMsg                   = "missing CloudZero Host"
	ErrNoAccountIDMsg                       = "missing AWS Account ID"
	ErrNoClusterNameMsg                     = "missing Cluster Name"
	ErrNoRegionMsg                          = "missing AWS Region"
	ErrNoSecretFilePathMsg                  = "missing Secret File"
	ErrNoAgentVersionMsg                    = "missing Agent Version"
	ErrNoChartVersionMsg                    = "missing Chart Version"
	ErrNoScrapeConfigLocationMsg            = "missing Scrape Config Location"
	ErrNoKubeStateMetricsServiceEndpointMsg = "missing Kube State Metrics Service Endpoint"
)

const (
	FlagEnvFile      = "env-file"
	FlagDescEnvFile  = "environment variable configuration file"
	FlagConfigFile   = "config-file"
	FlagDescConfFile = "configuration file location"

	FlagAccountID       = "account"
	FlagDescAccountID   = "cloud account ID"
	FlagClusterName     = "cluster"
	FlagDescClusterName = "kubernetes cluster name"
	FlagRegion          = "region"
	FlagDescRegion      = "deployment region matching the dimension in the CloudZero dashboard"
)

Functions

func IsValidDiagnostic

func IsValidDiagnostic(d string) bool

func IsValidStage

func IsValidStage(m string) bool

Types

type Cloudzero

type Cloudzero struct {
	Host             string `yaml:"host" default:"https://api.cloudzero.com" env:"CZ_HOST" env-description:"CloudZero API host"`
	Credential       string
	CredentialsFile  string `` /* 165-byte string literal not displayed */
	DisableTelemetry bool   `yaml:"disable_telemetry" default:"false" env:"CZ_DISABLE_TELEMETRY" env-description:"Disable telemetry"`
}

Cloudzero is the configuration for the CloudZero checker

func (*Cloudzero) Validate

func (s *Cloudzero) Validate() error

type Context

type Context struct {
	Stage string `env:"CZ_CHECKER_STAGE" env-description:"Execution stage one of init, post-start, pre-stop, or all" default:"init"`
}

func (*Context) Validate

func (s *Context) Validate() error

type Deployment

type Deployment struct {
	AccountID   string `yaml:"account_id" env:"ACCOUNT_ID" required:"true" env-description:"AWS Account ID"`
	ClusterName string `yaml:"cluster_name" env:"CLUSTER_NAME" required:"true" env-description:"Cluster Name"`
	Region      string `yaml:"region" env:"REGION" required:"true" env-description:"AWS Region"`
}

func (*Deployment) Validate

func (s *Deployment) Validate() error

type Diagnostics

type Diagnostics struct {
	Stages []Stage `yaml:"stages"`
}

func (*Diagnostics) Validate

func (s *Diagnostics) Validate() error

type Flags

type Flags struct {
	Mode  string
	Stage string

	EnvFile    string
	ConfigFile string
}

type Logging

type Logging struct {
	Level    string `yaml:"level" default:"info" env:"LOG_LEVEL" env-description:"logging level such as debug, info, error"`
	Location string `` /* 133-byte string literal not displayed */
}

func (*Logging) Validate

func (s *Logging) Validate() error

type Prometheus

type Prometheus struct {
	Executable                      string   `yaml:"executable" default:"/bin/prometheus" env:"PROMETHEUS_EXECUTABLE" env-description:"Prometheus Executable Path"`
	KubeStateMetricsServiceEndpoint string   `` /* 129-byte string literal not displayed */
	Configurations                  []string `yaml:"configurations"`
	KubeMetrics                     []string `yaml:"kube_metrics"`
}

func (*Prometheus) Validate

func (s *Prometheus) Validate() error

type Settings

type Settings struct {
	ExecutionContext Context
	Logging          Logging     `yaml:"logging"`
	Deployment       Deployment  `yaml:"deployment"`
	Versions         Versions    `yaml:"versions"`
	Cloudzero        Cloudzero   `yaml:"cloudzero"`
	Prometheus       Prometheus  `yaml:"prometheus"`
	Diagnostics      Diagnostics `yaml:"diagnostics"`
}

func NewSettings

func NewSettings(configFiles ...string) (*Settings, error)

func (*Settings) Validate

func (s *Settings) Validate() error

type Stage

type Stage struct {
	Name    string   `yaml:"name"`
	Enforce bool     `yaml:"enforce" default:"false"`
	Checks  []string `yaml:"checks"`
}

func (*Stage) Validate

func (s *Stage) Validate() error

type Versions

type Versions struct {
	ChartVersion string `yaml:"chart_version" env:"CHART_VERSION" env-description:"Chart Version"`
	AgentVersion string `yaml:"agent_version" env:"AGENT_VERSION" env-description:"Agent Version"`
}

func (*Versions) Validate

func (s *Versions) Validate() error