Definitions

AppHealth

AppHealth contains aggregated health from various sources, for a given app

Name Description Schema
deploymentStatuses
optional
Example : [ "[deploymentstatus](#deploymentstatus)" ] < DeploymentStatus > array
envoy
optional
Example : [ "[envoyhealthwrapper](#envoyhealthwrapper)" ] < EnvoyHealthWrapper > array
requests
optional
Example : "[requesthealth](#requesthealth)" RequestHealth

Autoscaler

Name Description Schema
createdAt
optional
Example : "string" string
currentCPUUtilizationPercentage
optional
Example : 0 integer (int32)
currentReplicas
optional
Example : 0 integer (int32)
desiredReplicas
optional
Example : 0 integer (int32)
labels
optional
Example : {<br> "string" : "string"<br>} < string, string > map
lastScaleTime
optional
Example : "string" string
maxReplicas
optional
Example : 0 integer (int32)
minReplicas
optional
Spec
Example : 0
integer (int32)
name
optional
Example : "string" string
observedGeneration
optional
Status
Example : 0
integer (int64)
targetCPUUtilizationPercentage
optional
Example : 0 integer (int32)

ContainerInfo

ContainerInfo holds container name and image

Name Description Schema
image
optional
Example : "string" string
name
optional
Example : "string" string

DeploymentStatus

DeploymentStatus gives the available / total replicas in a deployment of a pod

Name Description Schema
available
optional
Example : 0 integer (int32)
name
optional
Example : "string" string
replicas
optional
Example : 0 integer (int32)

EnvoyHealthWrapper

EnvoyHealthWrapper wraps EnvoyServiceHealth with the service name

Name Description Schema
inbound
optional
Example : "[envoyratio](#envoyratio)" EnvoyRatio
outbound
optional
Example : "[envoyratio](#envoyratio)" EnvoyRatio
service
optional
Example : "string" string

EnvoyRatio

EnvoyRatio is the number of healthy members versus total members

Name Description Schema
healthy
optional
Example : 0 integer (int64)
total
optional
Example : 0 integer (int64)

EnvoyServiceHealth

EnvoyServiceHealth is the number of healthy versus total membership (ie. replicas) inside envoy cluster for inbound and outbound traffic

Name Description Schema
inbound
optional
Example : "[envoyratio](#envoyratio)" EnvoyRatio
outbound
optional
Example : "[envoyratio](#envoyratio)" EnvoyRatio

Gateway

Name Description Schema
createdAt
optional
Example : "string" string
name
optional
Example : "string" string
resourceVersion
optional
Example : "string" string
selector
optional
Example : "object" object
servers
optional
Example : "object" object

Gateways

Type : < Gateway > array

IstioCheck

Name Description Schema
message
required
Description of the check
Example : "Weight sum should be 100"
string
path
optional
String that describes where in the yaml file is the check located
Example : "spec/http[0]/route"
string
severity
required
Indicates the level of importance: error or warning
Example : "error"
string

IstioConfigList

This type is used for returning a response of IstioConfigList

Name Description Schema
destinationRules
optional
Example : "[destinationrules](#destinationrules)" destinationRules
gateways
optional
Example : "[gateways](#gateways)" Gateways
namespace
required
Example : "[namespace](#namespace)" namespace
quotaSpecBindings
optional
Example : "[quotaspecbindings](#quotaspecbindings)" QuotaSpecBindings
quotaSpecs
optional
Example : "[quotaspecs](#quotaspecs)" QuotaSpecs
rules
optional
Example : "[istiorules](#istiorules)" istioRules
serviceEntries
optional
Example : "[serviceentries](#serviceentries)" ServiceEntries
virtualServices
optional
Example : "[virtualservices](#virtualservices)" virtualServices

IstioValidation

Name Description Schema
checks
optional
Array of checks. It might be empty.
Example : [ "[istiocheck](#istiocheck)" ]
< IstioCheck > array
name
required
Name of the object itself
Example : "reviews"
string
objectType
required
Type of the object
Example : "virtualservice"
string
valid
required
Represents validity of the object: in case of warning, validity remains as true
Example : false
boolean

