Documentation ¶
Index ¶
- Constants
- func GetSignedTokenString(claims jwt.Claims) (string, error)
- func GetSigningKey() string
- func IsIstioNamespace(namespace string) bool
- func Marshal(conf *Config) (yamlString string, err error)
- func SaveToFile(filename string, conf *Config) (err error)
- func Set(conf *Config)
- func ValidateSigningKey(signingKey string, authStrategy string) error
- type AdditionalDisplayItem
- type Aggregation
- type ApiConfig
- type ApiNamespacesConfig
- type Auth
- type AuthConfig
- type CertificatesInformationIndicators
- type ComponentStatus
- type ComponentStatuses
- type Config
- type CustomDashboardsConfig
- type DeploymentConfig
- type Extensions
- type ExternalServices
- type GrafanaConfig
- type GrafanaDashboardConfig
- type GrafanaVariablesConfig
- type GraphFindOption
- type GraphTraffic
- type GraphUIDefaults
- type HealthConfig
- type IanaClaims
- type IstioCanaryRevision
- type IstioConfig
- type IstioLabels
- type Iter8Config
- type KialiFeatureFlags
- type KubernetesConfig
- type LoginToken
- type MetricsDefaults
- type OpenIdConfig
- type OpenShiftConfig
- type PrometheusConfig
- type Rate
- type Server
- type ThanosProxy
- type TokenGenerated
- type Tolerance
- type TracingConfig
- type UIDefaults
- type Validations
Constants ¶
const ( // External services auth EnvGrafanaPassword = "GRAFANA_PASSWORD" EnvGrafanaToken = "GRAFANA_TOKEN" EnvPrometheusPassword = "PROMETHEUS_PASSWORD" EnvPrometheusToken = "PROMETHEUS_TOKEN" EnvTracingPassword = "TRACING_PASSWORD" EnvTracingToken = "TRACING_TOKEN" // Login Token signing key used to prepare the token for user login EnvLoginTokenSigningKey = "LOGIN_TOKEN_SIGNING_KEY" )
Environment variables that can override the ConfigMap yaml values
const ( IstioVersionSupported = ">= 1.0" MaistraVersionSupported = ">= 0.7.0" OSSMVersionSupported = ">= 1.0" Iter8VersionSupported = ">= 0.2" )
The versions that Kiali requires
const ( AuthStrategyOpenshift = "openshift" AuthStrategyAnonymous = "anonymous" AuthStrategyToken = "token" AuthStrategyOpenId = "openid" AuthStrategyHeader = "header" TokenCookieName = "kiali-token" AuthStrategyOpenshiftIssuer = "kiali-openshift" AuthStrategyTokenIssuer = "kiali-token" AuthStrategyOpenIdIssuer = "kiali-open-id" AuthStrategyHeaderIssuer = "kiali-header" // These constants are used for external services auth (Prometheus, Grafana ...) ; not for Kiali auth AuthTypeBasic = "basic" AuthTypeBearer = "bearer" AuthTypeNone = "none" )
The valid auth strategies and values for cookie handling
const ( IstioMultiClusterHostSuffix = "global" OidcClientSecretFile = "/kiali-secret/oidc-secret" )
const ( DashboardsDiscoveryEnabled = "true" DashboardsDiscoveryAuto = "auto" )
Variables ¶
This section is empty.
Functions ¶
func GetSignedTokenString ¶ added in v0.16.0
func GetSigningKey ¶ added in v1.0.10
func GetSigningKey() string
func IsIstioNamespace ¶ added in v1.4.0
IsIstioNamespace returns true if the namespace is the default istio namespace
func SaveToFile ¶
SaveToFile converts the Config object and stores its YAML string into the given file, overwriting any data that is in the file.
func Set ¶
func Set(conf *Config)
Set the global Config This function should not be called outside of main or tests. If possible keep config unmutated and use globals and/or appstate package for mutable states to avoid concurrent writes risk.
func ValidateSigningKey ¶ added in v1.17.0
Types ¶
type AdditionalDisplayItem ¶ added in v1.10.0
type AdditionalDisplayItem struct { Annotation string `yaml:"annotation"` IconAnnotation string `yaml:"icon_annotation"` Title string `yaml:"title"` }
AdditionalDisplayItem holds some display-related configuration, like which annotations are to be displayed
type Aggregation ¶ added in v1.41.0
type Aggregation struct { Label string `yaml:"label,omitempty" json:"label"` DisplayName string `yaml:"display_name,omitempty" json:"displayName"` SingleSelection bool `yaml:"single_selection,omitempty" json:"singleSelection"` }
Aggregation represents label's allowed aggregations, transformed from aggregation in MonitoringDashboard config resource
type ApiConfig ¶ added in v0.9.1
type ApiConfig struct {
Namespaces ApiNamespacesConfig
}
ApiConfig contains API specific configuration.
type ApiNamespacesConfig ¶ added in v0.9.1
type ApiNamespacesConfig struct { Exclude []string LabelSelector string `yaml:"label_selector,omitempty" json:"labelSelector"` }
ApiNamespacesConfig provides a list of regex strings defining namespaces to blacklist.
type Auth ¶ added in v0.21.0
type Auth struct { CAFile string `yaml:"ca_file"` InsecureSkipVerify bool `yaml:"insecure_skip_verify"` Password string `yaml:"password"` Token string `yaml:"token"` Type string `yaml:"type"` UseKialiToken bool `yaml:"use_kiali_token"` Username string `yaml:"username"` }
Auth provides authentication data for external services
type AuthConfig ¶ added in v0.16.0
type AuthConfig struct { OpenId OpenIdConfig `yaml:"openid,omitempty"` OpenShift OpenShiftConfig `yaml:"openshift,omitempty"` Strategy string `yaml:"strategy,omitempty"` }
AuthConfig provides details on how users are to authenticate
type CertificatesInformationIndicators ¶ added in v1.40.0
type CertificatesInformationIndicators struct { Enabled bool `yaml:"enabled,omitempty" json:"enabled"` Secrets []string `yaml:"secrets,omitempty" json:"secrets,omitempty"` }
CertificatesInformationIndicators defines configuration to enable the feature and to grant read permissions to a list of secrets
type ComponentStatus ¶ added in v1.22.1
type ComponentStatuses ¶ added in v1.22.1
type ComponentStatuses struct { Enabled bool `yaml:"enabled,omitempty"` Components []ComponentStatus `yaml:"components,omitempty"` }
type Config ¶
type Config struct { AdditionalDisplayDetails []AdditionalDisplayItem `yaml:"additional_display_details,omitempty"` API ApiConfig `yaml:"api,omitempty"` Auth AuthConfig `yaml:"auth,omitempty"` CustomDashboards dashboards.MonitoringDashboardsList `yaml:"custom_dashboards,omitempty"` Deployment DeploymentConfig `yaml:"deployment,omitempty"` Extensions Extensions `yaml:"extensions,omitempty"` ExternalServices ExternalServices `yaml:"external_services,omitempty"` HealthConfig HealthConfig `yaml:"health_config,omitempty" json:"healthConfig,omitempty"` Identity security.Identity `yaml:",omitempty"` InCluster bool `yaml:"in_cluster,omitempty"` InstallationTag string `yaml:"installation_tag,omitempty"` IstioLabels IstioLabels `yaml:"istio_labels,omitempty"` IstioNamespace string `yaml:"istio_namespace,omitempty"` // default component namespace KialiFeatureFlags KialiFeatureFlags `yaml:"kiali_feature_flags,omitempty"` KubernetesConfig KubernetesConfig `yaml:"kubernetes_config,omitempty"` LoginToken LoginToken `yaml:"login_token,omitempty"` Server Server `yaml:",omitempty"` }
Config defines full YAML configuration.
func LoadFromFile ¶
LoadFromFile reads the YAML from the given file, parses the content, and returns its Config object representation.
func Unmarshal ¶
Unmarshal parses the given YAML string and returns its Config object representation.
func (*Config) AddHealthDefault ¶ added in v1.24.0
func (conf *Config) AddHealthDefault()
AddHealthDefault Configuration
type CustomDashboardsConfig ¶ added in v1.22.1
type CustomDashboardsConfig struct { DiscoveryEnabled string `yaml:"discovery_enabled,omitempty"` DiscoveryAutoThreshold int `yaml:"discovery_auto_threshold,omitempty"` Enabled bool `yaml:"enabled,omitempty"` IsCore bool `yaml:"is_core,omitempty"` NamespaceLabel string `yaml:"namespace_label,omitempty"` Prometheus PrometheusConfig `yaml:"prometheus,omitempty"` }
CustomDashboardsConfig describes configuration specific to Custom Dashboards
type DeploymentConfig ¶ added in v0.21.0
type DeploymentConfig struct { AccessibleNamespaces []string `yaml:"accessible_namespaces"` Namespace string `yaml:"namespace,omitempty"` // Kiali deployment namespace ViewOnlyMode bool `yaml:"view_only_mode,omitempty"` }
DeploymentConfig provides details on how Kiali was deployed.
type Extensions ¶ added in v1.14.0
type Extensions struct {
Iter8 Iter8Config `yaml:"iter_8,omitempty"`
}
Extensions struct describes configuration for Kiali add-ons (extensions) New add-on/extension configuration should create a specific config and be located under this
type ExternalServices ¶
type ExternalServices struct { Grafana GrafanaConfig `yaml:"grafana,omitempty"` Istio IstioConfig `yaml:"istio,omitempty"` Prometheus PrometheusConfig `yaml:"prometheus,omitempty"` CustomDashboards CustomDashboardsConfig `yaml:"custom_dashboards,omitempty"` Tracing TracingConfig `yaml:"tracing,omitempty"` }
ExternalServices holds configurations for other systems that Kiali depends on
type GrafanaConfig ¶
type GrafanaConfig struct { Auth Auth `yaml:"auth"` Dashboards []GrafanaDashboardConfig `yaml:"dashboards"` Enabled bool `yaml:"enabled"` // Enable or disable Grafana support in Kiali HealthCheckUrl string `yaml:"health_check_url,omitempty"` InClusterURL string `yaml:"in_cluster_url"` IsCore bool `yaml:"is_core,omitempty"` URL string `yaml:"url"` }
GrafanaConfig describes configuration used for Grafana links
type GrafanaDashboardConfig ¶ added in v1.5.0
type GrafanaDashboardConfig struct { Name string `yaml:"name"` Variables GrafanaVariablesConfig `yaml:"variables"` }
type GrafanaVariablesConfig ¶ added in v1.5.0
type GrafanaVariablesConfig struct { App string `yaml:"app" json:"app,omitempty"` Namespace string `yaml:"namespace" json:"namespace,omitempty"` Service string `yaml:"service" json:"service,omitempty"` Version string `yaml:"version" json:"version,omitempty"` Workload string `yaml:"workload" json:"workload,omitempty"` }
type GraphFindOption ¶ added in v1.35.0
type GraphFindOption struct { Description string `yaml:"description,omitempty" json:"description,omitempty"` Expression string `yaml:"expression,omitempty" json:"expression,omitempty"` }
GraphFindOption defines a single Graph Find/Hide Option
type GraphTraffic ¶ added in v1.38.1
type GraphTraffic struct { Grpc string `yaml:"grpc,omitempty" json:"grpc,omitempty"` Http string `yaml:"http,omitempty" json:"http,omitempty"` Tcp string `yaml:"tcp,omitempty" json:"tcp,omitempty"` }
GraphTraffic defines the protocol-specific rates used to determine traffic for graph generation. grpc options : none | sent (messages) | received (messages) | requests (default) | total (messages) http options : none | requests (default) tcp options : none | sent (bytes, default) | received (bytes) | total (bytes)
type GraphUIDefaults ¶ added in v1.35.0
type GraphUIDefaults struct { FindOptions []GraphFindOption `yaml:"find_options,omitempty" json:"findOptions,omitempty"` HideOptions []GraphFindOption `yaml:"hide_options,omitempty" json:"hideOptions,omitempty"` Traffic GraphTraffic `yaml:"traffic,omitempty" json:"traffic,omitempty"` }
GraphUIDefaults defines UI Defaults specific to the UI Graph
type HealthConfig ¶ added in v1.24.0
type HealthConfig struct {
Rate []Rate `yaml:"rate,omitempty" json:"rate,omitempty"`
}
HealthConfig rates
type IanaClaims ¶ added in v0.16.0
type IanaClaims struct { SessionId string `json:"sid,omitempty"` jwt.StandardClaims }
Structured version of Claims Section, as referenced at https://tools.ietf.org/html/rfc7519#section-4.1 See examples for how to use this with your own claim types
func GetTokenClaimsIfValid ¶ added in v0.16.0
func GetTokenClaimsIfValid(tokenString string) (*IanaClaims, error)
type IstioCanaryRevision ¶ added in v1.37.0
type IstioConfig ¶
type IstioConfig struct { ComponentStatuses ComponentStatuses `yaml:"component_status,omitempty"` ConfigMapName string `yaml:"config_map_name,omitempty"` EnvoyAdminLocalPort int `yaml:"envoy_admin_local_port,omitempty"` IstioCanaryRevision IstioCanaryRevision `yaml:"istio_canary_revision,omitempty"` IstioIdentityDomain string `yaml:"istio_identity_domain,omitempty"` IstioInjectionAnnotation string `yaml:"istio_injection_annotation,omitempty"` IstioSidecarInjectorConfigMapName string `yaml:"istio_sidecar_injector_config_map_name,omitempty"` IstioSidecarAnnotation string `yaml:"istio_sidecar_annotation,omitempty"` IstiodDeploymentName string `yaml:"istiod_deployment_name,omitempty"` UrlServiceVersion string `yaml:"url_service_version"` }
IstioConfig describes configuration used for istio links
type IstioLabels ¶ added in v0.7.0
type IstioLabels struct { AppLabelName string `yaml:"app_label_name,omitempty" json:"appLabelName"` InjectionLabelName string `yaml:"injection_label,omitempty" json:"injectionLabelName"` InjectionLabelRev string `yaml:"injection_label_rev,omitempty" json:"injectionLabelRev"` VersionLabelName string `yaml:"version_label_name,omitempty" json:"versionLabelName"` }
IstioLabels holds configuration about the labels required by Istio
type Iter8Config ¶ added in v1.15.0
type KialiFeatureFlags ¶ added in v1.22.1
type KialiFeatureFlags struct { CertificatesInformationIndicators CertificatesInformationIndicators `yaml:"certificates_information_indicators,omitempty" json:"certificatesInformationIndicators"` IstioInjectionAction bool `yaml:"istio_injection_action,omitempty" json:"istioInjectionAction"` IstioUpgradeAction bool `yaml:"istio_upgrade_action,omitempty" json:"istioUpgradeAction"` UIDefaults UIDefaults `yaml:"ui_defaults,omitempty" json:"uiDefaults,omitempty"` Validations Validations `yaml:"validations,omitempty" json:"validations,omitempty"` }
KialiFeatureFlags available from the CR
type KubernetesConfig ¶ added in v0.9.0
type KubernetesConfig struct { Burst int `yaml:"burst,omitempty"` // Cache duration expressed in seconds // Cache uses watchers to sync with the backend, after a CacheDuration watchers are closed and re-opened CacheDuration int `yaml:"cache_duration,omitempty"` // Enable cache for kubernetes and istio resources CacheEnabled bool `yaml:"cache_enabled,omitempty"` // Kiali can cache VirtualService,DestinationRule,Gateway and ServiceEntry Istio resources if they are present // on this list of Istio types. Other Istio types are not yet supported. CacheIstioTypes []string `yaml:"cache_istio_types,omitempty"` // List of namespaces or regex defining namespaces to include in a cache CacheNamespaces []string `yaml:"cache_namespaces,omitempty"` // Cache duration expressed in seconds // Kiali cache list of namespaces per user, this is typically short lived cache compared with the duration of the // namespace cache defined by previous CacheDuration parameter CacheTokenNamespaceDuration int `yaml:"cache_token_namespace_duration,omitempty"` // List of controllers that won't be used for Workload calculation // Kiali queries Deployment,ReplicaSet,ReplicationController,DeploymentConfig,StatefulSet,Job and CronJob controllers // Deployment and ReplicaSet will be always queried, but ReplicationController,DeploymentConfig,StatefulSet,Job and CronJobs // can be skipped from Kiali workloads query if they are present in this list ExcludeWorkloads []string `yaml:"excluded_workloads,omitempty"` QPS float32 `yaml:"qps,omitempty"` }
KubernetesConfig holds the k8s client, caching and performance configuration
type LoginToken ¶ added in v0.6.0
type LoginToken struct { ExpirationSeconds int64 `yaml:"expiration_seconds,omitempty"` SigningKey string `yaml:"signing_key,omitempty"` }
LoginToken holds config used for generating the Kiali session tokens.
func (*LoginToken) Obfuscate ¶ added in v1.13.0
func (lt *LoginToken) Obfuscate()
type MetricsDefaults ¶ added in v1.41.0
type MetricsDefaults struct {
Aggregations []Aggregation `yaml:"aggregations,omitempty" json:"aggregations,omitempty"`
}
type OpenIdConfig ¶ added in v1.19.0
type OpenIdConfig struct { AdditionalRequestParams map[string]string `yaml:"additional_request_params,omitempty"` AllowedDomains []string `yaml:"allowed_domains,omitempty"` ApiProxy string `yaml:"api_proxy,omitempty"` ApiProxyCAData string `yaml:"api_proxy_ca_data,omitempty"` ApiToken string `yaml:"api_token,omitempty"` AuthenticationTimeout int `yaml:"authentication_timeout,omitempty"` AuthorizationEndpoint string `yaml:"authorization_endpoint,omitempty"` ClientId string `yaml:"client_id,omitempty"` ClientSecret string `yaml:"client_secret,omitempty"` DisableRBAC bool `yaml:"disable_rbac,omitempty"` HTTPProxy string `yaml:"http_proxy,omitempty"` HTTPSProxy string `yaml:"https_proxy,omitempty"` InsecureSkipVerifyTLS bool `yaml:"insecure_skip_verify_tls,omitempty"` IssuerUri string `yaml:"issuer_uri,omitempty"` Scopes []string `yaml:"scopes,omitempty"` UsernameClaim string `yaml:"username_claim,omitempty"` }
OpenIdConfig contains specific configuration for authentication using an OpenID provider
type OpenShiftConfig ¶ added in v1.22.1
type OpenShiftConfig struct {
ClientIdPrefix string `yaml:"client_id_prefix,omitempty"`
}
OpenShiftConfig contains specific configuration for authentication when on OpenShift
type PrometheusConfig ¶ added in v0.18.0
type PrometheusConfig struct { Auth Auth `yaml:"auth,omitempty"` // Cache duration per query expressed in seconds CacheDuration int `yaml:"cache_duration,omitempty"` // Enable cache for Prometheus queries CacheEnabled bool `yaml:"cache_enabled,omitempty"` // Global cache expiration expressed in seconds CacheExpiration int `yaml:"cache_expiration,omitempty"` CustomHeaders map[string]string `yaml:"custom_headers,omitempty"` HealthCheckUrl string `yaml:"health_check_url,omitempty"` IsCore bool `yaml:"is_core,omitempty"` ThanosProxy ThanosProxy `yaml:"thanos_proxy,omitempty"` URL string `yaml:"url,omitempty"` }
PrometheusConfig describes configuration of the Prometheus component
type Rate ¶ added in v1.24.0
type Rate struct { Namespace string `yaml:"namespace,omitempty" json:"namespace,omitempty"` Kind string `yaml:"kind,omitempty" json:"kind,omitempty"` Name string `yaml:"name,omitempty" json:"name,omitempty"` Tolerance []Tolerance `yaml:"tolerance,omitempty" json:"tolerance"` }
Rate config
type Server ¶
type Server struct { Address string `yaml:",omitempty"` AuditLog bool `yaml:"audit_log,omitempty"` // When true, allows additional audit logging on Write operations CORSAllowAll bool `yaml:"cors_allow_all,omitempty"` GzipEnabled bool `yaml:"gzip_enabled,omitempty"` MetricsEnabled bool `yaml:"metrics_enabled,omitempty"` MetricsPort int `yaml:"metrics_port,omitempty"` Port int `yaml:",omitempty"` StaticContentRootDirectory string `yaml:"static_content_root_directory,omitempty"` WebFQDN string `yaml:"web_fqdn,omitempty"` WebPort string `yaml:"web_port,omitempty"` WebRoot string `yaml:"web_root,omitempty"` WebHistoryMode string `yaml:"web_history_mode,omitempty"` WebSchema string `yaml:"web_schema,omitempty"` }
Server configuration
type ThanosProxy ¶ added in v1.42.0
type ThanosProxy struct { Enabled bool `yaml:"enabled,omitempty"` RetentionPeriod string `yaml:"retention_period,omitempty"` ScrapeInterval string `yaml:"scrape_interval,omitempty"` }
ThanosProxy describes configuration of the Thanos proxy component
type TokenGenerated ¶
type TokenGenerated struct { Username string `json:"username"` Token string `json:"token"` ExpiresOn time.Time `json:"expiresOn"` }
func GenerateToken ¶
func GenerateToken(username string) (TokenGenerated, error)
GenerateToken generates a signed token with an expiration of <ExpirationSeconds> seconds
type Tolerance ¶ added in v1.24.0
type Tolerance struct { Code string `yaml:"code,omitempty" json:"code"` Degraded float32 `yaml:"degraded,omitempty" json:"degraded"` Failure float32 `yaml:"failure,omitempty" json:"failure"` Protocol string `yaml:"protocol,omitempty" json:"protocol"` Direction string `yaml:"direction,omitempty" json:"direction"` }
Tolerance config
type TracingConfig ¶ added in v0.20.0
type TracingConfig struct { Auth Auth `yaml:"auth"` Enabled bool `yaml:"enabled"` // Enable Jaeger in Kiali InClusterURL string `yaml:"in_cluster_url"` IsCore bool `yaml:"is_core,omitempty"` NamespaceSelector bool `yaml:"namespace_selector"` URL string `yaml:"url"` UseGRPC bool `yaml:"use_grpc"` WhiteListIstioSystem []string `yaml:"whitelist_istio_system"` }
TracingConfig describes configuration used for tracing links
type UIDefaults ¶ added in v1.30.0
type UIDefaults struct { Graph GraphUIDefaults `yaml:"graph,omitempty" json:"graph,omitempty"` MetricsPerRefresh string `yaml:"metrics_per_refresh,omitempty" json:"metricsPerRefresh,omitempty"` MetricsInbound MetricsDefaults `yaml:"metrics_inbound,omitempty" json:"metricsInbound,omitempty"` MetricsOutbound MetricsDefaults `yaml:"metrics_outbound,omitempty" json:"metricsOutbound,omitempty"` Namespaces []string `yaml:"namespaces,omitempty" json:"namespaces,omitempty"` RefreshInterval string `yaml:"refresh_interval,omitempty" json:"refreshInterval,omitempty"` }
UIDefaults defines default settings configured for the UI
type Validations ¶ added in v1.38.1
type Validations struct {
Ignore []string `yaml:"ignore,omitempty" json:"ignore,omitempty"`
}
Validations defines default settings configured for the Validations subsystem