status

Documentation

Overview

status is a simple package for offering up various status information from Kiali.

Index

• Constants
• func AreCanonicalMetricsAvailable() bool
• func DiscoverGrafana() string
• func IsMixerDisabled() bool
• func Put(name, value string) (previous string, hasPrevious bool)
• type ExternalServiceInfo
• type StatusInfo
  • func Get() (status StatusInfo)

Constants

const (
	ContainerVersion = name + " container version"
	ConsoleVersion   = name + " console version"
	CoreVersion      = name + " core version"
	CoreCommitHash   = name + " core commit hash"
	State            = name + " state"
	ClusterMTLS      = "Istio mTLS"
	StateRunning     = "running"
)

Functions

func AreCanonicalMetricsAvailable

func AreCanonicalMetricsAvailable() bool

AreCanonicalMetricsAvailable returns true if canonical labels are present in Istio Telemetry. TODO: This test can be removed when Kiali stops supporting Istio versions with Mixer Telemetry

func DiscoverGrafana

func DiscoverGrafana() string

DiscoverGrafana will return the Grafana URL if it has been configured, or will try to retrieve it if an OpenShift Route is defined.

func IsMixerDisabled

func IsMixerDisabled() bool

IsMixerDisabled returns true if Telemetry V2 is enabled (mixer is not collecting metrics) TODO: This test can be removed when Kiali stops supporting Istio versions with Mixer Telemetry

func Put

func Put(name, value string) (previous string, hasPrevious bool)

Put adds or replaces status info for the provided name. Any previous setting is returned.

Types

type ExternalServiceInfo

type ExternalServiceInfo struct {
	// The name of the service
	//
	// required: true
	// example: Istio
	Name string `json:"name"`

	// The installed version of the service
	//
	// required: false
	// example: 0.8.0
	Version string `json:"version,omitempty"`

	// The service url
	//
	// required: false
	// example: jaeger-query-istio-system.127.0.0.1.nip.io
	Url string `json:"url,omitempty"`
}

Status response model

This is used for returning a response of Kiali Status

swagger:model externalServiceInfo

type StatusInfo

type StatusInfo struct {
	// The state of Kiali
	// A hash of key,values with versions of Kiali and state
	//
	// required: true
	Status map[string]string `json:"status"`
	// An array of external services installed
	//
	// required: true
	// swagger:allOf
	ExternalServices []ExternalServiceInfo `json:"externalServices"`
	// An array of warningMessages
	// items.example: Istio version 0.7.1 is not supported, the version should be 0.8.0
	// swagger:allOf
	WarningMessages []string `json:"warningMessages"`
}

StatusInfo statusInfo

This is used for returning a response of Kiali Status

swagger:model StatusInfo

func Get

func Get() (status StatusInfo)

Get returns a copy of the current status info.