Project: Kiali (Observability and Analysis / Observability)
File: kiali_internal_api.md

NOTE! The Kiali API is not for public use and is not supported for any use outside of the Kiali UI itself. The API can and will change from version to version with no guarantee of backwards compatibility. To generate this API document: ``` alias swagger='docker run --rm -it --user $(id -u):$(id -g) -e GOCACHE=/tmp -e GOPATH=$(go env GOPATH):/go -v $HOME:$HOME -w $(pwd) quay.io/goswagger/swagger' swagger generate spec -o ./swagger.json swagger generate markdown --quiet --spec ./swagger.json --output ./kialiinternalapi.md ``` _ http https application/json application/html application/json | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/metrics | | | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/apps/{app}/dashboard | | | | GET | /api/namespaces/{namespace}/apps/{app} | | | | GET | /api/namespaces/{namespace}/apps | | | | GET | /api/namespaces/{namespace}/apps/{app}/metrics | | | | Method | URI | Name | Summary | |||--|| | GET | /api/authenticate | | | | GET | /api/auth/info | | | | GET | /api/logout | | | | GET | /api/auth/openid_redirect | | | | POST | /api/authenticate | | | | Method | URI | Name | Summary | |||--|| | GET | /api/istio/certs | | | | Method | URI | Name | Summary | |||--|| | GET | /api/istio/permissions | | | | POST | /api/namespaces/{namespace}/istio/{object_type} | | | | DELETE | /api/namespaces/{namespace}/istio/{object_type}/{object} | | | | GET | /api/namespaces/{namespace}/istio/{object_type}/{object} | | | | GET | /api/namespaces/{namespace}/istio | | | | GET | /api/istio | | | | PATCH | /api/namespaces/{namespace}/istio/{object_type}/{object} | | Endpoint to update the Istio Config of an Istio object used for templates and adapters using Json Merge Patch strategy. | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/customdashboard/{dashboard} | | | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/graph | | | | GET | /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/{service}/graph | | | | GET | /api/namespaces/{namespace}/applications/{app}/graph | | | | GET | /api/namespaces/{namespace}/applications/{app}/versions/{version}/graph | | | | GET | /api/namespaces/graph | | The backing JSON for a namespaces graph. | | GET | /api/namespaces/{namespace}/services/{service}/graph | | The backing JSON for a service node detail graph. | | GET | /api/namespaces/{namespace}/workloads/{workload}/graph | | The backing JSON for a workload node detail graph. | | Method | URI | Name | Summary | |||--|| | GET | /api/grafana | | | | GET | /api/jaeger | | | | Method | URI | Name | Summary | |||--|| | GET | /api/config | | | | GET | /api/crippled | | | | GET | /api/healthz | | | | GET | /api | | | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/health | | | | GET | /api/namespaces | | | | GET | /api/namespaces/{namespace}/metrics | | | | PATCH | /api/namespaces/{namespace} | | Endpoint to update the Namespace configuration using Json Merge Patch

| | GET | /api/namespaces/{namespace}/validations | | | | GET | /api/istio/validations | | | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/pods/{pod} | | | | GET | /api/namespaces/{namespace}/pods/{pod}/logs | | | | GET | /api/namespaces/{namespace}/pods/{pod}/config_dump | | | | POST | /api/namespaces/{namespace}/pods/{pod}/logging | | | | GET | /api/namespaces/{namespace}/pods/{pod}/config_dump/{resource} | | | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/services/{service}/dashboard | | | | GET | /api/namespaces/{namespace}/services/{service} | | | | GET | /api/namespaces/{namespace}/services | | | | GET | /api/namespaces/{namespace}/services/{service}/metrics | | | | PATCH | /api/namespaces/{namespace}/services/{service} | | Endpoint to update the Service configuration using Json Merge Patch strategy. | | Method | URI | Name | Summary | |||--|| | POST | /api/stats/metrics | | | | Method | URI | Name | Summary | |||--|| | GET | /api/status | | | | GET | /api/istio/status | | | | Method | URI | Name | Summary | |||--|| | GET | /api/mesh/tls | | | | GET | /api/namespaces/{namespace}/tls | | | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/apps/{app}/spans | | | | GET | /api/namespaces/{namespace}/apps/{app}/traces | | | | GET | /api/namespaces/{namespace}/apps/{app}/errortraces | | | | GET | /api/namespaces/{namespace}/services/{service}/spans | | | | GET | /api/namespaces/{namespace}/services/{service}/traces | | | | GET | /api/traces/{traceID} | | | | GET | /api/namespaces/{namespace}/workloads/{workload}/spans | | | | GET | /api/namespaces/{namespace}/workloads/{workload}/traces | | | | Method | URI | Name | Summary | |||--|| | GET | /api/namespaces/{namespace}/workloads/{workload}/dashboard | | | | GET | /api/namespaces/{namespace}/workloads/{workload} | | | | GET | /api/namespaces/{namespace}/workloads | | | | GET | /api/namespaces/{namespace}/workloads/{workload}/metrics | | | | PATCH | /api/namespaces/{namespace}/workloads/{workload} | | Endpoint to update the Workload configuration using Json Merge Patch strategy. | ``` GET /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/metrics ``` Endpoint to fetch metrics to be displayed, related to a single aggregate http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | aggregate | `path` | string | `string` | | | | The aggregate name (label). | | aggregateValue | `path` | string | `string` | | | | The aggregate value (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | | version | `query` | string | `string` | | | | Filters metrics by the specified

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Metrics response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK map of Status: Bad Request Status: Service Unavailable <span id="aggregate-metrics-bad-request-body"></span> AggregateMetricsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="aggregate-metrics-service-unavailable-body"></span> AggregateMetricsServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/apps/{app}/dashboard ``` Endpoint to fetch dashboard to be displayed, related to a single app http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Dashboard response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Service Unavailable <span id="app-dashboard-bad-request-body"></span> AppDashboardBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="app-dashboard-service-unavailable-body"></span> AppDashboardServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/apps/{app} ``` Endpoint to get the app details http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Detailed information of an specific app | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="app-details-internal-server-error-body"></span> AppDetailsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="app-details-not-found-body"></span> AppDetailsNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/apps ``` Endpoint to get the list of apps for a namespace http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | QueryTime | `query` | date-time (formatted string) | `strfmt.DateTime` | | | | The time to use for the prometheus query | | app | `query` | string | `string` | | | | | | health | `query` | boolean | `bool` | | | | Optional | | rateInterval | `query` | string | `string` | | | `"10m"` | The rate interval used for fetching error rate | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all apps in the namespace | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="app-list-internal-server-error-body"></span> AppListInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/apps/{app}/metrics ``` Endpoint to fetch metrics to be displayed, related to a single app http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is

| | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | | version | `query` | string | `string` | | | | Filters metrics by the specified version. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Metrics response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK map of Status: Bad Request Status: Service Unavailable <span id="app-metrics-bad-request-body"></span> AppMetricsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="app-metrics-service-unavailable-body"></span> AppMetricsServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/apps/{app}/spans ``` Endpoint to get Jaeger spans for a given app http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a Span | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="app-spans-internal-server-error-body"></span> AppSpansInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/apps/{app}/traces ``` Endpoint to get the traces of a given app http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a Trace | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="app-traces-internal-server-error-body"></span> AppTracesInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="app-traces-not-found-body"></span> AppTracesNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/authenticate ``` Endpoint to authenticate the user http https application/json authorization: password, user | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and userGenerated model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="authenticate-internal-server-error-body"></span> AuthenticateInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/auth/info ``` Endpoint to get login info, such as strategy, authorization endpoints for OAuth providers and so on. http https application/json application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return the information necessary to handle login | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK | Name | Type | Go type | Separator | Default | Description | ||||--||-| | AuthorizationEndpoint | string | `string` | | | | | Strategy | string | `string` | | | | Status: Internal Server Error <span id="authentication-info-internal-server-error-body"></span> AuthenticationInfoInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/customdashboard/{dashboard} ``` Endpoint to fetch a custom dashboard http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | dashboard | `path` | string | `string` | | | | The dashboard resource name. | | namespace | `path` | string | `string` | | | | The namespace

| | additionalLabels | `query` | string | `string` | | | | In custom dashboards, additional labels that are made available for grouping in the UI, regardless which aggregations are defined in the MonitoringDashboard CR | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | labelsFilters | `query` | string | `string` | | | | In custom dashboards, labels filters to use when fetching metrics, formatted as key:value pairs. Ex: "app:foo,version:bar". | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Dashboard response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Service Unavailable <span id="custom-dashboard-bad-request-body"></span> CustomDashboardBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="custom-dashboard-service-unavailable-body"></span> CustomDashboardServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/apps/{app}/errortraces ``` Endpoint to get the number of traces in error for a given service http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Number of traces in error | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="error-traces-internal-server-error-body"></span> ErrorTracesInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="error-traces-not-found-body"></span> ErrorTracesNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/config ``` Endpoint to get the config of Kiali http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and statusInfo model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="get-config-internal-server-error-body"></span> GetConfigInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/crippled ``` Endpoint to get the crippled features of Kiali http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and statusInfo model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="get-crippled-features-internal-server-error-body"></span> GetCrippledFeaturesInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/istio/permissions ``` Endpoint to get the caller permissions on new Istio Config objects http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return caller permissions per namespace and Istio Config type | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="get-permissions-internal-server-error-body"></span> GetPermissionsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/status ``` Endpoint to get the status of Kiali http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and statusInfo model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="get-status-internal-server-error-body"></span> GetStatusInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/grafana ``` Get the grafana URL and other descriptors http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return all the descriptor data related to Grafana | | | | | No Content | NoContent: the response is empty | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK Status: No Content Status: Internal Server Error Status: Service Unavailable <span id="grafana-info-internal-server-error-body"></span> GrafanaInfoInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="grafana-info-no-content-body"></span> GrafanaInfoNoContentBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | | Message | string| `string` | | | | | <span id="grafana-info-service-unavailable-body"></span> GrafanaInfoServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/graph ``` The backing JSON for an aggregate node detail graph. (supported graphTypes: app | versionedApp | workload) http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | aggregate | `path` | string | `string` | | | | The aggregate name (label). | | aggregateValue | `path` | string | `string` | | | | The aggregate value (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and cytoscapejs Config in data | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="graph-aggregate-bad-request-body"></span> GraphAggregateBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="graph-aggregate-internal-server-error-body"></span> GraphAggregateInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/{service}/graph ``` The backing JSON for an aggregate node detail graph, specific to a service. (supported graphTypes: app | versionedApp | workload) http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | aggregate | `path` | string | `string` | | | | The aggregate name (label). | | aggregateValue | `path` | string | `string` | | | | The aggregate value (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | service | `path` | string | `string` | | | | The service

| | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and cytoscapejs Config in data | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="graph-aggregate-by-service-bad-request-body"></span> GraphAggregateByServiceBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="graph-aggregate-by-service-internal-server-error-body"></span> GraphAggregateByServiceInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/applications/{app}/graph ``` The backing JSON for an app node detail graph. (supported graphTypes: app | versionedApp) http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | appenders | `query` | string | `string` | | | `"aggregateNode,deadNode,healthConfig,idleNode,istio,responseTime,securityPolicy,serviceEntry,sidecarsCheck,throughput"` | Comma-separated list of Appenders to run. Available appenders: [aggregateNode, deadNode, healthConfig, idleNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, throughput]. | | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | | graphType | `query` | string | `string` | | | | Graph type. Available graph types: [app, versionedApp]. | | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. responsemessages) | requests | sent (i.e. requestmessages) | total (i.e. sent+received). | | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. receivedbytes) | sent (i.e. sentbytes) | total (i.e. sent+received). | | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 |

| | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request | response. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and cytoscapejs Config in data | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="graph-app-bad-request-body"></span> GraphAppBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="graph-app-internal-server-error-body"></span> GraphAppInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/applications/{app}/versions/{version}/graph ``` The backing JSON for a versioned app node detail graph. (supported graphTypes: app | versionedApp) http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | app | `path` | string | `string` | | | | The app name (label value). | | namespace | `path` | string | `string` | | | | The namespace name. | | version | `path` | string | `string` | | | | The app version (label value). | | appenders | `query` | string | `string` | | | `"aggregateNode,deadNode,healthConfig,idleNode,istio,responseTime,securityPolicy,serviceEntry,sidecarsCheck,throughput"` | Comma-separated list of Appenders to run. Available appenders: [aggregateNode, deadNode, healthConfig, idleNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, throughput]. | | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | | graphType | `query` | string | `string` | | | | Graph type. Available graph types: [app, versionedApp]. | | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. responsemessages) | requests | sent (i.e. requestmessages) | total (i.e. sent+received). | | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. receivedbytes) | sent (i.e. sentbytes) | total (i.e.

| | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request | response. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and cytoscapejs Config in data | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="graph-app-version-bad-request-body"></span> GraphAppVersionBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="graph-app-version-internal-server-error-body"></span> GraphAppVersionInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/graph ``` http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | appenders | `query` | string | `string` | | | `"aggregateNode,deadNode,healthConfig,idleNode,istio,responseTime,securityPolicy,serviceEntry,sidecarsCheck,throughput"` | Comma-separated list of Appenders to run. Available appenders: [aggregateNode, deadNode, healthConfig, idleNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, throughput]. | | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | | graphType | `query` | string | `string` | | | `"workload"` | Graph type. Available graph types: [app, service, versionedApp, workload]. | | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | | namespaces | `query` | string | `string` | | | | Comma-separated list of namespaces to include in the graph. The namespaces must be accessible to the client. | | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. responsemessages) | requests | sent (i.e. requestmessages) | total (i.e. sent+received). | | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. receivedbytes) | sent (i.e. sentbytes) | total (i.e. sent+received). | | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput

One of: request | response. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and cytoscapejs Config in data | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="graph-namespaces-bad-request-body"></span> GraphNamespacesBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="graph-namespaces-internal-server-error-body"></span> GraphNamespacesInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/services/{service}/graph ``` http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | service | `path` | string | `string` | | | | The service name. | | appenders | `query` | string | `string` | | | `"aggregateNode,deadNode,healthConfig,idleNode,istio,responseTime,securityPolicy,serviceEntry,sidecarsCheck,throughput"` | Comma-separated list of Appenders to run. Available appenders: [aggregateNode, deadNode, healthConfig, idleNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, throughput]. | | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | | graphType | `query` | string | `string` | | | `"workload"` | Graph type. Available graph types: [app, service, versionedApp, workload]. | | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. responsemessages) | requests | sent (i.e. requestmessages) | total (i.e. sent+received). | | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. receivedbytes) | sent (i.e. sentbytes) | total (i.e. sent+received). | | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request |

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and cytoscapejs Config in data | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="graph-service-bad-request-body"></span> GraphServiceBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="graph-service-internal-server-error-body"></span> GraphServiceInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/workloads/{workload}/graph ``` http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | workload | `path` | string | `string` | | | | The workload name. | | appenders | `query` | string | `string` | | | `"aggregateNode,deadNode,healthConfig,idleNode,istio,responseTime,securityPolicy,serviceEntry,sidecarsCheck,throughput"` | Comma-separated list of Appenders to run. Available appenders: [aggregateNode, deadNode, healthConfig, idleNode, istio, responseTime, securityPolicy, serviceEntry, sidecarsCheck, throughput]. | | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | | graphType | `query` | string | `string` | | | `"workload"` | Graph type. Available graph types: [app, service, versionedApp, workload]. | | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. responsemessages) | requests | sent (i.e. requestmessages) | total (i.e. sent+received). | | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. receivedbytes) | sent (i.e. sentbytes) | total (i.e. sent+received). | | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request |

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and cytoscapejs Config in data | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="graph-workload-bad-request-body"></span> GraphWorkloadBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="graph-workload-internal-server-error-body"></span> GraphWorkloadInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/healthz ``` Endpoint to get the health of Kiali http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: Internal Server Error <span id="healthz-internal-server-error-body"></span> HealthzInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/istio/certs ``` Get certificates (internal) information used by Istio http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return a list of certificates information | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="istio-certs-internal-server-error-body"></span> IstioCertsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` POST /api/namespaces/{namespace}/istio/{object_type} ``` Endpoint to create an Istio object by using an Istio Config item http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | object_type | `path` | string | `string` | | | | The Istio object type. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | IstioConfig details of an specific Istio Object | | | | | Created | IstioConfig details of an specific Istio Object | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Created Status: Not Found Status: Internal Server Error <span id="istio-config-create-internal-server-error-body"></span> IstioConfigCreateInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="istio-config-create-not-found-body"></span> IstioConfigCreateNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` DELETE /api/namespaces/{namespace}/istio/{object_type}/{object} ``` Endpoint to delete the Istio Config of an (arbitrary) Istio object http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | object | `path` | string | `string` | | | | The Istio object name. | | object_type | `path` | string | `string` | | | | The Istio object type. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: Not Found Status: Internal Server Error <span id="istio-config-delete-internal-server-error-body"></span> IstioConfigDeleteInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="istio-config-delete-not-found-body"></span> IstioConfigDeleteNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/istio/{object_type}/{object} ``` Endpoint to get the Istio Config of an Istio object http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | object | `path` | string | `string` | | | | The Istio object name. | | object_type | `path` | string | `string` | | | | The Istio object type. | | validate | `query` | string | `string` | | | | Enable validation or not | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | IstioConfig details of an specific Istio Object | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Not Found Status: Internal Server Error <span id="istio-config-details-bad-request-body"></span> IstioConfigDetailsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="istio-config-details-internal-server-error-body"></span> IstioConfigDetailsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="istio-config-details-not-found-body"></span> IstioConfigDetailsNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/istio ``` Endpoint to get the list of Istio Config of a namespace http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | validate | `query` | string | `string` | | | | Enable validation or not | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and IstioConfigList model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="istio-config-list-internal-server-error-body"></span> IstioConfigListInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/istio ``` Endpoint to get the list of Istio Config of all namespaces http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and IstioConfigList model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="istio-config-list-all-internal-server-error-body"></span> IstioConfigListAllInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` PATCH /api/namespaces/{namespace}/istio/{object_type}/{object} ``` http https application/json application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | object | `path` | string | `string` | | | | The Istio object name. | | object_type | `path` | string | `string` | | | | The Istio object type. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | IstioConfig details of an specific Istio Object | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Not Found Status: Internal Server Error <span id="istio-config-update-bad-request-body"></span> IstioConfigUpdateBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="istio-config-update-internal-server-error-body"></span> IstioConfigUpdateInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="istio-config-update-not-found-body"></span> IstioConfigUpdateNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/istio/status ``` Get the status of each components needed in the control plane http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return a list of Istio components along its status | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="istio-status-bad-request-body"></span> IstioStatusBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="istio-status-internal-server-error-body"></span> IstioStatusInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/jaeger ``` Get the jaeger URL and other descriptors http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return all the descriptor data related to Jaeger | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Not Acceptable | A NotAcceptable is the error message that means request can't be accepted | | | Status: OK Status: Not Found Status: Not Acceptable <span id="jaeger-info-not-acceptable-body"></span> JaegerInfoNotAcceptableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | <span id="jaeger-info-not-found-body"></span> JaegerInfoNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/logout ``` Endpoint to logout an user (unset the session cookie) http https | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | No Content | NoContent: the response is empty | | | Status: No Content <span id="logout-no-content-body"></span> LogoutNoContentBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | | Message | string| `string` | | | | | ``` GET /api/mesh/tls ``` Get TLS status for the whole mesh http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return the mTLS status of the whole Mesh | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="mesh-tls-bad-request-body"></span> MeshTLSBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="mesh-tls-internal-server-error-body"></span> MeshTLSInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` POST /api/stats/metrics ``` Produces metrics statistics http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | Body | `body` | | `models.MetricsStatsQueries` | | | | | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Response of the metrics stats query | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error Status: Service Unavailable <span id="metrics-stats-bad-request-body"></span> MetricsStatsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="metrics-stats-internal-server-error-body"></span> MetricsStatsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="metrics-stats-service-unavailable-body"></span> MetricsStatsServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/health ``` Get health for all objects in the given namespace http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace scope | | QueryTime | `query` | date-time (formatted string) | `strfmt.DateTime` | | | | The time to use for the prometheus query | | rateInterval | `query` | string | `string` | | | `"10m"` | The rate interval used for fetching error rate | | type | `query` | string | `string` | | | `"app"` | The type of health, "app", "service" or

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | namespaceAppHealthResponse is a map of app name x health | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="namespace-health-bad-request-body"></span> NamespaceHealthBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="namespace-health-internal-server-error-body"></span> NamespaceHealthInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces ``` Endpoint to get the list of the available namespaces http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | List of Namespaces | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="namespace-list-internal-server-error-body"></span> NamespaceListInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/metrics ``` Endpoint to fetch metrics to be displayed, related to a namespace http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Metrics response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK map of Status: Bad Request Status: Service Unavailable <span id="namespace-metrics-bad-request-body"></span> NamespaceMetricsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="namespace-metrics-service-unavailable-body"></span> NamespaceMetricsServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/tls ``` Get TLS status for the given namespace http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return the mTLS status of a specific Namespace | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="namespace-tls-bad-request-body"></span> NamespaceTLSBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="namespace-tls-internal-server-error-body"></span> NamespaceTLSInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` PATCH /api/namespaces/{namespace} ``` http https application/json application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | namespaceResponse is a basic namespace | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Not Found Status: Internal Server Error <span id="namespace-update-bad-request-body"></span> NamespaceUpdateBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="namespace-update-internal-server-error-body"></span> NamespaceUpdateInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="namespace-update-not-found-body"></span> NamespaceUpdateNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/validations ``` Get validation summary for all objects in the given namespace http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return the validation status of a specific Namespace | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="namespace-validations-bad-request-body"></span> NamespaceValidationsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="namespace-validations-internal-server-error-body"></span> NamespaceValidationsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/istio/validations ``` Get validation summary for all objects in the given namespaces http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return the validation status of a specific Namespace | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Internal Server Error <span id="namespaces-validations-bad-request-body"></span> NamespacesValidationsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="namespaces-validations-internal-server-error-body"></span> NamespacesValidationsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/auth/openid_redirect ``` Endpoint to redirect the browser of the user to the authentication endpoint of the configured OpenId provider. http https application/json application/html | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | NoContent: the response is empty | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="openid-redirect-internal-server-error-body"></span> OpenidRedirectInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="openid-redirect-o-k-body"></span> OpenidRedirectOKBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | | Message | string| `string` | | | | | ``` POST /api/authenticate ``` Endpoint to check if a token from Openshift is working correctly http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and userGenerated model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="openshift-check-token-internal-server-error-body"></span> OpenshiftCheckTokenInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/pods/{pod} ``` Endpoint to get pod details http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | pod | `path` | string | `string` | | | | The pod name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a workload | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="pod-details-internal-server-error-body"></span> PodDetailsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="pod-details-not-found-body"></span> PodDetailsNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/pods/{pod}/logs ``` Endpoint to get pod logs http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | pod | `path` | string | `string` | | | | The pod name. | | container | `query` | string | `string` | | | | The pod container name. Optional for single-container pod. Otherwise required. | | duration | `query` | string | `string` | | | | Query time-range duration (Golang string duration). Duration starts on `sinceTime` if set, or the time for the first log message if not set. | | sinceTime | `query` | string | `string` | | | | The start time for fetching logs. UNIX time in seconds. Default is all logs. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a workload | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="pod-logs-internal-server-error-body"></span> PodLogsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="pod-logs-not-found-body"></span> PodLogsNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/pods/{pod}/config_dump ``` Endpoint to get pod proxy dump http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | pod | `path` | string | `string` | | | | The pod name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return a dump of the configuration of a given envoy proxy | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="pod-proxy-dump-internal-server-error-body"></span> PodProxyDumpInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="pod-proxy-dump-not-found-body"></span> PodProxyDumpNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` POST /api/namespaces/{namespace}/pods/{pod}/logging ``` Endpoint to set pod proxy log level http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | pod | `path` | string | `string` | | | | The pod name. | | level | `query` | string | `string` | | | | The log level for the pod's proxy. off ProxyLogLevelOff trace ProxyLogLevelTrace debug ProxyLogLevelDebug info ProxyLogLevelInfo warning ProxyLogLevelWarning error ProxyLogLevelError critical ProxyLogLevelCritical | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | NoContent: the response is empty | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Not Found Status: Internal Server Error <span id="pod-proxy-logging-bad-request-body"></span> PodProxyLoggingBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="pod-proxy-logging-internal-server-error-body"></span> PodProxyLoggingInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="pod-proxy-logging-not-found-body"></span> PodProxyLoggingNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | <span id="pod-proxy-logging-o-k-body"></span> PodProxyLoggingOKBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/pods/{pod}/config_dump/{resource} ``` Endpoint to get pod logs http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | pod | `path` | string | `string` | | | | The pod

| | resource | `path` | string | `string` | | | | The discovery service resource | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Return a dump of the configuration of a given envoy proxy | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK any Status: Not Found Status: Internal Server Error <span id="pod-proxy-resource-internal-server-error-body"></span> PodProxyResourceInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="pod-proxy-resource-not-found-body"></span> PodProxyResourceNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api ``` Endpoint to get the status of Kiali http https application/json | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | HTTP status code 200 and statusInfo model in data | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="root-internal-server-error-body"></span> RootInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/services/{service}/dashboard ``` Endpoint to fetch dashboard to be displayed, related to a single service http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | service | `path` | string | `string` | | | | The service name. | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Dashboard response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Service Unavailable <span id="service-dashboard-bad-request-body"></span> ServiceDashboardBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="service-dashboard-service-unavailable-body"></span> ServiceDashboardServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/services/{service} ``` Endpoint to get the details of a given service http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | service | `path` | string | `string` | | | | The service name. | | validate | `query` | string | `string` | | | | Enable validation or not | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a workload | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="service-details-internal-server-error-body"></span> ServiceDetailsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="service-details-not-found-body"></span> ServiceDetailsNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/services ``` Endpoint to get the details of a given service http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | QueryTime | `query` | date-time (formatted string) |