NameIstioValidation

List of validations grouped by object name

Type : < string, IstioValidation > map

NamespaceAppHealth

NamespaceAppHealth is an alias of map of app name x health

Type : < string, AppHealth > map

NamespaceValidations

List of validations grouped by namespace

Type : < string, TypedIstioValidations > map

Pod

Pod holds a subset of v1.Pod data that is meaningful in Kiali

Name Description Schema
createdAt
optional
Example : "string" string
createdBy
optional
Example : [ "[reference](#reference)" ] < Reference > array
istioContainers
optional
Example : [ "[containerinfo](#containerinfo)" ] < ContainerInfo > array
istioInitContainers
optional
Example : [ "[containerinfo](#containerinfo)" ] < ContainerInfo > array
labels
optional
Example : {<br> "string" : "string"<br>} < string, string > map
name
optional
Example : "string" string

Pods

Pods alias for list of Pod structs

Type : < Pod > array

Port

Name Description Schema
name
optional
Example : "string" string
port
optional
Example : 0 integer (int32)
protocol
optional
Example : "string" string

Ports

Type : < Port > array

QuotaSpec

Name Description Schema
createdAt
optional
Example : "string" string
name
optional
Example : "string" string
resourceVersion
optional
Example : "string" string
rules
optional
Example : "object" object

QuotaSpecBinding

Name Description Schema
createdAt
optional
Example : "string" string
name
optional
Example : "string" string
quotaSpecs
optional
Example : "object" object
resourceVersion
optional
Example : "string" string
services
optional
Example : "object" object

QuotaSpecBindings

Type : < QuotaSpecBinding > array

QuotaSpecs

Type : < QuotaSpec > array

Reference

Reference holds some information on the pod creator

Name Description Schema
kind
optional
Example : "string" string
name
optional
Example : "string" string

RequestHealth

RequestHealth holds several stats about recent request errors

Name Description Schema
requestCount
optional
Example : 0.0 number (double)
requestErrorCount
optional
Example : 0.0 number (double)

Service

Name Description Schema
createdAt
optional
Example : "string" string
ip
optional
Example : "string" string
labels
optional
Example : {<br> "string" : "string"<br>} < string, string > map
name
optional
Example : "string" string
namespace
optional
Example : "[namespace](#namespace)" namespace
ports
optional
Example : "[ports](#ports)" Ports
resourceVersion
optional
Example : "string" string
type
optional
Example : "string" string

ServiceEntries

Type : < ServiceEntry > array

ServiceEntry

Name Description Schema
addresses
optional
Example : "object" object
createdAt
optional
Example : "string" string
endpoints
optional
Example : "object" object
hosts
optional
Example : "object" object
location
optional
Example : "object" object
name
optional
Example : "string" string
ports
optional
Example : "object" object
resolution
optional
Example : "object" object
resourceVersion
optional
Example : "string" string

ServiceHealth

ServiceHealth contains aggregated health from various sources, for a given service

Name Description Schema
envoy
optional
Example : "[envoyservicehealth](#envoyservicehealth)" EnvoyServiceHealth
requests
optional
Example : "[requesthealth](#requesthealth)" RequestHealth

Services

Type : < Service > array

StatusInfo

This is used for returning a response of Kiali Status

Name Description Schema
externalServices
required
An array of external services installed
Example : [ "[externalserviceinfo](#externalserviceinfo)" ]
< externalServiceInfo > array
status
required
The state of Kiali
A hash of key,values with versions of Kiali and state
Example : {<br> "string" : "string"<br>}
< string, string > map
warningMessages
optional
An array of warningMessages
Example : [ "string" ]
< string > array

TokenGenerated

This is used for returning the token