| | | | The time to use for the prometheus query | | health | `query` | boolean | `bool` | | | | Optional | | rateInterval | `query` | string | `string` | | | `"10m"` | The rate interval used for fetching error rate | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all services in the namespace | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="service-list-internal-server-error-body"></span> ServiceListInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/services/{service}/metrics ``` Endpoint to fetch metrics to be displayed, related to a single service http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | service | `path` | string | `string` | | | | The service name. | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | | version | `query` | string | `string` | | | | Filters metrics by the specified version. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Metrics response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK map of Status: Bad Request Status: Service Unavailable <span id="service-metrics-bad-request-body"></span> ServiceMetricsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="service-metrics-service-unavailable-body"></span> ServiceMetricsServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/services/{service}/spans ``` Endpoint to get Jaeger spans for a given service http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace

| | service | `path` | string | `string` | | | | The service name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a Span | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="service-spans-internal-server-error-body"></span> ServiceSpansInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/services/{service}/traces ``` Endpoint to get the traces of a given service http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | service | `path` | string | `string` | | | | The service name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a Trace | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="service-traces-internal-server-error-body"></span> ServiceTracesInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="service-traces-not-found-body"></span> ServiceTracesNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` PATCH /api/namespaces/{namespace}/services/{service} ``` http https application/json application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | service | `path` | string | `string` | | | | The service name. | | validate | `query` | string | `string` | | | | Enable validation or not | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a workload | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Not Found Status: Internal Server Error <span id="service-update-bad-request-body"></span> ServiceUpdateBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="service-update-internal-server-error-body"></span> ServiceUpdateInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="service-update-not-found-body"></span> ServiceUpdateNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/traces/{traceID} ``` Endpoint to get a specific trace from ID http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | traceID | `path` | string | `string` | | | | The trace ID. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a Trace | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="trace-details-internal-server-error-body"></span> TraceDetailsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="trace-details-not-found-body"></span> TraceDetailsNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/workloads/{workload}/dashboard ``` Endpoint to fetch dashboard to be displayed, related to a single workload http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | workload | `path` | string | `string` | | | | The workload name. | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or

| | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Dashboard response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Service Unavailable <span id="workload-dashboard-bad-request-body"></span> WorkloadDashboardBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="workload-dashboard-service-unavailable-body"></span> WorkloadDashboardServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/workloads/{workload} ``` Endpoint to get the workload details http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | workload | `path` | string | `string` | | | | The workload name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a workload | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="workload-details-internal-server-error-body"></span> WorkloadDetailsInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="workload-details-not-found-body"></span> WorkloadDetailsNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/workloads ``` Endpoint to get the list of workloads for a namespace http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all workloads in the namespace | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="workload-list-internal-server-error-body"></span> WorkloadListInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/workloads/{workload}/metrics ``` Endpoint to fetch metrics to be displayed, related to a single workload http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | workload | `path` | string | `string` | | | | The workload name. | | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | | version | `query` | string | `string` | | | | Filters metrics by the specified version. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Metrics response model | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Service Unavailable | A Internal is the error message that means something has gone wrong | | | Status: OK map of Status: Bad Request Status: Service Unavailable <span id="workload-metrics-bad-request-body"></span> WorkloadMetricsBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="workload-metrics-service-unavailable-body"></span> WorkloadMetricsServiceUnavailableBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/workloads/{workload}/spans ``` Endpoint to get Jaeger spans for a given workload http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | workload | `path` | string | `string` | | | | The workload

| | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a Span | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Internal Server Error <span id="workload-spans-internal-server-error-body"></span> WorkloadSpansInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | ``` GET /api/namespaces/{namespace}/workloads/{workload}/traces ``` Endpoint to get the traces of a given workload http https application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | workload | `path` | string | `string` | | | | The workload name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a Trace | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Not Found Status: Internal Server Error <span id="workload-traces-internal-server-error-body"></span> WorkloadTracesInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="workload-traces-not-found-body"></span> WorkloadTracesNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | ``` PATCH /api/namespaces/{namespace}/workloads/{workload} ``` http https application/json application/json | Name | Source | Type | Go type | Separator | Required | Default | Description | ||--|||--| :: ||-| | namespace | `path` | string | `string` | | | | The namespace name. | | workload | `path` | string | `string` | | | | The workload name. | | Code | Status | Description | Has headers | Schema | ||--|-|:--:|--| | | OK | Listing all the information related to a workload | | | | | Bad Request | BadRequestError: the client request is incorrect | | | | | Not Found | A NotFoundError is the error message that is generated when server could not find what was

| | | | | Internal Server Error | A Internal is the error message that means something has gone wrong | | | Status: OK Status: Bad Request Status: Not Found Status: Internal Server Error <span id="workload-update-bad-request-body"></span> WorkloadUpdateBadRequestBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | | Message | string| `string` | | | | | <span id="workload-update-internal-server-error-body"></span> WorkloadUpdateInternalServerErrorBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | | Message | string| `string` | | | | | <span id="workload-update-not-found-body"></span> WorkloadUpdateNotFoundBody Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | | Message | string| `string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Icon | string| `string` | | | | | | Title | string| `string` | | | | | | Value | string| `string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | IP | string| `string` | | | | | | Kind | string| `string` | | | | | | Name | string| `string` | | | | | | Port | uint32 (formatted integer)| `uint32` | | | | | A predefined CamelCase string identifier (currently limited to `IPAddress` or `Hostname`) A domain-prefixed string identifier (like `acme.io/CustomAddressType`) Values `IPAddress` and `Hostname` have Extended support. The `NamedAddress` value has been deprecated in favor of implementation specific domain-prefixed strings. All other values, including domain-prefixed values have Custom support, which are used in implementation-specific behaviors. Support for additional predefined CamelCase identifiers may be added in future releases. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^Hostname|IPAddress|NamedAddress|?(\.?)\/[A-Za-z0-9\/\-._~%!$&'()+,;=:]+$` | Name | Type | Go type | Default | Description | Example | |||| - |-|| | AddressType | string| string | | A predefined CamelCase string identifier (currently limited to `IPAddress` or `Hostname`) A domain-prefixed string identifier (like `acme.io/CustomAddressType`) Values `IPAddress` and `Hostname` have Extended support. The `NamedAddress` value has been deprecated in favor of implementation specific domain-prefixed strings. All other values, including domain-prefixed values have Custom support, which are used in implementation-specific behaviors. Support for additional predefined CamelCase identifiers may be added in future releases. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^Hostname|IPAddress|NamedAddress|?(\.?)\/[A-Za-z0-9\/\-._~%!$&'()+,;=:]+$` | | Aggregation represents label's allowed aggregations, transformed from aggregation in MonitoringDashboard config resource Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | DisplayName | string| `string` | | | | | | Label | string| `string` | | | | | | SingleSelection | boolean| `bool` | | | | | AnalysisMessageBase describes some common information that is needed for all messages. All information should be static with respect to the error code. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | DocumentationUrl | string| `string` | | | A url pointing to the Istio documentation for this specific error type. Should be of the form `^http(s)?://(preliminary\.)?istio.io/docs/reference/config/analysis/` Required. | | | level | | `AnalysisMessageBaseLevel` | | | | | | type | | `AnalysisMessageBaseType` | | | | | as well as leaving space in between to add more later | Name | Type | Go type | Default | Description | Example | |||| - |-|| | AnalysisMessageBase_Level | int32 (formatted integer)| int32 | | as well as leaving space in between to add more later | | A unique identifier for the type of message. Name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between name and code. (i.e. do not re-use names or codes between message

Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | string| `string` | | | A 7 character code matching `^IST[0-9]{4}$` intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.) 0000-0100 are reserved. Required. | | | Name | string| `string` | | | A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. Required. | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | Name of the application | `reviews` | | Runtimes | | `[]*Runtime` | | | Runtimes and associated dashboards | | | ServiceNames | []string| `[]string` | | | List of service names linked with an application | | | Workloads | | `[]*WorkloadItem` | | | Workloads for a given application | | | health | | `AppHealth` | | | | | | namespace | | `Namespace` | | | | | AppHealth contains aggregated health from various sources, for a given app Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | WorkloadStatuses | | `[]*WorkloadStatus` | | | | | | requests | | `RequestHealth` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Apps | | `[]*AppListItem` | | | Applications for a given namespace | | | namespace | | `Namespace` | | | | | AppListItem has the necessary information to display the console app list Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | IstioReferences | | `[]*IstioValidationKey` | | | Istio References | | | IstioSidecar | boolean| `bool` | | | Define if all Pods related to the Workloads of this app has an IstioSidecar deployed | `true` | | Labels | map of string| `map[string]string` | | | Labels for App | | | Name | string| `string` | | | Name of the application | `reviews` | | health | | `AppHealth` | | | | | <!-- crd generation tags +cue-gen:AuthorizationPolicy:groupName:security.istio.io +cue-gen:AuthorizationPolicy:version:v1beta1 +cue-gen:AuthorizationPolicy:storageVersion +cue-gen:AuthorizationPolicy:annotations:helm.sh/resource-policy=keep +cue-gen:AuthorizationPolicy:labels:app=istio-pilot,chart=istio,istio=security,heritage=Tiller,release=istio +cue-gen:AuthorizationPolicy:subresource:status +cue-gen:AuthorizationPolicy:scope:Namespaced +cue-gen:AuthorizationPolicy:resource:categories=istio-io,security-istio-io,plural=authorizationpolicies +cue-gen:AuthorizationPolicy:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=security.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be

In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `AuthorizationPolicy` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | Note that when a namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be

References to objects with invalid Group and Kind are not valid, and must be rejected by the implementation, with appropriate Conditions set on the containing object. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | group | | `Group` | | | | | | kind | | `Kind` | | | | | | name | | `ObjectName` | | | | | | namespace | | `Namespace` | | | | | | port | | `PortNumber` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Bootstrap | | `interface{}` | | | | | CertInfo contains the information for a given certificate Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Accessible | boolean| `bool` | | | | | | DNSNames | []string| `[]string` | | | | | | Error | string| `string` | | | | | | Issuer | string| `string` | | | | | | NotAfter | date-time (formatted string)| `strfmt.DateTime` | | | | | | NotBefore | date-time (formatted string)| `strfmt.DateTime` | | | | | | SecretName | string| `string` | | | | | | SecretNamespace | string| `string` | | | | | Chart is the model representing a custom chart, transformed from charts in MonitoringDashboard config resource Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ChartType | string| `string` | | | | | | Error | string| `string` | | | | | | Max | int64 (formatted integer)| `int64` | | | | | | Metrics | | `[]*Metric` | | | | | | Min | int64 (formatted integer)| `int64` | | | | | | Name | string| `string` | | | | | | Spans | int64 (formatted integer)| `int64` | | | | | | StartCollapsed | boolean| `bool` | | | | | | Unit | string| `string` | | | | | | XAxis | string| `string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | DestinationRule | string| `string` | | | | | | Direction | string| `string` | | | | | | Port | int64 (formatted integer)| `int64` | | | | | | Subset | string| `string` | | | | | | Type | string| `string` | | | | | | service_fqdn | | `Host` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | IsCore | boolean| `bool` | | | When true, the component is necessary for Istio to function. Otherwise, it is an addon. | `true` | | Name | string| `string` | | | The workload name of the Istio component. | `istio-ingressgateway` | | Status | string| `string` | | | The status of an Istio component. | `Not Found` | This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ Represents the observations of a foo's current state. Known .status.conditions.type are: "Available", "Progressing", and "Degraded" +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type Conditions

`json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` other fields } Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | LastTransitionTime | string| `string` | | | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. +required +kubebuilder:validation:Required +kubebuilder:validation:Type=string +kubebuilder:validation:Format=date-time | | | Message | string| `string` | | | message is a human readable message indicating details about the transition. This may be an empty string. +required +kubebuilder:validation:Required +kubebuilder:validation:MaxLength=32768 | | | ObservedGeneration | int64 (formatted integer)| `int64` | | | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. +optional +kubebuilder:validation:Minimum=0 | | | Reason | string| `string` | | | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. +required +kubebuilder:validation:Required +kubebuilder:validation:MaxLength=1024 +kubebuilder:validation:MinLength=1 +kubebuilder:validation:Pattern=`^?$` | | | Type | string| `string` | | | type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) +required +kubebuilder:validation:Required +kubebuilder:validation:Pattern=`^(?(\.?)/)?(()?[A-Za-z0-9])$` +kubebuilder:validation:MaxLength=316 | | | status | | `ConditionStatus` | | | | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | ConditionStatus | string| string | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Duration | int64 (formatted integer)| `int64` | | | | | | GraphType | string| `string` | | | | | | Timestamp | int64 (formatted integer)| `int64` | | | | | | elements | | `Elements` | | | | | Root of ConfigDump Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Configs | | `[]interface{}` | | | | | ContainerInfo holds container name and image Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Image | string| `string` | | | | | | IsProxy | boolean| `bool` | | | | | | IsReady | boolean| `bool` | | | | | | Name | string| `string` | | | | | DashboardRef holds template name and title for a custom dashboard Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Template | string| `string` | | | | | | Title | string| `string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Timestamp | int64 (formatted integer)| `int64` | | | | | | Value | double (formatted number)| `float64` | | | | | <!-- crd generation tags +cue-gen:DestinationRule:groupName:networking.istio.io +cue-gen:DestinationRule:version:v1beta1 +cue-gen:DestinationRule:annotations:helm.sh/resource-policy=keep +cue-gen:DestinationRule:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:DestinationRule:subresource:status +cue-gen:DestinationRule:scope:Namespaced +cue-gen:DestinationRule:resource:categories=istio-io,networking-istio-io,shortNames=dr +cue-gen:DestinationRule:printerColumn:name=Host,type=string,JSONPath=.spec.host,description="The name of a service from the service registry" +cue-gen:DestinationRule:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate

Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" +cue-gen:DestinationRule:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=networking.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true <!-- istio code generation tags +istio.io/sync-from:networking/v1alpha3/destination_rule.proto Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder

If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing

+optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `DestinationRule` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | DestPrincipal | string| `string` | | | App Fields (not required by Cytoscape) | | | ID | string| `string` | | | Cytoscape Fields | | | IsMTLS | string| `string` | | | | | | ResponseTime | string| `string` | | | | | | Source | string| `string` | | | | | | SourcePrincipal | string| `string` | | | | | | Target | string| `string` | | | | | | Throughput | string| `string` | | | | | | traffic | | `ProtocolTraffic` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | data | | `EdgeData` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Edges | | `[]*EdgeWrapper` | | | | | | Nodes | | `[]*NodeWrapper` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | addresses | | `Addresses` | | | | | | ports | | `Ports` | | | | | <!-- crd generation tags +cue-gen:EnvoyFilter:groupName:networking.istio.io +cue-gen:EnvoyFilter:version:v1alpha3 +cue-gen:EnvoyFilter:storageVersion +cue-gen:EnvoyFilter:annotations:helm.sh/resource-policy=keep +cue-gen:EnvoyFilter:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:EnvoyFilter:subresource:status +cue-gen:EnvoyFilter:scope:Namespaced +cue-gen:EnvoyFilter:resource:categories=istio-io,networking-istio-io +cue-gen:EnvoyFilter:preserveUnknownFields:configPatches.[].patch.value <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=networking.istio.io/v1alpha3 +genclient +k8s:deepcopy-gen=true Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system.

+optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental

+optional | | | spec | | `EnvoyFilter` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | bootstrap | | `Bootstrap` | | | | | | clusters | | `Clusters` | | | | | | config_dump | | `ConfigDump` | | | | | | listeners | | `Listeners` | | | | | | routes | | `Routes` | | | | | ExternalLink provides links to external dashboards (e.g. to Grafana) Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | | | | URL | string| `string` | | | | | | variables | | `MonitoringDashboardExternalLinkVariables` | | | | | Status response model This is used for returning a response of Kiali Status Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | The name of the service | `Istio` | | Url | string| `string` | | | The service url | `jaeger-query-istio-system.127.0.0.1.nip.io` | | Version | string| `string` | | | The installed version of the service | `0.8.0` | Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff +protobuf.options.(gogoproto.goproto_stringer)=false GWInfo contains the resolved gateway configuration if the node represents an Istio gateway Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | egressInfo | | `GWInfoIngress` | | | | | | gatewayAPIInfo | | `GWInfoIngress` | | | | | | ingressInfo | | `GWInfoIngress` | | | | | GWInfoIngress contains the resolved gateway configuration if the node represents an Istio ingress gateway Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Hostnames | []string| `[]string` | | | Hostnames is the list of hosts being served by the associated Istio gateways. | | Gateway represents an instance of a service-traffic handling infrastructure by binding Listeners to a set of IP addresses. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system.

+optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `GatewaySpec` | | | | | | status | | `GatewayStatus` | | | | | | uid | | `UID` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Value | string| `string` | | | Value of the

The validity of the values will depend on the type and support by the controller. Examples: `1.2.3.4`, `128::1`, `my-ip-address`. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 | | | type | | `AddressType` | | | | | Valid values include: "example.com/bar" Invalid values include: "example.com" - must include path "foo.example.com" - must include path +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^?(\.?)\/[A-Za-z0-9\/\-._~%!$&'()+,;=:]+$` | Name | Type | Go type | Default | Description | Example | |||| - |-|| | GatewayController | string| string | | Valid values include: "example.com/bar" Invalid values include: "example.com" - must include path "foo.example.com" - must include path +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^?(\.?)\/[A-Za-z0-9\/\-._~%!$&'()+,;=:]+$` | | Not all possible combinations of options specified in the Spec are valid. Some invalid configurations can be caught synchronously via a webhook, but there are many cases that will require asynchronous signaling via the GatewayStatus block. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Addresses | | `[]*GatewayAddress` | | | Addresses requested for this Gateway. This is optional and behavior can depend on the implementation. If a value is set in the spec and the requested address is invalid or unavailable, the implementation MUST indicate this in the associated entry in GatewayStatus.Addresses. The Addresses field represents a request for the address(es) on the "outside of the Gateway", that traffic bound for this Gateway will use. This could be the IP address or hostname of an external load balancer or other networking infrastructure, or some other address that traffic will be sent to. The .listener.hostname field is used to route traffic that has already arrived at the Gateway to the correct in-cluster destination. If no Addresses are specified, the implementation MAY schedule the Gateway in an implementation-specific manner, assigning an appropriate set of Addresses. The implementation MUST bind all Listeners to every GatewayAddress that it assigns to the Gateway and add a corresponding entry in GatewayStatus.Addresses. Support: Extended +optional +kubebuilder:validation:MaxItems=16 | | | Listeners | | `[]*Listener` | | | Listeners associated with this Gateway. Listeners define logical endpoints that are bound on this Gateway's addresses. At least one Listener MUST be specified. Each listener in a Gateway must have a unique combination of Hostname, Port, and Protocol. An implementation MAY group Listeners by Port and then collapse each group of Listeners into a single Listener if the implementation determines that the Listeners in the group are "compatible". An implementation MAY also group together and collapse compatible Listeners belonging to different Gateways. For example, an implementation might consider Listeners to be compatible with each other if all of the following conditions are met: Either each Listener within the group specifies the "HTTP" Protocol or each Listener within the group specifies either the "HTTPS" or "TLS" Protocol. Each Listener within the group specifies a Hostname that is unique within the group. As a special case, one Listener within a group may omit Hostname, in which case this Listener matches when no other Listener matches. If the implementation does collapse compatible Listeners, the hostname provided in the incoming client request MUST be matched to a Listener to find the correct set of Routes. The incoming hostname MUST be matched using the Hostname field for each Listener in order of most to least specific. That is, exact matches must be processed before wildcard matches. If this field specifies multiple Listeners that have the same Port value but are not compatible, the implementation must raise a "Conflicted" condition in the Listener

Support: Core +listType=map +listMapKey=name +kubebuilder:validation:MinItems=1 +kubebuilder:validation:MaxItems=64 | | | gatewayClassName | | `ObjectName` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Addresses | | `[]*GatewayAddress` | | | Addresses lists the IP addresses that have actually been bound to the Gateway. These addresses may differ from the addresses in the Spec, e.g. if the Gateway automatically assigns an address from a reserved pool. +optional +kubebuilder:validation:MaxItems=16 | | | Conditions | | `[]*Condition` | | | Conditions describe the current conditions of the Gateway. Implementations should prefer to express Gateway conditions using the `GatewayConditionType` and `GatewayConditionReason` constants so that operators and tools can converge on a common vocabulary to describe Gateway state. Known condition types are: "Scheduled" "Ready" +optional +listType=map +listMapKey=type +kubebuilder:validation:MaxItems=8 +kubebuilder:default={{type: "Scheduled", status: "Unknown", reason:"NotReconciled", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}} | | | Listeners | | `[]*ListenerStatus` | | | Listeners provide status for each unique listener port defined in the Spec. +optional +listType=map +listMapKey=name +kubebuilder:validation:MaxItems=64 | | GrafanaInfo provides information to access Grafana dashboards Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ExternalLinks | | `[]*ExternalLink` | | | | | This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 Valid values include: "" - empty string implies core Kubernetes API group "networking.k8s.io" "foo.example.com" Invalid values include: "example.com/bar" - "/" is an invalid character +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^$|^?(\.?)*$` | Name | Type | Go type | Default | Description | Example | |||| - |-|| | Group | string| string | | This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 Valid values include: "" - empty string implies core Kubernetes API group "networking.k8s.io" "foo.example.com" Invalid values include: "example.com/bar" - "/" is an invalid character +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^$|^?(\.?)*$` | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Filters | | `[]*HTTPRouteFilter` | | | Filters defined at this level should be executed if and only if the request is being forwarded to the backend defined here. Support: Custom (For broader support of filters, use the Filters field in HTTPRouteRule.) +optional +kubebuilder:validation:MaxItems=16 | | | Weight | int32 (formatted integer)| `int32` | | | Weight specifies the proportion of requests forwarded to the referenced backend. This is computed as weight/(sum of all weights in this BackendRefs list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. Weight is not a percentage and the sum of weights does not need to equal 100. If only one backend is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weight is set to 0, no traffic should be forwarded for this entry. If unspecified, weight defaults to 1. Support for this field varies based on the context where used. +optional +kubebuilder:default=1 +kubebuilder:validation:Minimum=0 +kubebuilder:validation:Maximum=1000000 | | | group | | `Group` | | | | | | kind | | `Kind` | | | | | | name | | `ObjectName` | | | | | | namespace | | `Namespace` | | | | | | port | | `PortNumber` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Value | string| `string` | | | Value is the value of HTTP Header to be

+kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=4096 | | | name | | `HTTPHeaderName` | | | | | HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request headers. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Value | string| `string` | | | Value is the value of HTTP Header to be matched. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=4096 | | | name | | `HTTPHeaderName` | | | | | | type | | `HeaderMatchType` | | | | | Valid values include: "Authorization" "Set-Cookie" Invalid values include: ":method" - ":" is an invalid character. This means that HTTP/2 pseudo headers are not currently supported by this type. "/invalid" - "/" is an invalid character +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=256 +kubebuilder:validation:Pattern=`^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$` | Name | Type | Go type | Default | Description | Example | |||| - |-|| | HTTPHeaderName | string| string | | Valid values include: "Authorization" "Set-Cookie" Invalid values include: ":method" - ":" is an invalid character. This means that HTTP/2 pseudo headers are not currently supported by this type. "/invalid" - "/" is an invalid character +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=256 +kubebuilder:validation:Pattern=`^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$` | | Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=GET;HEAD;POST;PUT;DELETE;CONNECT;OPTIONS;TRACE;PATCH | Name | Type | Go type | Default | Description | Example | |||| - |-|| | HTTPMethod | string| string | | Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=GET;HEAD;POST;PUT;DELETE;CONNECT;OPTIONS;TRACE;PATCH | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Value | string| `string` | | | Value of the HTTP path to match against. +optional +kubebuilder:default="/" +kubebuilder:validation:MaxLength=1024 | | | type | | `PathMatchType` | | | | | <gateway:experimental> Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ReplaceFullPath | string| `string` | | | ReplaceFullPath specifies the value with which to replace the full path of a request during a rewrite or redirect. <gateway:experimental> +kubebuilder:validation:MaxLength=1024 +optional | | | ReplacePrefixMatch | string| `string` | | | ReplacePrefixMatch specifies the value with which to replace the prefix match of a request during a rewrite or redirect. For example, a request to "/foo/bar" with a prefix match of "/foo" would be modified to "/bar". Note that this matches the behavior of the PathPrefix match type. This matches full path elements. A path element refers to the list of labels in the path split by the `/` separator. When specified, a trailing `/` is ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all match the prefix `/abc`, but the path `/abcd` would not. <gateway:experimental> +kubebuilder:validation:MaxLength=1024 +optional | | | type | | `HTTPPathModifierType` | | | | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | HTTPPathModifierType | string| string | | | | HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP query parameters. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | Name is the name of the HTTP query param to be

This must be an exact string match. (See https://tools.ietf.org/html/rfc7230#section-2.7.3). If multiple entries specify equivalent query param names, only the first entry with an equivalent name MUST be considered for a match. Subsequent entries with an equivalent query param name MUST be ignored. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=256 | | | Value | string| `string` | | | Value is the value of HTTP query param to be matched. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=1024 | | | type | | `QueryParamMatchType` | | | | | HTTPRequestHeaderFilter defines configuration for the RequestHeaderModifier filter. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Add | | `[]*HTTPHeader` | | | Add adds the given header(s) (name, value) to the request before the action. It appends to any existing values associated with the header name. Input: GET /foo HTTP/1.1 my-header: foo Config: add: name: "my-header" value: "bar" Output: GET /foo HTTP/1.1 my-header: foo my-header: bar +optional +listType=map +listMapKey=name +kubebuilder:validation:MaxItems=16 | | | Remove | []string| `[]string` | | | Remove the given header(s) from the HTTP request before the action. The value of Remove is a list of HTTP header names. Note that the header names are case-insensitive (see https://datatracker.ietf.org/doc/html/rfc2616#section-4.2). Input: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz Config: remove: ["my-header1", "my-header3"] Output: GET /foo HTTP/1.1 my-header2: bar +optional +kubebuilder:validation:MaxItems=16 | | | Set | | `[]*HTTPHeader` | | | Set overwrites the request with the given header (name, value) before the action. Input: GET /foo HTTP/1.1 my-header: foo Config: set: name: "my-header" value: "bar" Output: GET /foo HTTP/1.1 my-header: bar +optional +listType=map +listMapKey=name +kubebuilder:validation:MaxItems=16 | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | backendRef | | `BackendObjectReference` | | | | | HTTPRequestRedirect defines a filter that redirects a request. This filter MUST NOT be used on the same Route rule as a HTTPURLRewrite filter. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Scheme | string| `string` | | | Scheme is the scheme to be used in the value of the `Location` header in the response. When empty, the scheme of the request is used. Support: Extended Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +optional +kubebuilder:validation:Enum=http;https | | | StatusCode | int64 (formatted integer)| `int64` | | | StatusCode is the HTTP status code to be used in response. Support: Core Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +optional +kubebuilder:default=302 +kubebuilder:validation:Enum=301;302 | | | hostname | | `PreciseHostname` | | | | | | path | | `HTTPPathModifier` | | | | | | port | | `PortNumber` | | | | | HTTPRoute provides a way to route HTTP requests. This includes the capability to match requests by hostname, path, header, or query param. Filters can be used to specify additional processing steps. Backends specify where matching requests should be

Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the

+optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `HTTPRouteSpec` | | | | | | status | | `HTTPRouteStatus` | | | | | | uid | | `UID` | | | | | HTTPRouteFilter defines processing steps that must be completed during the request or response lifecycle. HTTPRouteFilters are meant as an extension point to express processing that may be done in Gateway implementations. Some examples include request or response modification, implementing authentication strategies, rate-limiting, and traffic shaping. API guarantee/conformance is defined based on the type of the filter. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | extensionRef | | `LocalObjectReference` | | | | | | requestHeaderModifier | | `HTTPRequestHeaderFilter` | | | | | | requestMirror | | `HTTPRequestMirrorFilter` | | | | | | requestRedirect | | `HTTPRequestRedirectFilter` | | | | | | type | | `HTTPRouteFilterType` | | | | | | urlRewrite | | `HTTPURLRewriteFilter` | | | | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | HTTPRouteFilterType | string| string | | | | For example, the match below will match a HTTP request only if its path starts with `/foo` AND it contains the `version: v1` header: ``` match: path: value: "/foo" headers: name: "version" value "v1" ``` Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Headers | | `[]*HTTPHeaderMatch` | | | Headers specifies HTTP request header matchers. Multiple match values are ANDed together, meaning, a request must match all the specified headers to select the route. +listType=map +listMapKey=name +optional +kubebuilder:validation:MaxItems=16 | | | QueryParams | | `[]*HTTPQueryParamMatch` | | | QueryParams specifies HTTP query parameter matchers. Multiple match values are ANDed together, meaning, a request must match all the specified query parameters to select the route. +listType=map +listMapKey=name +optional +kubebuilder:validation:MaxItems=16 | | | method | | `HTTPMethod` | | | | | | path | | `HTTPPathMatch` | | | | | HTTPRouteRule defines semantics for matching an HTTP request based on conditions (matches), processing it (filters), and forwarding the request to an API object (backendRefs). Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | BackendRefs | | `[]*HTTPBackendRef` | | | BackendRefs defines the backend(s) where matching requests should be sent. Failure behavior here depends on how many BackendRefs are specified and how many are invalid. If all entries in BackendRefs are invalid, and there are also no filters specified in this route rule, all traffic which matches this rule MUST receive a 500 status code. See the HTTPBackendRef definition for the rules about what makes a single HTTPBackendRef invalid. When a HTTPBackendRef is invalid, 500 status codes MUST be returned for requests that would have otherwise been routed to an invalid backend. If multiple backends are specified, and some are invalid, the proportion of requests that would otherwise have been routed to an invalid backend MUST receive a 500 status

For example, if two backends are specified with equal weights, and one is invalid, 50 percent of traffic must receive a 500. Implementations may choose how that 50 percent is determined. Support: Core for Kubernetes Service Support: Custom for any other resource Support for weight: Core +optional +kubebuilder:validation:MaxItems=16 | | | Filters | | `[]*HTTPRouteFilter` | | | Filters define the filters that are applied to requests that match this rule. The effects of ordering of multiple behaviors are currently unspecified. This can change in the future based on feedback during the alpha stage. Conformance-levels at this level are defined based on the type of filter: ALL core filters MUST be supported by all implementations. Implementers are encouraged to support extended filters. Implementation-specific custom filters have no API guarantees across implementations. Specifying a core filter multiple times has unspecified or custom conformance. All filters are expected to be compatible with each other except for the URLRewrite and RequestRedirect filters, which may not be combined. If an implementation can not support other combinations of filters, they must clearly document that limitation. In all cases where incompatible or unsupported filters are specified, implementations MUST add a warning condition to status. Support: Core +optional +kubebuilder:validation:MaxItems=16 | | | Matches | | `[]*HTTPRouteMatch` | | | Matches define conditions used for matching the rule against incoming HTTP requests. Each match is independent, i.e. this rule will be matched if any one of the matches is satisfied. For example, take the following matches configuration: ``` matches: path: value: "/foo" headers: name: "version" value: "v2" path: value: "/v2/foo" ``` For a request to match against this rule, a request must satisfy EITHER of the two conditions: path prefixed with `/foo` AND contains the header `version: v2` path prefix of `/v2/foo` See the documentation for HTTPRouteMatch on how to specify multiple match conditions that should be ANDed together. If no matches are specified, the default is a prefix path match on "/", which has the effect of matching every HTTP request. Proxy or Load Balancer routing configuration generated from HTTPRoutes MUST prioritize rules based on the following criteria, continuing on ties. Precedence must be given to the Rule with the largest number of: Characters in a matching non-wildcard hostname. Characters in a matching hostname. Characters in a matching path. Header matches. Query param matches. If ties still exist across multiple Routes, matching precedence MUST be determined in order of the following criteria, continuing on ties: The oldest Route based on creation timestamp. The Route appearing first in alphabetical order by "{namespace}/{name}". If ties still exist within the Route that has been given precedence, matching precedence MUST be granted to the first matching rule meeting the above criteria. When no rules matching a request have been successfully attached to the parent a request is coming from, a HTTP 404 status code MUST be returned. +optional +kubebuilder:validation:MaxItems=8 +kubebuilder:default={{path:{ type: "PathPrefix", value: "/"}}} | | HTTPRouteSpec defines the desired state of HTTPRoute Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Hostnames | | `[]Hostname` | | | Hostnames defines a set of hostname that should match against the HTTP Host header to select a HTTPRoute to process the request. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: IPs are not allowed. A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first

If a hostname is specified by both the Listener and HTTPRoute, there must be at least one intersecting hostname for the HTTPRoute to be | | | ParentRefs | | `[]*ParentReference` | | | ParentRefs references the resources (usually Gateways) that a Route wants to be attached to. Note that the referenced parent resource needs to allow this for the attachment to be complete. For Gateways, that means the Gateway needs to allow attachment from Routes of this kind and namespace. The only kind of parent resource with "Core" support is Gateway. This API may be extended in the future to support additional kinds of parent resources such as one of the route kinds. It is invalid to reference an identical parent more than once. It is valid to reference multiple distinct sections within the same parent resource, such as 2 Listeners within a Gateway. It is possible to separately reference multiple distinct objects that may be collapsed by an implementation. For example, some implementations may choose to merge compatible Gateway Listeners together. If that is the case, the list of routes attached to those resources should also be merged. +optional +kubebuilder:validation:MaxItems=32 | | | Rules | | `[]*HTTPRouteRule` | | | Rules are a list of HTTP matchers, filters and actions. +optional +kubebuilder:validation:MaxItems=16 +kubebuilder:default={{matches: {{path: {type: "PathPrefix", value: "/"}}}}} | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Parents | | `[]*RouteParentStatus` | | | Parents is a list of parent resources (usually Gateways) that are associated with the route, and the status of the route with respect to each parent. When this route attaches to a parent, the controller that manages the parent must add an entry to this list when the controller first sees the route and should update the entry as appropriate when the route or gateway is modified. Note that parent references that cannot be resolved by an implementation of this API will not be added to this list. Implementations of this API can only populate Route status for the Gateways/parent resources they are responsible for. A maximum of 32 Gateways will be represented in this list. An empty list means the route has not been attached to any Gateway. +kubebuilder:validation:MaxItems=32 | | Support: Extended <gateway:experimental> Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | hostname | | `PreciseHostname` | | | | | | path | | `HTTPPathModifier` | | | | | "Exact" "RegularExpression" Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=Exact;RegularExpression | Name | Type | Go type | Default | Description | Example | |||| - |-|| | HeaderMatchType | string| string | | "Exact" "RegularExpression" Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=Exact;RegularExpression | | HealthConfig maps annotations information for health Host represents the FQDN format for Istio hostnames Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Cluster | string| `string` | | | | | | CompleteInput | boolean| `bool` | | | CompleteInput is true when Service, Namespace and Cluster fields are present. It is true for simple service names and FQDN

It is false for service.namespace format and service entries. | | | Namespace | string| `string` | | | | | | Service | string| `string` | | | | | IPs are not allowed. A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.example.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^(\\.)??(\.?)$` | Name | Type | Go type | Default | Description | Example | |||| - |-|| | Hostname | string| string | | 1. IPs are not allowed. A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.example.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^(\\.)??(\.?)$` | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Code | string| `string` | | | The check code used to identify a check | `KIA0001` | | Message | string| `string` | | | Description of the check | `Weight sum should be 100` | | Path | string| `string` | | | String that describes where in the yaml file is the check located | `spec/http[0]/route` | | severity | | `SeverityLevel` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Message | string| `string` | | | Human-readable message indicating details about last transition. +optional | | | Reason | string| `string` | | | Unique, one-word, CamelCase reason for the condition's last transition. +optional | | | Status | string| `string` | | | Status is the status of the condition. Can be True, False, Unknown. | | | Type | string| `string` | | | Type is the type of the

| | | lastprobetime | | `Timestamp` | | | | | | lasttransitiontime | | `Timestamp` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | IstioConfigHelpFields | | `[]*IstioConfigHelp` | | | | | | ObjectType | string| `string` | | | | | | authorizationPolicy | | `AuthorizationPolicy` | | | | | | destinationRule | | `DestinationRule` | | | | | | envoyFilter | | `EnvoyFilter` | | | | | | gateway | | `Gateway` | | | | | | k8sGateway | | `Gateway` | | | | | | k8sHTTPRoute | | `HTTPRoute` | | | | | | namespace | | `Namespace` | | | | | | peerAuthentication | | `PeerAuthentication` | | | | | | permissions | | `ResourcePermissions` | | | | | | references | | `IstioReferences` | | | | | | requestAuthentication | | `RequestAuthentication` | | | | | | serviceEntry | | `ServiceEntry` | | | | | | sidecar | | `Sidecar` | | | | | | telemetry | | `Telemetry` | | | | | | validation | | `IstioValidation` | | | | | | virtualService | | `VirtualService` | | | | | | wasmPlugin | | `WasmPlugin` | | | | | | workloadEntry | | `WorkloadEntry` | | | | | | workloadGroup | | `WorkloadGroup` | | | | | IstioConfigHelp represents a help message for a given Istio object type and field Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Message | string| `string` | | | | | | ObjectField | string| `string` | | | | | IstioConfigList istioConfigList This type is used for returning a response of IstioConfigList Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AuthorizationPolicies | | `[]*AuthorizationPolicy` | | | | | | DestinationRules | | `[]*DestinationRule` | | | | | | EnvoyFilters | | `[]*EnvoyFilter` | | | | | | Gateways | | `[]*Gateway` | | | | | | K8sGateways | | `[]*Gateway` | | | | | | K8sHTTPRoutes | | `[]*HTTPRoute` | | | | | | K8sReferenceGrants | | `[]*ReferenceGrant` | | | | | | PeerAuthentications | | `[]*PeerAuthentication` | | | | | | RequestAuthentications | | `[]*RequestAuthentication` | | | | | | ServiceEntries | | `[]*ServiceEntry` | | | | | | Sidecars | | `[]*Sidecar` | | | | | | Telemetries | | `[]*Telemetry` | | | | | | VirtualServices | | `[]*VirtualService` | | | | | | WasmPlugins | | `[]*WasmPlugin` | | | | | | WorkloadEntries | | `[]*WorkloadEntry` | | | | | | WorkloadGroups | | `[]*WorkloadGroup` | | | | | | namespace | | `Namespace` | | | | | | validations | | `IstioValidations` | | | | | IstioConfigPermissions holds a map of ResourcesPermissions per namespace IstioEnvironment describes the Istio implementation environment Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | IstioAPIEnabled | boolean| `bool` | | | Is api enabled | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | | | | Namespace | string| `string` | | | | | | ObjectType | string| `string` | | | | | IstioReferences represents a sets of different references Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ObjectReferences | | `[]*IstioReference` | | | Related Istio objects | | | ServiceReferences | | `[]*ServiceReference` | | | Related Istio objects | | | WorkloadReferences | | `[]*WorkloadReference` | | | Related Istio objects | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Conditions | | `[]*IstioCondition` | | | Current service state of pod. More info: https://istio.io/docs/reference/config/config-status/ +optional +patchMergeKey=type +patchStrategy=merge | | | ObservedGeneration | int64 (formatted integer)| `int64` | | | Resource Generation to which the Reconciled Condition

When this value is not equal to the object's metadata generation, reconciled condition calculation for the current generation is still in progress. See https://istio.io/latest/docs/reference/config/config-status/ for more info. +optional | | | ValidationMessages | | `[]*AnalysisMessageBase` | | | Includes any errors or warnings detected by Istio's analyzers. +optional +patchMergeKey=type +patchStrategy=merge | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Checks | | `[]*IstioCheck` | | | Array of checks. It might be

| | | Name | string| `string` | | | Name of the object itself | `reviews` | | ObjectType | string| `string` | | | Type of the object | `virtualservice` | | References | | `[]*IstioValidationKey` | | | Related objects (only validation errors) | | | Valid | boolean| `bool` | | | Represents validity of the object: in case of warning, validity remains as true | `false` | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | | | | Namespace | string| `string` | | | | | | ObjectType | string| `string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Errors | int64 (formatted integer)| `int64` | | | Number of validations with error severity | `2` | | ObjectCount | int64 (formatted integer)| `int64` | | | Number of Istio Objects analyzed | `6` | | Warnings | int64 (formatted integer)| `int64` | | | Number of validations with warning severity | `4` | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Enabled | boolean| `bool` | | | | | | Integration | boolean| `bool` | | | | | | NamespaceSelector | boolean| `bool` | | | | | | URL | string| `string` | | | | | | WhiteListIstioSystem | []string| `[]string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Duration | uint64 (formatted integer)| `uint64` | | | | | | Flags | uint32 (formatted integer)| `uint32` | | | | | | Logs | | `[]*Log` | | | | | | OperationName | string| `string` | | | | | | References | | `[]*Reference` | | | | | | StartTime | uint64 (formatted integer)| `uint64` | | | | | | Tags | | `[]*KeyValue` | | | | | | TraceSize | int64 (formatted integer)| `int64` | | | | | | Warnings | []string| `[]string` | | | | | | parentSpanID | | `SpanID` | | | | | | process | | `Process` | | | | | | processID | | `ProcessID` | | | | | | spanID | | `SpanID` | | | | | | traceID | | `TraceID` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Key | string| `string` | | | | | | Value | | `interface{}` | | | | | | type | | `ValueType` | | | | | Valid values include: "Service" "HTTPRoute" Invalid values include: "invalid/kind" - "/" is an invalid character +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=63 +kubebuilder:validation:Pattern=`^?$` | Name | Type | Go type | Default | Description | Example | |||| - |-|| | Kind | string| string | | Valid values include: "Service" "HTTPRoute" Invalid values include: "invalid/kind" - "/" is an invalid character +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=63 +kubebuilder:validation:Pattern=`^?$` | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Address | string| `string` | | | | | | Destination | string| `string` | | | | | | Match | string| `string` | | | | | | Port | double (formatted number)| `float64` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AttachedRoutes | int32 (formatted integer)| `int32` | | | AttachedRoutes represents the total number of Routes that have been successfully attached to this Listener. | | | Conditions | | `[]*Condition` | | | Conditions describe the current condition of this listener. +listType=map +listMapKey=type +kubebuilder:validation:MaxItems=8 | | | SupportedKinds | | `[]*RouteGroupKind` | | | SupportedKinds is the list indicating the Kinds supported by this listener. This MUST represent the kinds an implementation supports for that Listener configuration. If kinds are specified in Spec that are not supported, they MUST NOT appear in this list and an implementation MUST set the "ResolvedRefs" condition to "False" with the "InvalidRouteKinds" reason. If both valid and invalid Route kinds are specified, the implementation MUST reference the valid Route kinds that have been specified. +kubebuilder:validation:MaxItems=8 | | | name | | `SectionName` | | | | | References to objects with invalid Group and Kind are not valid, and must be rejected by the implementation, with appropriate Conditions set on the containing object. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | group | | `Group` | | | | | | kind | | `Kind` | | | | | | name | | `ObjectName` | | | | | Log is a log emitted in a span Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Fields | | `[]*KeyValue` | | | | | | Timestamp | uint64 (formatted integer)| `uint64` | | | | | MTLSStatus describes the current mTLS status of a mesh entity Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AutoMTLSEnabled | boolean| `bool` | | | | | | MinTLS | string| `string` | | | | | | Status | string| `string` | | | mTLS status: MTLSENABLED, MTLSPARTIALLYENABLED, MTLSNOTENABLED | `MTLSENABLED` | ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. | | | FieldsType | string| `string` | | | FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" | | | Manager | string| `string` | | | Manager is an identifier of the workflow managing these

| | | Subresource | string| `string` | | | Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. | | | Time | string| `string` | | | Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. +optional | | | fieldsV1 | | `FieldsV1` | | | | | | operation | | `ManagedFieldsOperationType` | | | | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | ManagedFieldsOperationType | string| string | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Datapoints | | `[]*Datapoint` | | | | | | Labels | map of string| `map[string]string` | | | | | | Name | string| `string` | | | | | | Stat | string| `string` | | | | | MetricsStats contains opinionated statistics on metrics on a single

Currently limited to response times (avg/percentiles over interval) Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ResponseTimes | | `[]*Stat` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Queries | | `[]*MetricsStatsQuery` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Avg | boolean| `bool` | | | | | | Direction | string| `string` | | | | | | PeerTarget | | `Target` | | | | | | Quantiles | []string| `[]string` | | | | | | RawInterval | string| `string` | | | | | | RawQueryTime | int64 (formatted integer)| `int64` | | | | | | Target | | `Target` | | | | | MonitoringDashboard is the model representing custom monitoring dashboard, transformed from MonitoringDashboard config resource Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Aggregations | | `[]*Aggregation` | | | | | | Charts | | `[]*Chart` | | | | | | ExternalLinks | | `[]*ExternalLink` | | | | | | Name | string| `string` | | | | | | Rows | int64 (formatted integer)| `int64` | | | | | | Title | string| `string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | App | string| `string` | | | | | | Namespace | string| `string` | | | | | | Service | string| `string` | | | | | | Version | string| `string` | | | | | | Workload | string| `string` | | | | | A Namespace provide a scope for names This type is used to describe a set of objects. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Annotations | map of string| `map[string]string` | | | Specific annotations used in Kiali | | | Labels | map of string| `map[string]string` | | | Labels for Namespace | | | Name | string| `string` | | | The id of the namespace. | `istio-system` | This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L187 This is used for Namespace name validation here: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/api/validation/generic.go#L63 Valid values include: "example" Invalid values include: "example.com" - "." is an invalid character +kubebuilder:validation:Pattern=`^?$` +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=63 | Name | Type | Go type | Default | Description | Example | |||| - |-|| | Namespace | string| string | | This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L187 This is used for Namespace name validation here: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/api/validation/generic.go#L63 Valid values include: "example" Invalid values include: "example.com" -

is an invalid character +kubebuilder:validation:Pattern=`^?$` +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=63 | | NamespaceAppHealth is an alias of map of app name x health Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Aggregate | string| `string` | | | | | | App | string| `string` | | | | | | Cluster | string| `string` | | | | | | DestServices | | `[]*ServiceName` | | | | | | HasCB | boolean| `bool` | | | | | | HasFaultInjection | boolean| `bool` | | | | | | HasMirroring | boolean| `bool` | | | | | | HasMissingSC | boolean| `bool` | | | | | | HasRequestRouting | boolean| `bool` | | | | | | HasRequestTimeout | boolean| `bool` | | | | | | HasTCPTrafficShifting | boolean| `bool` | | | | | | HasTrafficShifting | boolean| `bool` | | | | | | HasWorkloadEntry | | `[]*WEInfo` | | | | | | HealthData | | `interface{}` | | | | | | ID | string| `string` | | | Cytoscape Fields | | | IsBox | string| `string` | | | | | | IsDead | boolean| `bool` | | | | | | IsIdle | boolean| `bool` | | | | | | IsInaccessible | boolean| `bool` | | | | | | IsOutside | boolean| `bool` | | | | | | IsRoot | boolean| `bool` | | | | | | Labels | map of string| `map[string]string` | | | | | | Namespace | string| `string` | | | | | | NodeType | string| `string` | | | App Fields (not required by Cytoscape) | | | Parent | string| `string` | | | | | | Service | string| `string` | | | | | | Traffic | | `[]*ProtocolTraffic` | | | | | | Version | string| `string` | | | | | | Workload | string| `string` | | | | | | hasHealthConfig | | `HealthConfig` | | | | | | hasVS | | `VSInfo` | | | | | | isGateway | | `GWInfo` | | | | | | isServiceEntry | | `SEInfo` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | data | | `NodeData` | | | | | +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 | Name | Type | Go type | Default | Description | Example | |||| - |-|| | ObjectName | string| string | | +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 | | OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. +structType=atomic Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | API version of the referent. | | | BlockOwnerDeletion | boolean| `bool` | | | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional | | | Controller | boolean| `bool` | | | If true, this reference points to the managing controller. +optional | | | Kind | string| `string` | | | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | Name | string| `string` | | | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | | | uid | | `UID` | | | | | The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | group | | `Group` | | | | | | kind | | `Kind` | | | | | | name | | `ObjectName` | | | | | | namespace | | `Namespace` | | | | | | port | | `PortNumber` | | | | | | sectionName | | `SectionName` | | | | | "Exact" "PathPrefix" "RegularExpression" PathPrefix and Exact paths must be syntactically valid: Must begin with the `/` character Must not contain consecutive `/` characters (e.g. `/foo///`, `//`). Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=Exact;PathPrefix;RegularExpression | Name | Type | Go type | Default | Description | Example | |||| - |-|| | PathMatchType | string| string | | "Exact" "PathPrefix" "RegularExpression" PathPrefix and Exact paths must be syntactically valid: Must begin with the `/` character Must not contain consecutive `/` characters (e.g. `/foo///`, `//`). Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=Exact;PathPrefix;RegularExpression | | Examples: Policy to allow mTLS traffic for all workloads under namespace `foo`: ```yaml apiVersion: security.istio.io/v1beta1 kind: PeerAuthentication metadata: name: default namespace: foo spec: mtls: mode: STRICT ``` For mesh level, put the policy in root-namespace according to your Istio installation. Policies to allow both mTLS & plaintext traffic for all workloads under namespace `foo`, but require mTLS for workload `finance`. ```yaml apiVersion: security.istio.io/v1beta1 kind: PeerAuthentication metadata: name: default namespace: foo spec: mtls: mode: PERMISSIVE apiVersion: security.istio.io/v1beta1 kind: PeerAuthentication metadata: name: default namespace: foo spec: selector: matchLabels: app: finance mtls: mode: STRICT ``` Policy to allow mTLS strict for all workloads, but leave port 8080 to plaintext: ```yaml apiVersion:

kind: PeerAuthentication metadata: name: default namespace: foo spec: selector: matchLabels: app: finance mtls: mode: STRICT portLevelMtls: 8080: mode: DISABLE ``` Policy to inherit mTLS mode from namespace (or mesh) settings, and overwrite settings for port 8080 ```yaml apiVersion: security.istio.io/v1beta1 kind: PeerAuthentication metadata: name: default namespace: foo spec: selector: matchLabels: app: finance mtls: mode: UNSET portLevelMtls: 8080: mode: DISABLE ``` <!-- crd generation tags +cue-gen:PeerAuthentication:groupName:security.istio.io +cue-gen:PeerAuthentication:version:v1beta1 +cue-gen:PeerAuthentication:storageVersion +cue-gen:PeerAuthentication:annotations:helm.sh/resource-policy=keep +cue-gen:PeerAuthentication:labels:app=istio-pilot,chart=istio,istio=security,heritage=Tiller,release=istio +cue-gen:PeerAuthentication:subresource:status +cue-gen:PeerAuthentication:scope:Namespaced +cue-gen:PeerAuthentication:resource:categories=istio-io,security-istio-io,shortNames=pa +cue-gen:PeerAuthentication:preserveUnknownFields:false +cue-gen:PeerAuthentication:printerColumn:name=Mode,type=string,JSONPath=.spec.mtls.mode,description="Defines the mTLS mode used for peer authentication." +cue-gen:PeerAuthentication:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=security.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info:

+optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `PeerAuthentication` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | Pod holds a subset of v1.Pod data that is meaningful in Kiali Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Annotations | map of string| `map[string]string` | | | | | | AppLabel | boolean| `bool` | | | | | | Containers | | `[]*ContainerInfo` | | | | | | CreatedAt | string| `string` | | | | | | CreatedBy | | `[]*Reference` | | | | | | IstioContainers | | `[]*ContainerInfo` | | | | | | IstioInitContainers | | `[]*ContainerInfo` | | | | | | Labels | map of string| `map[string]string` | | | | | | Name | string| `string` | | | | | | ServiceAccountName | string| `string` | | | | | | Status | string| `string` | | | | | | StatusMessage | string| `string` | | | | | | StatusReason | string| `string` | | | | | | VersionLabel | boolean| `bool` | | | | | | proxyStatus | | `ProxyStatus` | | | | | Pods alias for list of Pod structs Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AppProtocol | string| `string` | | | | | | IstioProtocol | string| `string` | | | | | | Name | string| `string` | | | | | | Port | int32 (formatted integer)| `int32` | | | | | | Protocol | string| `string` | | | | | | TLSMode | string| `string` | | | TLSMode endpoint is injected with istio sidecar and ready to configure Istio mTLS DisabledTLSModeLabel implies that this endpoint should receive traffic as is (mostly plaintext) DisabledTLSModeLabel = "disabled" IstioMutualTLSModeLabel implies that the endpoint is ready to receive Istio mTLS

IstioMutualTLSModeLabel = "istio" | | +kubebuilder:validation:Minimum=1 +kubebuilder:validation:Maximum=65535 | Name | Type | Go type | Default | Description | Example | |||| - |-|| | PortNumber | int32 (formatted integer)| int32 | | +kubebuilder:validation:Minimum=1 +kubebuilder:validation:Maximum=65535 | | Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^?(\.?)*$` | Name | Type | Go type | Default | Description | Example | |||| - |-|| | PreciseHostname | string| string | | Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 +kubebuilder:validation:Pattern=`^?(\.?)*$` | | Process is the process emitting a set of spans Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ServiceName | string| `string` | | | | | | Tags | | `[]*KeyValue` | | | | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | ProcessID | string| string | | | | ProtocolTraffic supplies all of the traffic information for a single protocol Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Protocol | string| `string` | | | | | | Rates | map of string| `map[string]string` | | | | | | responses | | `Responses` | | | | | In healthy scenarios all variables should be true. If at least one variable is false, then the proxy isn't fully sync'ed with pilot. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | CDS | string| `string` | | | | | | EDS | string| `string` | | | | | | LDS | string| `string` | | | | | | RDS | string| `string` | | | | | "Exact" "RegularExpression" Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=Exact;RegularExpression | Name | Type | Go type | Default | Description | Example | |||| - |-|| | QueryParamMatchType | string| string | | "Exact" "RegularExpression" Note that values may be added to this enum, implementations must ensure that unknown values will not cause a crash. Unknown values here must result in the implementation setting the Attached Condition for the Route to `status: False`, with a Reason of `UnsupportedValue`. +kubebuilder:validation:Enum=Exact;RegularExpression | | Reference is a reference from one span to another Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | refType | | `ReferenceType` | | | | | | spanID | | `SpanID` | | | | | | traceID | | `TraceID` | | | | | ReferenceType is the reference type of one span to another | Name | Type | Go type | Default | Description | Example | |||| - |-|| | ReferenceType | string| string | | ReferenceType is the reference type of one span to another | | Require JWT for all request for workloads that have label `app:httpbin` ```yaml apiVersion:

kind: RequestAuthentication metadata: name: httpbin namespace: foo spec: selector: matchLabels: app: httpbin jwtRules: issuer: "issuer-foo" jwksUri: https://example.com/.well-known/jwks.json apiVersion: security.istio.io/v1beta1 kind: AuthorizationPolicy metadata: name: httpbin namespace: foo spec: selector: matchLabels: app: httpbin rules: from: source: requestPrincipals: ["*"] ``` A policy in the root namespace ("istio-system" by default) applies to workloads in all namespaces in a mesh. The following policy makes all workloads only accept requests that contain a valid JWT token. ```yaml apiVersion: security.istio.io/v1beta1 kind: RequestAuthentication metadata: name: req-authn-for-all namespace: istio-system spec: jwtRules: issuer: "issuer-foo" jwksUri: https://example.com/.well-known/jwks.json apiVersion: security.istio.io/v1beta1 kind: AuthorizationPolicy metadata: name: require-jwt-for-all namespace: istio-system spec: rules: from: source: requestPrincipals: ["*"] ``` The next example shows how to set a different JWT requirement for a different `host`. The `RequestAuthentication` declares it can accept JWTs issued by either `issuer-foo` or `issuer-bar` (the public key set is implicitly set from the OpenID Connect spec). ```yaml apiVersion: security.istio.io/v1beta1 kind: RequestAuthentication metadata: name: httpbin namespace: foo spec: selector: matchLabels: app: httpbin jwtRules: issuer: "issuer-foo" issuer: "issuer-bar" apiVersion: security.istio.io/v1beta1 kind: AuthorizationPolicy metadata: name: httpbin namespace: foo spec: selector: matchLabels: app: httpbin rules: from: source: requestPrincipals: ["issuer-foo/*"] to: operation: hosts: ["example.com"] from: source: requestPrincipals: ["issuer-bar/*"] to: operation: hosts: ["another-host.com"] ``` You can fine tune the authorization policy to set different requirement per path. For example, to require JWT on all paths, except /healthz, the same `RequestAuthentication` can be used, but the authorization policy could be: ```yaml apiVersion: security.istio.io/v1beta1 kind: AuthorizationPolicy metadata: name: httpbin namespace: foo spec: selector: matchLabels: app: httpbin rules: from: source: requestPrincipals: ["*"] to: operation: paths: ["/healthz"] ``` is now supported. A prefix '@' is used to denote a match against internal metadata instead of the headers in the request. Currently this feature is only supported for the following metadata: `request.auth.claims.{claim-name}[.{sub-claim}]*` which are extracted from validated JWT tokens. The claim name currently does not support the `.` character. Examples: `request.auth.claims.sub` and `request.auth.claims.name.givenName`. The use of matches against JWT claim metadata is only supported in Gateways. The following example shows: RequestAuthentication to decode and validate a JWT. This also makes the `@request.auth.claims` available for use in the VirtualService. AuthorizationPolicy to check for valid principals in the request. This makes the JWT required for the request. VirtualService to route the request based on the "sub" claim. ```yaml apiVersion: security.istio.io/v1beta1 kind: RequestAuthentication metadata: name: jwt-on-ingress namespace: istio-system spec: selector: matchLabels: app: istio-ingressgateway jwtRules: issuer: "example.com" jwksUri: https://example.com/.well-known/jwks.json apiVersion: security.istio.io/v1beta1 kind: AuthorizationPolicy metadata: name: require-jwt namespace: istio-system spec: selector: matchLabels: app: istio-ingressgateway rules: from: source: requestPrincipals: ["*"] apiVersion: networking.istio.io/v1alpha3 kind: VirtualService metadata: name: route-jwt spec: hosts: foo.prod.svc.cluster.local gateways: istio-ingressgateway http: name: "v2" match: headers: "@request.auth.claims.sub": exact: "dev" route: destination: host: foo.prod.svc.cluster.local subset: v2 name: "default" route: destination: host: foo.prod.svc.cluster.local subset: v1 ``` <!-- crd generation tags +cue-gen:RequestAuthentication:groupName:security.istio.io +cue-gen:RequestAuthentication:version:v1beta1 +cue-gen:RequestAuthentication:storageVersion +cue-gen:RequestAuthentication:annotations:helm.sh/resource-policy=keep +cue-gen:RequestAuthentication:labels:app=istio-pilot,chart=istio,istio=security,heritage=Tiller,release=istio +cue-gen:RequestAuthentication:subresource:status +cue-gen:RequestAuthentication:scope:Namespaced +cue-gen:RequestAuthentication:resource:categories=istio-io,security-istio-io,shortNames=ra +cue-gen:RequestAuthentication:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=security.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was

It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental

+optional | | | spec | | `RequestAuthentication` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | RequestHealth holds several stats about recent request errors Inbound//Outbound are the rates of requests by protocol and status_code. Example: Inbound: { "http": {"200": 1.5, "400": 2.3}, "grpc": {"1": 1.2} } Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | HealthAnnotations | map of string| `map[string]string` | | | | | | Inbound | map of | `map[string]map[string]float64` | | | | | | Outbound | map of | `map[string]map[string]float64` | | | | | ResourcePermissions holds permission flags for an object type True means allowed. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Create | boolean| `bool` | | | | | | Delete | boolean| `bool` | | | | | | Update | boolean| `bool` | | | | | ResourcesPermissions holds a map of permission flags per resource Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | flags | | `ResponseFlags` | | | | | | hosts | | `ResponseHosts` | | | | | "200" : { "www.google.com" : "80.0", "www.yahoo.com" : "20.0" }, ... Responses maps responseCodes to detailed information for that code Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Match | string| `string` | | | | | | Name | string| `string` | | | | | | VirtualService | string| `string` | | | | | | domains | | `Host` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | group | | `Group` | | | | | | kind | | `Kind` | | | | | RouteParentStatus describes the status of a route with respect to an associated Parent. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Conditions | | `[]*Condition` | | | Conditions describes the status of the route with respect to the Gateway. Note that the route's availability is also subject to the Gateway's own status conditions and listener status. If the Route's ParentRef specifies an existing Gateway that supports Routes of this kind AND that Gateway's controller has sufficient access, then that Gateway's controller MUST set the "Accepted" condition on the Route, to indicate whether the route has been accepted or rejected by the Gateway, and why. A Route MUST be considered "Accepted" if at least one of the Route's rules is implemented by the Gateway. There are a number of cases where the "Accepted" condition may not be set due to lack of controller visibility, that includes when: The Route refers to a non-existent parent. The Route is of a type that the controller does not support. The Route is in a namespace the controller does not have access

+listType=map +listMapKey=type +kubebuilder:validation:MinItems=1 +kubebuilder:validation:MaxItems=8 | | | controllerName | | `GatewayController` | | | | | | parentRef | | `ParentReference` | | | | | Runtime holds the runtime title and associated dashboard template(s) Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | DashboardRefs | | `[]*DashboardRef` | | | | | | Name | string| `string` | | | | | SEInfo provides static information about the service entry Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Hosts | []string| `[]string` | | | | | | Location | string| `string` | | | | | | Namespace | string| `string` | | | | | This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 Valid values include: "example.com" "foo.example.com" Invalid values include: "example.com/bar" - "/" is an invalid character +kubebuilder:validation:Pattern=`^?(\.?)*$` +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 | Name | Type | Go type | Default | Description | Example | |||| - |-|| | SectionName | string| string | | This validation is based off of the corresponding Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 Valid values include: "example.com" "foo.example.com" Invalid values include: "example.com/bar" - "/" is an invalid character +kubebuilder:validation:Pattern=`^?(\.?)*$` +kubebuilder:validation:MinLength=1 +kubebuilder:validation:MaxLength=253 | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AdditionalDetails | | `[]*AdditionalItem` | | | | | | CreatedAt | string| `string` | | | | | | ExternalName | string| `string` | | | | | | HealthAnnotations | map of string| `map[string]string` | | | | | | Ip | string| `string` | | | | | | Labels | map of string| `map[string]string` | | | | | | Name | string| `string` | | | | | | ResourceVersion | string| `string` | | | | | | Selectors | map of string| `map[string]string` | | | | | | Type | string| `string` | | | | | | namespace | | `Namespace` | | | | | | ports | | `Ports` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | DestinationRules | | `[]*DestinationRule` | | | | | | IstioSidecar | boolean| `bool` | | | | | | K8sHTTPRoutes | | `[]*HTTPRoute` | | | | | | K8sReferenceGrants | | `[]*ReferenceGrant` | | | | | | ServiceEntries | | `[]*ServiceEntry` | | | | | | SubServices | | `[]*ServiceOverview` | | | Services with same app labels (different versions or a single version) | | | VirtualServices | | `[]*VirtualService` | | | | | | endpoints | | `Endpoints` | | | | | | health | | `ServiceHealth` | | | | | | istioPermissions | | `ResourcePermissions` | | | | | | namespaceMTLS | | `MTLSStatus` | | | | | | service | | `Service` | | | | | | validations | | `IstioValidations` | | | | | | workloads | | `WorkloadOverviews` | | | | | <!-- crd generation tags +cue-gen:ServiceEntry:groupName:networking.istio.io +cue-gen:ServiceEntry:version:v1beta1 +cue-gen:ServiceEntry:annotations:helm.sh/resource-policy=keep +cue-gen:ServiceEntry:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:ServiceEntry:subresource:status +cue-gen:ServiceEntry:scope:Namespaced +cue-gen:ServiceEntry:resource:categories=istio-io,networking-istio-io,shortNames=se,plural=serviceentries +cue-gen:ServiceEntry:printerColumn:name=Hosts,type=string,JSONPath=.spec.hosts,description="The hosts associated with the ServiceEntry" +cue-gen:ServiceEntry:printerColumn:name=Location,type=string,JSONPath=.spec.location,description="Whether the service is external to the mesh or part of the mesh (MESHEXTERNAL or MESHINTERNAL)" +cue-gen:ServiceEntry:printerColumn:name=Resolution,type=string,JSONPath=.spec.resolution,description="Service discovery mode for the hosts (NONE, STATIC, or DNS)" +cue-gen:ServiceEntry:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" +cue-gen:ServiceEntry:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=networking.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true <!-- istio code generation tags +istio.io/sync-from:networking/v1alpha3/service_entry.proto Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an

Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the

+optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `ServiceEntry` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | ServiceHealth contains aggregated health from various sources, for a given service Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | requests | | `RequestHealth` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Services | | `[]*ServiceOverview` | | | | | | namespace | | `Namespace` | | | | | | validations | | `IstioValidations` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Cluster | string| `string` | | | | | | Name | string| `string` | | | | | | Namespace | string| `string` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AppLabel | boolean| `bool` | | | Has label app | `true` | | HealthAnnotations | map of string| `map[string]string` | | | Annotations of the service | | | IstioReferences | | `[]*IstioValidationKey` | | | Istio References | | | IstioSidecar | boolean| `bool` | | | Define if Pods related to this Service has an IstioSidecar deployed | `true` | | KialiWizard | string| `string` | | | Kiali Wizard scenario, if any | | | Labels | map of string| `map[string]string` | | | Labels for Service | | | Name | string| `string` | | | Name of the Service | `reviews-v1` | | Namespace | string| `string` | | | Namespace of the Service | | | Ports | map of int64 (formatted integer)| `map[string]int64` | | | Names and Ports of Service | | | Selector | map of string| `map[string]string` | | | Selector for Service | | | ServiceRegistry | string| `string` | | | ServiceRegistry values: Kubernetes: is a service registry backed by k8s API server External: is a service registry for externally provided ServiceEntries Federation: special case when registry is provided from a federated environment | | | additionalDetailSample | | `AdditionalItem` | | | | | | health | | `ServiceHealth` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | | | | Namespace | string| `string` | | | | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | SeverityLevel | string| string | | | | <!-- crd generation tags +cue-gen:Sidecar:groupName:networking.istio.io +cue-gen:Sidecar:version:v1beta1 +cue-gen:Sidecar:annotations:helm.sh/resource-policy=keep +cue-gen:Sidecar:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:Sidecar:subresource:status +cue-gen:Sidecar:scope:Namespaced +cue-gen:Sidecar:resource:categories=istio-io,networking-istio-io +cue-gen:Sidecar:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=networking.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true <!-- istio code generation tags

Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the

+optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `Sidecar` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | Span is a span denoting a piece of work in some infrastructure When converting to UI model, ParentSpanID and Process should be dereferenced into References and ProcessID, respectively. When converting to ES model, ProcessID and Warnings should be omitted. Even if included, ES with dynamic settings off will automatically ignore unneeded fields. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Duration | uint64 (formatted integer)| `uint64` | | | | | | Flags | uint32 (formatted integer)| `uint32` | | | | | | Logs | | `[]*Log` | | | | | | OperationName | string| `string` | | | | | | References | | `[]*Reference` | | | | | | StartTime | uint64 (formatted integer)| `uint64` | | | | | | Tags | | `[]*KeyValue` | | | | | | Warnings | []string| `[]string` | | | | | | parentSpanID | | `SpanID` | | | | | | process | | `Process` | | | | | | processID | | `ProcessID` | | | | | | spanID | | `SpanID` | | | | | | traceID | | `TraceID` | | | | | SpanID is the id of a span | Name | Type | Go type | Default | Description | Example | |||| - |-|| | SpanID | string| string | | SpanID is the id of a span | | Stat holds arbitrary stat name & value Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | | | | Value | double (formatted number)| `float64` | | | | | StatusInfo statusInfo This is used for returning a response of Kiali Status Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ExternalServices | | `[]*ExternalServiceInfo` | | | An array of external services installed | | | Status | map of string| `map[string]string` | | | The state of Kiali A hash of key,values with versions of Kiali and state | | | WarningMessages | []string| `[]string` | | | An array of warningMessages. CAUTION: Please read the doc comments the in AddWarningMessages func. | | | istioEnvironment | | `IstioEnvironment` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Kind | string| `string` | | | | | | Name | string| `string` | | | | | | Namespace | string| `string` | | | | | <!-- go code generation tags +kubetype-gen

+genclient +k8s:deepcopy-gen=true Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the

+optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `Telemetry` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.setseconds(tv.tvsec); timestamp.setnanos(tv.tvusec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() In JSON format, the Timestamp type is encoded as a string in the format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard method. In Python, a standard `datetime.datetime` object can be converted to this format using with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Nanos | int32 (formatted integer)| `int32` | | | Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. | | | Seconds | int64 (formatted integer)| `int64` | | | Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z

| | Trace is a list of spans Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Processes | map of | `map[string]Process` | | | | | | Spans | | `[]*Span` | | | | | | Warnings | []string| `[]string` | | | | | | traceID | | `TraceID` | | | | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | TraceID | string| string | | | | UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. | Name | Type | Go type | Default | Description | Example | |||| - |-|| | UID | string| string | | UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated. | | UserSessionData userSessionData This is used for returning the token Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | ExpiresOn | date-time (formatted string)| `strfmt.DateTime` | | | The expired time for the token A string with the Datetime when the token will be expired | `Thu, 07 Mar 2019 17:50:26 +0000` | | Username | string| `string` | | | The username for the token A string with the user's username | `admin` | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Hostnames | []string| `[]string` | | | Hostnames is the list of hostnames configured in the associated VSs | | | Name | Type | Go type | Default | Description | Example | |||| - |-|| | ValueType | string| string | | | | <!-- crd generation tags +cue-gen:VirtualService:groupName:networking.istio.io +cue-gen:VirtualService:version:v1beta1 +cue-gen:VirtualService:annotations:helm.sh/resource-policy=keep +cue-gen:VirtualService:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:VirtualService:subresource:status +cue-gen:VirtualService:scope:Namespaced +cue-gen:VirtualService:resource:categories=istio-io,networking-istio-io,shortNames=vs +cue-gen:VirtualService:printerColumn:name=Gateways,type=string,JSONPath=.spec.gateways,description="The names of gateways and sidecars that should apply these routes" +cue-gen:VirtualService:printerColumn:name=Hosts,type=string,JSONPath=.spec.hosts,description="The destination hosts to which traffic is being sent" +cue-gen:VirtualService:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" +cue-gen:VirtualService:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=networking.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true <!-- istio code generation tags +istio.io/sync-from:networking/v1alpha3/virtual_service.proto Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object

Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `VirtualService` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | WEInfo provides static information about a workload entry associated with a workload node. Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | Name of the workload entry object | | <!-- crd generation tags +cue-gen:WasmPlugin:groupName:extensions.istio.io +cue-gen:WasmPlugin:version:v1alpha1 +cue-gen:WasmPlugin:storageVersion

+cue-gen:WasmPlugin:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:WasmPlugin:subresource:status +cue-gen:WasmPlugin:scope:Namespaced +cue-gen:WasmPlugin:resource:categories=istio-io,extensions-istio-io +cue-gen:WasmPlugin:preserveUnknownFields:pluginConfig +cue-gen:WasmPlugin:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=extensions.istio.io/v1alpha1 +genclient +k8s:deepcopy-gen=true Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck

finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing

+optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `WasmPlugin` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | Workload has the details of a workload Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AdditionalDetails | | `[]*AdditionalItem` | | | Additional details to display, such as configured annotations | | | AppLabel | boolean| `bool` | | | Define if Pods related to this Workload has the label App | `true` | | AvailableReplicas | int32 (formatted integer)| `int32` | | | Number of available replicas | `1` | | CreatedAt | string| `string` | | | Creation timestamp (in RFC3339 format) | `2018-07-31T12:24:17Z` | | CurrentReplicas | int32 (formatted integer)| `int32` | | | Number of current replicas pods that matches controller selector labels | `2` | | DashboardAnnotations | map of string| `map[string]string` | | | Dashboard annotations | | | DesiredReplicas | int32 (formatted integer)| `int32` | | | Number of desired replicas defined by the user in the controller Spec | `2` | | HealthAnnotations | map of string| `map[string]string` | | | HealthAnnotations | | | IstioInjectionAnnotation | boolean| `bool` | | | Define if Workload has an explicit Istio policy annotation Istio supports this as a label as well - this will be defined if the label is set, too. If both annotation and label are set, if any is false, injection is

It's mapped as a pointer to show three values nil, true, false | | | IstioReferences | | `[]*IstioValidationKey` | | | Istio References | | | IstioSidecar | boolean| `bool` | | | Define if Pods related to this Workload has an IstioSidecar deployed | `true` | | Labels | map of string| `map[string]string` | | | Workload labels | | | Name | string| `string` | | | Name of the workload | `reviews-v1` | | PodCount | int64 (formatted integer)| `int64` | | | Number of current workload pods | `1` | | ResourceVersion | string| `string` | | | Kubernetes ResourceVersion | `192892127` | | Runtimes | | `[]*Runtime` | | | Runtimes and associated dashboards | | | ServiceAccountNames | []string| `[]string` | | | Names of the workload service accounts | | | Services | | `[]*ServiceOverview` | | | Services that match workload selector | | | Type | string| `string` | | | Type of the workload | `deployment` | | VersionLabel | boolean| `bool` | | | Define if Pods related to this Workload has the label Version | `true` | | additionalDetailSample | | `AdditionalItem` | | | | | | health | | `WorkloadHealth` | | | | | | pods | | `Pods` | | | | | | validations | | `IstioValidations` | | | | | <!-- crd generation tags +cue-gen:WorkloadEntry:groupName:networking.istio.io +cue-gen:WorkloadEntry:version:v1beta1 +cue-gen:WorkloadEntry:annotations:helm.sh/resource-policy=keep +cue-gen:WorkloadEntry:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:WorkloadEntry:subresource:status +cue-gen:WorkloadEntry:scope:Namespaced +cue-gen:WorkloadEntry:resource:categories=istio-io,networking-istio-io,shortNames=we,plural=workloadentries +cue-gen:WorkloadEntry:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" +cue-gen:WorkloadEntry:printerColumn:name=Address,type=string,JSONPath=.spec.address,description="Address associated with the network endpoint." +cue-gen:WorkloadEntry:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=networking.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true <!-- istio code generation tags +istio.io/sync-from:networking/v1alpha3/workload_entry.proto Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More

https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info:

+optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. +optional | | | spec | | `WorkloadEntry` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | <!-- crd generation tags +cue-gen:WorkloadGroup:groupName:networking.istio.io +cue-gen:WorkloadGroup:version:v1beta1 +cue-gen:WorkloadGroup:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio +cue-gen:WorkloadGroup:subresource:status +cue-gen:WorkloadGroup:scope:Namespaced +cue-gen:WorkloadGroup:resource:categories=istio-io,networking-istio-io,shortNames=wg,plural=workloadgroups +cue-gen:WorkloadGroup:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" +cue-gen:WorkloadGroup:preserveUnknownFields:false <!-- go code generation tags +kubetype-gen +kubetype-gen:groupVersion=networking.istio.io/v1beta1 +genclient +k8s:deepcopy-gen=true <!-- istio code generation tags +istio.io/sync-from:networking/v1alpha3/workload_group.proto Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional | | | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional | | | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional | | | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be

This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional | | | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge | | | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional | | | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional | | | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional | | | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and

More info: http://kubernetes.io/docs/user-guide/labels +optional | | | ManagedFields | | `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional | | | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional | | | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional | | | OwnerReferences | | `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge | | | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional | | | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional | | | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental

+optional | | | spec | | `WorkloadGroup` | | | | | | status | | `IstioStatus` | | | | | | uid | | `UID` | | | | | WorkloadHealth contains aggregated health from various sources, for a given workload Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | requests | | `RequestHealth` | | | | | | workloadStatus | | `WorkloadStatus` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | IstioSidecar | boolean| `bool` | | | Define if all Pods related to the Workload has an IstioSidecar deployed | `true` | | Labels | map of string| `map[string]string` | | | Labels for Workload | | | ServiceAccountNames | []string| `[]string` | | | List of service accounts involved in this application | | | WorkloadName | string| `string` | | | Name of a workload member of an application | `reviews-v1` | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Workloads | | `[]*WorkloadListItem` | | | Workloads for a given namespace | | | namespace | | `Namespace` | | | | | | validations | | `IstioValidations` | | | | | WorkloadListItem has the necessary information to display the console workload list Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | AppLabel | boolean| `bool` | | | Define if Pods related to this Workload has the label App | `true` | | CreatedAt | string| `string` | | | Creation timestamp (in RFC3339 format) | `2018-07-31T12:24:17Z` | | DashboardAnnotations | map of string| `map[string]string` | | | Dashboard annotations | | | HealthAnnotations | map of string| `map[string]string` | | | HealthAnnotations | | | IstioInjectionAnnotation | boolean| `bool` | | | Define if Workload has an explicit Istio policy annotation Istio supports this as a label as well - this will be defined if the label is set, too. If both annotation and label are set, if any is false, injection is disabled. It's mapped as a pointer to show three values nil, true, false | | | IstioReferences | | `[]*IstioValidationKey` | | | Istio References | | | IstioSidecar | boolean| `bool` | | | Define if Pods related to this Workload has an IstioSidecar deployed | `true` | | Labels | map of string| `map[string]string` | | | Workload labels | | | Name | string| `string` | | | Name of the workload | `reviews-v1` | | PodCount | int64 (formatted integer)| `int64` | | | Number of current workload pods | `1` | | ResourceVersion | string| `string` | | | Kubernetes ResourceVersion | `192892127` | | ServiceAccountNames | []string| `[]string` | | | Names of the workload service accounts | | | Type | string| `string` | | | Type of the workload | `deployment` | | VersionLabel | boolean| `bool` | | | Define if Pods related to this Workload has the label Version | `true` | | additionalDetailSample | | `AdditionalItem` | | | | | | health | | `WorkloadHealth` | | | | | Properties | Name | Type | Go type | Required | Default | Description | Example | ||||:--:| - |-|| | Name | string| `string` | | | | | | Namespace | string| `string` | | | |