Name Description Schema
expired_at
required
The expired time for the token
A string with the Datetime when the token will be expired
Example : "2018-06-20 19:40:54.116369887 +0000 UTC m=+43224.838320603"
string
token
required
The authentication token
A string with the authentication token for the user
Example : "zI1NiIsIsR5cCI6IkpXVCJ9.ezJ1c2VybmFtZSI6ImFkbWluIiwiZXhwIjoxNTI5NTIzNjU0fQ.PPZvRGnR6VA4v7FmgSfQcGQr-VD"
string

TypedIstioValidations

List of validations grouped by object type

Type : < string, NameIstioValidation > map

Workload

Name Description Schema
autoscaler
optional
Example : "[autoscaler](#autoscaler)" Autoscaler
availableReplicas
required
Number of available replicas
Example : 1
integer (int32)
createdAt
required
Creation timestamp (in RFC3339 format)
Example : "2018-07-31T12:24:17Z"
string
labels
required
Kubernetes labels
Example : {<br> "string" : "string"<br>}
< string, string > map
name
required
Workload name
Example : "reviews"
string
pods
optional
Example : "[pods](#pods)" Pods
replicas
required
Number of desired replicas
Example : 2
integer (int32)
resourceVersion
required
Kubernetes ResourceVersion
Example : "192892127"
string
services
optional
Example : "[services](#services)" Services
templateAnnotations
required
Kubernetes annotations
Example : {<br> "string" : "string"<br>}
< string, string > map
unavailableReplicas
required
Number of unavailable replicas
Example : 1
integer (int32)

WorkloadHealth

WorkloadHealth contains aggregated health from various sources, for a given workload

Name Description Schema
deploymentStatus
optional
Example : "[deploymentstatus](#deploymentstatus)" DeploymentStatus
requests
optional
Example : "[requesthealth](#requesthealth)" RequestHealth

WorkloadList

Name Description Schema
namespace
required
Example : "[namespace](#namespace)" namespace
workloads
required
Workloads for a given namespace
Example : [ "[workloadoverview](#workloadoverview)" ]
< WorkloadOverview > array

WorkloadOverview

Name Description Schema
appLabel
required
Has label app
Example : true
boolean
istioSidecar
required
Has IstioSidecar
Example : true
boolean
name
required
Name of the workload
Example : "reviews-v1"
string
type
required
Type of the workload
Example : "deployment"
string
versionLabel
required
Has version label
Example : true
boolean

destinationRule

This is used for returning a DestinationRule

Name Description Schema
createdAt
required
The creation date of the destinationRule
Example : "string"
string
host
optional
Example : "object" object
name
required
The name of the destinationRule
Example : "string"
string
resourceVersion
required
The resource version of the destinationRule
Example : "string"
string
subsets
optional
Example : "object" object
trafficPolicy
optional
Example : "object" object

destinationRules

This is used for returning an array of DestinationRules

Type : < destinationRule > array

externalServiceInfo

This is used for returning a response of Kiali Status

Name Description Schema
name
required
The name of the service
Example : "Istio"
string
version
required
The installed version of the service
Example : "0.8.0"
string

istioRule

This type type is used for returning a IstioRule

Name Description Schema
actions
optional
Example : "object" object
match
optional
Example : "object" object
name
required
The name of the istioRule
Example : "string"
string

istioRules

This type type is used for returning an array of IstioRules

Type : < istioRule > array

namespace

A Namespace provide a scope for names This type is used to describe a set of objects.

Name Description Schema
name
required
The id of the namespace.
Example : "istio-system"
string

virtualService

This type is used for returning a VirtualService

Name Description Schema
createdAt
required
The creation date of the virtualService
Example : "string"
string
gateways
optional
Example : "object" object
hosts
optional
Example : "object" object
http
optional
Example : "object" object
name
required
The name of the virtualService
Example : "string"
string
resourceVersion
required
The resource version of the virtualService
Example : "string"
string
tcp
optional
Example : "object" object

virtualServices

This type is used for returning an array of VirtualServices

Type : < virtualService > array