github.com/kiali/kiali@v1.84.0/kiali_internal_api.md (about) 1 2 3 4 # Kiali 5 # Kiali Project, The Console for Istio Service Mesh 6 7 NOTE! The Kiali API is not for public use and is not supported for any use outside of the Kiali UI itself. 8 The API can and will change from version to version with no guarantee of backwards compatibility. 9 10 To generate this API document: 11 ``` 12 13 > 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' 14 > swagger generate spec -o ./swagger.json 15 > swagger generate markdown --quiet --spec ./swagger.json --output ./kiali_internal_api.md 16 17 ``` 18 19 20 ## Informations 21 22 ### Version 23 24 _ 25 26 ## Content negotiation 27 28 ### URI Schemes 29 * http 30 * https 31 32 ### Consumes 33 * application/json 34 35 ### Produces 36 * application/html 37 * application/json 38 39 ## All endpoints 40 41 ### aggregates 42 43 | Method | URI | Name | Summary | 44 |---------|---------|--------|---------| 45 | GET | /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/metrics | [aggregate metrics](#aggregate-metrics) | | 46 47 48 49 ### apps 50 51 | Method | URI | Name | Summary | 52 |---------|---------|--------|---------| 53 | GET | /api/namespaces/{namespace}/apps/{app}/dashboard | [app dashboard](#app-dashboard) | | 54 | GET | /api/namespaces/{namespace}/apps/{app} | [app details](#app-details) | | 55 | GET | /api/namespaces/{namespace}/apps | [app list](#app-list) | | 56 | GET | /api/namespaces/{namespace}/apps/{app}/metrics | [app metrics](#app-metrics) | | 57 58 59 60 ### auth 61 62 | Method | URI | Name | Summary | 63 |---------|---------|--------|---------| 64 | GET | /api/authenticate | [authenticate](#authenticate) | | 65 | GET | /api/auth/info | [authentication info](#authentication-info) | | 66 | GET | /api/logout | [logout](#logout) | | 67 | GET | /api/auth/openid_redirect | [openid redirect](#openid-redirect) | | 68 | POST | /api/authenticate | [openshift check token](#openshift-check-token) | | 69 70 71 72 ### certs 73 74 | Method | URI | Name | Summary | 75 |---------|---------|--------|---------| 76 | GET | /api/istio/certs | [istio certs](#istio-certs) | | 77 78 79 80 ### config 81 82 | Method | URI | Name | Summary | 83 |---------|---------|--------|---------| 84 | GET | /api/istio/permissions | [get permissions](#get-permissions) | | 85 | POST | /api/namespaces/{namespace}/istio/{object_type} | [istio config create](#istio-config-create) | | 86 | DELETE | /api/namespaces/{namespace}/istio/{object_type}/{object} | [istio config delete](#istio-config-delete) | | 87 | GET | /api/namespaces/{namespace}/istio/{object_type}/{object} | [istio config details](#istio-config-details) | | 88 | GET | /api/namespaces/{namespace}/istio | [istio config list](#istio-config-list) | | 89 | GET | /api/istio | [istio config list all](#istio-config-list-all) | | 90 | PATCH | /api/namespaces/{namespace}/istio/{object_type}/{object} | [istio config update](#istio-config-update) | Endpoint to update the Istio Config of an Istio object used for templates and adapters using Json Merge Patch strategy. | 91 92 93 94 ### dashboards 95 96 | Method | URI | Name | Summary | 97 |---------|---------|--------|---------| 98 | GET | /api/namespaces/{namespace}/customdashboard/{dashboard} | [custom dashboard](#custom-dashboard) | | 99 100 101 102 ### graphs 103 104 | Method | URI | Name | Summary | 105 |---------|---------|--------|---------| 106 | GET | /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/graph | [graph aggregate](#graph-aggregate) | | 107 | GET | /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/{service}/graph | [graph aggregate by service](#graph-aggregate-by-service) | | 108 | GET | /api/namespaces/{namespace}/applications/{app}/graph | [graph app](#graph-app) | | 109 | GET | /api/namespaces/{namespace}/applications/{app}/versions/{version}/graph | [graph app version](#graph-app-version) | | 110 | GET | /api/namespaces/graph | [graph namespaces](#graph-namespaces) | The backing JSON for a namespaces graph. | 111 | GET | /api/namespaces/{namespace}/services/{service}/graph | [graph service](#graph-service) | The backing JSON for a service node detail graph. | 112 | GET | /api/namespaces/{namespace}/workloads/{workload}/graph | [graph workload](#graph-workload) | The backing JSON for a workload node detail graph. | 113 114 115 116 ### integrations 117 118 | Method | URI | Name | Summary | 119 |---------|---------|--------|---------| 120 | GET | /api/grafana | [grafana info](#grafana-info) | | 121 | GET | /api/jaeger | [jaeger info](#jaeger-info) | | 122 123 124 125 ### kiali 126 127 | Method | URI | Name | Summary | 128 |---------|---------|--------|---------| 129 | GET | /api/config | [get config](#get-config) | | 130 | GET | /api/crippled | [get crippled features](#get-crippled-features) | | 131 | GET | /api/healthz | [healthz](#healthz) | | 132 | GET | /api | [root](#root) | | 133 134 135 136 ### namespaces 137 138 | Method | URI | Name | Summary | 139 |---------|---------|--------|---------| 140 | GET | /api/namespaces/{namespace}/health | [namespace health](#namespace-health) | | 141 | GET | /api/namespaces | [namespace list](#namespace-list) | | 142 | GET | /api/namespaces/{namespace}/metrics | [namespace metrics](#namespace-metrics) | | 143 | PATCH | /api/namespaces/{namespace} | [namespace update](#namespace-update) | Endpoint to update the Namespace configuration using Json Merge Patch strategy. | 144 | GET | /api/namespaces/{namespace}/validations | [namespace validations](#namespace-validations) | | 145 | GET | /api/istio/validations | [namespaces validations](#namespaces-validations) | | 146 147 148 149 ### pods 150 151 | Method | URI | Name | Summary | 152 |---------|---------|--------|---------| 153 | GET | /api/namespaces/{namespace}/pods/{pod} | [pod details](#pod-details) | | 154 | GET | /api/namespaces/{namespace}/pods/{pod}/logs | [pod logs](#pod-logs) | | 155 | GET | /api/namespaces/{namespace}/pods/{pod}/config_dump | [pod proxy dump](#pod-proxy-dump) | | 156 | POST | /api/namespaces/{namespace}/pods/{pod}/logging | [pod proxy logging](#pod-proxy-logging) | | 157 | GET | /api/namespaces/{namespace}/pods/{pod}/config_dump/{resource} | [pod proxy resource](#pod-proxy-resource) | | 158 159 160 161 ### services 162 163 | Method | URI | Name | Summary | 164 |---------|---------|--------|---------| 165 | GET | /api/namespaces/{namespace}/services/{service}/dashboard | [service dashboard](#service-dashboard) | | 166 | GET | /api/namespaces/{namespace}/services/{service} | [service details](#service-details) | | 167 | GET | /api/namespaces/{namespace}/services | [service list](#service-list) | | 168 | GET | /api/namespaces/{namespace}/services/{service}/metrics | [service metrics](#service-metrics) | | 169 | PATCH | /api/namespaces/{namespace}/services/{service} | [service update](#service-update) | Endpoint to update the Service configuration using Json Merge Patch strategy. | 170 171 172 173 ### stats 174 175 | Method | URI | Name | Summary | 176 |---------|---------|--------|---------| 177 | POST | /api/stats/metrics | [metrics stats](#metrics-stats) | | 178 179 180 181 ### status 182 183 | Method | URI | Name | Summary | 184 |---------|---------|--------|---------| 185 | GET | /api/status | [get status](#get-status) | | 186 | GET | /api/istio/status | [istio status](#istio-status) | | 187 188 189 190 ### tlsops 191 192 | Method | URI | Name | Summary | 193 |---------|---------|--------|---------| 194 | GET | /api/mesh/tls | [mesh Tls](#mesh-tls) | | 195 | GET | /api/namespaces/{namespace}/tls | [namespace Tls](#namespace-tls) | | 196 197 198 199 ### traces 200 201 | Method | URI | Name | Summary | 202 |---------|---------|--------|---------| 203 | GET | /api/namespaces/{namespace}/apps/{app}/spans | [app spans](#app-spans) | | 204 | GET | /api/namespaces/{namespace}/apps/{app}/traces | [app traces](#app-traces) | | 205 | GET | /api/namespaces/{namespace}/apps/{app}/errortraces | [error traces](#error-traces) | | 206 | GET | /api/namespaces/{namespace}/services/{service}/spans | [service spans](#service-spans) | | 207 | GET | /api/namespaces/{namespace}/services/{service}/traces | [service traces](#service-traces) | | 208 | GET | /api/traces/{traceID} | [trace details](#trace-details) | | 209 | GET | /api/namespaces/{namespace}/workloads/{workload}/spans | [workload spans](#workload-spans) | | 210 | GET | /api/namespaces/{namespace}/workloads/{workload}/traces | [workload traces](#workload-traces) | | 211 212 213 214 ### workloads 215 216 | Method | URI | Name | Summary | 217 |---------|---------|--------|---------| 218 | GET | /api/namespaces/{namespace}/workloads/{workload}/dashboard | [workload dashboard](#workload-dashboard) | | 219 | GET | /api/namespaces/{namespace}/workloads/{workload} | [workload details](#workload-details) | | 220 | GET | /api/namespaces/{namespace}/workloads | [workload list](#workload-list) | | 221 | GET | /api/namespaces/{namespace}/workloads/{workload}/metrics | [workload metrics](#workload-metrics) | | 222 | PATCH | /api/namespaces/{namespace}/workloads/{workload} | [workload update](#workload-update) | Endpoint to update the Workload configuration using Json Merge Patch strategy. | 223 224 225 226 ## Paths 227 228 ### <span id="aggregate-metrics"></span> aggregate metrics (*aggregateMetrics*) 229 230 ``` 231 GET /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/metrics 232 ``` 233 234 Endpoint to fetch metrics to be displayed, related to a single aggregate 235 236 #### URI Schemes 237 * http 238 * https 239 240 #### Produces 241 * application/json 242 243 #### Parameters 244 245 | Name | Source | Type | Go type | Separator | Required | Default | Description | 246 |------|--------|------|---------|-----------| :------: |---------|-------------| 247 | aggregate | `path` | string | `string` | | ✓ | | The aggregate name (label). | 248 | aggregateValue | `path` | string | `string` | | ✓ | | The aggregate value (label value). | 249 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 250 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 251 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 252 | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | 253 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 254 | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | 255 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 256 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 257 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 258 | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | 259 | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | 260 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 261 | version | `query` | string | `string` | | | | Filters metrics by the specified version. | 262 263 #### All responses 264 | Code | Status | Description | Has headers | Schema | 265 |------|--------|-------------|:-----------:|--------| 266 | [200](#aggregate-metrics-200) | OK | Metrics response model | | [schema](#aggregate-metrics-200-schema) | 267 | [400](#aggregate-metrics-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#aggregate-metrics-400-schema) | 268 | [503](#aggregate-metrics-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#aggregate-metrics-503-schema) | 269 270 #### Responses 271 272 273 ##### <span id="aggregate-metrics-200"></span> 200 - Metrics response model 274 Status: OK 275 276 ###### <span id="aggregate-metrics-200-schema"></span> Schema 277 278 279 280 map of [Metric](#metric) 281 282 ##### <span id="aggregate-metrics-400"></span> 400 - BadRequestError: the client request is incorrect 283 Status: Bad Request 284 285 ###### <span id="aggregate-metrics-400-schema"></span> Schema 286 287 288 289 [AggregateMetricsBadRequestBody](#aggregate-metrics-bad-request-body) 290 291 ##### <span id="aggregate-metrics-503"></span> 503 - A Internal is the error message that means something has gone wrong 292 Status: Service Unavailable 293 294 ###### <span id="aggregate-metrics-503-schema"></span> Schema 295 296 297 298 [AggregateMetricsServiceUnavailableBody](#aggregate-metrics-service-unavailable-body) 299 300 ###### Inlined models 301 302 **<span id="aggregate-metrics-bad-request-body"></span> AggregateMetricsBadRequestBody** 303 304 305 306 307 308 309 **Properties** 310 311 | Name | Type | Go type | Required | Default | Description | Example | 312 |------|------|---------|:--------:| ------- |-------------|---------| 313 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 314 | Message | string| `string` | | | | | 315 316 317 318 **<span id="aggregate-metrics-service-unavailable-body"></span> AggregateMetricsServiceUnavailableBody** 319 320 321 322 323 324 325 **Properties** 326 327 | Name | Type | Go type | Required | Default | Description | Example | 328 |------|------|---------|:--------:| ------- |-------------|---------| 329 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 330 | Message | string| `string` | | | | | 331 332 333 334 ### <span id="app-dashboard"></span> app dashboard (*appDashboard*) 335 336 ``` 337 GET /api/namespaces/{namespace}/apps/{app}/dashboard 338 ``` 339 340 Endpoint to fetch dashboard to be displayed, related to a single app 341 342 #### URI Schemes 343 * http 344 * https 345 346 #### Produces 347 * application/json 348 349 #### Parameters 350 351 | Name | Source | Type | Go type | Separator | Required | Default | Description | 352 |------|--------|------|---------|-----------| :------: |---------|-------------| 353 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 354 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 355 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 356 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 357 | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | 358 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 359 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 360 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 361 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 362 | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | 363 | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | 364 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 365 366 #### All responses 367 | Code | Status | Description | Has headers | Schema | 368 |------|--------|-------------|:-----------:|--------| 369 | [200](#app-dashboard-200) | OK | Dashboard response model | | [schema](#app-dashboard-200-schema) | 370 | [400](#app-dashboard-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#app-dashboard-400-schema) | 371 | [503](#app-dashboard-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#app-dashboard-503-schema) | 372 373 #### Responses 374 375 376 ##### <span id="app-dashboard-200"></span> 200 - Dashboard response model 377 Status: OK 378 379 ###### <span id="app-dashboard-200-schema"></span> Schema 380 381 382 383 [MonitoringDashboard](#monitoring-dashboard) 384 385 ##### <span id="app-dashboard-400"></span> 400 - BadRequestError: the client request is incorrect 386 Status: Bad Request 387 388 ###### <span id="app-dashboard-400-schema"></span> Schema 389 390 391 392 [AppDashboardBadRequestBody](#app-dashboard-bad-request-body) 393 394 ##### <span id="app-dashboard-503"></span> 503 - A Internal is the error message that means something has gone wrong 395 Status: Service Unavailable 396 397 ###### <span id="app-dashboard-503-schema"></span> Schema 398 399 400 401 [AppDashboardServiceUnavailableBody](#app-dashboard-service-unavailable-body) 402 403 ###### Inlined models 404 405 **<span id="app-dashboard-bad-request-body"></span> AppDashboardBadRequestBody** 406 407 408 409 410 411 412 **Properties** 413 414 | Name | Type | Go type | Required | Default | Description | Example | 415 |------|------|---------|:--------:| ------- |-------------|---------| 416 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 417 | Message | string| `string` | | | | | 418 419 420 421 **<span id="app-dashboard-service-unavailable-body"></span> AppDashboardServiceUnavailableBody** 422 423 424 425 426 427 428 **Properties** 429 430 | Name | Type | Go type | Required | Default | Description | Example | 431 |------|------|---------|:--------:| ------- |-------------|---------| 432 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 433 | Message | string| `string` | | | | | 434 435 436 437 ### <span id="app-details"></span> app details (*appDetails*) 438 439 ``` 440 GET /api/namespaces/{namespace}/apps/{app} 441 ``` 442 443 Endpoint to get the app details 444 445 #### URI Schemes 446 * http 447 * https 448 449 #### Produces 450 * application/json 451 452 #### Parameters 453 454 | Name | Source | Type | Go type | Separator | Required | Default | Description | 455 |------|--------|------|---------|-----------| :------: |---------|-------------| 456 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 457 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 458 459 #### All responses 460 | Code | Status | Description | Has headers | Schema | 461 |------|--------|-------------|:-----------:|--------| 462 | [200](#app-details-200) | OK | Detailed information of an specific app | | [schema](#app-details-200-schema) | 463 | [404](#app-details-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#app-details-404-schema) | 464 | [500](#app-details-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#app-details-500-schema) | 465 466 #### Responses 467 468 469 ##### <span id="app-details-200"></span> 200 - Detailed information of an specific app 470 Status: OK 471 472 ###### <span id="app-details-200-schema"></span> Schema 473 474 475 476 [App](#app) 477 478 ##### <span id="app-details-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 479 Status: Not Found 480 481 ###### <span id="app-details-404-schema"></span> Schema 482 483 484 485 [AppDetailsNotFoundBody](#app-details-not-found-body) 486 487 ##### <span id="app-details-500"></span> 500 - A Internal is the error message that means something has gone wrong 488 Status: Internal Server Error 489 490 ###### <span id="app-details-500-schema"></span> Schema 491 492 493 494 [AppDetailsInternalServerErrorBody](#app-details-internal-server-error-body) 495 496 ###### Inlined models 497 498 **<span id="app-details-internal-server-error-body"></span> AppDetailsInternalServerErrorBody** 499 500 501 502 503 504 505 **Properties** 506 507 | Name | Type | Go type | Required | Default | Description | Example | 508 |------|------|---------|:--------:| ------- |-------------|---------| 509 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 510 | Message | string| `string` | | | | | 511 512 513 514 **<span id="app-details-not-found-body"></span> AppDetailsNotFoundBody** 515 516 517 518 519 520 521 **Properties** 522 523 | Name | Type | Go type | Required | Default | Description | Example | 524 |------|------|---------|:--------:| ------- |-------------|---------| 525 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 526 | Message | string| `string` | | | | | 527 528 529 530 ### <span id="app-list"></span> app list (*appList*) 531 532 ``` 533 GET /api/namespaces/{namespace}/apps 534 ``` 535 536 Endpoint to get the list of apps for a namespace 537 538 #### URI Schemes 539 * http 540 * https 541 542 #### Produces 543 * application/json 544 545 #### Parameters 546 547 | Name | Source | Type | Go type | Separator | Required | Default | Description | 548 |------|--------|------|---------|-----------| :------: |---------|-------------| 549 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 550 | QueryTime | `query` | date-time (formatted string) | `strfmt.DateTime` | | | | The time to use for the prometheus query | 551 | app | `query` | string | `string` | | | | | 552 | health | `query` | boolean | `bool` | | | | Optional | 553 | rateInterval | `query` | string | `string` | | | `"10m"` | The rate interval used for fetching error rate | 554 555 #### All responses 556 | Code | Status | Description | Has headers | Schema | 557 |------|--------|-------------|:-----------:|--------| 558 | [200](#app-list-200) | OK | Listing all apps in the namespace | | [schema](#app-list-200-schema) | 559 | [500](#app-list-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#app-list-500-schema) | 560 561 #### Responses 562 563 564 ##### <span id="app-list-200"></span> 200 - Listing all apps in the namespace 565 Status: OK 566 567 ###### <span id="app-list-200-schema"></span> Schema 568 569 570 571 [AppList](#app-list) 572 573 ##### <span id="app-list-500"></span> 500 - A Internal is the error message that means something has gone wrong 574 Status: Internal Server Error 575 576 ###### <span id="app-list-500-schema"></span> Schema 577 578 579 580 [AppListInternalServerErrorBody](#app-list-internal-server-error-body) 581 582 ###### Inlined models 583 584 **<span id="app-list-internal-server-error-body"></span> AppListInternalServerErrorBody** 585 586 587 588 589 590 591 **Properties** 592 593 | Name | Type | Go type | Required | Default | Description | Example | 594 |------|------|---------|:--------:| ------- |-------------|---------| 595 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 596 | Message | string| `string` | | | | | 597 598 599 600 ### <span id="app-metrics"></span> app metrics (*appMetrics*) 601 602 ``` 603 GET /api/namespaces/{namespace}/apps/{app}/metrics 604 ``` 605 606 Endpoint to fetch metrics to be displayed, related to a single app 607 608 #### URI Schemes 609 * http 610 * https 611 612 #### Produces 613 * application/json 614 615 #### Parameters 616 617 | Name | Source | Type | Go type | Separator | Required | Default | Description | 618 |------|--------|------|---------|-----------| :------: |---------|-------------| 619 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 620 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 621 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 622 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 623 | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | 624 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 625 | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | 626 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 627 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 628 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 629 | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | 630 | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | 631 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 632 | version | `query` | string | `string` | | | | Filters metrics by the specified version. | 633 634 #### All responses 635 | Code | Status | Description | Has headers | Schema | 636 |------|--------|-------------|:-----------:|--------| 637 | [200](#app-metrics-200) | OK | Metrics response model | | [schema](#app-metrics-200-schema) | 638 | [400](#app-metrics-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#app-metrics-400-schema) | 639 | [503](#app-metrics-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#app-metrics-503-schema) | 640 641 #### Responses 642 643 644 ##### <span id="app-metrics-200"></span> 200 - Metrics response model 645 Status: OK 646 647 ###### <span id="app-metrics-200-schema"></span> Schema 648 649 650 651 map of [Metric](#metric) 652 653 ##### <span id="app-metrics-400"></span> 400 - BadRequestError: the client request is incorrect 654 Status: Bad Request 655 656 ###### <span id="app-metrics-400-schema"></span> Schema 657 658 659 660 [AppMetricsBadRequestBody](#app-metrics-bad-request-body) 661 662 ##### <span id="app-metrics-503"></span> 503 - A Internal is the error message that means something has gone wrong 663 Status: Service Unavailable 664 665 ###### <span id="app-metrics-503-schema"></span> Schema 666 667 668 669 [AppMetricsServiceUnavailableBody](#app-metrics-service-unavailable-body) 670 671 ###### Inlined models 672 673 **<span id="app-metrics-bad-request-body"></span> AppMetricsBadRequestBody** 674 675 676 677 678 679 680 **Properties** 681 682 | Name | Type | Go type | Required | Default | Description | Example | 683 |------|------|---------|:--------:| ------- |-------------|---------| 684 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 685 | Message | string| `string` | | | | | 686 687 688 689 **<span id="app-metrics-service-unavailable-body"></span> AppMetricsServiceUnavailableBody** 690 691 692 693 694 695 696 **Properties** 697 698 | Name | Type | Go type | Required | Default | Description | Example | 699 |------|------|---------|:--------:| ------- |-------------|---------| 700 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 701 | Message | string| `string` | | | | | 702 703 704 705 ### <span id="app-spans"></span> app spans (*appSpans*) 706 707 ``` 708 GET /api/namespaces/{namespace}/apps/{app}/spans 709 ``` 710 711 Endpoint to get Jaeger spans for a given app 712 713 #### URI Schemes 714 * http 715 * https 716 717 #### Produces 718 * application/json 719 720 #### Parameters 721 722 | Name | Source | Type | Go type | Separator | Required | Default | Description | 723 |------|--------|------|---------|-----------| :------: |---------|-------------| 724 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 725 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 726 727 #### All responses 728 | Code | Status | Description | Has headers | Schema | 729 |------|--------|-------------|:-----------:|--------| 730 | [200](#app-spans-200) | OK | Listing all the information related to a Span | | [schema](#app-spans-200-schema) | 731 | [500](#app-spans-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#app-spans-500-schema) | 732 733 #### Responses 734 735 736 ##### <span id="app-spans-200"></span> 200 - Listing all the information related to a Span 737 Status: OK 738 739 ###### <span id="app-spans-200-schema"></span> Schema 740 741 742 743 [][JaegerSpan](#jaeger-span) 744 745 ##### <span id="app-spans-500"></span> 500 - A Internal is the error message that means something has gone wrong 746 Status: Internal Server Error 747 748 ###### <span id="app-spans-500-schema"></span> Schema 749 750 751 752 [AppSpansInternalServerErrorBody](#app-spans-internal-server-error-body) 753 754 ###### Inlined models 755 756 **<span id="app-spans-internal-server-error-body"></span> AppSpansInternalServerErrorBody** 757 758 759 760 761 762 763 **Properties** 764 765 | Name | Type | Go type | Required | Default | Description | Example | 766 |------|------|---------|:--------:| ------- |-------------|---------| 767 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 768 | Message | string| `string` | | | | | 769 770 771 772 ### <span id="app-traces"></span> app traces (*appTraces*) 773 774 ``` 775 GET /api/namespaces/{namespace}/apps/{app}/traces 776 ``` 777 778 Endpoint to get the traces of a given app 779 780 #### URI Schemes 781 * http 782 * https 783 784 #### Produces 785 * application/json 786 787 #### Parameters 788 789 | Name | Source | Type | Go type | Separator | Required | Default | Description | 790 |------|--------|------|---------|-----------| :------: |---------|-------------| 791 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 792 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 793 794 #### All responses 795 | Code | Status | Description | Has headers | Schema | 796 |------|--------|-------------|:-----------:|--------| 797 | [200](#app-traces-200) | OK | Listing all the information related to a Trace | | [schema](#app-traces-200-schema) | 798 | [404](#app-traces-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#app-traces-404-schema) | 799 | [500](#app-traces-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#app-traces-500-schema) | 800 801 #### Responses 802 803 804 ##### <span id="app-traces-200"></span> 200 - Listing all the information related to a Trace 805 Status: OK 806 807 ###### <span id="app-traces-200-schema"></span> Schema 808 809 810 811 [][Trace](#trace) 812 813 ##### <span id="app-traces-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 814 Status: Not Found 815 816 ###### <span id="app-traces-404-schema"></span> Schema 817 818 819 820 [AppTracesNotFoundBody](#app-traces-not-found-body) 821 822 ##### <span id="app-traces-500"></span> 500 - A Internal is the error message that means something has gone wrong 823 Status: Internal Server Error 824 825 ###### <span id="app-traces-500-schema"></span> Schema 826 827 828 829 [AppTracesInternalServerErrorBody](#app-traces-internal-server-error-body) 830 831 ###### Inlined models 832 833 **<span id="app-traces-internal-server-error-body"></span> AppTracesInternalServerErrorBody** 834 835 836 837 838 839 840 **Properties** 841 842 | Name | Type | Go type | Required | Default | Description | Example | 843 |------|------|---------|:--------:| ------- |-------------|---------| 844 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 845 | Message | string| `string` | | | | | 846 847 848 849 **<span id="app-traces-not-found-body"></span> AppTracesNotFoundBody** 850 851 852 853 854 855 856 **Properties** 857 858 | Name | Type | Go type | Required | Default | Description | Example | 859 |------|------|---------|:--------:| ------- |-------------|---------| 860 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 861 | Message | string| `string` | | | | | 862 863 864 865 ### <span id="authenticate"></span> authenticate (*authenticate*) 866 867 ``` 868 GET /api/authenticate 869 ``` 870 871 Endpoint to authenticate the user 872 873 #### URI Schemes 874 * http 875 * https 876 877 #### Produces 878 * application/json 879 880 #### Security Requirements 881 * authorization: password, user 882 883 #### All responses 884 | Code | Status | Description | Has headers | Schema | 885 |------|--------|-------------|:-----------:|--------| 886 | [200](#authenticate-200) | OK | HTTP status code 200 and userGenerated model in data | | [schema](#authenticate-200-schema) | 887 | [500](#authenticate-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#authenticate-500-schema) | 888 889 #### Responses 890 891 892 ##### <span id="authenticate-200"></span> 200 - HTTP status code 200 and userGenerated model in data 893 Status: OK 894 895 ###### <span id="authenticate-200-schema"></span> Schema 896 897 898 899 [UserSessionData](#user-session-data) 900 901 ##### <span id="authenticate-500"></span> 500 - A Internal is the error message that means something has gone wrong 902 Status: Internal Server Error 903 904 ###### <span id="authenticate-500-schema"></span> Schema 905 906 907 908 [AuthenticateInternalServerErrorBody](#authenticate-internal-server-error-body) 909 910 ###### Inlined models 911 912 **<span id="authenticate-internal-server-error-body"></span> AuthenticateInternalServerErrorBody** 913 914 915 916 917 918 919 **Properties** 920 921 | Name | Type | Go type | Required | Default | Description | Example | 922 |------|------|---------|:--------:| ------- |-------------|---------| 923 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 924 | Message | string| `string` | | | | | 925 926 927 928 ### <span id="authentication-info"></span> authentication info (*authenticationInfo*) 929 930 ``` 931 GET /api/auth/info 932 ``` 933 934 Endpoint to get login info, such as strategy, authorization endpoints 935 for OAuth providers and so on. 936 937 #### URI Schemes 938 * http 939 * https 940 941 #### Consumes 942 * application/json 943 944 #### Produces 945 * application/json 946 947 #### All responses 948 | Code | Status | Description | Has headers | Schema | 949 |------|--------|-------------|:-----------:|--------| 950 | [200](#authentication-info-200) | OK | Return the information necessary to handle login | ✓ | [schema](#authentication-info-200-schema) | 951 | [500](#authentication-info-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#authentication-info-500-schema) | 952 953 #### Responses 954 955 956 ##### <span id="authentication-info-200"></span> 200 - Return the information necessary to handle login 957 Status: OK 958 959 ###### <span id="authentication-info-200-schema"></span> Schema 960 961 ###### Response headers 962 963 | Name | Type | Go type | Separator | Default | Description | 964 |------|------|---------|-----------|---------|-------------| 965 | AuthorizationEndpoint | string | `string` | | | | 966 | Strategy | string | `string` | | | | 967 968 ##### <span id="authentication-info-500"></span> 500 - A Internal is the error message that means something has gone wrong 969 Status: Internal Server Error 970 971 ###### <span id="authentication-info-500-schema"></span> Schema 972 973 974 975 [AuthenticationInfoInternalServerErrorBody](#authentication-info-internal-server-error-body) 976 977 ###### Inlined models 978 979 **<span id="authentication-info-internal-server-error-body"></span> AuthenticationInfoInternalServerErrorBody** 980 981 982 983 984 985 986 **Properties** 987 988 | Name | Type | Go type | Required | Default | Description | Example | 989 |------|------|---------|:--------:| ------- |-------------|---------| 990 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 991 | Message | string| `string` | | | | | 992 993 994 995 ### <span id="custom-dashboard"></span> custom dashboard (*customDashboard*) 996 997 ``` 998 GET /api/namespaces/{namespace}/customdashboard/{dashboard} 999 ``` 1000 1001 Endpoint to fetch a custom dashboard 1002 1003 #### URI Schemes 1004 * http 1005 * https 1006 1007 #### Produces 1008 * application/json 1009 1010 #### Parameters 1011 1012 | Name | Source | Type | Go type | Separator | Required | Default | Description | 1013 |------|--------|------|---------|-----------| :------: |---------|-------------| 1014 | dashboard | `path` | string | `string` | | ✓ | | The dashboard resource name. | 1015 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 1016 | 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 | 1017 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 1018 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 1019 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 1020 | labelsFilters | `query` | string | `string` | | | | In custom dashboards, labels filters to use when fetching metrics, formatted as key:value pairs. Ex: "app:foo,version:bar". | 1021 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 1022 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 1023 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 1024 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 1025 1026 #### All responses 1027 | Code | Status | Description | Has headers | Schema | 1028 |------|--------|-------------|:-----------:|--------| 1029 | [200](#custom-dashboard-200) | OK | Dashboard response model | | [schema](#custom-dashboard-200-schema) | 1030 | [400](#custom-dashboard-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#custom-dashboard-400-schema) | 1031 | [503](#custom-dashboard-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#custom-dashboard-503-schema) | 1032 1033 #### Responses 1034 1035 1036 ##### <span id="custom-dashboard-200"></span> 200 - Dashboard response model 1037 Status: OK 1038 1039 ###### <span id="custom-dashboard-200-schema"></span> Schema 1040 1041 1042 1043 [MonitoringDashboard](#monitoring-dashboard) 1044 1045 ##### <span id="custom-dashboard-400"></span> 400 - BadRequestError: the client request is incorrect 1046 Status: Bad Request 1047 1048 ###### <span id="custom-dashboard-400-schema"></span> Schema 1049 1050 1051 1052 [CustomDashboardBadRequestBody](#custom-dashboard-bad-request-body) 1053 1054 ##### <span id="custom-dashboard-503"></span> 503 - A Internal is the error message that means something has gone wrong 1055 Status: Service Unavailable 1056 1057 ###### <span id="custom-dashboard-503-schema"></span> Schema 1058 1059 1060 1061 [CustomDashboardServiceUnavailableBody](#custom-dashboard-service-unavailable-body) 1062 1063 ###### Inlined models 1064 1065 **<span id="custom-dashboard-bad-request-body"></span> CustomDashboardBadRequestBody** 1066 1067 1068 1069 1070 1071 1072 **Properties** 1073 1074 | Name | Type | Go type | Required | Default | Description | Example | 1075 |------|------|---------|:--------:| ------- |-------------|---------| 1076 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 1077 | Message | string| `string` | | | | | 1078 1079 1080 1081 **<span id="custom-dashboard-service-unavailable-body"></span> CustomDashboardServiceUnavailableBody** 1082 1083 1084 1085 1086 1087 1088 **Properties** 1089 1090 | Name | Type | Go type | Required | Default | Description | Example | 1091 |------|------|---------|:--------:| ------- |-------------|---------| 1092 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 1093 | Message | string| `string` | | | | | 1094 1095 1096 1097 ### <span id="error-traces"></span> error traces (*errorTraces*) 1098 1099 ``` 1100 GET /api/namespaces/{namespace}/apps/{app}/errortraces 1101 ``` 1102 1103 Endpoint to get the number of traces in error for a given service 1104 1105 #### URI Schemes 1106 * http 1107 * https 1108 1109 #### Produces 1110 * application/json 1111 1112 #### Parameters 1113 1114 | Name | Source | Type | Go type | Separator | Required | Default | Description | 1115 |------|--------|------|---------|-----------| :------: |---------|-------------| 1116 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 1117 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 1118 1119 #### All responses 1120 | Code | Status | Description | Has headers | Schema | 1121 |------|--------|-------------|:-----------:|--------| 1122 | [200](#error-traces-200) | OK | Number of traces in error | | [schema](#error-traces-200-schema) | 1123 | [404](#error-traces-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#error-traces-404-schema) | 1124 | [500](#error-traces-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#error-traces-500-schema) | 1125 1126 #### Responses 1127 1128 1129 ##### <span id="error-traces-200"></span> 200 - Number of traces in error 1130 Status: OK 1131 1132 ###### <span id="error-traces-200-schema"></span> Schema 1133 1134 ##### <span id="error-traces-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 1135 Status: Not Found 1136 1137 ###### <span id="error-traces-404-schema"></span> Schema 1138 1139 1140 1141 [ErrorTracesNotFoundBody](#error-traces-not-found-body) 1142 1143 ##### <span id="error-traces-500"></span> 500 - A Internal is the error message that means something has gone wrong 1144 Status: Internal Server Error 1145 1146 ###### <span id="error-traces-500-schema"></span> Schema 1147 1148 1149 1150 [ErrorTracesInternalServerErrorBody](#error-traces-internal-server-error-body) 1151 1152 ###### Inlined models 1153 1154 **<span id="error-traces-internal-server-error-body"></span> ErrorTracesInternalServerErrorBody** 1155 1156 1157 1158 1159 1160 1161 **Properties** 1162 1163 | Name | Type | Go type | Required | Default | Description | Example | 1164 |------|------|---------|:--------:| ------- |-------------|---------| 1165 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1166 | Message | string| `string` | | | | | 1167 1168 1169 1170 **<span id="error-traces-not-found-body"></span> ErrorTracesNotFoundBody** 1171 1172 1173 1174 1175 1176 1177 **Properties** 1178 1179 | Name | Type | Go type | Required | Default | Description | Example | 1180 |------|------|---------|:--------:| ------- |-------------|---------| 1181 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 1182 | Message | string| `string` | | | | | 1183 1184 1185 1186 ### <span id="get-config"></span> get config (*getConfig*) 1187 1188 ``` 1189 GET /api/config 1190 ``` 1191 1192 Endpoint to get the config of Kiali 1193 1194 #### URI Schemes 1195 * http 1196 * https 1197 1198 #### Produces 1199 * application/json 1200 1201 #### All responses 1202 | Code | Status | Description | Has headers | Schema | 1203 |------|--------|-------------|:-----------:|--------| 1204 | [200](#get-config-200) | OK | HTTP status code 200 and statusInfo model in data | | [schema](#get-config-200-schema) | 1205 | [500](#get-config-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#get-config-500-schema) | 1206 1207 #### Responses 1208 1209 1210 ##### <span id="get-config-200"></span> 200 - HTTP status code 200 and statusInfo model in data 1211 Status: OK 1212 1213 ###### <span id="get-config-200-schema"></span> Schema 1214 1215 1216 1217 [StatusInfo](#status-info) 1218 1219 ##### <span id="get-config-500"></span> 500 - A Internal is the error message that means something has gone wrong 1220 Status: Internal Server Error 1221 1222 ###### <span id="get-config-500-schema"></span> Schema 1223 1224 1225 1226 [GetConfigInternalServerErrorBody](#get-config-internal-server-error-body) 1227 1228 ###### Inlined models 1229 1230 **<span id="get-config-internal-server-error-body"></span> GetConfigInternalServerErrorBody** 1231 1232 1233 1234 1235 1236 1237 **Properties** 1238 1239 | Name | Type | Go type | Required | Default | Description | Example | 1240 |------|------|---------|:--------:| ------- |-------------|---------| 1241 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1242 | Message | string| `string` | | | | | 1243 1244 1245 1246 ### <span id="get-crippled-features"></span> get crippled features (*getCrippledFeatures*) 1247 1248 ``` 1249 GET /api/crippled 1250 ``` 1251 1252 Endpoint to get the crippled features of Kiali 1253 1254 #### URI Schemes 1255 * http 1256 * https 1257 1258 #### Produces 1259 * application/json 1260 1261 #### All responses 1262 | Code | Status | Description | Has headers | Schema | 1263 |------|--------|-------------|:-----------:|--------| 1264 | [200](#get-crippled-features-200) | OK | HTTP status code 200 and statusInfo model in data | | [schema](#get-crippled-features-200-schema) | 1265 | [500](#get-crippled-features-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#get-crippled-features-500-schema) | 1266 1267 #### Responses 1268 1269 1270 ##### <span id="get-crippled-features-200"></span> 200 - HTTP status code 200 and statusInfo model in data 1271 Status: OK 1272 1273 ###### <span id="get-crippled-features-200-schema"></span> Schema 1274 1275 1276 1277 [StatusInfo](#status-info) 1278 1279 ##### <span id="get-crippled-features-500"></span> 500 - A Internal is the error message that means something has gone wrong 1280 Status: Internal Server Error 1281 1282 ###### <span id="get-crippled-features-500-schema"></span> Schema 1283 1284 1285 1286 [GetCrippledFeaturesInternalServerErrorBody](#get-crippled-features-internal-server-error-body) 1287 1288 ###### Inlined models 1289 1290 **<span id="get-crippled-features-internal-server-error-body"></span> GetCrippledFeaturesInternalServerErrorBody** 1291 1292 1293 1294 1295 1296 1297 **Properties** 1298 1299 | Name | Type | Go type | Required | Default | Description | Example | 1300 |------|------|---------|:--------:| ------- |-------------|---------| 1301 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1302 | Message | string| `string` | | | | | 1303 1304 1305 1306 ### <span id="get-permissions"></span> get permissions (*getPermissions*) 1307 1308 ``` 1309 GET /api/istio/permissions 1310 ``` 1311 1312 Endpoint to get the caller permissions on new Istio Config objects 1313 1314 #### URI Schemes 1315 * http 1316 * https 1317 1318 #### Produces 1319 * application/json 1320 1321 #### All responses 1322 | Code | Status | Description | Has headers | Schema | 1323 |------|--------|-------------|:-----------:|--------| 1324 | [200](#get-permissions-200) | OK | Return caller permissions per namespace and Istio Config type | | [schema](#get-permissions-200-schema) | 1325 | [500](#get-permissions-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#get-permissions-500-schema) | 1326 1327 #### Responses 1328 1329 1330 ##### <span id="get-permissions-200"></span> 200 - Return caller permissions per namespace and Istio Config type 1331 Status: OK 1332 1333 ###### <span id="get-permissions-200-schema"></span> Schema 1334 1335 1336 1337 [IstioConfigPermissions](#istio-config-permissions) 1338 1339 ##### <span id="get-permissions-500"></span> 500 - A Internal is the error message that means something has gone wrong 1340 Status: Internal Server Error 1341 1342 ###### <span id="get-permissions-500-schema"></span> Schema 1343 1344 1345 1346 [GetPermissionsInternalServerErrorBody](#get-permissions-internal-server-error-body) 1347 1348 ###### Inlined models 1349 1350 **<span id="get-permissions-internal-server-error-body"></span> GetPermissionsInternalServerErrorBody** 1351 1352 1353 1354 1355 1356 1357 **Properties** 1358 1359 | Name | Type | Go type | Required | Default | Description | Example | 1360 |------|------|---------|:--------:| ------- |-------------|---------| 1361 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1362 | Message | string| `string` | | | | | 1363 1364 1365 1366 ### <span id="get-status"></span> get status (*getStatus*) 1367 1368 ``` 1369 GET /api/status 1370 ``` 1371 1372 Endpoint to get the status of Kiali 1373 1374 #### URI Schemes 1375 * http 1376 * https 1377 1378 #### Produces 1379 * application/json 1380 1381 #### All responses 1382 | Code | Status | Description | Has headers | Schema | 1383 |------|--------|-------------|:-----------:|--------| 1384 | [200](#get-status-200) | OK | HTTP status code 200 and statusInfo model in data | | [schema](#get-status-200-schema) | 1385 | [500](#get-status-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#get-status-500-schema) | 1386 1387 #### Responses 1388 1389 1390 ##### <span id="get-status-200"></span> 200 - HTTP status code 200 and statusInfo model in data 1391 Status: OK 1392 1393 ###### <span id="get-status-200-schema"></span> Schema 1394 1395 1396 1397 [StatusInfo](#status-info) 1398 1399 ##### <span id="get-status-500"></span> 500 - A Internal is the error message that means something has gone wrong 1400 Status: Internal Server Error 1401 1402 ###### <span id="get-status-500-schema"></span> Schema 1403 1404 1405 1406 [GetStatusInternalServerErrorBody](#get-status-internal-server-error-body) 1407 1408 ###### Inlined models 1409 1410 **<span id="get-status-internal-server-error-body"></span> GetStatusInternalServerErrorBody** 1411 1412 1413 1414 1415 1416 1417 **Properties** 1418 1419 | Name | Type | Go type | Required | Default | Description | Example | 1420 |------|------|---------|:--------:| ------- |-------------|---------| 1421 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1422 | Message | string| `string` | | | | | 1423 1424 1425 1426 ### <span id="grafana-info"></span> grafana info (*grafanaInfo*) 1427 1428 ``` 1429 GET /api/grafana 1430 ``` 1431 1432 Get the grafana URL and other descriptors 1433 1434 #### URI Schemes 1435 * http 1436 * https 1437 1438 #### Produces 1439 * application/json 1440 1441 #### All responses 1442 | Code | Status | Description | Has headers | Schema | 1443 |------|--------|-------------|:-----------:|--------| 1444 | [200](#grafana-info-200) | OK | Return all the descriptor data related to Grafana | | [schema](#grafana-info-200-schema) | 1445 | [204](#grafana-info-204) | No Content | NoContent: the response is empty | | [schema](#grafana-info-204-schema) | 1446 | [500](#grafana-info-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#grafana-info-500-schema) | 1447 | [503](#grafana-info-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#grafana-info-503-schema) | 1448 1449 #### Responses 1450 1451 1452 ##### <span id="grafana-info-200"></span> 200 - Return all the descriptor data related to Grafana 1453 Status: OK 1454 1455 ###### <span id="grafana-info-200-schema"></span> Schema 1456 1457 1458 1459 [GrafanaInfo](#grafana-info) 1460 1461 ##### <span id="grafana-info-204"></span> 204 - NoContent: the response is empty 1462 Status: No Content 1463 1464 ###### <span id="grafana-info-204-schema"></span> Schema 1465 1466 1467 1468 [GrafanaInfoNoContentBody](#grafana-info-no-content-body) 1469 1470 ##### <span id="grafana-info-500"></span> 500 - A Internal is the error message that means something has gone wrong 1471 Status: Internal Server Error 1472 1473 ###### <span id="grafana-info-500-schema"></span> Schema 1474 1475 1476 1477 [GrafanaInfoInternalServerErrorBody](#grafana-info-internal-server-error-body) 1478 1479 ##### <span id="grafana-info-503"></span> 503 - A Internal is the error message that means something has gone wrong 1480 Status: Service Unavailable 1481 1482 ###### <span id="grafana-info-503-schema"></span> Schema 1483 1484 1485 1486 [GrafanaInfoServiceUnavailableBody](#grafana-info-service-unavailable-body) 1487 1488 ###### Inlined models 1489 1490 **<span id="grafana-info-internal-server-error-body"></span> GrafanaInfoInternalServerErrorBody** 1491 1492 1493 1494 1495 1496 1497 **Properties** 1498 1499 | Name | Type | Go type | Required | Default | Description | Example | 1500 |------|------|---------|:--------:| ------- |-------------|---------| 1501 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1502 | Message | string| `string` | | | | | 1503 1504 1505 1506 **<span id="grafana-info-no-content-body"></span> GrafanaInfoNoContentBody** 1507 1508 1509 1510 1511 1512 1513 **Properties** 1514 1515 | Name | Type | Go type | Required | Default | Description | Example | 1516 |------|------|---------|:--------:| ------- |-------------|---------| 1517 | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | 1518 | Message | string| `string` | | | | | 1519 1520 1521 1522 **<span id="grafana-info-service-unavailable-body"></span> GrafanaInfoServiceUnavailableBody** 1523 1524 1525 1526 1527 1528 1529 **Properties** 1530 1531 | Name | Type | Go type | Required | Default | Description | Example | 1532 |------|------|---------|:--------:| ------- |-------------|---------| 1533 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 1534 | Message | string| `string` | | | | | 1535 1536 1537 1538 ### <span id="graph-aggregate"></span> graph aggregate (*graphAggregate*) 1539 1540 ``` 1541 GET /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/graph 1542 ``` 1543 1544 The backing JSON for an aggregate node detail graph. (supported graphTypes: app | versionedApp | workload) 1545 1546 #### URI Schemes 1547 * http 1548 * https 1549 1550 #### Produces 1551 * application/json 1552 1553 #### Parameters 1554 1555 | Name | Source | Type | Go type | Separator | Required | Default | Description | 1556 |------|--------|------|---------|-----------| :------: |---------|-------------| 1557 | aggregate | `path` | string | `string` | | ✓ | | The aggregate name (label). | 1558 | aggregateValue | `path` | string | `string` | | ✓ | | The aggregate value (label value). | 1559 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 1560 | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | 1561 1562 #### All responses 1563 | Code | Status | Description | Has headers | Schema | 1564 |------|--------|-------------|:-----------:|--------| 1565 | [200](#graph-aggregate-200) | OK | HTTP status code 200 and cytoscapejs Config in data | | [schema](#graph-aggregate-200-schema) | 1566 | [400](#graph-aggregate-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#graph-aggregate-400-schema) | 1567 | [500](#graph-aggregate-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#graph-aggregate-500-schema) | 1568 1569 #### Responses 1570 1571 1572 ##### <span id="graph-aggregate-200"></span> 200 - HTTP status code 200 and cytoscapejs Config in data 1573 Status: OK 1574 1575 ###### <span id="graph-aggregate-200-schema"></span> Schema 1576 1577 1578 1579 [Config](#config) 1580 1581 ##### <span id="graph-aggregate-400"></span> 400 - BadRequestError: the client request is incorrect 1582 Status: Bad Request 1583 1584 ###### <span id="graph-aggregate-400-schema"></span> Schema 1585 1586 1587 1588 [GraphAggregateBadRequestBody](#graph-aggregate-bad-request-body) 1589 1590 ##### <span id="graph-aggregate-500"></span> 500 - A Internal is the error message that means something has gone wrong 1591 Status: Internal Server Error 1592 1593 ###### <span id="graph-aggregate-500-schema"></span> Schema 1594 1595 1596 1597 [GraphAggregateInternalServerErrorBody](#graph-aggregate-internal-server-error-body) 1598 1599 ###### Inlined models 1600 1601 **<span id="graph-aggregate-bad-request-body"></span> GraphAggregateBadRequestBody** 1602 1603 1604 1605 1606 1607 1608 **Properties** 1609 1610 | Name | Type | Go type | Required | Default | Description | Example | 1611 |------|------|---------|:--------:| ------- |-------------|---------| 1612 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 1613 | Message | string| `string` | | | | | 1614 1615 1616 1617 **<span id="graph-aggregate-internal-server-error-body"></span> GraphAggregateInternalServerErrorBody** 1618 1619 1620 1621 1622 1623 1624 **Properties** 1625 1626 | Name | Type | Go type | Required | Default | Description | Example | 1627 |------|------|---------|:--------:| ------- |-------------|---------| 1628 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1629 | Message | string| `string` | | | | | 1630 1631 1632 1633 ### <span id="graph-aggregate-by-service"></span> graph aggregate by service (*graphAggregateByService*) 1634 1635 ``` 1636 GET /api/namespaces/{namespace}/aggregates/{aggregate}/{aggregateValue}/{service}/graph 1637 ``` 1638 1639 The backing JSON for an aggregate node detail graph, specific to a service. (supported graphTypes: app | versionedApp | workload) 1640 1641 #### URI Schemes 1642 * http 1643 * https 1644 1645 #### Produces 1646 * application/json 1647 1648 #### Parameters 1649 1650 | Name | Source | Type | Go type | Separator | Required | Default | Description | 1651 |------|--------|------|---------|-----------| :------: |---------|-------------| 1652 | aggregate | `path` | string | `string` | | ✓ | | The aggregate name (label). | 1653 | aggregateValue | `path` | string | `string` | | ✓ | | The aggregate value (label value). | 1654 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 1655 | service | `path` | string | `string` | | ✓ | | The service name. | 1656 | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | 1657 1658 #### All responses 1659 | Code | Status | Description | Has headers | Schema | 1660 |------|--------|-------------|:-----------:|--------| 1661 | [200](#graph-aggregate-by-service-200) | OK | HTTP status code 200 and cytoscapejs Config in data | | [schema](#graph-aggregate-by-service-200-schema) | 1662 | [400](#graph-aggregate-by-service-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#graph-aggregate-by-service-400-schema) | 1663 | [500](#graph-aggregate-by-service-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#graph-aggregate-by-service-500-schema) | 1664 1665 #### Responses 1666 1667 1668 ##### <span id="graph-aggregate-by-service-200"></span> 200 - HTTP status code 200 and cytoscapejs Config in data 1669 Status: OK 1670 1671 ###### <span id="graph-aggregate-by-service-200-schema"></span> Schema 1672 1673 1674 1675 [Config](#config) 1676 1677 ##### <span id="graph-aggregate-by-service-400"></span> 400 - BadRequestError: the client request is incorrect 1678 Status: Bad Request 1679 1680 ###### <span id="graph-aggregate-by-service-400-schema"></span> Schema 1681 1682 1683 1684 [GraphAggregateByServiceBadRequestBody](#graph-aggregate-by-service-bad-request-body) 1685 1686 ##### <span id="graph-aggregate-by-service-500"></span> 500 - A Internal is the error message that means something has gone wrong 1687 Status: Internal Server Error 1688 1689 ###### <span id="graph-aggregate-by-service-500-schema"></span> Schema 1690 1691 1692 1693 [GraphAggregateByServiceInternalServerErrorBody](#graph-aggregate-by-service-internal-server-error-body) 1694 1695 ###### Inlined models 1696 1697 **<span id="graph-aggregate-by-service-bad-request-body"></span> GraphAggregateByServiceBadRequestBody** 1698 1699 1700 1701 1702 1703 1704 **Properties** 1705 1706 | Name | Type | Go type | Required | Default | Description | Example | 1707 |------|------|---------|:--------:| ------- |-------------|---------| 1708 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 1709 | Message | string| `string` | | | | | 1710 1711 1712 1713 **<span id="graph-aggregate-by-service-internal-server-error-body"></span> GraphAggregateByServiceInternalServerErrorBody** 1714 1715 1716 1717 1718 1719 1720 **Properties** 1721 1722 | Name | Type | Go type | Required | Default | Description | Example | 1723 |------|------|---------|:--------:| ------- |-------------|---------| 1724 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1725 | Message | string| `string` | | | | | 1726 1727 1728 1729 ### <span id="graph-app"></span> graph app (*graphApp*) 1730 1731 ``` 1732 GET /api/namespaces/{namespace}/applications/{app}/graph 1733 ``` 1734 1735 The backing JSON for an app node detail graph. (supported graphTypes: app | versionedApp) 1736 1737 #### URI Schemes 1738 * http 1739 * https 1740 1741 #### Produces 1742 * application/json 1743 1744 #### Parameters 1745 1746 | Name | Source | Type | Go type | Separator | Required | Default | Description | 1747 |------|--------|------|---------|-----------| :------: |---------|-------------| 1748 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 1749 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 1750 | 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]. | 1751 | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | 1752 | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | 1753 | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | 1754 | graphType | `query` | string | `string` | | ✓ | | Graph type. Available graph types: [app, versionedApp]. | 1755 | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | 1756 | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | 1757 | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | 1758 | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. response_messages) | requests | sent (i.e. request_messages) | total (i.e. sent+received). | 1759 | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | 1760 | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. received_bytes) | sent (i.e. sent_bytes) | total (i.e. sent+received). | 1761 | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | 1762 | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request | response. | 1763 1764 #### All responses 1765 | Code | Status | Description | Has headers | Schema | 1766 |------|--------|-------------|:-----------:|--------| 1767 | [200](#graph-app-200) | OK | HTTP status code 200 and cytoscapejs Config in data | | [schema](#graph-app-200-schema) | 1768 | [400](#graph-app-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#graph-app-400-schema) | 1769 | [500](#graph-app-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#graph-app-500-schema) | 1770 1771 #### Responses 1772 1773 1774 ##### <span id="graph-app-200"></span> 200 - HTTP status code 200 and cytoscapejs Config in data 1775 Status: OK 1776 1777 ###### <span id="graph-app-200-schema"></span> Schema 1778 1779 1780 1781 [Config](#config) 1782 1783 ##### <span id="graph-app-400"></span> 400 - BadRequestError: the client request is incorrect 1784 Status: Bad Request 1785 1786 ###### <span id="graph-app-400-schema"></span> Schema 1787 1788 1789 1790 [GraphAppBadRequestBody](#graph-app-bad-request-body) 1791 1792 ##### <span id="graph-app-500"></span> 500 - A Internal is the error message that means something has gone wrong 1793 Status: Internal Server Error 1794 1795 ###### <span id="graph-app-500-schema"></span> Schema 1796 1797 1798 1799 [GraphAppInternalServerErrorBody](#graph-app-internal-server-error-body) 1800 1801 ###### Inlined models 1802 1803 **<span id="graph-app-bad-request-body"></span> GraphAppBadRequestBody** 1804 1805 1806 1807 1808 1809 1810 **Properties** 1811 1812 | Name | Type | Go type | Required | Default | Description | Example | 1813 |------|------|---------|:--------:| ------- |-------------|---------| 1814 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 1815 | Message | string| `string` | | | | | 1816 1817 1818 1819 **<span id="graph-app-internal-server-error-body"></span> GraphAppInternalServerErrorBody** 1820 1821 1822 1823 1824 1825 1826 **Properties** 1827 1828 | Name | Type | Go type | Required | Default | Description | Example | 1829 |------|------|---------|:--------:| ------- |-------------|---------| 1830 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1831 | Message | string| `string` | | | | | 1832 1833 1834 1835 ### <span id="graph-app-version"></span> graph app version (*graphAppVersion*) 1836 1837 ``` 1838 GET /api/namespaces/{namespace}/applications/{app}/versions/{version}/graph 1839 ``` 1840 1841 The backing JSON for a versioned app node detail graph. (supported graphTypes: app | versionedApp) 1842 1843 #### URI Schemes 1844 * http 1845 * https 1846 1847 #### Produces 1848 * application/json 1849 1850 #### Parameters 1851 1852 | Name | Source | Type | Go type | Separator | Required | Default | Description | 1853 |------|--------|------|---------|-----------| :------: |---------|-------------| 1854 | app | `path` | string | `string` | | ✓ | | The app name (label value). | 1855 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 1856 | version | `path` | string | `string` | | ✓ | | The app version (label value). | 1857 | 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]. | 1858 | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | 1859 | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | 1860 | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | 1861 | graphType | `query` | string | `string` | | ✓ | | Graph type. Available graph types: [app, versionedApp]. | 1862 | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | 1863 | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | 1864 | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | 1865 | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. response_messages) | requests | sent (i.e. request_messages) | total (i.e. sent+received). | 1866 | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | 1867 | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. received_bytes) | sent (i.e. sent_bytes) | total (i.e. sent+received). | 1868 | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | 1869 | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request | response. | 1870 1871 #### All responses 1872 | Code | Status | Description | Has headers | Schema | 1873 |------|--------|-------------|:-----------:|--------| 1874 | [200](#graph-app-version-200) | OK | HTTP status code 200 and cytoscapejs Config in data | | [schema](#graph-app-version-200-schema) | 1875 | [400](#graph-app-version-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#graph-app-version-400-schema) | 1876 | [500](#graph-app-version-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#graph-app-version-500-schema) | 1877 1878 #### Responses 1879 1880 1881 ##### <span id="graph-app-version-200"></span> 200 - HTTP status code 200 and cytoscapejs Config in data 1882 Status: OK 1883 1884 ###### <span id="graph-app-version-200-schema"></span> Schema 1885 1886 1887 1888 [Config](#config) 1889 1890 ##### <span id="graph-app-version-400"></span> 400 - BadRequestError: the client request is incorrect 1891 Status: Bad Request 1892 1893 ###### <span id="graph-app-version-400-schema"></span> Schema 1894 1895 1896 1897 [GraphAppVersionBadRequestBody](#graph-app-version-bad-request-body) 1898 1899 ##### <span id="graph-app-version-500"></span> 500 - A Internal is the error message that means something has gone wrong 1900 Status: Internal Server Error 1901 1902 ###### <span id="graph-app-version-500-schema"></span> Schema 1903 1904 1905 1906 [GraphAppVersionInternalServerErrorBody](#graph-app-version-internal-server-error-body) 1907 1908 ###### Inlined models 1909 1910 **<span id="graph-app-version-bad-request-body"></span> GraphAppVersionBadRequestBody** 1911 1912 1913 1914 1915 1916 1917 **Properties** 1918 1919 | Name | Type | Go type | Required | Default | Description | Example | 1920 |------|------|---------|:--------:| ------- |-------------|---------| 1921 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 1922 | Message | string| `string` | | | | | 1923 1924 1925 1926 **<span id="graph-app-version-internal-server-error-body"></span> GraphAppVersionInternalServerErrorBody** 1927 1928 1929 1930 1931 1932 1933 **Properties** 1934 1935 | Name | Type | Go type | Required | Default | Description | Example | 1936 |------|------|---------|:--------:| ------- |-------------|---------| 1937 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 1938 | Message | string| `string` | | | | | 1939 1940 1941 1942 ### <span id="graph-namespaces"></span> The backing JSON for a namespaces graph. (*graphNamespaces*) 1943 1944 ``` 1945 GET /api/namespaces/graph 1946 ``` 1947 1948 #### URI Schemes 1949 * http 1950 * https 1951 1952 #### Produces 1953 * application/json 1954 1955 #### Parameters 1956 1957 | Name | Source | Type | Go type | Separator | Required | Default | Description | 1958 |------|--------|------|---------|-----------| :------: |---------|-------------| 1959 | 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]. | 1960 | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | 1961 | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | 1962 | graphType | `query` | string | `string` | | | `"workload"` | Graph type. Available graph types: [app, service, versionedApp, workload]. | 1963 | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | 1964 | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | 1965 | namespaces | `query` | string | `string` | | ✓ | | Comma-separated list of namespaces to include in the graph. The namespaces must be accessible to the client. | 1966 | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | 1967 | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. response_messages) | requests | sent (i.e. request_messages) | total (i.e. sent+received). | 1968 | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | 1969 | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. received_bytes) | sent (i.e. sent_bytes) | total (i.e. sent+received). | 1970 | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | 1971 | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request | response. | 1972 1973 #### All responses 1974 | Code | Status | Description | Has headers | Schema | 1975 |------|--------|-------------|:-----------:|--------| 1976 | [200](#graph-namespaces-200) | OK | HTTP status code 200 and cytoscapejs Config in data | | [schema](#graph-namespaces-200-schema) | 1977 | [400](#graph-namespaces-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#graph-namespaces-400-schema) | 1978 | [500](#graph-namespaces-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#graph-namespaces-500-schema) | 1979 1980 #### Responses 1981 1982 1983 ##### <span id="graph-namespaces-200"></span> 200 - HTTP status code 200 and cytoscapejs Config in data 1984 Status: OK 1985 1986 ###### <span id="graph-namespaces-200-schema"></span> Schema 1987 1988 1989 1990 [Config](#config) 1991 1992 ##### <span id="graph-namespaces-400"></span> 400 - BadRequestError: the client request is incorrect 1993 Status: Bad Request 1994 1995 ###### <span id="graph-namespaces-400-schema"></span> Schema 1996 1997 1998 1999 [GraphNamespacesBadRequestBody](#graph-namespaces-bad-request-body) 2000 2001 ##### <span id="graph-namespaces-500"></span> 500 - A Internal is the error message that means something has gone wrong 2002 Status: Internal Server Error 2003 2004 ###### <span id="graph-namespaces-500-schema"></span> Schema 2005 2006 2007 2008 [GraphNamespacesInternalServerErrorBody](#graph-namespaces-internal-server-error-body) 2009 2010 ###### Inlined models 2011 2012 **<span id="graph-namespaces-bad-request-body"></span> GraphNamespacesBadRequestBody** 2013 2014 2015 2016 2017 2018 2019 **Properties** 2020 2021 | Name | Type | Go type | Required | Default | Description | Example | 2022 |------|------|---------|:--------:| ------- |-------------|---------| 2023 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 2024 | Message | string| `string` | | | | | 2025 2026 2027 2028 **<span id="graph-namespaces-internal-server-error-body"></span> GraphNamespacesInternalServerErrorBody** 2029 2030 2031 2032 2033 2034 2035 **Properties** 2036 2037 | Name | Type | Go type | Required | Default | Description | Example | 2038 |------|------|---------|:--------:| ------- |-------------|---------| 2039 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2040 | Message | string| `string` | | | | | 2041 2042 2043 2044 ### <span id="graph-service"></span> The backing JSON for a service node detail graph. (*graphService*) 2045 2046 ``` 2047 GET /api/namespaces/{namespace}/services/{service}/graph 2048 ``` 2049 2050 #### URI Schemes 2051 * http 2052 * https 2053 2054 #### Produces 2055 * application/json 2056 2057 #### Parameters 2058 2059 | Name | Source | Type | Go type | Separator | Required | Default | Description | 2060 |------|--------|------|---------|-----------| :------: |---------|-------------| 2061 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 2062 | service | `path` | string | `string` | | ✓ | | The service name. | 2063 | 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]. | 2064 | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | 2065 | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | 2066 | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | 2067 | graphType | `query` | string | `string` | | | `"workload"` | Graph type. Available graph types: [app, service, versionedApp, workload]. | 2068 | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | 2069 | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. response_messages) | requests | sent (i.e. request_messages) | total (i.e. sent+received). | 2070 | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | 2071 | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. received_bytes) | sent (i.e. sent_bytes) | total (i.e. sent+received). | 2072 | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | 2073 | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request | response. | 2074 2075 #### All responses 2076 | Code | Status | Description | Has headers | Schema | 2077 |------|--------|-------------|:-----------:|--------| 2078 | [200](#graph-service-200) | OK | HTTP status code 200 and cytoscapejs Config in data | | [schema](#graph-service-200-schema) | 2079 | [400](#graph-service-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#graph-service-400-schema) | 2080 | [500](#graph-service-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#graph-service-500-schema) | 2081 2082 #### Responses 2083 2084 2085 ##### <span id="graph-service-200"></span> 200 - HTTP status code 200 and cytoscapejs Config in data 2086 Status: OK 2087 2088 ###### <span id="graph-service-200-schema"></span> Schema 2089 2090 2091 2092 [Config](#config) 2093 2094 ##### <span id="graph-service-400"></span> 400 - BadRequestError: the client request is incorrect 2095 Status: Bad Request 2096 2097 ###### <span id="graph-service-400-schema"></span> Schema 2098 2099 2100 2101 [GraphServiceBadRequestBody](#graph-service-bad-request-body) 2102 2103 ##### <span id="graph-service-500"></span> 500 - A Internal is the error message that means something has gone wrong 2104 Status: Internal Server Error 2105 2106 ###### <span id="graph-service-500-schema"></span> Schema 2107 2108 2109 2110 [GraphServiceInternalServerErrorBody](#graph-service-internal-server-error-body) 2111 2112 ###### Inlined models 2113 2114 **<span id="graph-service-bad-request-body"></span> GraphServiceBadRequestBody** 2115 2116 2117 2118 2119 2120 2121 **Properties** 2122 2123 | Name | Type | Go type | Required | Default | Description | Example | 2124 |------|------|---------|:--------:| ------- |-------------|---------| 2125 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 2126 | Message | string| `string` | | | | | 2127 2128 2129 2130 **<span id="graph-service-internal-server-error-body"></span> GraphServiceInternalServerErrorBody** 2131 2132 2133 2134 2135 2136 2137 **Properties** 2138 2139 | Name | Type | Go type | Required | Default | Description | Example | 2140 |------|------|---------|:--------:| ------- |-------------|---------| 2141 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2142 | Message | string| `string` | | | | | 2143 2144 2145 2146 ### <span id="graph-workload"></span> The backing JSON for a workload node detail graph. (*graphWorkload*) 2147 2148 ``` 2149 GET /api/namespaces/{namespace}/workloads/{workload}/graph 2150 ``` 2151 2152 #### URI Schemes 2153 * http 2154 * https 2155 2156 #### Produces 2157 * application/json 2158 2159 #### Parameters 2160 2161 | Name | Source | Type | Go type | Separator | Required | Default | Description | 2162 |------|--------|------|---------|-----------| :------: |---------|-------------| 2163 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 2164 | workload | `path` | string | `string` | | ✓ | | The workload name. | 2165 | 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]. | 2166 | boxBy | `query` | string | `string` | | | | Comma-separated list of desired node boxing. Available boxings: [app, cluster, namespace]. | 2167 | container | `query` | string | `string` | | | | The cluster name. If not supplied queries/results will not be constrained by cluster. | 2168 | duration | `query` | string | `string` | | | `"10m"` | Query time-range duration (Golang string duration). | 2169 | graphType | `query` | string | `string` | | | `"workload"` | Graph type. Available graph types: [app, service, versionedApp, workload]. | 2170 | includeIdleEdges | `query` | string | `string` | | | `"false"` | Flag for including edges that have no request traffic for the time period. | 2171 | injectServiceNodes | `query` | string | `string` | | | `"false"` | Flag for injecting the requested service node between source and destination nodes. | 2172 | queryTime | `query` | string | `string` | | | `"now"` | Unix time (seconds) for query such that time range is [queryTime-duration..queryTime]. Default is now. | 2173 | rateGrpc | `query` | string | `string` | | | `"requests"` | How to calculate gRPC traffic rate. One of: none | received (i.e. response_messages) | requests | sent (i.e. request_messages) | total (i.e. sent+received). | 2174 | rateHttp | `query` | string | `string` | | | `"requests"` | How to calculate HTTP traffic rate. One of: none | requests. | 2175 | rateTcp | `query` | string | `string` | | | `"sent"` | How to calculate TCP traffic rate. One of: none | received (i.e. received_bytes) | sent (i.e. sent_bytes) | total (i.e. sent+received). | 2176 | responseTime | `query` | string | `string` | | | `"95"` | Used only with responseTime appender. One of: avg | 50 | 95 | 99. | 2177 | throughput | `query` | string | `string` | | | `"request"` | Used only with throughput appender. One of: request | response. | 2178 2179 #### All responses 2180 | Code | Status | Description | Has headers | Schema | 2181 |------|--------|-------------|:-----------:|--------| 2182 | [200](#graph-workload-200) | OK | HTTP status code 200 and cytoscapejs Config in data | | [schema](#graph-workload-200-schema) | 2183 | [400](#graph-workload-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#graph-workload-400-schema) | 2184 | [500](#graph-workload-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#graph-workload-500-schema) | 2185 2186 #### Responses 2187 2188 2189 ##### <span id="graph-workload-200"></span> 200 - HTTP status code 200 and cytoscapejs Config in data 2190 Status: OK 2191 2192 ###### <span id="graph-workload-200-schema"></span> Schema 2193 2194 2195 2196 [Config](#config) 2197 2198 ##### <span id="graph-workload-400"></span> 400 - BadRequestError: the client request is incorrect 2199 Status: Bad Request 2200 2201 ###### <span id="graph-workload-400-schema"></span> Schema 2202 2203 2204 2205 [GraphWorkloadBadRequestBody](#graph-workload-bad-request-body) 2206 2207 ##### <span id="graph-workload-500"></span> 500 - A Internal is the error message that means something has gone wrong 2208 Status: Internal Server Error 2209 2210 ###### <span id="graph-workload-500-schema"></span> Schema 2211 2212 2213 2214 [GraphWorkloadInternalServerErrorBody](#graph-workload-internal-server-error-body) 2215 2216 ###### Inlined models 2217 2218 **<span id="graph-workload-bad-request-body"></span> GraphWorkloadBadRequestBody** 2219 2220 2221 2222 2223 2224 2225 **Properties** 2226 2227 | Name | Type | Go type | Required | Default | Description | Example | 2228 |------|------|---------|:--------:| ------- |-------------|---------| 2229 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 2230 | Message | string| `string` | | | | | 2231 2232 2233 2234 **<span id="graph-workload-internal-server-error-body"></span> GraphWorkloadInternalServerErrorBody** 2235 2236 2237 2238 2239 2240 2241 **Properties** 2242 2243 | Name | Type | Go type | Required | Default | Description | Example | 2244 |------|------|---------|:--------:| ------- |-------------|---------| 2245 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2246 | Message | string| `string` | | | | | 2247 2248 2249 2250 ### <span id="healthz"></span> healthz (*healthz*) 2251 2252 ``` 2253 GET /api/healthz 2254 ``` 2255 2256 Endpoint to get the health of Kiali 2257 2258 #### URI Schemes 2259 * http 2260 * https 2261 2262 #### Produces 2263 * application/json 2264 2265 #### All responses 2266 | Code | Status | Description | Has headers | Schema | 2267 |------|--------|-------------|:-----------:|--------| 2268 | [500](#healthz-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#healthz-500-schema) | 2269 2270 #### Responses 2271 2272 2273 ##### <span id="healthz-500"></span> 500 - A Internal is the error message that means something has gone wrong 2274 Status: Internal Server Error 2275 2276 ###### <span id="healthz-500-schema"></span> Schema 2277 2278 2279 2280 [HealthzInternalServerErrorBody](#healthz-internal-server-error-body) 2281 2282 ###### Inlined models 2283 2284 **<span id="healthz-internal-server-error-body"></span> HealthzInternalServerErrorBody** 2285 2286 2287 2288 2289 2290 2291 **Properties** 2292 2293 | Name | Type | Go type | Required | Default | Description | Example | 2294 |------|------|---------|:--------:| ------- |-------------|---------| 2295 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2296 | Message | string| `string` | | | | | 2297 2298 2299 2300 ### <span id="istio-certs"></span> istio certs (*istioCerts*) 2301 2302 ``` 2303 GET /api/istio/certs 2304 ``` 2305 2306 Get certificates (internal) information used by Istio 2307 2308 #### URI Schemes 2309 * http 2310 * https 2311 2312 #### Produces 2313 * application/json 2314 2315 #### All responses 2316 | Code | Status | Description | Has headers | Schema | 2317 |------|--------|-------------|:-----------:|--------| 2318 | [200](#istio-certs-200) | OK | Return a list of certificates information | | [schema](#istio-certs-200-schema) | 2319 | [500](#istio-certs-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-certs-500-schema) | 2320 2321 #### Responses 2322 2323 2324 ##### <span id="istio-certs-200"></span> 200 - Return a list of certificates information 2325 Status: OK 2326 2327 ###### <span id="istio-certs-200-schema"></span> Schema 2328 2329 2330 2331 [][CertInfo](#cert-info) 2332 2333 ##### <span id="istio-certs-500"></span> 500 - A Internal is the error message that means something has gone wrong 2334 Status: Internal Server Error 2335 2336 ###### <span id="istio-certs-500-schema"></span> Schema 2337 2338 2339 2340 [IstioCertsInternalServerErrorBody](#istio-certs-internal-server-error-body) 2341 2342 ###### Inlined models 2343 2344 **<span id="istio-certs-internal-server-error-body"></span> IstioCertsInternalServerErrorBody** 2345 2346 2347 2348 2349 2350 2351 **Properties** 2352 2353 | Name | Type | Go type | Required | Default | Description | Example | 2354 |------|------|---------|:--------:| ------- |-------------|---------| 2355 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2356 | Message | string| `string` | | | | | 2357 2358 2359 2360 ### <span id="istio-config-create"></span> istio config create (*istioConfigCreate*) 2361 2362 ``` 2363 POST /api/namespaces/{namespace}/istio/{object_type} 2364 ``` 2365 2366 Endpoint to create an Istio object by using an Istio Config item 2367 2368 #### URI Schemes 2369 * http 2370 * https 2371 2372 #### Produces 2373 * application/json 2374 2375 #### Parameters 2376 2377 | Name | Source | Type | Go type | Separator | Required | Default | Description | 2378 |------|--------|------|---------|-----------| :------: |---------|-------------| 2379 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 2380 | object_type | `path` | string | `string` | | ✓ | | The Istio object type. | 2381 2382 #### All responses 2383 | Code | Status | Description | Has headers | Schema | 2384 |------|--------|-------------|:-----------:|--------| 2385 | [200](#istio-config-create-200) | OK | IstioConfig details of an specific Istio Object | | [schema](#istio-config-create-200-schema) | 2386 | [201](#istio-config-create-201) | Created | IstioConfig details of an specific Istio Object | | [schema](#istio-config-create-201-schema) | 2387 | [404](#istio-config-create-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#istio-config-create-404-schema) | 2388 | [500](#istio-config-create-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-config-create-500-schema) | 2389 2390 #### Responses 2391 2392 2393 ##### <span id="istio-config-create-200"></span> 200 - IstioConfig details of an specific Istio Object 2394 Status: OK 2395 2396 ###### <span id="istio-config-create-200-schema"></span> Schema 2397 2398 2399 2400 [IstioConfigDetails](#istio-config-details) 2401 2402 ##### <span id="istio-config-create-201"></span> 201 - IstioConfig details of an specific Istio Object 2403 Status: Created 2404 2405 ###### <span id="istio-config-create-201-schema"></span> Schema 2406 2407 2408 2409 [IstioConfigDetails](#istio-config-details) 2410 2411 ##### <span id="istio-config-create-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 2412 Status: Not Found 2413 2414 ###### <span id="istio-config-create-404-schema"></span> Schema 2415 2416 2417 2418 [IstioConfigCreateNotFoundBody](#istio-config-create-not-found-body) 2419 2420 ##### <span id="istio-config-create-500"></span> 500 - A Internal is the error message that means something has gone wrong 2421 Status: Internal Server Error 2422 2423 ###### <span id="istio-config-create-500-schema"></span> Schema 2424 2425 2426 2427 [IstioConfigCreateInternalServerErrorBody](#istio-config-create-internal-server-error-body) 2428 2429 ###### Inlined models 2430 2431 **<span id="istio-config-create-internal-server-error-body"></span> IstioConfigCreateInternalServerErrorBody** 2432 2433 2434 2435 2436 2437 2438 **Properties** 2439 2440 | Name | Type | Go type | Required | Default | Description | Example | 2441 |------|------|---------|:--------:| ------- |-------------|---------| 2442 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2443 | Message | string| `string` | | | | | 2444 2445 2446 2447 **<span id="istio-config-create-not-found-body"></span> IstioConfigCreateNotFoundBody** 2448 2449 2450 2451 2452 2453 2454 **Properties** 2455 2456 | Name | Type | Go type | Required | Default | Description | Example | 2457 |------|------|---------|:--------:| ------- |-------------|---------| 2458 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 2459 | Message | string| `string` | | | | | 2460 2461 2462 2463 ### <span id="istio-config-delete"></span> istio config delete (*istioConfigDelete*) 2464 2465 ``` 2466 DELETE /api/namespaces/{namespace}/istio/{object_type}/{object} 2467 ``` 2468 2469 Endpoint to delete the Istio Config of an (arbitrary) Istio object 2470 2471 #### URI Schemes 2472 * http 2473 * https 2474 2475 #### Produces 2476 * application/json 2477 2478 #### Parameters 2479 2480 | Name | Source | Type | Go type | Separator | Required | Default | Description | 2481 |------|--------|------|---------|-----------| :------: |---------|-------------| 2482 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 2483 | object | `path` | string | `string` | | ✓ | | The Istio object name. | 2484 | object_type | `path` | string | `string` | | ✓ | | The Istio object type. | 2485 2486 #### All responses 2487 | Code | Status | Description | Has headers | Schema | 2488 |------|--------|-------------|:-----------:|--------| 2489 | [404](#istio-config-delete-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#istio-config-delete-404-schema) | 2490 | [500](#istio-config-delete-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-config-delete-500-schema) | 2491 2492 #### Responses 2493 2494 2495 ##### <span id="istio-config-delete-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 2496 Status: Not Found 2497 2498 ###### <span id="istio-config-delete-404-schema"></span> Schema 2499 2500 2501 2502 [IstioConfigDeleteNotFoundBody](#istio-config-delete-not-found-body) 2503 2504 ##### <span id="istio-config-delete-500"></span> 500 - A Internal is the error message that means something has gone wrong 2505 Status: Internal Server Error 2506 2507 ###### <span id="istio-config-delete-500-schema"></span> Schema 2508 2509 2510 2511 [IstioConfigDeleteInternalServerErrorBody](#istio-config-delete-internal-server-error-body) 2512 2513 ###### Inlined models 2514 2515 **<span id="istio-config-delete-internal-server-error-body"></span> IstioConfigDeleteInternalServerErrorBody** 2516 2517 2518 2519 2520 2521 2522 **Properties** 2523 2524 | Name | Type | Go type | Required | Default | Description | Example | 2525 |------|------|---------|:--------:| ------- |-------------|---------| 2526 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2527 | Message | string| `string` | | | | | 2528 2529 2530 2531 **<span id="istio-config-delete-not-found-body"></span> IstioConfigDeleteNotFoundBody** 2532 2533 2534 2535 2536 2537 2538 **Properties** 2539 2540 | Name | Type | Go type | Required | Default | Description | Example | 2541 |------|------|---------|:--------:| ------- |-------------|---------| 2542 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 2543 | Message | string| `string` | | | | | 2544 2545 2546 2547 ### <span id="istio-config-details"></span> istio config details (*istioConfigDetails*) 2548 2549 ``` 2550 GET /api/namespaces/{namespace}/istio/{object_type}/{object} 2551 ``` 2552 2553 Endpoint to get the Istio Config of an Istio object 2554 2555 #### URI Schemes 2556 * http 2557 * https 2558 2559 #### Produces 2560 * application/json 2561 2562 #### Parameters 2563 2564 | Name | Source | Type | Go type | Separator | Required | Default | Description | 2565 |------|--------|------|---------|-----------| :------: |---------|-------------| 2566 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 2567 | object | `path` | string | `string` | | ✓ | | The Istio object name. | 2568 | object_type | `path` | string | `string` | | ✓ | | The Istio object type. | 2569 | validate | `query` | string | `string` | | | | Enable validation or not | 2570 2571 #### All responses 2572 | Code | Status | Description | Has headers | Schema | 2573 |------|--------|-------------|:-----------:|--------| 2574 | [200](#istio-config-details-200) | OK | IstioConfig details of an specific Istio Object | | [schema](#istio-config-details-200-schema) | 2575 | [400](#istio-config-details-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#istio-config-details-400-schema) | 2576 | [404](#istio-config-details-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#istio-config-details-404-schema) | 2577 | [500](#istio-config-details-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-config-details-500-schema) | 2578 2579 #### Responses 2580 2581 2582 ##### <span id="istio-config-details-200"></span> 200 - IstioConfig details of an specific Istio Object 2583 Status: OK 2584 2585 ###### <span id="istio-config-details-200-schema"></span> Schema 2586 2587 2588 2589 [IstioConfigDetails](#istio-config-details) 2590 2591 ##### <span id="istio-config-details-400"></span> 400 - BadRequestError: the client request is incorrect 2592 Status: Bad Request 2593 2594 ###### <span id="istio-config-details-400-schema"></span> Schema 2595 2596 2597 2598 [IstioConfigDetailsBadRequestBody](#istio-config-details-bad-request-body) 2599 2600 ##### <span id="istio-config-details-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 2601 Status: Not Found 2602 2603 ###### <span id="istio-config-details-404-schema"></span> Schema 2604 2605 2606 2607 [IstioConfigDetailsNotFoundBody](#istio-config-details-not-found-body) 2608 2609 ##### <span id="istio-config-details-500"></span> 500 - A Internal is the error message that means something has gone wrong 2610 Status: Internal Server Error 2611 2612 ###### <span id="istio-config-details-500-schema"></span> Schema 2613 2614 2615 2616 [IstioConfigDetailsInternalServerErrorBody](#istio-config-details-internal-server-error-body) 2617 2618 ###### Inlined models 2619 2620 **<span id="istio-config-details-bad-request-body"></span> IstioConfigDetailsBadRequestBody** 2621 2622 2623 2624 2625 2626 2627 **Properties** 2628 2629 | Name | Type | Go type | Required | Default | Description | Example | 2630 |------|------|---------|:--------:| ------- |-------------|---------| 2631 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 2632 | Message | string| `string` | | | | | 2633 2634 2635 2636 **<span id="istio-config-details-internal-server-error-body"></span> IstioConfigDetailsInternalServerErrorBody** 2637 2638 2639 2640 2641 2642 2643 **Properties** 2644 2645 | Name | Type | Go type | Required | Default | Description | Example | 2646 |------|------|---------|:--------:| ------- |-------------|---------| 2647 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2648 | Message | string| `string` | | | | | 2649 2650 2651 2652 **<span id="istio-config-details-not-found-body"></span> IstioConfigDetailsNotFoundBody** 2653 2654 2655 2656 2657 2658 2659 **Properties** 2660 2661 | Name | Type | Go type | Required | Default | Description | Example | 2662 |------|------|---------|:--------:| ------- |-------------|---------| 2663 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 2664 | Message | string| `string` | | | | | 2665 2666 2667 2668 ### <span id="istio-config-list"></span> istio config list (*istioConfigList*) 2669 2670 ``` 2671 GET /api/namespaces/{namespace}/istio 2672 ``` 2673 2674 Endpoint to get the list of Istio Config of a namespace 2675 2676 #### URI Schemes 2677 * http 2678 * https 2679 2680 #### Produces 2681 * application/json 2682 2683 #### Parameters 2684 2685 | Name | Source | Type | Go type | Separator | Required | Default | Description | 2686 |------|--------|------|---------|-----------| :------: |---------|-------------| 2687 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 2688 | validate | `query` | string | `string` | | | | Enable validation or not | 2689 2690 #### All responses 2691 | Code | Status | Description | Has headers | Schema | 2692 |------|--------|-------------|:-----------:|--------| 2693 | [200](#istio-config-list-200) | OK | HTTP status code 200 and IstioConfigList model in data | | [schema](#istio-config-list-200-schema) | 2694 | [500](#istio-config-list-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-config-list-500-schema) | 2695 2696 #### Responses 2697 2698 2699 ##### <span id="istio-config-list-200"></span> 200 - HTTP status code 200 and IstioConfigList model in data 2700 Status: OK 2701 2702 ###### <span id="istio-config-list-200-schema"></span> Schema 2703 2704 2705 2706 [IstioConfigList](#istio-config-list) 2707 2708 ##### <span id="istio-config-list-500"></span> 500 - A Internal is the error message that means something has gone wrong 2709 Status: Internal Server Error 2710 2711 ###### <span id="istio-config-list-500-schema"></span> Schema 2712 2713 2714 2715 [IstioConfigListInternalServerErrorBody](#istio-config-list-internal-server-error-body) 2716 2717 ###### Inlined models 2718 2719 **<span id="istio-config-list-internal-server-error-body"></span> IstioConfigListInternalServerErrorBody** 2720 2721 2722 2723 2724 2725 2726 **Properties** 2727 2728 | Name | Type | Go type | Required | Default | Description | Example | 2729 |------|------|---------|:--------:| ------- |-------------|---------| 2730 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2731 | Message | string| `string` | | | | | 2732 2733 2734 2735 ### <span id="istio-config-list-all"></span> istio config list all (*istioConfigListAll*) 2736 2737 ``` 2738 GET /api/istio 2739 ``` 2740 2741 Endpoint to get the list of Istio Config of all namespaces 2742 2743 #### URI Schemes 2744 * http 2745 * https 2746 2747 #### Produces 2748 * application/json 2749 2750 #### All responses 2751 | Code | Status | Description | Has headers | Schema | 2752 |------|--------|-------------|:-----------:|--------| 2753 | [200](#istio-config-list-all-200) | OK | HTTP status code 200 and IstioConfigList model in data | | [schema](#istio-config-list-all-200-schema) | 2754 | [500](#istio-config-list-all-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-config-list-all-500-schema) | 2755 2756 #### Responses 2757 2758 2759 ##### <span id="istio-config-list-all-200"></span> 200 - HTTP status code 200 and IstioConfigList model in data 2760 Status: OK 2761 2762 ###### <span id="istio-config-list-all-200-schema"></span> Schema 2763 2764 2765 2766 [IstioConfigList](#istio-config-list) 2767 2768 ##### <span id="istio-config-list-all-500"></span> 500 - A Internal is the error message that means something has gone wrong 2769 Status: Internal Server Error 2770 2771 ###### <span id="istio-config-list-all-500-schema"></span> Schema 2772 2773 2774 2775 [IstioConfigListAllInternalServerErrorBody](#istio-config-list-all-internal-server-error-body) 2776 2777 ###### Inlined models 2778 2779 **<span id="istio-config-list-all-internal-server-error-body"></span> IstioConfigListAllInternalServerErrorBody** 2780 2781 2782 2783 2784 2785 2786 **Properties** 2787 2788 | Name | Type | Go type | Required | Default | Description | Example | 2789 |------|------|---------|:--------:| ------- |-------------|---------| 2790 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2791 | Message | string| `string` | | | | | 2792 2793 2794 2795 ### <span id="istio-config-update"></span> Endpoint to update the Istio Config of an Istio object used for templates and adapters using Json Merge Patch strategy. (*istioConfigUpdate*) 2796 2797 ``` 2798 PATCH /api/namespaces/{namespace}/istio/{object_type}/{object} 2799 ``` 2800 2801 #### URI Schemes 2802 * http 2803 * https 2804 2805 #### Consumes 2806 * application/json 2807 2808 #### Produces 2809 * application/json 2810 2811 #### Parameters 2812 2813 | Name | Source | Type | Go type | Separator | Required | Default | Description | 2814 |------|--------|------|---------|-----------| :------: |---------|-------------| 2815 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 2816 | object | `path` | string | `string` | | ✓ | | The Istio object name. | 2817 | object_type | `path` | string | `string` | | ✓ | | The Istio object type. | 2818 2819 #### All responses 2820 | Code | Status | Description | Has headers | Schema | 2821 |------|--------|-------------|:-----------:|--------| 2822 | [200](#istio-config-update-200) | OK | IstioConfig details of an specific Istio Object | | [schema](#istio-config-update-200-schema) | 2823 | [400](#istio-config-update-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#istio-config-update-400-schema) | 2824 | [404](#istio-config-update-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#istio-config-update-404-schema) | 2825 | [500](#istio-config-update-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-config-update-500-schema) | 2826 2827 #### Responses 2828 2829 2830 ##### <span id="istio-config-update-200"></span> 200 - IstioConfig details of an specific Istio Object 2831 Status: OK 2832 2833 ###### <span id="istio-config-update-200-schema"></span> Schema 2834 2835 2836 2837 [IstioConfigDetails](#istio-config-details) 2838 2839 ##### <span id="istio-config-update-400"></span> 400 - BadRequestError: the client request is incorrect 2840 Status: Bad Request 2841 2842 ###### <span id="istio-config-update-400-schema"></span> Schema 2843 2844 2845 2846 [IstioConfigUpdateBadRequestBody](#istio-config-update-bad-request-body) 2847 2848 ##### <span id="istio-config-update-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 2849 Status: Not Found 2850 2851 ###### <span id="istio-config-update-404-schema"></span> Schema 2852 2853 2854 2855 [IstioConfigUpdateNotFoundBody](#istio-config-update-not-found-body) 2856 2857 ##### <span id="istio-config-update-500"></span> 500 - A Internal is the error message that means something has gone wrong 2858 Status: Internal Server Error 2859 2860 ###### <span id="istio-config-update-500-schema"></span> Schema 2861 2862 2863 2864 [IstioConfigUpdateInternalServerErrorBody](#istio-config-update-internal-server-error-body) 2865 2866 ###### Inlined models 2867 2868 **<span id="istio-config-update-bad-request-body"></span> IstioConfigUpdateBadRequestBody** 2869 2870 2871 2872 2873 2874 2875 **Properties** 2876 2877 | Name | Type | Go type | Required | Default | Description | Example | 2878 |------|------|---------|:--------:| ------- |-------------|---------| 2879 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 2880 | Message | string| `string` | | | | | 2881 2882 2883 2884 **<span id="istio-config-update-internal-server-error-body"></span> IstioConfigUpdateInternalServerErrorBody** 2885 2886 2887 2888 2889 2890 2891 **Properties** 2892 2893 | Name | Type | Go type | Required | Default | Description | Example | 2894 |------|------|---------|:--------:| ------- |-------------|---------| 2895 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2896 | Message | string| `string` | | | | | 2897 2898 2899 2900 **<span id="istio-config-update-not-found-body"></span> IstioConfigUpdateNotFoundBody** 2901 2902 2903 2904 2905 2906 2907 **Properties** 2908 2909 | Name | Type | Go type | Required | Default | Description | Example | 2910 |------|------|---------|:--------:| ------- |-------------|---------| 2911 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 2912 | Message | string| `string` | | | | | 2913 2914 2915 2916 ### <span id="istio-status"></span> istio status (*istioStatus*) 2917 2918 ``` 2919 GET /api/istio/status 2920 ``` 2921 2922 Get the status of each components needed in the control plane 2923 2924 #### URI Schemes 2925 * http 2926 * https 2927 2928 #### Produces 2929 * application/json 2930 2931 #### All responses 2932 | Code | Status | Description | Has headers | Schema | 2933 |------|--------|-------------|:-----------:|--------| 2934 | [200](#istio-status-200) | OK | Return a list of Istio components along its status | | [schema](#istio-status-200-schema) | 2935 | [400](#istio-status-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#istio-status-400-schema) | 2936 | [500](#istio-status-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#istio-status-500-schema) | 2937 2938 #### Responses 2939 2940 2941 ##### <span id="istio-status-200"></span> 200 - Return a list of Istio components along its status 2942 Status: OK 2943 2944 ###### <span id="istio-status-200-schema"></span> Schema 2945 2946 2947 2948 2949 [IstioComponentStatus](#istio-component-status) 2950 2951 ##### <span id="istio-status-400"></span> 400 - BadRequestError: the client request is incorrect 2952 Status: Bad Request 2953 2954 ###### <span id="istio-status-400-schema"></span> Schema 2955 2956 2957 2958 [IstioStatusBadRequestBody](#istio-status-bad-request-body) 2959 2960 ##### <span id="istio-status-500"></span> 500 - A Internal is the error message that means something has gone wrong 2961 Status: Internal Server Error 2962 2963 ###### <span id="istio-status-500-schema"></span> Schema 2964 2965 2966 2967 [IstioStatusInternalServerErrorBody](#istio-status-internal-server-error-body) 2968 2969 ###### Inlined models 2970 2971 **<span id="istio-status-bad-request-body"></span> IstioStatusBadRequestBody** 2972 2973 2974 2975 2976 2977 2978 **Properties** 2979 2980 | Name | Type | Go type | Required | Default | Description | Example | 2981 |------|------|---------|:--------:| ------- |-------------|---------| 2982 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 2983 | Message | string| `string` | | | | | 2984 2985 2986 2987 **<span id="istio-status-internal-server-error-body"></span> IstioStatusInternalServerErrorBody** 2988 2989 2990 2991 2992 2993 2994 **Properties** 2995 2996 | Name | Type | Go type | Required | Default | Description | Example | 2997 |------|------|---------|:--------:| ------- |-------------|---------| 2998 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 2999 | Message | string| `string` | | | | | 3000 3001 3002 3003 ### <span id="jaeger-info"></span> jaeger info (*jaegerInfo*) 3004 3005 ``` 3006 GET /api/jaeger 3007 ``` 3008 3009 Get the jaeger URL and other descriptors 3010 3011 #### URI Schemes 3012 * http 3013 * https 3014 3015 #### Produces 3016 * application/json 3017 3018 #### All responses 3019 | Code | Status | Description | Has headers | Schema | 3020 |------|--------|-------------|:-----------:|--------| 3021 | [200](#jaeger-info-200) | OK | Return all the descriptor data related to Jaeger | | [schema](#jaeger-info-200-schema) | 3022 | [404](#jaeger-info-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#jaeger-info-404-schema) | 3023 | [406](#jaeger-info-406) | Not Acceptable | A NotAcceptable is the error message that means request can't be accepted | | [schema](#jaeger-info-406-schema) | 3024 3025 #### Responses 3026 3027 3028 ##### <span id="jaeger-info-200"></span> 200 - Return all the descriptor data related to Jaeger 3029 Status: OK 3030 3031 ###### <span id="jaeger-info-200-schema"></span> Schema 3032 3033 3034 3035 [TracingInfo](#jaeger-info) 3036 3037 ##### <span id="jaeger-info-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 3038 Status: Not Found 3039 3040 ###### <span id="jaeger-info-404-schema"></span> Schema 3041 3042 3043 3044 [JaegerInfoNotFoundBody](#jaeger-info-not-found-body) 3045 3046 ##### <span id="jaeger-info-406"></span> 406 - A NotAcceptable is the error message that means request can't be accepted 3047 Status: Not Acceptable 3048 3049 ###### <span id="jaeger-info-406-schema"></span> Schema 3050 3051 3052 3053 [JaegerInfoNotAcceptableBody](#jaeger-info-not-acceptable-body) 3054 3055 ###### Inlined models 3056 3057 **<span id="jaeger-info-not-acceptable-body"></span> JaegerInfoNotAcceptableBody** 3058 3059 3060 3061 3062 3063 3064 **Properties** 3065 3066 | Name | Type | Go type | Required | Default | Description | Example | 3067 |------|------|---------|:--------:| ------- |-------------|---------| 3068 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 3069 | Message | string| `string` | | | | | 3070 3071 3072 3073 **<span id="jaeger-info-not-found-body"></span> JaegerInfoNotFoundBody** 3074 3075 3076 3077 3078 3079 3080 **Properties** 3081 3082 | Name | Type | Go type | Required | Default | Description | Example | 3083 |------|------|---------|:--------:| ------- |-------------|---------| 3084 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 3085 | Message | string| `string` | | | | | 3086 3087 3088 3089 ### <span id="logout"></span> logout (*logout*) 3090 3091 ``` 3092 GET /api/logout 3093 ``` 3094 3095 Endpoint to logout an user (unset the session cookie) 3096 3097 #### URI Schemes 3098 * http 3099 * https 3100 3101 #### All responses 3102 | Code | Status | Description | Has headers | Schema | 3103 |------|--------|-------------|:-----------:|--------| 3104 | [204](#logout-204) | No Content | NoContent: the response is empty | | [schema](#logout-204-schema) | 3105 3106 #### Responses 3107 3108 3109 ##### <span id="logout-204"></span> 204 - NoContent: the response is empty 3110 Status: No Content 3111 3112 ###### <span id="logout-204-schema"></span> Schema 3113 3114 3115 3116 [LogoutNoContentBody](#logout-no-content-body) 3117 3118 ###### Inlined models 3119 3120 **<span id="logout-no-content-body"></span> LogoutNoContentBody** 3121 3122 3123 3124 3125 3126 3127 **Properties** 3128 3129 | Name | Type | Go type | Required | Default | Description | Example | 3130 |------|------|---------|:--------:| ------- |-------------|---------| 3131 | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | 3132 | Message | string| `string` | | | | | 3133 3134 3135 3136 ### <span id="mesh-tls"></span> mesh Tls (*meshTls*) 3137 3138 ``` 3139 GET /api/mesh/tls 3140 ``` 3141 3142 Get TLS status for the whole mesh 3143 3144 #### URI Schemes 3145 * http 3146 * https 3147 3148 #### Produces 3149 * application/json 3150 3151 #### All responses 3152 | Code | Status | Description | Has headers | Schema | 3153 |------|--------|-------------|:-----------:|--------| 3154 | [200](#mesh-tls-200) | OK | Return the mTLS status of the whole Mesh | | [schema](#mesh-tls-200-schema) | 3155 | [400](#mesh-tls-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#mesh-tls-400-schema) | 3156 | [500](#mesh-tls-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#mesh-tls-500-schema) | 3157 3158 #### Responses 3159 3160 3161 ##### <span id="mesh-tls-200"></span> 200 - Return the mTLS status of the whole Mesh 3162 Status: OK 3163 3164 ###### <span id="mesh-tls-200-schema"></span> Schema 3165 3166 3167 3168 [MTLSStatus](#m-tls-status) 3169 3170 ##### <span id="mesh-tls-400"></span> 400 - BadRequestError: the client request is incorrect 3171 Status: Bad Request 3172 3173 ###### <span id="mesh-tls-400-schema"></span> Schema 3174 3175 3176 3177 [MeshTLSBadRequestBody](#mesh-tls-bad-request-body) 3178 3179 ##### <span id="mesh-tls-500"></span> 500 - A Internal is the error message that means something has gone wrong 3180 Status: Internal Server Error 3181 3182 ###### <span id="mesh-tls-500-schema"></span> Schema 3183 3184 3185 3186 [MeshTLSInternalServerErrorBody](#mesh-tls-internal-server-error-body) 3187 3188 ###### Inlined models 3189 3190 **<span id="mesh-tls-bad-request-body"></span> MeshTLSBadRequestBody** 3191 3192 3193 3194 3195 3196 3197 **Properties** 3198 3199 | Name | Type | Go type | Required | Default | Description | Example | 3200 |------|------|---------|:--------:| ------- |-------------|---------| 3201 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3202 | Message | string| `string` | | | | | 3203 3204 3205 3206 **<span id="mesh-tls-internal-server-error-body"></span> MeshTLSInternalServerErrorBody** 3207 3208 3209 3210 3211 3212 3213 **Properties** 3214 3215 | Name | Type | Go type | Required | Default | Description | Example | 3216 |------|------|---------|:--------:| ------- |-------------|---------| 3217 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3218 | Message | string| `string` | | | | | 3219 3220 3221 3222 ### <span id="metrics-stats"></span> metrics stats (*metricsStats*) 3223 3224 ``` 3225 POST /api/stats/metrics 3226 ``` 3227 3228 Produces metrics statistics 3229 3230 #### URI Schemes 3231 * http 3232 * https 3233 3234 #### Produces 3235 * application/json 3236 3237 #### Parameters 3238 3239 | Name | Source | Type | Go type | Separator | Required | Default | Description | 3240 |------|--------|------|---------|-----------| :------: |---------|-------------| 3241 | Body | `body` | [MetricsStatsQueries](#metrics-stats-queries) | `models.MetricsStatsQueries` | | | | | 3242 3243 #### All responses 3244 | Code | Status | Description | Has headers | Schema | 3245 |------|--------|-------------|:-----------:|--------| 3246 | [200](#metrics-stats-200) | OK | Response of the metrics stats query | | [schema](#metrics-stats-200-schema) | 3247 | [400](#metrics-stats-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#metrics-stats-400-schema) | 3248 | [500](#metrics-stats-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#metrics-stats-500-schema) | 3249 | [503](#metrics-stats-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#metrics-stats-503-schema) | 3250 3251 #### Responses 3252 3253 3254 ##### <span id="metrics-stats-200"></span> 200 - Response of the metrics stats query 3255 Status: OK 3256 3257 ###### <span id="metrics-stats-200-schema"></span> Schema 3258 3259 3260 3261 [MetricsStats](#metrics-stats) 3262 3263 ##### <span id="metrics-stats-400"></span> 400 - BadRequestError: the client request is incorrect 3264 Status: Bad Request 3265 3266 ###### <span id="metrics-stats-400-schema"></span> Schema 3267 3268 3269 3270 [MetricsStatsBadRequestBody](#metrics-stats-bad-request-body) 3271 3272 ##### <span id="metrics-stats-500"></span> 500 - A Internal is the error message that means something has gone wrong 3273 Status: Internal Server Error 3274 3275 ###### <span id="metrics-stats-500-schema"></span> Schema 3276 3277 3278 3279 [MetricsStatsInternalServerErrorBody](#metrics-stats-internal-server-error-body) 3280 3281 ##### <span id="metrics-stats-503"></span> 503 - A Internal is the error message that means something has gone wrong 3282 Status: Service Unavailable 3283 3284 ###### <span id="metrics-stats-503-schema"></span> Schema 3285 3286 3287 3288 [MetricsStatsServiceUnavailableBody](#metrics-stats-service-unavailable-body) 3289 3290 ###### Inlined models 3291 3292 **<span id="metrics-stats-bad-request-body"></span> MetricsStatsBadRequestBody** 3293 3294 3295 3296 3297 3298 3299 **Properties** 3300 3301 | Name | Type | Go type | Required | Default | Description | Example | 3302 |------|------|---------|:--------:| ------- |-------------|---------| 3303 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3304 | Message | string| `string` | | | | | 3305 3306 3307 3308 **<span id="metrics-stats-internal-server-error-body"></span> MetricsStatsInternalServerErrorBody** 3309 3310 3311 3312 3313 3314 3315 **Properties** 3316 3317 | Name | Type | Go type | Required | Default | Description | Example | 3318 |------|------|---------|:--------:| ------- |-------------|---------| 3319 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3320 | Message | string| `string` | | | | | 3321 3322 3323 3324 **<span id="metrics-stats-service-unavailable-body"></span> MetricsStatsServiceUnavailableBody** 3325 3326 3327 3328 3329 3330 3331 **Properties** 3332 3333 | Name | Type | Go type | Required | Default | Description | Example | 3334 |------|------|---------|:--------:| ------- |-------------|---------| 3335 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 3336 | Message | string| `string` | | | | | 3337 3338 3339 3340 ### <span id="namespace-health"></span> namespace health (*namespaceHealth*) 3341 3342 ``` 3343 GET /api/namespaces/{namespace}/health 3344 ``` 3345 3346 Get health for all objects in the given namespace 3347 3348 #### URI Schemes 3349 * http 3350 * https 3351 3352 #### Produces 3353 * application/json 3354 3355 #### Parameters 3356 3357 | Name | Source | Type | Go type | Separator | Required | Default | Description | 3358 |------|--------|------|---------|-----------| :------: |---------|-------------| 3359 | namespace | `path` | string | `string` | | ✓ | | The namespace scope | 3360 | QueryTime | `query` | date-time (formatted string) | `strfmt.DateTime` | | | | The time to use for the prometheus query | 3361 | rateInterval | `query` | string | `string` | | | `"10m"` | The rate interval used for fetching error rate | 3362 | type | `query` | string | `string` | | | `"app"` | The type of health, "app", "service" or "workload". | 3363 3364 #### All responses 3365 | Code | Status | Description | Has headers | Schema | 3366 |------|--------|-------------|:-----------:|--------| 3367 | [200](#namespace-health-200) | OK | namespaceAppHealthResponse is a map of app name x health | | [schema](#namespace-health-200-schema) | 3368 | [400](#namespace-health-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#namespace-health-400-schema) | 3369 | [500](#namespace-health-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#namespace-health-500-schema) | 3370 3371 #### Responses 3372 3373 3374 ##### <span id="namespace-health-200"></span> 200 - namespaceAppHealthResponse is a map of app name x health 3375 Status: OK 3376 3377 ###### <span id="namespace-health-200-schema"></span> Schema 3378 3379 3380 3381 [NamespaceAppHealth](#namespace-app-health) 3382 3383 ##### <span id="namespace-health-400"></span> 400 - BadRequestError: the client request is incorrect 3384 Status: Bad Request 3385 3386 ###### <span id="namespace-health-400-schema"></span> Schema 3387 3388 3389 3390 [NamespaceHealthBadRequestBody](#namespace-health-bad-request-body) 3391 3392 ##### <span id="namespace-health-500"></span> 500 - A Internal is the error message that means something has gone wrong 3393 Status: Internal Server Error 3394 3395 ###### <span id="namespace-health-500-schema"></span> Schema 3396 3397 3398 3399 [NamespaceHealthInternalServerErrorBody](#namespace-health-internal-server-error-body) 3400 3401 ###### Inlined models 3402 3403 **<span id="namespace-health-bad-request-body"></span> NamespaceHealthBadRequestBody** 3404 3405 3406 3407 3408 3409 3410 **Properties** 3411 3412 | Name | Type | Go type | Required | Default | Description | Example | 3413 |------|------|---------|:--------:| ------- |-------------|---------| 3414 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3415 | Message | string| `string` | | | | | 3416 3417 3418 3419 **<span id="namespace-health-internal-server-error-body"></span> NamespaceHealthInternalServerErrorBody** 3420 3421 3422 3423 3424 3425 3426 **Properties** 3427 3428 | Name | Type | Go type | Required | Default | Description | Example | 3429 |------|------|---------|:--------:| ------- |-------------|---------| 3430 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3431 | Message | string| `string` | | | | | 3432 3433 3434 3435 ### <span id="namespace-list"></span> namespace list (*namespaceList*) 3436 3437 ``` 3438 GET /api/namespaces 3439 ``` 3440 3441 Endpoint to get the list of the available namespaces 3442 3443 #### URI Schemes 3444 * http 3445 * https 3446 3447 #### Produces 3448 * application/json 3449 3450 #### All responses 3451 | Code | Status | Description | Has headers | Schema | 3452 |------|--------|-------------|:-----------:|--------| 3453 | [200](#namespace-list-200) | OK | List of Namespaces | | [schema](#namespace-list-200-schema) | 3454 | [500](#namespace-list-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#namespace-list-500-schema) | 3455 3456 #### Responses 3457 3458 3459 ##### <span id="namespace-list-200"></span> 200 - List of Namespaces 3460 Status: OK 3461 3462 ###### <span id="namespace-list-200-schema"></span> Schema 3463 3464 3465 3466 [][Namespace](#namespace) 3467 3468 ##### <span id="namespace-list-500"></span> 500 - A Internal is the error message that means something has gone wrong 3469 Status: Internal Server Error 3470 3471 ###### <span id="namespace-list-500-schema"></span> Schema 3472 3473 3474 3475 [NamespaceListInternalServerErrorBody](#namespace-list-internal-server-error-body) 3476 3477 ###### Inlined models 3478 3479 **<span id="namespace-list-internal-server-error-body"></span> NamespaceListInternalServerErrorBody** 3480 3481 3482 3483 3484 3485 3486 **Properties** 3487 3488 | Name | Type | Go type | Required | Default | Description | Example | 3489 |------|------|---------|:--------:| ------- |-------------|---------| 3490 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3491 | Message | string| `string` | | | | | 3492 3493 3494 3495 ### <span id="namespace-metrics"></span> namespace metrics (*namespaceMetrics*) 3496 3497 ``` 3498 GET /api/namespaces/{namespace}/metrics 3499 ``` 3500 3501 Endpoint to fetch metrics to be displayed, related to a namespace 3502 3503 #### URI Schemes 3504 * http 3505 * https 3506 3507 #### Produces 3508 * application/json 3509 3510 #### Parameters 3511 3512 | Name | Source | Type | Go type | Separator | Required | Default | Description | 3513 |------|--------|------|---------|-----------| :------: |---------|-------------| 3514 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 3515 3516 #### All responses 3517 | Code | Status | Description | Has headers | Schema | 3518 |------|--------|-------------|:-----------:|--------| 3519 | [200](#namespace-metrics-200) | OK | Metrics response model | | [schema](#namespace-metrics-200-schema) | 3520 | [400](#namespace-metrics-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#namespace-metrics-400-schema) | 3521 | [503](#namespace-metrics-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#namespace-metrics-503-schema) | 3522 3523 #### Responses 3524 3525 3526 ##### <span id="namespace-metrics-200"></span> 200 - Metrics response model 3527 Status: OK 3528 3529 ###### <span id="namespace-metrics-200-schema"></span> Schema 3530 3531 3532 3533 map of [Metric](#metric) 3534 3535 ##### <span id="namespace-metrics-400"></span> 400 - BadRequestError: the client request is incorrect 3536 Status: Bad Request 3537 3538 ###### <span id="namespace-metrics-400-schema"></span> Schema 3539 3540 3541 3542 [NamespaceMetricsBadRequestBody](#namespace-metrics-bad-request-body) 3543 3544 ##### <span id="namespace-metrics-503"></span> 503 - A Internal is the error message that means something has gone wrong 3545 Status: Service Unavailable 3546 3547 ###### <span id="namespace-metrics-503-schema"></span> Schema 3548 3549 3550 3551 [NamespaceMetricsServiceUnavailableBody](#namespace-metrics-service-unavailable-body) 3552 3553 ###### Inlined models 3554 3555 **<span id="namespace-metrics-bad-request-body"></span> NamespaceMetricsBadRequestBody** 3556 3557 3558 3559 3560 3561 3562 **Properties** 3563 3564 | Name | Type | Go type | Required | Default | Description | Example | 3565 |------|------|---------|:--------:| ------- |-------------|---------| 3566 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3567 | Message | string| `string` | | | | | 3568 3569 3570 3571 **<span id="namespace-metrics-service-unavailable-body"></span> NamespaceMetricsServiceUnavailableBody** 3572 3573 3574 3575 3576 3577 3578 **Properties** 3579 3580 | Name | Type | Go type | Required | Default | Description | Example | 3581 |------|------|---------|:--------:| ------- |-------------|---------| 3582 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 3583 | Message | string| `string` | | | | | 3584 3585 3586 3587 ### <span id="namespace-tls"></span> namespace Tls (*namespaceTls*) 3588 3589 ``` 3590 GET /api/namespaces/{namespace}/tls 3591 ``` 3592 3593 Get TLS status for the given namespace 3594 3595 #### URI Schemes 3596 * http 3597 * https 3598 3599 #### Produces 3600 * application/json 3601 3602 #### Parameters 3603 3604 | Name | Source | Type | Go type | Separator | Required | Default | Description | 3605 |------|--------|------|---------|-----------| :------: |---------|-------------| 3606 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 3607 3608 #### All responses 3609 | Code | Status | Description | Has headers | Schema | 3610 |------|--------|-------------|:-----------:|--------| 3611 | [200](#namespace-tls-200) | OK | Return the mTLS status of a specific Namespace | | [schema](#namespace-tls-200-schema) | 3612 | [400](#namespace-tls-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#namespace-tls-400-schema) | 3613 | [500](#namespace-tls-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#namespace-tls-500-schema) | 3614 3615 #### Responses 3616 3617 3618 ##### <span id="namespace-tls-200"></span> 200 - Return the mTLS status of a specific Namespace 3619 Status: OK 3620 3621 ###### <span id="namespace-tls-200-schema"></span> Schema 3622 3623 3624 3625 [MTLSStatus](#m-tls-status) 3626 3627 ##### <span id="namespace-tls-400"></span> 400 - BadRequestError: the client request is incorrect 3628 Status: Bad Request 3629 3630 ###### <span id="namespace-tls-400-schema"></span> Schema 3631 3632 3633 3634 [NamespaceTLSBadRequestBody](#namespace-tls-bad-request-body) 3635 3636 ##### <span id="namespace-tls-500"></span> 500 - A Internal is the error message that means something has gone wrong 3637 Status: Internal Server Error 3638 3639 ###### <span id="namespace-tls-500-schema"></span> Schema 3640 3641 3642 3643 [NamespaceTLSInternalServerErrorBody](#namespace-tls-internal-server-error-body) 3644 3645 ###### Inlined models 3646 3647 **<span id="namespace-tls-bad-request-body"></span> NamespaceTLSBadRequestBody** 3648 3649 3650 3651 3652 3653 3654 **Properties** 3655 3656 | Name | Type | Go type | Required | Default | Description | Example | 3657 |------|------|---------|:--------:| ------- |-------------|---------| 3658 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3659 | Message | string| `string` | | | | | 3660 3661 3662 3663 **<span id="namespace-tls-internal-server-error-body"></span> NamespaceTLSInternalServerErrorBody** 3664 3665 3666 3667 3668 3669 3670 **Properties** 3671 3672 | Name | Type | Go type | Required | Default | Description | Example | 3673 |------|------|---------|:--------:| ------- |-------------|---------| 3674 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3675 | Message | string| `string` | | | | | 3676 3677 3678 3679 ### <span id="namespace-update"></span> Endpoint to update the Namespace configuration using Json Merge Patch strategy. (*namespaceUpdate*) 3680 3681 ``` 3682 PATCH /api/namespaces/{namespace} 3683 ``` 3684 3685 #### URI Schemes 3686 * http 3687 * https 3688 3689 #### Consumes 3690 * application/json 3691 3692 #### Produces 3693 * application/json 3694 3695 #### Parameters 3696 3697 | Name | Source | Type | Go type | Separator | Required | Default | Description | 3698 |------|--------|------|---------|-----------| :------: |---------|-------------| 3699 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 3700 3701 #### All responses 3702 | Code | Status | Description | Has headers | Schema | 3703 |------|--------|-------------|:-----------:|--------| 3704 | [200](#namespace-update-200) | OK | namespaceResponse is a basic namespace | | [schema](#namespace-update-200-schema) | 3705 | [400](#namespace-update-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#namespace-update-400-schema) | 3706 | [404](#namespace-update-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#namespace-update-404-schema) | 3707 | [500](#namespace-update-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#namespace-update-500-schema) | 3708 3709 #### Responses 3710 3711 3712 ##### <span id="namespace-update-200"></span> 200 - namespaceResponse is a basic namespace 3713 Status: OK 3714 3715 ###### <span id="namespace-update-200-schema"></span> Schema 3716 3717 3718 3719 [Namespace](#namespace) 3720 3721 ##### <span id="namespace-update-400"></span> 400 - BadRequestError: the client request is incorrect 3722 Status: Bad Request 3723 3724 ###### <span id="namespace-update-400-schema"></span> Schema 3725 3726 3727 3728 [NamespaceUpdateBadRequestBody](#namespace-update-bad-request-body) 3729 3730 ##### <span id="namespace-update-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 3731 Status: Not Found 3732 3733 ###### <span id="namespace-update-404-schema"></span> Schema 3734 3735 3736 3737 [NamespaceUpdateNotFoundBody](#namespace-update-not-found-body) 3738 3739 ##### <span id="namespace-update-500"></span> 500 - A Internal is the error message that means something has gone wrong 3740 Status: Internal Server Error 3741 3742 ###### <span id="namespace-update-500-schema"></span> Schema 3743 3744 3745 3746 [NamespaceUpdateInternalServerErrorBody](#namespace-update-internal-server-error-body) 3747 3748 ###### Inlined models 3749 3750 **<span id="namespace-update-bad-request-body"></span> NamespaceUpdateBadRequestBody** 3751 3752 3753 3754 3755 3756 3757 **Properties** 3758 3759 | Name | Type | Go type | Required | Default | Description | Example | 3760 |------|------|---------|:--------:| ------- |-------------|---------| 3761 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3762 | Message | string| `string` | | | | | 3763 3764 3765 3766 **<span id="namespace-update-internal-server-error-body"></span> NamespaceUpdateInternalServerErrorBody** 3767 3768 3769 3770 3771 3772 3773 **Properties** 3774 3775 | Name | Type | Go type | Required | Default | Description | Example | 3776 |------|------|---------|:--------:| ------- |-------------|---------| 3777 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3778 | Message | string| `string` | | | | | 3779 3780 3781 3782 **<span id="namespace-update-not-found-body"></span> NamespaceUpdateNotFoundBody** 3783 3784 3785 3786 3787 3788 3789 **Properties** 3790 3791 | Name | Type | Go type | Required | Default | Description | Example | 3792 |------|------|---------|:--------:| ------- |-------------|---------| 3793 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 3794 | Message | string| `string` | | | | | 3795 3796 3797 3798 ### <span id="namespace-validations"></span> namespace validations (*namespaceValidations*) 3799 3800 ``` 3801 GET /api/namespaces/{namespace}/validations 3802 ``` 3803 3804 Get validation summary for all objects in the given namespace 3805 3806 #### URI Schemes 3807 * http 3808 * https 3809 3810 #### Produces 3811 * application/json 3812 3813 #### Parameters 3814 3815 | Name | Source | Type | Go type | Separator | Required | Default | Description | 3816 |------|--------|------|---------|-----------| :------: |---------|-------------| 3817 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 3818 3819 #### All responses 3820 | Code | Status | Description | Has headers | Schema | 3821 |------|--------|-------------|:-----------:|--------| 3822 | [200](#namespace-validations-200) | OK | Return the validation status of a specific Namespace | | [schema](#namespace-validations-200-schema) | 3823 | [400](#namespace-validations-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#namespace-validations-400-schema) | 3824 | [500](#namespace-validations-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#namespace-validations-500-schema) | 3825 3826 #### Responses 3827 3828 3829 ##### <span id="namespace-validations-200"></span> 200 - Return the validation status of a specific Namespace 3830 Status: OK 3831 3832 ###### <span id="namespace-validations-200-schema"></span> Schema 3833 3834 3835 3836 [IstioValidationSummary](#istio-validation-summary) 3837 3838 ##### <span id="namespace-validations-400"></span> 400 - BadRequestError: the client request is incorrect 3839 Status: Bad Request 3840 3841 ###### <span id="namespace-validations-400-schema"></span> Schema 3842 3843 3844 3845 [NamespaceValidationsBadRequestBody](#namespace-validations-bad-request-body) 3846 3847 ##### <span id="namespace-validations-500"></span> 500 - A Internal is the error message that means something has gone wrong 3848 Status: Internal Server Error 3849 3850 ###### <span id="namespace-validations-500-schema"></span> Schema 3851 3852 3853 3854 [NamespaceValidationsInternalServerErrorBody](#namespace-validations-internal-server-error-body) 3855 3856 ###### Inlined models 3857 3858 **<span id="namespace-validations-bad-request-body"></span> NamespaceValidationsBadRequestBody** 3859 3860 3861 3862 3863 3864 3865 **Properties** 3866 3867 | Name | Type | Go type | Required | Default | Description | Example | 3868 |------|------|---------|:--------:| ------- |-------------|---------| 3869 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3870 | Message | string| `string` | | | | | 3871 3872 3873 3874 **<span id="namespace-validations-internal-server-error-body"></span> NamespaceValidationsInternalServerErrorBody** 3875 3876 3877 3878 3879 3880 3881 **Properties** 3882 3883 | Name | Type | Go type | Required | Default | Description | Example | 3884 |------|------|---------|:--------:| ------- |-------------|---------| 3885 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3886 | Message | string| `string` | | | | | 3887 3888 3889 3890 ### <span id="namespaces-validations"></span> namespaces validations (*namespacesValidations*) 3891 3892 ``` 3893 GET /api/istio/validations 3894 ``` 3895 3896 Get validation summary for all objects in the given namespaces 3897 3898 #### URI Schemes 3899 * http 3900 * https 3901 3902 #### Produces 3903 * application/json 3904 3905 #### All responses 3906 | Code | Status | Description | Has headers | Schema | 3907 |------|--------|-------------|:-----------:|--------| 3908 | [200](#namespaces-validations-200) | OK | Return the validation status of a specific Namespace | | [schema](#namespaces-validations-200-schema) | 3909 | [400](#namespaces-validations-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#namespaces-validations-400-schema) | 3910 | [500](#namespaces-validations-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#namespaces-validations-500-schema) | 3911 3912 #### Responses 3913 3914 3915 ##### <span id="namespaces-validations-200"></span> 200 - Return the validation status of a specific Namespace 3916 Status: OK 3917 3918 ###### <span id="namespaces-validations-200-schema"></span> Schema 3919 3920 3921 3922 [IstioValidationSummary](#istio-validation-summary) 3923 3924 ##### <span id="namespaces-validations-400"></span> 400 - BadRequestError: the client request is incorrect 3925 Status: Bad Request 3926 3927 ###### <span id="namespaces-validations-400-schema"></span> Schema 3928 3929 3930 3931 [NamespacesValidationsBadRequestBody](#namespaces-validations-bad-request-body) 3932 3933 ##### <span id="namespaces-validations-500"></span> 500 - A Internal is the error message that means something has gone wrong 3934 Status: Internal Server Error 3935 3936 ###### <span id="namespaces-validations-500-schema"></span> Schema 3937 3938 3939 3940 [NamespacesValidationsInternalServerErrorBody](#namespaces-validations-internal-server-error-body) 3941 3942 ###### Inlined models 3943 3944 **<span id="namespaces-validations-bad-request-body"></span> NamespacesValidationsBadRequestBody** 3945 3946 3947 3948 3949 3950 3951 **Properties** 3952 3953 | Name | Type | Go type | Required | Default | Description | Example | 3954 |------|------|---------|:--------:| ------- |-------------|---------| 3955 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 3956 | Message | string| `string` | | | | | 3957 3958 3959 3960 **<span id="namespaces-validations-internal-server-error-body"></span> NamespacesValidationsInternalServerErrorBody** 3961 3962 3963 3964 3965 3966 3967 **Properties** 3968 3969 | Name | Type | Go type | Required | Default | Description | Example | 3970 |------|------|---------|:--------:| ------- |-------------|---------| 3971 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 3972 | Message | string| `string` | | | | | 3973 3974 3975 3976 ### <span id="openid-redirect"></span> openid redirect (*openidRedirect*) 3977 3978 ``` 3979 GET /api/auth/openid_redirect 3980 ``` 3981 3982 Endpoint to redirect the browser of the user to the authentication 3983 endpoint of the configured OpenId provider. 3984 3985 #### URI Schemes 3986 * http 3987 * https 3988 3989 #### Consumes 3990 * application/json 3991 3992 #### Produces 3993 * application/html 3994 3995 #### All responses 3996 | Code | Status | Description | Has headers | Schema | 3997 |------|--------|-------------|:-----------:|--------| 3998 | [200](#openid-redirect-200) | OK | NoContent: the response is empty | | [schema](#openid-redirect-200-schema) | 3999 | [500](#openid-redirect-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#openid-redirect-500-schema) | 4000 4001 #### Responses 4002 4003 4004 ##### <span id="openid-redirect-200"></span> 200 - NoContent: the response is empty 4005 Status: OK 4006 4007 ###### <span id="openid-redirect-200-schema"></span> Schema 4008 4009 4010 4011 [OpenidRedirectOKBody](#openid-redirect-o-k-body) 4012 4013 ##### <span id="openid-redirect-500"></span> 500 - A Internal is the error message that means something has gone wrong 4014 Status: Internal Server Error 4015 4016 ###### <span id="openid-redirect-500-schema"></span> Schema 4017 4018 4019 4020 [OpenidRedirectInternalServerErrorBody](#openid-redirect-internal-server-error-body) 4021 4022 ###### Inlined models 4023 4024 **<span id="openid-redirect-internal-server-error-body"></span> OpenidRedirectInternalServerErrorBody** 4025 4026 4027 4028 4029 4030 4031 **Properties** 4032 4033 | Name | Type | Go type | Required | Default | Description | Example | 4034 |------|------|---------|:--------:| ------- |-------------|---------| 4035 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4036 | Message | string| `string` | | | | | 4037 4038 4039 4040 **<span id="openid-redirect-o-k-body"></span> OpenidRedirectOKBody** 4041 4042 4043 4044 4045 4046 4047 **Properties** 4048 4049 | Name | Type | Go type | Required | Default | Description | Example | 4050 |------|------|---------|:--------:| ------- |-------------|---------| 4051 | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | 4052 | Message | string| `string` | | | | | 4053 4054 4055 4056 ### <span id="openshift-check-token"></span> openshift check token (*openshiftCheckToken*) 4057 4058 ``` 4059 POST /api/authenticate 4060 ``` 4061 4062 Endpoint to check if a token from Openshift is working correctly 4063 4064 #### URI Schemes 4065 * http 4066 * https 4067 4068 #### Produces 4069 * application/json 4070 4071 #### All responses 4072 | Code | Status | Description | Has headers | Schema | 4073 |------|--------|-------------|:-----------:|--------| 4074 | [200](#openshift-check-token-200) | OK | HTTP status code 200 and userGenerated model in data | | [schema](#openshift-check-token-200-schema) | 4075 | [500](#openshift-check-token-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#openshift-check-token-500-schema) | 4076 4077 #### Responses 4078 4079 4080 ##### <span id="openshift-check-token-200"></span> 200 - HTTP status code 200 and userGenerated model in data 4081 Status: OK 4082 4083 ###### <span id="openshift-check-token-200-schema"></span> Schema 4084 4085 4086 4087 [UserSessionData](#user-session-data) 4088 4089 ##### <span id="openshift-check-token-500"></span> 500 - A Internal is the error message that means something has gone wrong 4090 Status: Internal Server Error 4091 4092 ###### <span id="openshift-check-token-500-schema"></span> Schema 4093 4094 4095 4096 [OpenshiftCheckTokenInternalServerErrorBody](#openshift-check-token-internal-server-error-body) 4097 4098 ###### Inlined models 4099 4100 **<span id="openshift-check-token-internal-server-error-body"></span> OpenshiftCheckTokenInternalServerErrorBody** 4101 4102 4103 4104 4105 4106 4107 **Properties** 4108 4109 | Name | Type | Go type | Required | Default | Description | Example | 4110 |------|------|---------|:--------:| ------- |-------------|---------| 4111 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4112 | Message | string| `string` | | | | | 4113 4114 4115 4116 ### <span id="pod-details"></span> pod details (*podDetails*) 4117 4118 ``` 4119 GET /api/namespaces/{namespace}/pods/{pod} 4120 ``` 4121 4122 Endpoint to get pod details 4123 4124 #### URI Schemes 4125 * http 4126 * https 4127 4128 #### Produces 4129 * application/json 4130 4131 #### Parameters 4132 4133 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4134 |------|--------|------|---------|-----------| :------: |---------|-------------| 4135 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4136 | pod | `path` | string | `string` | | ✓ | | The pod name. | 4137 4138 #### All responses 4139 | Code | Status | Description | Has headers | Schema | 4140 |------|--------|-------------|:-----------:|--------| 4141 | [200](#pod-details-200) | OK | Listing all the information related to a workload | | [schema](#pod-details-200-schema) | 4142 | [404](#pod-details-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#pod-details-404-schema) | 4143 | [500](#pod-details-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#pod-details-500-schema) | 4144 4145 #### Responses 4146 4147 4148 ##### <span id="pod-details-200"></span> 200 - Listing all the information related to a workload 4149 Status: OK 4150 4151 ###### <span id="pod-details-200-schema"></span> Schema 4152 4153 4154 4155 [Workload](#workload) 4156 4157 ##### <span id="pod-details-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 4158 Status: Not Found 4159 4160 ###### <span id="pod-details-404-schema"></span> Schema 4161 4162 4163 4164 [PodDetailsNotFoundBody](#pod-details-not-found-body) 4165 4166 ##### <span id="pod-details-500"></span> 500 - A Internal is the error message that means something has gone wrong 4167 Status: Internal Server Error 4168 4169 ###### <span id="pod-details-500-schema"></span> Schema 4170 4171 4172 4173 [PodDetailsInternalServerErrorBody](#pod-details-internal-server-error-body) 4174 4175 ###### Inlined models 4176 4177 **<span id="pod-details-internal-server-error-body"></span> PodDetailsInternalServerErrorBody** 4178 4179 4180 4181 4182 4183 4184 **Properties** 4185 4186 | Name | Type | Go type | Required | Default | Description | Example | 4187 |------|------|---------|:--------:| ------- |-------------|---------| 4188 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4189 | Message | string| `string` | | | | | 4190 4191 4192 4193 **<span id="pod-details-not-found-body"></span> PodDetailsNotFoundBody** 4194 4195 4196 4197 4198 4199 4200 **Properties** 4201 4202 | Name | Type | Go type | Required | Default | Description | Example | 4203 |------|------|---------|:--------:| ------- |-------------|---------| 4204 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 4205 | Message | string| `string` | | | | | 4206 4207 4208 4209 ### <span id="pod-logs"></span> pod logs (*podLogs*) 4210 4211 ``` 4212 GET /api/namespaces/{namespace}/pods/{pod}/logs 4213 ``` 4214 4215 Endpoint to get pod logs 4216 4217 #### URI Schemes 4218 * http 4219 * https 4220 4221 #### Produces 4222 * application/json 4223 4224 #### Parameters 4225 4226 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4227 |------|--------|------|---------|-----------| :------: |---------|-------------| 4228 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4229 | pod | `path` | string | `string` | | ✓ | | The pod name. | 4230 | container | `query` | string | `string` | | | | The pod container name. Optional for single-container pod. Otherwise required. | 4231 | duration | `query` | string | `string` | | | | Query time-range duration (Golang string duration). Duration starts on 4232 `sinceTime` if set, or the time for the first log message if not set. | 4233 | sinceTime | `query` | string | `string` | | | | The start time for fetching logs. UNIX time in seconds. Default is all logs. | 4234 4235 #### All responses 4236 | Code | Status | Description | Has headers | Schema | 4237 |------|--------|-------------|:-----------:|--------| 4238 | [200](#pod-logs-200) | OK | Listing all the information related to a workload | | [schema](#pod-logs-200-schema) | 4239 | [404](#pod-logs-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#pod-logs-404-schema) | 4240 | [500](#pod-logs-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#pod-logs-500-schema) | 4241 4242 #### Responses 4243 4244 4245 ##### <span id="pod-logs-200"></span> 200 - Listing all the information related to a workload 4246 Status: OK 4247 4248 ###### <span id="pod-logs-200-schema"></span> Schema 4249 4250 4251 4252 [Workload](#workload) 4253 4254 ##### <span id="pod-logs-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 4255 Status: Not Found 4256 4257 ###### <span id="pod-logs-404-schema"></span> Schema 4258 4259 4260 4261 [PodLogsNotFoundBody](#pod-logs-not-found-body) 4262 4263 ##### <span id="pod-logs-500"></span> 500 - A Internal is the error message that means something has gone wrong 4264 Status: Internal Server Error 4265 4266 ###### <span id="pod-logs-500-schema"></span> Schema 4267 4268 4269 4270 [PodLogsInternalServerErrorBody](#pod-logs-internal-server-error-body) 4271 4272 ###### Inlined models 4273 4274 **<span id="pod-logs-internal-server-error-body"></span> PodLogsInternalServerErrorBody** 4275 4276 4277 4278 4279 4280 4281 **Properties** 4282 4283 | Name | Type | Go type | Required | Default | Description | Example | 4284 |------|------|---------|:--------:| ------- |-------------|---------| 4285 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4286 | Message | string| `string` | | | | | 4287 4288 4289 4290 **<span id="pod-logs-not-found-body"></span> PodLogsNotFoundBody** 4291 4292 4293 4294 4295 4296 4297 **Properties** 4298 4299 | Name | Type | Go type | Required | Default | Description | Example | 4300 |------|------|---------|:--------:| ------- |-------------|---------| 4301 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 4302 | Message | string| `string` | | | | | 4303 4304 4305 4306 ### <span id="pod-proxy-dump"></span> pod proxy dump (*podProxyDump*) 4307 4308 ``` 4309 GET /api/namespaces/{namespace}/pods/{pod}/config_dump 4310 ``` 4311 4312 Endpoint to get pod proxy dump 4313 4314 #### URI Schemes 4315 * http 4316 * https 4317 4318 #### Produces 4319 * application/json 4320 4321 #### Parameters 4322 4323 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4324 |------|--------|------|---------|-----------| :------: |---------|-------------| 4325 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4326 | pod | `path` | string | `string` | | ✓ | | The pod name. | 4327 4328 #### All responses 4329 | Code | Status | Description | Has headers | Schema | 4330 |------|--------|-------------|:-----------:|--------| 4331 | [200](#pod-proxy-dump-200) | OK | Return a dump of the configuration of a given envoy proxy | | [schema](#pod-proxy-dump-200-schema) | 4332 | [404](#pod-proxy-dump-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#pod-proxy-dump-404-schema) | 4333 | [500](#pod-proxy-dump-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#pod-proxy-dump-500-schema) | 4334 4335 #### Responses 4336 4337 4338 ##### <span id="pod-proxy-dump-200"></span> 200 - Return a dump of the configuration of a given envoy proxy 4339 Status: OK 4340 4341 ###### <span id="pod-proxy-dump-200-schema"></span> Schema 4342 4343 4344 4345 [EnvoyProxyDump](#envoy-proxy-dump) 4346 4347 ##### <span id="pod-proxy-dump-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 4348 Status: Not Found 4349 4350 ###### <span id="pod-proxy-dump-404-schema"></span> Schema 4351 4352 4353 4354 [PodProxyDumpNotFoundBody](#pod-proxy-dump-not-found-body) 4355 4356 ##### <span id="pod-proxy-dump-500"></span> 500 - A Internal is the error message that means something has gone wrong 4357 Status: Internal Server Error 4358 4359 ###### <span id="pod-proxy-dump-500-schema"></span> Schema 4360 4361 4362 4363 [PodProxyDumpInternalServerErrorBody](#pod-proxy-dump-internal-server-error-body) 4364 4365 ###### Inlined models 4366 4367 **<span id="pod-proxy-dump-internal-server-error-body"></span> PodProxyDumpInternalServerErrorBody** 4368 4369 4370 4371 4372 4373 4374 **Properties** 4375 4376 | Name | Type | Go type | Required | Default | Description | Example | 4377 |------|------|---------|:--------:| ------- |-------------|---------| 4378 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4379 | Message | string| `string` | | | | | 4380 4381 4382 4383 **<span id="pod-proxy-dump-not-found-body"></span> PodProxyDumpNotFoundBody** 4384 4385 4386 4387 4388 4389 4390 **Properties** 4391 4392 | Name | Type | Go type | Required | Default | Description | Example | 4393 |------|------|---------|:--------:| ------- |-------------|---------| 4394 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 4395 | Message | string| `string` | | | | | 4396 4397 4398 4399 ### <span id="pod-proxy-logging"></span> pod proxy logging (*podProxyLogging*) 4400 4401 ``` 4402 POST /api/namespaces/{namespace}/pods/{pod}/logging 4403 ``` 4404 4405 Endpoint to set pod proxy log level 4406 4407 #### URI Schemes 4408 * http 4409 * https 4410 4411 #### Produces 4412 * application/json 4413 4414 #### Parameters 4415 4416 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4417 |------|--------|------|---------|-----------| :------: |---------|-------------| 4418 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4419 | pod | `path` | string | `string` | | ✓ | | The pod name. | 4420 | level | `query` | string | `string` | | ✓ | | The log level for the pod's proxy. 4421 off ProxyLogLevelOff 4422 trace ProxyLogLevelTrace 4423 debug ProxyLogLevelDebug 4424 info ProxyLogLevelInfo 4425 warning ProxyLogLevelWarning 4426 error ProxyLogLevelError 4427 critical ProxyLogLevelCritical | 4428 4429 #### All responses 4430 | Code | Status | Description | Has headers | Schema | 4431 |------|--------|-------------|:-----------:|--------| 4432 | [200](#pod-proxy-logging-200) | OK | NoContent: the response is empty | | [schema](#pod-proxy-logging-200-schema) | 4433 | [400](#pod-proxy-logging-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#pod-proxy-logging-400-schema) | 4434 | [404](#pod-proxy-logging-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#pod-proxy-logging-404-schema) | 4435 | [500](#pod-proxy-logging-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#pod-proxy-logging-500-schema) | 4436 4437 #### Responses 4438 4439 4440 ##### <span id="pod-proxy-logging-200"></span> 200 - NoContent: the response is empty 4441 Status: OK 4442 4443 ###### <span id="pod-proxy-logging-200-schema"></span> Schema 4444 4445 4446 4447 [PodProxyLoggingOKBody](#pod-proxy-logging-o-k-body) 4448 4449 ##### <span id="pod-proxy-logging-400"></span> 400 - BadRequestError: the client request is incorrect 4450 Status: Bad Request 4451 4452 ###### <span id="pod-proxy-logging-400-schema"></span> Schema 4453 4454 4455 4456 [PodProxyLoggingBadRequestBody](#pod-proxy-logging-bad-request-body) 4457 4458 ##### <span id="pod-proxy-logging-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 4459 Status: Not Found 4460 4461 ###### <span id="pod-proxy-logging-404-schema"></span> Schema 4462 4463 4464 4465 [PodProxyLoggingNotFoundBody](#pod-proxy-logging-not-found-body) 4466 4467 ##### <span id="pod-proxy-logging-500"></span> 500 - A Internal is the error message that means something has gone wrong 4468 Status: Internal Server Error 4469 4470 ###### <span id="pod-proxy-logging-500-schema"></span> Schema 4471 4472 4473 4474 [PodProxyLoggingInternalServerErrorBody](#pod-proxy-logging-internal-server-error-body) 4475 4476 ###### Inlined models 4477 4478 **<span id="pod-proxy-logging-bad-request-body"></span> PodProxyLoggingBadRequestBody** 4479 4480 4481 4482 4483 4484 4485 **Properties** 4486 4487 | Name | Type | Go type | Required | Default | Description | Example | 4488 |------|------|---------|:--------:| ------- |-------------|---------| 4489 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 4490 | Message | string| `string` | | | | | 4491 4492 4493 4494 **<span id="pod-proxy-logging-internal-server-error-body"></span> PodProxyLoggingInternalServerErrorBody** 4495 4496 4497 4498 4499 4500 4501 **Properties** 4502 4503 | Name | Type | Go type | Required | Default | Description | Example | 4504 |------|------|---------|:--------:| ------- |-------------|---------| 4505 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4506 | Message | string| `string` | | | | | 4507 4508 4509 4510 **<span id="pod-proxy-logging-not-found-body"></span> PodProxyLoggingNotFoundBody** 4511 4512 4513 4514 4515 4516 4517 **Properties** 4518 4519 | Name | Type | Go type | Required | Default | Description | Example | 4520 |------|------|---------|:--------:| ------- |-------------|---------| 4521 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 4522 | Message | string| `string` | | | | | 4523 4524 4525 4526 **<span id="pod-proxy-logging-o-k-body"></span> PodProxyLoggingOKBody** 4527 4528 4529 4530 4531 4532 4533 **Properties** 4534 4535 | Name | Type | Go type | Required | Default | Description | Example | 4536 |------|------|---------|:--------:| ------- |-------------|---------| 4537 | Code | int32 (formatted integer)| `int32` | | `204`| HTTP status code | `204` | 4538 | Message | string| `string` | | | | | 4539 4540 4541 4542 ### <span id="pod-proxy-resource"></span> pod proxy resource (*podProxyResource*) 4543 4544 ``` 4545 GET /api/namespaces/{namespace}/pods/{pod}/config_dump/{resource} 4546 ``` 4547 4548 Endpoint to get pod logs 4549 4550 #### URI Schemes 4551 * http 4552 * https 4553 4554 #### Produces 4555 * application/json 4556 4557 #### Parameters 4558 4559 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4560 |------|--------|------|---------|-----------| :------: |---------|-------------| 4561 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4562 | pod | `path` | string | `string` | | ✓ | | The pod name. | 4563 | resource | `path` | string | `string` | | ✓ | | The discovery service resource | 4564 4565 #### All responses 4566 | Code | Status | Description | Has headers | Schema | 4567 |------|--------|-------------|:-----------:|--------| 4568 | [200](#pod-proxy-resource-200) | OK | Return a dump of the configuration of a given envoy proxy | | [schema](#pod-proxy-resource-200-schema) | 4569 | [404](#pod-proxy-resource-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#pod-proxy-resource-404-schema) | 4570 | [500](#pod-proxy-resource-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#pod-proxy-resource-500-schema) | 4571 4572 #### Responses 4573 4574 4575 ##### <span id="pod-proxy-resource-200"></span> 200 - Return a dump of the configuration of a given envoy proxy 4576 Status: OK 4577 4578 ###### <span id="pod-proxy-resource-200-schema"></span> Schema 4579 4580 4581 4582 any 4583 4584 ##### <span id="pod-proxy-resource-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 4585 Status: Not Found 4586 4587 ###### <span id="pod-proxy-resource-404-schema"></span> Schema 4588 4589 4590 4591 [PodProxyResourceNotFoundBody](#pod-proxy-resource-not-found-body) 4592 4593 ##### <span id="pod-proxy-resource-500"></span> 500 - A Internal is the error message that means something has gone wrong 4594 Status: Internal Server Error 4595 4596 ###### <span id="pod-proxy-resource-500-schema"></span> Schema 4597 4598 4599 4600 [PodProxyResourceInternalServerErrorBody](#pod-proxy-resource-internal-server-error-body) 4601 4602 ###### Inlined models 4603 4604 **<span id="pod-proxy-resource-internal-server-error-body"></span> PodProxyResourceInternalServerErrorBody** 4605 4606 4607 4608 4609 4610 4611 **Properties** 4612 4613 | Name | Type | Go type | Required | Default | Description | Example | 4614 |------|------|---------|:--------:| ------- |-------------|---------| 4615 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4616 | Message | string| `string` | | | | | 4617 4618 4619 4620 **<span id="pod-proxy-resource-not-found-body"></span> PodProxyResourceNotFoundBody** 4621 4622 4623 4624 4625 4626 4627 **Properties** 4628 4629 | Name | Type | Go type | Required | Default | Description | Example | 4630 |------|------|---------|:--------:| ------- |-------------|---------| 4631 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 4632 | Message | string| `string` | | | | | 4633 4634 4635 4636 ### <span id="root"></span> root (*root*) 4637 4638 ``` 4639 GET /api 4640 ``` 4641 4642 Endpoint to get the status of Kiali 4643 4644 #### URI Schemes 4645 * http 4646 * https 4647 4648 #### Produces 4649 * application/json 4650 4651 #### All responses 4652 | Code | Status | Description | Has headers | Schema | 4653 |------|--------|-------------|:-----------:|--------| 4654 | [200](#root-200) | OK | HTTP status code 200 and statusInfo model in data | | [schema](#root-200-schema) | 4655 | [500](#root-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#root-500-schema) | 4656 4657 #### Responses 4658 4659 4660 ##### <span id="root-200"></span> 200 - HTTP status code 200 and statusInfo model in data 4661 Status: OK 4662 4663 ###### <span id="root-200-schema"></span> Schema 4664 4665 4666 4667 [StatusInfo](#status-info) 4668 4669 ##### <span id="root-500"></span> 500 - A Internal is the error message that means something has gone wrong 4670 Status: Internal Server Error 4671 4672 ###### <span id="root-500-schema"></span> Schema 4673 4674 4675 4676 [RootInternalServerErrorBody](#root-internal-server-error-body) 4677 4678 ###### Inlined models 4679 4680 **<span id="root-internal-server-error-body"></span> RootInternalServerErrorBody** 4681 4682 4683 4684 4685 4686 4687 **Properties** 4688 4689 | Name | Type | Go type | Required | Default | Description | Example | 4690 |------|------|---------|:--------:| ------- |-------------|---------| 4691 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4692 | Message | string| `string` | | | | | 4693 4694 4695 4696 ### <span id="service-dashboard"></span> service dashboard (*serviceDashboard*) 4697 4698 ``` 4699 GET /api/namespaces/{namespace}/services/{service}/dashboard 4700 ``` 4701 4702 Endpoint to fetch dashboard to be displayed, related to a single service 4703 4704 #### URI Schemes 4705 * http 4706 * https 4707 4708 #### Produces 4709 * application/json 4710 4711 #### Parameters 4712 4713 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4714 |------|--------|------|---------|-----------| :------: |---------|-------------| 4715 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4716 | service | `path` | string | `string` | | ✓ | | The service name. | 4717 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 4718 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 4719 | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | 4720 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 4721 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 4722 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 4723 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 4724 | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | 4725 | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | 4726 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 4727 4728 #### All responses 4729 | Code | Status | Description | Has headers | Schema | 4730 |------|--------|-------------|:-----------:|--------| 4731 | [200](#service-dashboard-200) | OK | Dashboard response model | | [schema](#service-dashboard-200-schema) | 4732 | [400](#service-dashboard-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#service-dashboard-400-schema) | 4733 | [503](#service-dashboard-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#service-dashboard-503-schema) | 4734 4735 #### Responses 4736 4737 4738 ##### <span id="service-dashboard-200"></span> 200 - Dashboard response model 4739 Status: OK 4740 4741 ###### <span id="service-dashboard-200-schema"></span> Schema 4742 4743 4744 4745 [MonitoringDashboard](#monitoring-dashboard) 4746 4747 ##### <span id="service-dashboard-400"></span> 400 - BadRequestError: the client request is incorrect 4748 Status: Bad Request 4749 4750 ###### <span id="service-dashboard-400-schema"></span> Schema 4751 4752 4753 4754 [ServiceDashboardBadRequestBody](#service-dashboard-bad-request-body) 4755 4756 ##### <span id="service-dashboard-503"></span> 503 - A Internal is the error message that means something has gone wrong 4757 Status: Service Unavailable 4758 4759 ###### <span id="service-dashboard-503-schema"></span> Schema 4760 4761 4762 4763 [ServiceDashboardServiceUnavailableBody](#service-dashboard-service-unavailable-body) 4764 4765 ###### Inlined models 4766 4767 **<span id="service-dashboard-bad-request-body"></span> ServiceDashboardBadRequestBody** 4768 4769 4770 4771 4772 4773 4774 **Properties** 4775 4776 | Name | Type | Go type | Required | Default | Description | Example | 4777 |------|------|---------|:--------:| ------- |-------------|---------| 4778 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 4779 | Message | string| `string` | | | | | 4780 4781 4782 4783 **<span id="service-dashboard-service-unavailable-body"></span> ServiceDashboardServiceUnavailableBody** 4784 4785 4786 4787 4788 4789 4790 **Properties** 4791 4792 | Name | Type | Go type | Required | Default | Description | Example | 4793 |------|------|---------|:--------:| ------- |-------------|---------| 4794 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 4795 | Message | string| `string` | | | | | 4796 4797 4798 4799 ### <span id="service-details"></span> service details (*serviceDetails*) 4800 4801 ``` 4802 GET /api/namespaces/{namespace}/services/{service} 4803 ``` 4804 4805 Endpoint to get the details of a given service 4806 4807 #### URI Schemes 4808 * http 4809 * https 4810 4811 #### Produces 4812 * application/json 4813 4814 #### Parameters 4815 4816 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4817 |------|--------|------|---------|-----------| :------: |---------|-------------| 4818 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4819 | service | `path` | string | `string` | | ✓ | | The service name. | 4820 | validate | `query` | string | `string` | | | | Enable validation or not | 4821 4822 #### All responses 4823 | Code | Status | Description | Has headers | Schema | 4824 |------|--------|-------------|:-----------:|--------| 4825 | [200](#service-details-200) | OK | Listing all the information related to a workload | | [schema](#service-details-200-schema) | 4826 | [404](#service-details-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#service-details-404-schema) | 4827 | [500](#service-details-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#service-details-500-schema) | 4828 4829 #### Responses 4830 4831 4832 ##### <span id="service-details-200"></span> 200 - Listing all the information related to a workload 4833 Status: OK 4834 4835 ###### <span id="service-details-200-schema"></span> Schema 4836 4837 4838 4839 [ServiceDetails](#service-details) 4840 4841 ##### <span id="service-details-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 4842 Status: Not Found 4843 4844 ###### <span id="service-details-404-schema"></span> Schema 4845 4846 4847 4848 [ServiceDetailsNotFoundBody](#service-details-not-found-body) 4849 4850 ##### <span id="service-details-500"></span> 500 - A Internal is the error message that means something has gone wrong 4851 Status: Internal Server Error 4852 4853 ###### <span id="service-details-500-schema"></span> Schema 4854 4855 4856 4857 [ServiceDetailsInternalServerErrorBody](#service-details-internal-server-error-body) 4858 4859 ###### Inlined models 4860 4861 **<span id="service-details-internal-server-error-body"></span> ServiceDetailsInternalServerErrorBody** 4862 4863 4864 4865 4866 4867 4868 **Properties** 4869 4870 | Name | Type | Go type | Required | Default | Description | Example | 4871 |------|------|---------|:--------:| ------- |-------------|---------| 4872 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4873 | Message | string| `string` | | | | | 4874 4875 4876 4877 **<span id="service-details-not-found-body"></span> ServiceDetailsNotFoundBody** 4878 4879 4880 4881 4882 4883 4884 **Properties** 4885 4886 | Name | Type | Go type | Required | Default | Description | Example | 4887 |------|------|---------|:--------:| ------- |-------------|---------| 4888 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 4889 | Message | string| `string` | | | | | 4890 4891 4892 4893 ### <span id="service-list"></span> service list (*serviceList*) 4894 4895 ``` 4896 GET /api/namespaces/{namespace}/services 4897 ``` 4898 4899 Endpoint to get the details of a given service 4900 4901 #### URI Schemes 4902 * http 4903 * https 4904 4905 #### Produces 4906 * application/json 4907 4908 #### Parameters 4909 4910 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4911 |------|--------|------|---------|-----------| :------: |---------|-------------| 4912 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4913 | QueryTime | `query` | date-time (formatted string) | `strfmt.DateTime` | | | | The time to use for the prometheus query | 4914 | health | `query` | boolean | `bool` | | | | Optional | 4915 | rateInterval | `query` | string | `string` | | | `"10m"` | The rate interval used for fetching error rate | 4916 4917 #### All responses 4918 | Code | Status | Description | Has headers | Schema | 4919 |------|--------|-------------|:-----------:|--------| 4920 | [200](#service-list-200) | OK | Listing all services in the namespace | | [schema](#service-list-200-schema) | 4921 | [500](#service-list-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#service-list-500-schema) | 4922 4923 #### Responses 4924 4925 4926 ##### <span id="service-list-200"></span> 200 - Listing all services in the namespace 4927 Status: OK 4928 4929 ###### <span id="service-list-200-schema"></span> Schema 4930 4931 4932 4933 [ServiceList](#service-list) 4934 4935 ##### <span id="service-list-500"></span> 500 - A Internal is the error message that means something has gone wrong 4936 Status: Internal Server Error 4937 4938 ###### <span id="service-list-500-schema"></span> Schema 4939 4940 4941 4942 [ServiceListInternalServerErrorBody](#service-list-internal-server-error-body) 4943 4944 ###### Inlined models 4945 4946 **<span id="service-list-internal-server-error-body"></span> ServiceListInternalServerErrorBody** 4947 4948 4949 4950 4951 4952 4953 **Properties** 4954 4955 | Name | Type | Go type | Required | Default | Description | Example | 4956 |------|------|---------|:--------:| ------- |-------------|---------| 4957 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 4958 | Message | string| `string` | | | | | 4959 4960 4961 4962 ### <span id="service-metrics"></span> service metrics (*serviceMetrics*) 4963 4964 ``` 4965 GET /api/namespaces/{namespace}/services/{service}/metrics 4966 ``` 4967 4968 Endpoint to fetch metrics to be displayed, related to a single service 4969 4970 #### URI Schemes 4971 * http 4972 * https 4973 4974 #### Produces 4975 * application/json 4976 4977 #### Parameters 4978 4979 | Name | Source | Type | Go type | Separator | Required | Default | Description | 4980 |------|--------|------|---------|-----------| :------: |---------|-------------| 4981 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 4982 | service | `path` | string | `string` | | ✓ | | The service name. | 4983 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 4984 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 4985 | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | 4986 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 4987 | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | 4988 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 4989 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 4990 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 4991 | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | 4992 | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | 4993 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 4994 | version | `query` | string | `string` | | | | Filters metrics by the specified version. | 4995 4996 #### All responses 4997 | Code | Status | Description | Has headers | Schema | 4998 |------|--------|-------------|:-----------:|--------| 4999 | [200](#service-metrics-200) | OK | Metrics response model | | [schema](#service-metrics-200-schema) | 5000 | [400](#service-metrics-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#service-metrics-400-schema) | 5001 | [503](#service-metrics-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#service-metrics-503-schema) | 5002 5003 #### Responses 5004 5005 5006 ##### <span id="service-metrics-200"></span> 200 - Metrics response model 5007 Status: OK 5008 5009 ###### <span id="service-metrics-200-schema"></span> Schema 5010 5011 5012 5013 map of [Metric](#metric) 5014 5015 ##### <span id="service-metrics-400"></span> 400 - BadRequestError: the client request is incorrect 5016 Status: Bad Request 5017 5018 ###### <span id="service-metrics-400-schema"></span> Schema 5019 5020 5021 5022 [ServiceMetricsBadRequestBody](#service-metrics-bad-request-body) 5023 5024 ##### <span id="service-metrics-503"></span> 503 - A Internal is the error message that means something has gone wrong 5025 Status: Service Unavailable 5026 5027 ###### <span id="service-metrics-503-schema"></span> Schema 5028 5029 5030 5031 [ServiceMetricsServiceUnavailableBody](#service-metrics-service-unavailable-body) 5032 5033 ###### Inlined models 5034 5035 **<span id="service-metrics-bad-request-body"></span> ServiceMetricsBadRequestBody** 5036 5037 5038 5039 5040 5041 5042 **Properties** 5043 5044 | Name | Type | Go type | Required | Default | Description | Example | 5045 |------|------|---------|:--------:| ------- |-------------|---------| 5046 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 5047 | Message | string| `string` | | | | | 5048 5049 5050 5051 **<span id="service-metrics-service-unavailable-body"></span> ServiceMetricsServiceUnavailableBody** 5052 5053 5054 5055 5056 5057 5058 **Properties** 5059 5060 | Name | Type | Go type | Required | Default | Description | Example | 5061 |------|------|---------|:--------:| ------- |-------------|---------| 5062 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 5063 | Message | string| `string` | | | | | 5064 5065 5066 5067 ### <span id="service-spans"></span> service spans (*serviceSpans*) 5068 5069 ``` 5070 GET /api/namespaces/{namespace}/services/{service}/spans 5071 ``` 5072 5073 Endpoint to get Jaeger spans for a given service 5074 5075 #### URI Schemes 5076 * http 5077 * https 5078 5079 #### Produces 5080 * application/json 5081 5082 #### Parameters 5083 5084 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5085 |------|--------|------|---------|-----------| :------: |---------|-------------| 5086 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5087 | service | `path` | string | `string` | | ✓ | | The service name. | 5088 5089 #### All responses 5090 | Code | Status | Description | Has headers | Schema | 5091 |------|--------|-------------|:-----------:|--------| 5092 | [200](#service-spans-200) | OK | Listing all the information related to a Span | | [schema](#service-spans-200-schema) | 5093 | [500](#service-spans-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#service-spans-500-schema) | 5094 5095 #### Responses 5096 5097 5098 ##### <span id="service-spans-200"></span> 200 - Listing all the information related to a Span 5099 Status: OK 5100 5101 ###### <span id="service-spans-200-schema"></span> Schema 5102 5103 5104 5105 [][JaegerSpan](#jaeger-span) 5106 5107 ##### <span id="service-spans-500"></span> 500 - A Internal is the error message that means something has gone wrong 5108 Status: Internal Server Error 5109 5110 ###### <span id="service-spans-500-schema"></span> Schema 5111 5112 5113 5114 [ServiceSpansInternalServerErrorBody](#service-spans-internal-server-error-body) 5115 5116 ###### Inlined models 5117 5118 **<span id="service-spans-internal-server-error-body"></span> ServiceSpansInternalServerErrorBody** 5119 5120 5121 5122 5123 5124 5125 **Properties** 5126 5127 | Name | Type | Go type | Required | Default | Description | Example | 5128 |------|------|---------|:--------:| ------- |-------------|---------| 5129 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5130 | Message | string| `string` | | | | | 5131 5132 5133 5134 ### <span id="service-traces"></span> service traces (*serviceTraces*) 5135 5136 ``` 5137 GET /api/namespaces/{namespace}/services/{service}/traces 5138 ``` 5139 5140 Endpoint to get the traces of a given service 5141 5142 #### URI Schemes 5143 * http 5144 * https 5145 5146 #### Produces 5147 * application/json 5148 5149 #### Parameters 5150 5151 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5152 |------|--------|------|---------|-----------| :------: |---------|-------------| 5153 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5154 | service | `path` | string | `string` | | ✓ | | The service name. | 5155 5156 #### All responses 5157 | Code | Status | Description | Has headers | Schema | 5158 |------|--------|-------------|:-----------:|--------| 5159 | [200](#service-traces-200) | OK | Listing all the information related to a Trace | | [schema](#service-traces-200-schema) | 5160 | [404](#service-traces-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#service-traces-404-schema) | 5161 | [500](#service-traces-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#service-traces-500-schema) | 5162 5163 #### Responses 5164 5165 5166 ##### <span id="service-traces-200"></span> 200 - Listing all the information related to a Trace 5167 Status: OK 5168 5169 ###### <span id="service-traces-200-schema"></span> Schema 5170 5171 5172 5173 [][Trace](#trace) 5174 5175 ##### <span id="service-traces-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 5176 Status: Not Found 5177 5178 ###### <span id="service-traces-404-schema"></span> Schema 5179 5180 5181 5182 [ServiceTracesNotFoundBody](#service-traces-not-found-body) 5183 5184 ##### <span id="service-traces-500"></span> 500 - A Internal is the error message that means something has gone wrong 5185 Status: Internal Server Error 5186 5187 ###### <span id="service-traces-500-schema"></span> Schema 5188 5189 5190 5191 [ServiceTracesInternalServerErrorBody](#service-traces-internal-server-error-body) 5192 5193 ###### Inlined models 5194 5195 **<span id="service-traces-internal-server-error-body"></span> ServiceTracesInternalServerErrorBody** 5196 5197 5198 5199 5200 5201 5202 **Properties** 5203 5204 | Name | Type | Go type | Required | Default | Description | Example | 5205 |------|------|---------|:--------:| ------- |-------------|---------| 5206 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5207 | Message | string| `string` | | | | | 5208 5209 5210 5211 **<span id="service-traces-not-found-body"></span> ServiceTracesNotFoundBody** 5212 5213 5214 5215 5216 5217 5218 **Properties** 5219 5220 | Name | Type | Go type | Required | Default | Description | Example | 5221 |------|------|---------|:--------:| ------- |-------------|---------| 5222 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 5223 | Message | string| `string` | | | | | 5224 5225 5226 5227 ### <span id="service-update"></span> Endpoint to update the Service configuration using Json Merge Patch strategy. (*serviceUpdate*) 5228 5229 ``` 5230 PATCH /api/namespaces/{namespace}/services/{service} 5231 ``` 5232 5233 #### URI Schemes 5234 * http 5235 * https 5236 5237 #### Consumes 5238 * application/json 5239 5240 #### Produces 5241 * application/json 5242 5243 #### Parameters 5244 5245 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5246 |------|--------|------|---------|-----------| :------: |---------|-------------| 5247 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5248 | service | `path` | string | `string` | | ✓ | | The service name. | 5249 | validate | `query` | string | `string` | | | | Enable validation or not | 5250 5251 #### All responses 5252 | Code | Status | Description | Has headers | Schema | 5253 |------|--------|-------------|:-----------:|--------| 5254 | [200](#service-update-200) | OK | Listing all the information related to a workload | | [schema](#service-update-200-schema) | 5255 | [400](#service-update-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#service-update-400-schema) | 5256 | [404](#service-update-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#service-update-404-schema) | 5257 | [500](#service-update-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#service-update-500-schema) | 5258 5259 #### Responses 5260 5261 5262 ##### <span id="service-update-200"></span> 200 - Listing all the information related to a workload 5263 Status: OK 5264 5265 ###### <span id="service-update-200-schema"></span> Schema 5266 5267 5268 5269 [ServiceDetails](#service-details) 5270 5271 ##### <span id="service-update-400"></span> 400 - BadRequestError: the client request is incorrect 5272 Status: Bad Request 5273 5274 ###### <span id="service-update-400-schema"></span> Schema 5275 5276 5277 5278 [ServiceUpdateBadRequestBody](#service-update-bad-request-body) 5279 5280 ##### <span id="service-update-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 5281 Status: Not Found 5282 5283 ###### <span id="service-update-404-schema"></span> Schema 5284 5285 5286 5287 [ServiceUpdateNotFoundBody](#service-update-not-found-body) 5288 5289 ##### <span id="service-update-500"></span> 500 - A Internal is the error message that means something has gone wrong 5290 Status: Internal Server Error 5291 5292 ###### <span id="service-update-500-schema"></span> Schema 5293 5294 5295 5296 [ServiceUpdateInternalServerErrorBody](#service-update-internal-server-error-body) 5297 5298 ###### Inlined models 5299 5300 **<span id="service-update-bad-request-body"></span> ServiceUpdateBadRequestBody** 5301 5302 5303 5304 5305 5306 5307 **Properties** 5308 5309 | Name | Type | Go type | Required | Default | Description | Example | 5310 |------|------|---------|:--------:| ------- |-------------|---------| 5311 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 5312 | Message | string| `string` | | | | | 5313 5314 5315 5316 **<span id="service-update-internal-server-error-body"></span> ServiceUpdateInternalServerErrorBody** 5317 5318 5319 5320 5321 5322 5323 **Properties** 5324 5325 | Name | Type | Go type | Required | Default | Description | Example | 5326 |------|------|---------|:--------:| ------- |-------------|---------| 5327 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5328 | Message | string| `string` | | | | | 5329 5330 5331 5332 **<span id="service-update-not-found-body"></span> ServiceUpdateNotFoundBody** 5333 5334 5335 5336 5337 5338 5339 **Properties** 5340 5341 | Name | Type | Go type | Required | Default | Description | Example | 5342 |------|------|---------|:--------:| ------- |-------------|---------| 5343 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 5344 | Message | string| `string` | | | | | 5345 5346 5347 5348 ### <span id="trace-details"></span> trace details (*traceDetails*) 5349 5350 ``` 5351 GET /api/traces/{traceID} 5352 ``` 5353 5354 Endpoint to get a specific trace from ID 5355 5356 #### URI Schemes 5357 * http 5358 * https 5359 5360 #### Produces 5361 * application/json 5362 5363 #### Parameters 5364 5365 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5366 |------|--------|------|---------|-----------| :------: |---------|-------------| 5367 | traceID | `path` | string | `string` | | ✓ | | The trace ID. | 5368 5369 #### All responses 5370 | Code | Status | Description | Has headers | Schema | 5371 |------|--------|-------------|:-----------:|--------| 5372 | [200](#trace-details-200) | OK | Listing all the information related to a Trace | | [schema](#trace-details-200-schema) | 5373 | [404](#trace-details-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#trace-details-404-schema) | 5374 | [500](#trace-details-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#trace-details-500-schema) | 5375 5376 #### Responses 5377 5378 5379 ##### <span id="trace-details-200"></span> 200 - Listing all the information related to a Trace 5380 Status: OK 5381 5382 ###### <span id="trace-details-200-schema"></span> Schema 5383 5384 5385 5386 [][Trace](#trace) 5387 5388 ##### <span id="trace-details-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 5389 Status: Not Found 5390 5391 ###### <span id="trace-details-404-schema"></span> Schema 5392 5393 5394 5395 [TraceDetailsNotFoundBody](#trace-details-not-found-body) 5396 5397 ##### <span id="trace-details-500"></span> 500 - A Internal is the error message that means something has gone wrong 5398 Status: Internal Server Error 5399 5400 ###### <span id="trace-details-500-schema"></span> Schema 5401 5402 5403 5404 [TraceDetailsInternalServerErrorBody](#trace-details-internal-server-error-body) 5405 5406 ###### Inlined models 5407 5408 **<span id="trace-details-internal-server-error-body"></span> TraceDetailsInternalServerErrorBody** 5409 5410 5411 5412 5413 5414 5415 **Properties** 5416 5417 | Name | Type | Go type | Required | Default | Description | Example | 5418 |------|------|---------|:--------:| ------- |-------------|---------| 5419 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5420 | Message | string| `string` | | | | | 5421 5422 5423 5424 **<span id="trace-details-not-found-body"></span> TraceDetailsNotFoundBody** 5425 5426 5427 5428 5429 5430 5431 **Properties** 5432 5433 | Name | Type | Go type | Required | Default | Description | Example | 5434 |------|------|---------|:--------:| ------- |-------------|---------| 5435 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 5436 | Message | string| `string` | | | | | 5437 5438 5439 5440 ### <span id="workload-dashboard"></span> workload dashboard (*workloadDashboard*) 5441 5442 ``` 5443 GET /api/namespaces/{namespace}/workloads/{workload}/dashboard 5444 ``` 5445 5446 Endpoint to fetch dashboard to be displayed, related to a single workload 5447 5448 #### URI Schemes 5449 * http 5450 * https 5451 5452 #### Produces 5453 * application/json 5454 5455 #### Parameters 5456 5457 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5458 |------|--------|------|---------|-----------| :------: |---------|-------------| 5459 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5460 | workload | `path` | string | `string` | | ✓ | | The workload name. | 5461 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 5462 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 5463 | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | 5464 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 5465 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 5466 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 5467 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 5468 | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | 5469 | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | 5470 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 5471 5472 #### All responses 5473 | Code | Status | Description | Has headers | Schema | 5474 |------|--------|-------------|:-----------:|--------| 5475 | [200](#workload-dashboard-200) | OK | Dashboard response model | | [schema](#workload-dashboard-200-schema) | 5476 | [400](#workload-dashboard-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#workload-dashboard-400-schema) | 5477 | [503](#workload-dashboard-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#workload-dashboard-503-schema) | 5478 5479 #### Responses 5480 5481 5482 ##### <span id="workload-dashboard-200"></span> 200 - Dashboard response model 5483 Status: OK 5484 5485 ###### <span id="workload-dashboard-200-schema"></span> Schema 5486 5487 5488 5489 [MonitoringDashboard](#monitoring-dashboard) 5490 5491 ##### <span id="workload-dashboard-400"></span> 400 - BadRequestError: the client request is incorrect 5492 Status: Bad Request 5493 5494 ###### <span id="workload-dashboard-400-schema"></span> Schema 5495 5496 5497 5498 [WorkloadDashboardBadRequestBody](#workload-dashboard-bad-request-body) 5499 5500 ##### <span id="workload-dashboard-503"></span> 503 - A Internal is the error message that means something has gone wrong 5501 Status: Service Unavailable 5502 5503 ###### <span id="workload-dashboard-503-schema"></span> Schema 5504 5505 5506 5507 [WorkloadDashboardServiceUnavailableBody](#workload-dashboard-service-unavailable-body) 5508 5509 ###### Inlined models 5510 5511 **<span id="workload-dashboard-bad-request-body"></span> WorkloadDashboardBadRequestBody** 5512 5513 5514 5515 5516 5517 5518 **Properties** 5519 5520 | Name | Type | Go type | Required | Default | Description | Example | 5521 |------|------|---------|:--------:| ------- |-------------|---------| 5522 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 5523 | Message | string| `string` | | | | | 5524 5525 5526 5527 **<span id="workload-dashboard-service-unavailable-body"></span> WorkloadDashboardServiceUnavailableBody** 5528 5529 5530 5531 5532 5533 5534 **Properties** 5535 5536 | Name | Type | Go type | Required | Default | Description | Example | 5537 |------|------|---------|:--------:| ------- |-------------|---------| 5538 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 5539 | Message | string| `string` | | | | | 5540 5541 5542 5543 ### <span id="workload-details"></span> workload details (*workloadDetails*) 5544 5545 ``` 5546 GET /api/namespaces/{namespace}/workloads/{workload} 5547 ``` 5548 5549 Endpoint to get the workload details 5550 5551 #### URI Schemes 5552 * http 5553 * https 5554 5555 #### Produces 5556 * application/json 5557 5558 #### Parameters 5559 5560 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5561 |------|--------|------|---------|-----------| :------: |---------|-------------| 5562 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5563 | workload | `path` | string | `string` | | ✓ | | The workload name. | 5564 5565 #### All responses 5566 | Code | Status | Description | Has headers | Schema | 5567 |------|--------|-------------|:-----------:|--------| 5568 | [200](#workload-details-200) | OK | Listing all the information related to a workload | | [schema](#workload-details-200-schema) | 5569 | [404](#workload-details-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#workload-details-404-schema) | 5570 | [500](#workload-details-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#workload-details-500-schema) | 5571 5572 #### Responses 5573 5574 5575 ##### <span id="workload-details-200"></span> 200 - Listing all the information related to a workload 5576 Status: OK 5577 5578 ###### <span id="workload-details-200-schema"></span> Schema 5579 5580 5581 5582 [Workload](#workload) 5583 5584 ##### <span id="workload-details-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 5585 Status: Not Found 5586 5587 ###### <span id="workload-details-404-schema"></span> Schema 5588 5589 5590 5591 [WorkloadDetailsNotFoundBody](#workload-details-not-found-body) 5592 5593 ##### <span id="workload-details-500"></span> 500 - A Internal is the error message that means something has gone wrong 5594 Status: Internal Server Error 5595 5596 ###### <span id="workload-details-500-schema"></span> Schema 5597 5598 5599 5600 [WorkloadDetailsInternalServerErrorBody](#workload-details-internal-server-error-body) 5601 5602 ###### Inlined models 5603 5604 **<span id="workload-details-internal-server-error-body"></span> WorkloadDetailsInternalServerErrorBody** 5605 5606 5607 5608 5609 5610 5611 **Properties** 5612 5613 | Name | Type | Go type | Required | Default | Description | Example | 5614 |------|------|---------|:--------:| ------- |-------------|---------| 5615 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5616 | Message | string| `string` | | | | | 5617 5618 5619 5620 **<span id="workload-details-not-found-body"></span> WorkloadDetailsNotFoundBody** 5621 5622 5623 5624 5625 5626 5627 **Properties** 5628 5629 | Name | Type | Go type | Required | Default | Description | Example | 5630 |------|------|---------|:--------:| ------- |-------------|---------| 5631 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 5632 | Message | string| `string` | | | | | 5633 5634 5635 5636 ### <span id="workload-list"></span> workload list (*workloadList*) 5637 5638 ``` 5639 GET /api/namespaces/{namespace}/workloads 5640 ``` 5641 5642 Endpoint to get the list of workloads for a namespace 5643 5644 #### URI Schemes 5645 * http 5646 * https 5647 5648 #### Produces 5649 * application/json 5650 5651 #### Parameters 5652 5653 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5654 |------|--------|------|---------|-----------| :------: |---------|-------------| 5655 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5656 5657 #### All responses 5658 | Code | Status | Description | Has headers | Schema | 5659 |------|--------|-------------|:-----------:|--------| 5660 | [200](#workload-list-200) | OK | Listing all workloads in the namespace | | [schema](#workload-list-200-schema) | 5661 | [500](#workload-list-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#workload-list-500-schema) | 5662 5663 #### Responses 5664 5665 5666 ##### <span id="workload-list-200"></span> 200 - Listing all workloads in the namespace 5667 Status: OK 5668 5669 ###### <span id="workload-list-200-schema"></span> Schema 5670 5671 5672 5673 [WorkloadList](#workload-list) 5674 5675 ##### <span id="workload-list-500"></span> 500 - A Internal is the error message that means something has gone wrong 5676 Status: Internal Server Error 5677 5678 ###### <span id="workload-list-500-schema"></span> Schema 5679 5680 5681 5682 [WorkloadListInternalServerErrorBody](#workload-list-internal-server-error-body) 5683 5684 ###### Inlined models 5685 5686 **<span id="workload-list-internal-server-error-body"></span> WorkloadListInternalServerErrorBody** 5687 5688 5689 5690 5691 5692 5693 **Properties** 5694 5695 | Name | Type | Go type | Required | Default | Description | Example | 5696 |------|------|---------|:--------:| ------- |-------------|---------| 5697 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5698 | Message | string| `string` | | | | | 5699 5700 5701 5702 ### <span id="workload-metrics"></span> workload metrics (*workloadMetrics*) 5703 5704 ``` 5705 GET /api/namespaces/{namespace}/workloads/{workload}/metrics 5706 ``` 5707 5708 Endpoint to fetch metrics to be displayed, related to a single workload 5709 5710 #### URI Schemes 5711 * http 5712 * https 5713 5714 #### Produces 5715 * application/json 5716 5717 #### Parameters 5718 5719 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5720 |------|--------|------|---------|-----------| :------: |---------|-------------| 5721 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5722 | workload | `path` | string | `string` | | ✓ | | The workload name. | 5723 | avg | `query` | boolean | `bool` | | | `true` | Flag for fetching histogram average. Default is true. | 5724 | byLabels[] | `query` | []string | `[]string` | | | | List of labels to use for grouping metrics (via Prometheus 'by' clause). | 5725 | direction | `query` | string | `string` | | | `"outbound"` | Traffic direction: 'inbound' or 'outbound'. | 5726 | duration | `query` | int64 (formatted integer) | `int64` | | | `1800` | Duration of the query period, in seconds. | 5727 | filters[] | `query` | []string | `[]string` | | | | List of metrics to fetch. Fetch all metrics when empty. List entries are Kiali internal metric names. | 5728 | quantiles[] | `query` | []string | `[]string` | | | | List of quantiles to fetch. Fetch no quantiles when empty. Ex: [0.5, 0.95, 0.99]. | 5729 | rateFunc | `query` | string | `string` | | | `"rate"` | Prometheus function used to calculate rate: 'rate' or 'irate'. | 5730 | rateInterval | `query` | string | `string` | | | `"1m"` | Interval used for rate and histogram calculation. | 5731 | reporter | `query` | string | `string` | | | `"source"` | Istio telemetry reporter: 'source' or 'destination'. | 5732 | requestProtocol | `query` | string | `string` | | | `"all protocols"` | Desired request protocol for the telemetry: For example, 'http' or 'grpc'. | 5733 | step | `query` | int64 (formatted integer) | `int64` | | | `15` | Step between [graph] datapoints, in seconds. | 5734 | version | `query` | string | `string` | | | | Filters metrics by the specified version. | 5735 5736 #### All responses 5737 | Code | Status | Description | Has headers | Schema | 5738 |------|--------|-------------|:-----------:|--------| 5739 | [200](#workload-metrics-200) | OK | Metrics response model | | [schema](#workload-metrics-200-schema) | 5740 | [400](#workload-metrics-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#workload-metrics-400-schema) | 5741 | [503](#workload-metrics-503) | Service Unavailable | A Internal is the error message that means something has gone wrong | | [schema](#workload-metrics-503-schema) | 5742 5743 #### Responses 5744 5745 5746 ##### <span id="workload-metrics-200"></span> 200 - Metrics response model 5747 Status: OK 5748 5749 ###### <span id="workload-metrics-200-schema"></span> Schema 5750 5751 5752 5753 map of [Metric](#metric) 5754 5755 ##### <span id="workload-metrics-400"></span> 400 - BadRequestError: the client request is incorrect 5756 Status: Bad Request 5757 5758 ###### <span id="workload-metrics-400-schema"></span> Schema 5759 5760 5761 5762 [WorkloadMetricsBadRequestBody](#workload-metrics-bad-request-body) 5763 5764 ##### <span id="workload-metrics-503"></span> 503 - A Internal is the error message that means something has gone wrong 5765 Status: Service Unavailable 5766 5767 ###### <span id="workload-metrics-503-schema"></span> Schema 5768 5769 5770 5771 [WorkloadMetricsServiceUnavailableBody](#workload-metrics-service-unavailable-body) 5772 5773 ###### Inlined models 5774 5775 **<span id="workload-metrics-bad-request-body"></span> WorkloadMetricsBadRequestBody** 5776 5777 5778 5779 5780 5781 5782 **Properties** 5783 5784 | Name | Type | Go type | Required | Default | Description | Example | 5785 |------|------|---------|:--------:| ------- |-------------|---------| 5786 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 5787 | Message | string| `string` | | | | | 5788 5789 5790 5791 **<span id="workload-metrics-service-unavailable-body"></span> WorkloadMetricsServiceUnavailableBody** 5792 5793 5794 5795 5796 5797 5798 **Properties** 5799 5800 | Name | Type | Go type | Required | Default | Description | Example | 5801 |------|------|---------|:--------:| ------- |-------------|---------| 5802 | Code | int32 (formatted integer)| `int32` | | `503`| HTTP status code | `503` | 5803 | Message | string| `string` | | | | | 5804 5805 5806 5807 ### <span id="workload-spans"></span> workload spans (*workloadSpans*) 5808 5809 ``` 5810 GET /api/namespaces/{namespace}/workloads/{workload}/spans 5811 ``` 5812 5813 Endpoint to get Jaeger spans for a given workload 5814 5815 #### URI Schemes 5816 * http 5817 * https 5818 5819 #### Produces 5820 * application/json 5821 5822 #### Parameters 5823 5824 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5825 |------|--------|------|---------|-----------| :------: |---------|-------------| 5826 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5827 | workload | `path` | string | `string` | | ✓ | | The workload name. | 5828 5829 #### All responses 5830 | Code | Status | Description | Has headers | Schema | 5831 |------|--------|-------------|:-----------:|--------| 5832 | [200](#workload-spans-200) | OK | Listing all the information related to a Span | | [schema](#workload-spans-200-schema) | 5833 | [500](#workload-spans-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#workload-spans-500-schema) | 5834 5835 #### Responses 5836 5837 5838 ##### <span id="workload-spans-200"></span> 200 - Listing all the information related to a Span 5839 Status: OK 5840 5841 ###### <span id="workload-spans-200-schema"></span> Schema 5842 5843 5844 5845 [][JaegerSpan](#jaeger-span) 5846 5847 ##### <span id="workload-spans-500"></span> 500 - A Internal is the error message that means something has gone wrong 5848 Status: Internal Server Error 5849 5850 ###### <span id="workload-spans-500-schema"></span> Schema 5851 5852 5853 5854 [WorkloadSpansInternalServerErrorBody](#workload-spans-internal-server-error-body) 5855 5856 ###### Inlined models 5857 5858 **<span id="workload-spans-internal-server-error-body"></span> WorkloadSpansInternalServerErrorBody** 5859 5860 5861 5862 5863 5864 5865 **Properties** 5866 5867 | Name | Type | Go type | Required | Default | Description | Example | 5868 |------|------|---------|:--------:| ------- |-------------|---------| 5869 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5870 | Message | string| `string` | | | | | 5871 5872 5873 5874 ### <span id="workload-traces"></span> workload traces (*workloadTraces*) 5875 5876 ``` 5877 GET /api/namespaces/{namespace}/workloads/{workload}/traces 5878 ``` 5879 5880 Endpoint to get the traces of a given workload 5881 5882 #### URI Schemes 5883 * http 5884 * https 5885 5886 #### Produces 5887 * application/json 5888 5889 #### Parameters 5890 5891 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5892 |------|--------|------|---------|-----------| :------: |---------|-------------| 5893 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5894 | workload | `path` | string | `string` | | ✓ | | The workload name. | 5895 5896 #### All responses 5897 | Code | Status | Description | Has headers | Schema | 5898 |------|--------|-------------|:-----------:|--------| 5899 | [200](#workload-traces-200) | OK | Listing all the information related to a Trace | | [schema](#workload-traces-200-schema) | 5900 | [404](#workload-traces-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#workload-traces-404-schema) | 5901 | [500](#workload-traces-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#workload-traces-500-schema) | 5902 5903 #### Responses 5904 5905 5906 ##### <span id="workload-traces-200"></span> 200 - Listing all the information related to a Trace 5907 Status: OK 5908 5909 ###### <span id="workload-traces-200-schema"></span> Schema 5910 5911 5912 5913 [][Trace](#trace) 5914 5915 ##### <span id="workload-traces-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 5916 Status: Not Found 5917 5918 ###### <span id="workload-traces-404-schema"></span> Schema 5919 5920 5921 5922 [WorkloadTracesNotFoundBody](#workload-traces-not-found-body) 5923 5924 ##### <span id="workload-traces-500"></span> 500 - A Internal is the error message that means something has gone wrong 5925 Status: Internal Server Error 5926 5927 ###### <span id="workload-traces-500-schema"></span> Schema 5928 5929 5930 5931 [WorkloadTracesInternalServerErrorBody](#workload-traces-internal-server-error-body) 5932 5933 ###### Inlined models 5934 5935 **<span id="workload-traces-internal-server-error-body"></span> WorkloadTracesInternalServerErrorBody** 5936 5937 5938 5939 5940 5941 5942 **Properties** 5943 5944 | Name | Type | Go type | Required | Default | Description | Example | 5945 |------|------|---------|:--------:| ------- |-------------|---------| 5946 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 5947 | Message | string| `string` | | | | | 5948 5949 5950 5951 **<span id="workload-traces-not-found-body"></span> WorkloadTracesNotFoundBody** 5952 5953 5954 5955 5956 5957 5958 **Properties** 5959 5960 | Name | Type | Go type | Required | Default | Description | Example | 5961 |------|------|---------|:--------:| ------- |-------------|---------| 5962 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 5963 | Message | string| `string` | | | | | 5964 5965 5966 5967 ### <span id="workload-update"></span> Endpoint to update the Workload configuration using Json Merge Patch strategy. (*workloadUpdate*) 5968 5969 ``` 5970 PATCH /api/namespaces/{namespace}/workloads/{workload} 5971 ``` 5972 5973 #### URI Schemes 5974 * http 5975 * https 5976 5977 #### Consumes 5978 * application/json 5979 5980 #### Produces 5981 * application/json 5982 5983 #### Parameters 5984 5985 | Name | Source | Type | Go type | Separator | Required | Default | Description | 5986 |------|--------|------|---------|-----------| :------: |---------|-------------| 5987 | namespace | `path` | string | `string` | | ✓ | | The namespace name. | 5988 | workload | `path` | string | `string` | | ✓ | | The workload name. | 5989 5990 #### All responses 5991 | Code | Status | Description | Has headers | Schema | 5992 |------|--------|-------------|:-----------:|--------| 5993 | [200](#workload-update-200) | OK | Listing all the information related to a workload | | [schema](#workload-update-200-schema) | 5994 | [400](#workload-update-400) | Bad Request | BadRequestError: the client request is incorrect | | [schema](#workload-update-400-schema) | 5995 | [404](#workload-update-404) | Not Found | A NotFoundError is the error message that is generated when server could not find what was requested. | | [schema](#workload-update-404-schema) | 5996 | [500](#workload-update-500) | Internal Server Error | A Internal is the error message that means something has gone wrong | | [schema](#workload-update-500-schema) | 5997 5998 #### Responses 5999 6000 6001 ##### <span id="workload-update-200"></span> 200 - Listing all the information related to a workload 6002 Status: OK 6003 6004 ###### <span id="workload-update-200-schema"></span> Schema 6005 6006 6007 6008 [Workload](#workload) 6009 6010 ##### <span id="workload-update-400"></span> 400 - BadRequestError: the client request is incorrect 6011 Status: Bad Request 6012 6013 ###### <span id="workload-update-400-schema"></span> Schema 6014 6015 6016 6017 [WorkloadUpdateBadRequestBody](#workload-update-bad-request-body) 6018 6019 ##### <span id="workload-update-404"></span> 404 - A NotFoundError is the error message that is generated when server could not find what was requested. 6020 Status: Not Found 6021 6022 ###### <span id="workload-update-404-schema"></span> Schema 6023 6024 6025 6026 [WorkloadUpdateNotFoundBody](#workload-update-not-found-body) 6027 6028 ##### <span id="workload-update-500"></span> 500 - A Internal is the error message that means something has gone wrong 6029 Status: Internal Server Error 6030 6031 ###### <span id="workload-update-500-schema"></span> Schema 6032 6033 6034 6035 [WorkloadUpdateInternalServerErrorBody](#workload-update-internal-server-error-body) 6036 6037 ###### Inlined models 6038 6039 **<span id="workload-update-bad-request-body"></span> WorkloadUpdateBadRequestBody** 6040 6041 6042 6043 6044 6045 6046 **Properties** 6047 6048 | Name | Type | Go type | Required | Default | Description | Example | 6049 |------|------|---------|:--------:| ------- |-------------|---------| 6050 | Code | int32 (formatted integer)| `int32` | | `400`| HTTP status code | `400` | 6051 | Message | string| `string` | | | | | 6052 6053 6054 6055 **<span id="workload-update-internal-server-error-body"></span> WorkloadUpdateInternalServerErrorBody** 6056 6057 6058 6059 6060 6061 6062 **Properties** 6063 6064 | Name | Type | Go type | Required | Default | Description | Example | 6065 |------|------|---------|:--------:| ------- |-------------|---------| 6066 | Code | int32 (formatted integer)| `int32` | | `500`| HTTP status code | `500` | 6067 | Message | string| `string` | | | | | 6068 6069 6070 6071 **<span id="workload-update-not-found-body"></span> WorkloadUpdateNotFoundBody** 6072 6073 6074 6075 6076 6077 6078 **Properties** 6079 6080 | Name | Type | Go type | Required | Default | Description | Example | 6081 |------|------|---------|:--------:| ------- |-------------|---------| 6082 | Code | int32 (formatted integer)| `int32` | | `404`| HTTP status code | `404` | 6083 | Message | string| `string` | | | | | 6084 6085 6086 6087 ## Models 6088 6089 ### <span id="additional-item"></span> AdditionalItem 6090 6091 6092 6093 6094 6095 6096 **Properties** 6097 6098 | Name | Type | Go type | Required | Default | Description | Example | 6099 |------|------|---------|:--------:| ------- |-------------|---------| 6100 | Icon | string| `string` | | | | | 6101 | Title | string| `string` | | | | | 6102 | Value | string| `string` | | | | | 6103 6104 6105 6106 ### <span id="address"></span> Address 6107 6108 6109 6110 6111 6112 6113 **Properties** 6114 6115 | Name | Type | Go type | Required | Default | Description | Example | 6116 |------|------|---------|:--------:| ------- |-------------|---------| 6117 | IP | string| `string` | | | | | 6118 | Kind | string| `string` | | | | | 6119 | Name | string| `string` | | | | | 6120 | Port | uint32 (formatted integer)| `uint32` | | | | | 6121 6122 6123 6124 ### <span id="address-type"></span> AddressType 6125 6126 6127 > A predefined CamelCase string identifier (currently limited to `IPAddress` or `Hostname`) 6128 A domain-prefixed string identifier (like `acme.io/CustomAddressType`) 6129 6130 Values `IPAddress` and `Hostname` have Extended support. 6131 6132 The `NamedAddress` value has been deprecated in favor of implementation 6133 specific domain-prefixed strings. 6134 6135 All other values, including domain-prefixed values have Custom support, which 6136 are used in implementation-specific behaviors. Support for additional 6137 predefined CamelCase identifiers may be added in future releases. 6138 6139 +kubebuilder:validation:MinLength=1 6140 +kubebuilder:validation:MaxLength=253 6141 +kubebuilder:validation:Pattern=`^Hostname|IPAddress|NamedAddress|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$` 6142 6143 6144 6145 6146 | Name | Type | Go type | Default | Description | Example | 6147 |------|------|---------| ------- |-------------|---------| 6148 | AddressType | string| string | | A predefined CamelCase string identifier (currently limited to `IPAddress` or `Hostname`) 6149 A domain-prefixed string identifier (like `acme.io/CustomAddressType`) 6150 6151 Values `IPAddress` and `Hostname` have Extended support. 6152 6153 The `NamedAddress` value has been deprecated in favor of implementation 6154 specific domain-prefixed strings. 6155 6156 All other values, including domain-prefixed values have Custom support, which 6157 are used in implementation-specific behaviors. Support for additional 6158 predefined CamelCase identifiers may be added in future releases. 6159 6160 +kubebuilder:validation:MinLength=1 6161 +kubebuilder:validation:MaxLength=253 6162 +kubebuilder:validation:Pattern=`^Hostname|IPAddress|NamedAddress|[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$` | | 6163 6164 6165 6166 ### <span id="addresses"></span> Addresses 6167 6168 6169 6170 6171 [][Address](#address) 6172 6173 ### <span id="aggregation"></span> Aggregation 6174 6175 6176 > Aggregation represents label's allowed aggregations, transformed from aggregation in MonitoringDashboard config resource 6177 6178 6179 6180 6181 6182 6183 **Properties** 6184 6185 | Name | Type | Go type | Required | Default | Description | Example | 6186 |------|------|---------|:--------:| ------- |-------------|---------| 6187 | DisplayName | string| `string` | | | | | 6188 | Label | string| `string` | | | | | 6189 | SingleSelection | boolean| `bool` | | | | | 6190 6191 6192 6193 ### <span id="analysis-message-base"></span> AnalysisMessageBase 6194 6195 6196 > AnalysisMessageBase describes some common information that is needed for all 6197 messages. All information should be static with respect to the error code. 6198 6199 6200 6201 6202 6203 6204 **Properties** 6205 6206 | Name | Type | Go type | Required | Default | Description | Example | 6207 |------|------|---------|:--------:| ------- |-------------|---------| 6208 | DocumentationUrl | string| `string` | | | A url pointing to the Istio documentation for this specific error type. 6209 Should be of the form 6210 `^http(s)?://(preliminary\.)?istio.io/docs/reference/config/analysis/` 6211 Required. | | 6212 | level | [AnalysisMessageBaseLevel](#analysis-message-base-level)| `AnalysisMessageBaseLevel` | | | | | 6213 | type | [AnalysisMessageBaseType](#analysis-message-base-type)| `AnalysisMessageBaseType` | | | | | 6214 6215 6216 6217 ### <span id="analysis-message-base-level"></span> AnalysisMessageBase_Level 6218 6219 6220 > as well as leaving space in between to add more later 6221 6222 6223 6224 6225 | Name | Type | Go type | Default | Description | Example | 6226 |------|------|---------| ------- |-------------|---------| 6227 | AnalysisMessageBase_Level | int32 (formatted integer)| int32 | | as well as leaving space in between to add more later | | 6228 6229 6230 6231 ### <span id="analysis-message-base-type"></span> AnalysisMessageBase_Type 6232 6233 6234 > A unique identifier for the type of message. Name is intended to be 6235 human-readable, code is intended to be machine readable. There should be a 6236 one-to-one mapping between name and code. (i.e. do not re-use names or 6237 codes between message types.) 6238 6239 6240 6241 6242 6243 6244 **Properties** 6245 6246 | Name | Type | Go type | Required | Default | Description | Example | 6247 |------|------|---------|:--------:| ------- |-------------|---------| 6248 | Code | string| `string` | | | A 7 character code matching `^IST[0-9]{4}$` intended to uniquely identify 6249 the message type. (e.g. "IST0001" is mapped to the "InternalError" message 6250 type.) 0000-0100 are reserved. Required. | | 6251 | Name | string| `string` | | | A human-readable name for the message type. e.g. "InternalError", 6252 "PodMissingProxy". This should be the same for all messages of the same type. 6253 Required. | | 6254 6255 6256 6257 ### <span id="app"></span> App 6258 6259 6260 6261 6262 6263 6264 **Properties** 6265 6266 | Name | Type | Go type | Required | Default | Description | Example | 6267 |------|------|---------|:--------:| ------- |-------------|---------| 6268 | Name | string| `string` | ✓ | | Name of the application | `reviews` | 6269 | Runtimes | [][Runtime](#runtime)| `[]*Runtime` | | | Runtimes and associated dashboards | | 6270 | ServiceNames | []string| `[]string` | ✓ | | List of service names linked with an application | | 6271 | Workloads | [][WorkloadItem](#workload-item)| `[]*WorkloadItem` | ✓ | | Workloads for a given application | | 6272 | health | [AppHealth](#app-health)| `AppHealth` | | | | | 6273 | namespace | [Namespace](#namespace)| `Namespace` | ✓ | | | | 6274 6275 6276 6277 ### <span id="app-health"></span> AppHealth 6278 6279 6280 > AppHealth contains aggregated health from various sources, for a given app 6281 6282 6283 6284 6285 6286 6287 **Properties** 6288 6289 | Name | Type | Go type | Required | Default | Description | Example | 6290 |------|------|---------|:--------:| ------- |-------------|---------| 6291 | WorkloadStatuses | [][WorkloadStatus](#workload-status)| `[]*WorkloadStatus` | | | | | 6292 | requests | [RequestHealth](#request-health)| `RequestHealth` | | | | | 6293 6294 6295 6296 ### <span id="app-list"></span> AppList 6297 6298 6299 6300 6301 6302 6303 **Properties** 6304 6305 | Name | Type | Go type | Required | Default | Description | Example | 6306 |------|------|---------|:--------:| ------- |-------------|---------| 6307 | Apps | [][AppListItem](#app-list-item)| `[]*AppListItem` | ✓ | | Applications for a given namespace | | 6308 | namespace | [Namespace](#namespace)| `Namespace` | ✓ | | | | 6309 6310 6311 6312 ### <span id="app-list-item"></span> AppListItem 6313 6314 6315 > AppListItem has the necessary information to display the console app list 6316 6317 6318 6319 6320 6321 6322 **Properties** 6323 6324 | Name | Type | Go type | Required | Default | Description | Example | 6325 |------|------|---------|:--------:| ------- |-------------|---------| 6326 | IstioReferences | [][IstioValidationKey](#istio-validation-key)| `[]*IstioValidationKey` | | | Istio References | | 6327 | IstioSidecar | boolean| `bool` | ✓ | | Define if all Pods related to the Workloads of this app has an IstioSidecar deployed | `true` | 6328 | Labels | map of string| `map[string]string` | | | Labels for App | | 6329 | Name | string| `string` | ✓ | | Name of the application | `reviews` | 6330 | health | [AppHealth](#app-health)| `AppHealth` | | | | | 6331 6332 6333 6334 ### <span id="authorization-policy"></span> AuthorizationPolicy 6335 6336 6337 > <!-- crd generation tags 6338 +cue-gen:AuthorizationPolicy:groupName:security.istio.io 6339 +cue-gen:AuthorizationPolicy:version:v1beta1 6340 +cue-gen:AuthorizationPolicy:storageVersion 6341 +cue-gen:AuthorizationPolicy:annotations:helm.sh/resource-policy=keep 6342 +cue-gen:AuthorizationPolicy:labels:app=istio-pilot,chart=istio,istio=security,heritage=Tiller,release=istio 6343 +cue-gen:AuthorizationPolicy:subresource:status 6344 +cue-gen:AuthorizationPolicy:scope:Namespaced 6345 +cue-gen:AuthorizationPolicy:resource:categories=istio-io,security-istio-io,plural=authorizationpolicies 6346 +cue-gen:AuthorizationPolicy:preserveUnknownFields:false 6347 > 6348 6349 <!-- go code generation tags 6350 +kubetype-gen 6351 +kubetype-gen:groupVersion=security.istio.io/v1beta1 6352 +genclient 6353 +k8s:deepcopy-gen=true 6354 > 6355 6356 6357 6358 6359 6360 6361 **Properties** 6362 6363 | Name | Type | Go type | Required | Default | Description | Example | 6364 |------|------|---------|:--------:| ------- |-------------|---------| 6365 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 6366 Servers should convert recognized schemas to the latest internal value, and 6367 may reject unrecognized values. 6368 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 6369 +optional | | 6370 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 6371 set by external tools to store and retrieve arbitrary metadata. They are not 6372 queryable and should be preserved when modifying objects. 6373 More info: http://kubernetes.io/docs/user-guide/annotations 6374 +optional | | 6375 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 6376 created. It is not guaranteed to be set in happens-before order across separate operations. 6377 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 6378 6379 Populated by the system. 6380 Read-only. 6381 Null for lists. 6382 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 6383 +optional | | 6384 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 6385 it will be removed from the system. Only set when deletionTimestamp is also set. 6386 May only be shortened. 6387 Read-only. 6388 +optional | | 6389 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 6390 field is set by the server when a graceful deletion is requested by the user, and is not 6391 directly settable by a client. The resource is expected to be deleted (no longer visible 6392 from resource lists, and not reachable by name) after the time in this field, once the 6393 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 6394 Once the deletionTimestamp is set, this value may not be unset or be set further into the 6395 future, although it may be shortened or the resource may be deleted prior to this time. 6396 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 6397 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 6398 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 6399 remove the pod from the API. In the presence of network partitions, this object may still 6400 exist after this timestamp, until an administrator or automated process can determine the 6401 resource is fully terminated. 6402 If not set, graceful deletion of the object has not been requested. 6403 6404 Populated by the system when a graceful deletion is requested. 6405 Read-only. 6406 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 6407 +optional | | 6408 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 6409 is an identifier for the responsible component that will remove the entry 6410 from the list. If the deletionTimestamp of the object is non-nil, entries 6411 in this list can only be removed. 6412 Finalizers may be processed and removed in any order. Order is NOT enforced 6413 because it introduces significant risk of stuck finalizers. 6414 finalizers is a shared field, any actor with permission can reorder it. 6415 If the finalizer list is processed in order, then this can lead to a situation 6416 in which the component responsible for the first finalizer in the list is 6417 waiting for a signal (field value, external system, or other) produced by a 6418 component responsible for a finalizer later in the list, resulting in a deadlock. 6419 Without enforced ordering finalizers are free to order amongst themselves and 6420 are not vulnerable to ordering changes in the list. 6421 +optional 6422 +patchStrategy=merge | | 6423 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 6424 name ONLY IF the Name field has not been provided. 6425 If this field is used, the name returned to the client will be different 6426 than the name passed. This value will also be combined with a unique suffix. 6427 The provided value has the same validation rules as the Name field, 6428 and may be truncated by the length of the suffix required to make the value 6429 unique on the server. 6430 6431 If this field is specified and the generated name exists, the server will return a 409. 6432 6433 Applied only if Name is not specified. 6434 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 6435 +optional | | 6436 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 6437 Populated by the system. Read-only. 6438 +optional | | 6439 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 6440 Servers may infer this from the endpoint the client submits requests to. 6441 Cannot be updated. 6442 In CamelCase. 6443 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 6444 +optional | | 6445 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 6446 (scope and select) objects. May match selectors of replication controllers 6447 and services. 6448 More info: http://kubernetes.io/docs/user-guide/labels 6449 +optional | | 6450 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 6451 that are managed by that workflow. This is mostly for internal 6452 housekeeping, and users typically shouldn't need to set or 6453 understand this field. A workflow can be the user's name, a 6454 controller's name, or the name of a specific apply path like 6455 "ci-cd". The set of fields is always in the version that the 6456 workflow used when modifying the object. 6457 6458 +optional | | 6459 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 6460 some resources may allow a client to request the generation of an appropriate name 6461 automatically. Name is primarily intended for creation idempotence and configuration 6462 definition. 6463 Cannot be updated. 6464 More info: http://kubernetes.io/docs/user-guide/identifiers#names 6465 +optional | | 6466 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 6467 equivalent to the "default" namespace, but "default" is the canonical representation. 6468 Not all objects are required to be scoped to a namespace - the value of this field for 6469 those objects will be empty. 6470 6471 Must be a DNS_LABEL. 6472 Cannot be updated. 6473 More info: http://kubernetes.io/docs/user-guide/namespaces 6474 +optional | | 6475 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 6476 been deleted, this object will be garbage collected. If this object is managed by a controller, 6477 then an entry in this list will point to this controller, with the controller field set to true. 6478 There cannot be more than one managing controller. 6479 +optional 6480 +patchMergeKey=uid 6481 +patchStrategy=merge | | 6482 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 6483 be used by clients to determine when objects have changed. May be used for optimistic 6484 concurrency, change detection, and the watch operation on a resource or set of resources. 6485 Clients must treat these values as opaque and passed unmodified back to the server. 6486 They may only be valid for a particular resource or set of resources. 6487 6488 Populated by the system. 6489 Read-only. 6490 Value must be treated as opaque by clients and . 6491 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 6492 +optional | | 6493 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 6494 +optional | | 6495 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 6496 the system and never used; it will be removed completely in 1.25. 6497 6498 The name in the go struct is changed to help clients detect 6499 accidental use. 6500 6501 +optional | | 6502 | spec | [AuthorizationPolicy](#authorization-policy)| `AuthorizationPolicy` | | | | | 6503 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 6504 | uid | [UID](#uid)| `UID` | | | | | 6505 6506 6507 6508 ### <span id="backend-object-reference"></span> BackendObjectReference 6509 6510 6511 > Note that when a namespace is specified, a ReferenceGrant object 6512 is required in the referent namespace to allow that namespace's 6513 owner to accept the reference. See the ReferenceGrant documentation 6514 for details. 6515 6516 The API object must be valid in the cluster; the Group and Kind must 6517 be registered in the cluster for this reference to be valid. 6518 6519 References to objects with invalid Group and Kind are not valid, and must 6520 be rejected by the implementation, with appropriate Conditions set 6521 on the containing object. 6522 6523 6524 6525 6526 6527 6528 **Properties** 6529 6530 | Name | Type | Go type | Required | Default | Description | Example | 6531 |------|------|---------|:--------:| ------- |-------------|---------| 6532 | group | [Group](#group)| `Group` | | | | | 6533 | kind | [Kind](#kind)| `Kind` | | | | | 6534 | name | [ObjectName](#object-name)| `ObjectName` | | | | | 6535 | namespace | [Namespace](#namespace)| `Namespace` | | | | | 6536 | port | [PortNumber](#port-number)| `PortNumber` | | | | | 6537 6538 6539 6540 ### <span id="bootstrap"></span> Bootstrap 6541 6542 6543 6544 6545 6546 6547 **Properties** 6548 6549 | Name | Type | Go type | Required | Default | Description | Example | 6550 |------|------|---------|:--------:| ------- |-------------|---------| 6551 | Bootstrap | [interface{}](#interface)| `interface{}` | | | | | 6552 6553 6554 6555 ### <span id="cert-info"></span> CertInfo 6556 6557 6558 > CertInfo contains the information for a given certificate 6559 6560 6561 6562 6563 6564 6565 **Properties** 6566 6567 | Name | Type | Go type | Required | Default | Description | Example | 6568 |------|------|---------|:--------:| ------- |-------------|---------| 6569 | Accessible | boolean| `bool` | | | | | 6570 | DNSNames | []string| `[]string` | | | | | 6571 | Error | string| `string` | | | | | 6572 | Issuer | string| `string` | | | | | 6573 | NotAfter | date-time (formatted string)| `strfmt.DateTime` | | | | | 6574 | NotBefore | date-time (formatted string)| `strfmt.DateTime` | | | | | 6575 | SecretName | string| `string` | | | | | 6576 | SecretNamespace | string| `string` | | | | | 6577 6578 6579 6580 ### <span id="chart"></span> Chart 6581 6582 6583 > Chart is the model representing a custom chart, transformed from charts in MonitoringDashboard config resource 6584 6585 6586 6587 6588 6589 6590 **Properties** 6591 6592 | Name | Type | Go type | Required | Default | Description | Example | 6593 |------|------|---------|:--------:| ------- |-------------|---------| 6594 | ChartType | string| `string` | | | | | 6595 | Error | string| `string` | | | | | 6596 | Max | int64 (formatted integer)| `int64` | | | | | 6597 | Metrics | [][Metric](#metric)| `[]*Metric` | | | | | 6598 | Min | int64 (formatted integer)| `int64` | | | | | 6599 | Name | string| `string` | | | | | 6600 | Spans | int64 (formatted integer)| `int64` | | | | | 6601 | StartCollapsed | boolean| `bool` | | | | | 6602 | Unit | string| `string` | | | | | 6603 | XAxis | string| `string` | | | | | 6604 6605 6606 6607 ### <span id="cluster"></span> Cluster 6608 6609 6610 6611 6612 6613 6614 **Properties** 6615 6616 | Name | Type | Go type | Required | Default | Description | Example | 6617 |------|------|---------|:--------:| ------- |-------------|---------| 6618 | DestinationRule | string| `string` | | | | | 6619 | Direction | string| `string` | | | | | 6620 | Port | int64 (formatted integer)| `int64` | | | | | 6621 | Subset | string| `string` | | | | | 6622 | Type | string| `string` | | | | | 6623 | service_fqdn | [Host](#host)| `Host` | | | | | 6624 6625 6626 6627 ### <span id="clusters"></span> Clusters 6628 6629 6630 6631 6632 [][Cluster](#cluster) 6633 6634 ### <span id="component-status"></span> ComponentStatus 6635 6636 6637 6638 6639 6640 6641 **Properties** 6642 6643 | Name | Type | Go type | Required | Default | Description | Example | 6644 |------|------|---------|:--------:| ------- |-------------|---------| 6645 | IsCore | boolean| `bool` | ✓ | | When true, the component is necessary for Istio to function. Otherwise, it is an addon. | `true` | 6646 | Name | string| `string` | ✓ | | The workload name of the Istio component. | `istio-ingressgateway` | 6647 | Status | string| `string` | ✓ | | The status of an Istio component. | `Not Found` | 6648 6649 6650 6651 ### <span id="condition"></span> Condition 6652 6653 6654 > This struct is intended for direct use as an array at the field path .status.conditions. For example, 6655 type FooStatus struct{ 6656 Represents the observations of a foo's current state. 6657 Known .status.conditions.type are: "Available", "Progressing", and "Degraded" 6658 +patchMergeKey=type 6659 +patchStrategy=merge 6660 +listType=map 6661 +listMapKey=type 6662 Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` 6663 6664 other fields 6665 } 6666 6667 6668 6669 6670 6671 6672 **Properties** 6673 6674 | Name | Type | Go type | Required | Default | Description | Example | 6675 |------|------|---------|:--------:| ------- |-------------|---------| 6676 | LastTransitionTime | string| `string` | | | lastTransitionTime is the last time the condition transitioned from one status to another. 6677 This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. 6678 +required 6679 +kubebuilder:validation:Required 6680 +kubebuilder:validation:Type=string 6681 +kubebuilder:validation:Format=date-time | | 6682 | Message | string| `string` | | | message is a human readable message indicating details about the transition. 6683 This may be an empty string. 6684 +required 6685 +kubebuilder:validation:Required 6686 +kubebuilder:validation:MaxLength=32768 | | 6687 | ObservedGeneration | int64 (formatted integer)| `int64` | | | observedGeneration represents the .metadata.generation that the condition was set based upon. 6688 For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date 6689 with respect to the current state of the instance. 6690 +optional 6691 +kubebuilder:validation:Minimum=0 | | 6692 | Reason | string| `string` | | | reason contains a programmatic identifier indicating the reason for the condition's last transition. 6693 Producers of specific condition types may define expected values and meanings for this field, 6694 and whether the values are considered a guaranteed API. 6695 The value should be a CamelCase string. 6696 This field may not be empty. 6697 +required 6698 +kubebuilder:validation:Required 6699 +kubebuilder:validation:MaxLength=1024 6700 +kubebuilder:validation:MinLength=1 6701 +kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$` | | 6702 | Type | string| `string` | | | type of condition in CamelCase or in foo.example.com/CamelCase. 6703 6704 Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be 6705 useful (see .node.status.conditions), the ability to deconflict is important. 6706 The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) 6707 +required 6708 +kubebuilder:validation:Required 6709 +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$` 6710 +kubebuilder:validation:MaxLength=316 | | 6711 | status | [ConditionStatus](#condition-status)| `ConditionStatus` | | | | | 6712 6713 6714 6715 ### <span id="condition-status"></span> ConditionStatus 6716 6717 6718 6719 6720 | Name | Type | Go type | Default | Description | Example | 6721 |------|------|---------| ------- |-------------|---------| 6722 | ConditionStatus | string| string | | | | 6723 6724 6725 6726 ### <span id="config"></span> Config 6727 6728 6729 6730 6731 6732 6733 **Properties** 6734 6735 | Name | Type | Go type | Required | Default | Description | Example | 6736 |------|------|---------|:--------:| ------- |-------------|---------| 6737 | Duration | int64 (formatted integer)| `int64` | | | | | 6738 | GraphType | string| `string` | | | | | 6739 | Timestamp | int64 (formatted integer)| `int64` | | | | | 6740 | elements | [Elements](#elements)| `Elements` | | | | | 6741 6742 6743 6744 ### <span id="config-dump"></span> ConfigDump 6745 6746 6747 > Root of ConfigDump 6748 6749 6750 6751 6752 6753 6754 **Properties** 6755 6756 | Name | Type | Go type | Required | Default | Description | Example | 6757 |------|------|---------|:--------:| ------- |-------------|---------| 6758 | Configs | [][interface{}](#interface)| `[]interface{}` | | | | | 6759 6760 6761 6762 ### <span id="container-info"></span> ContainerInfo 6763 6764 6765 > ContainerInfo holds container name and image 6766 6767 6768 6769 6770 6771 6772 **Properties** 6773 6774 | Name | Type | Go type | Required | Default | Description | Example | 6775 |------|------|---------|:--------:| ------- |-------------|---------| 6776 | Image | string| `string` | | | | | 6777 | IsProxy | boolean| `bool` | | | | | 6778 | IsReady | boolean| `bool` | | | | | 6779 | Name | string| `string` | | | | | 6780 6781 6782 6783 ### <span id="dashboard-ref"></span> DashboardRef 6784 6785 6786 > DashboardRef holds template name and title for a custom dashboard 6787 6788 6789 6790 6791 6792 6793 **Properties** 6794 6795 | Name | Type | Go type | Required | Default | Description | Example | 6796 |------|------|---------|:--------:| ------- |-------------|---------| 6797 | Template | string| `string` | | | | | 6798 | Title | string| `string` | | | | | 6799 6800 6801 6802 ### <span id="datapoint"></span> Datapoint 6803 6804 6805 6806 6807 6808 6809 **Properties** 6810 6811 | Name | Type | Go type | Required | Default | Description | Example | 6812 |------|------|---------|:--------:| ------- |-------------|---------| 6813 | Timestamp | int64 (formatted integer)| `int64` | | | | | 6814 | Value | double (formatted number)| `float64` | | | | | 6815 6816 6817 6818 ### <span id="destination-rule"></span> DestinationRule 6819 6820 6821 > <!-- crd generation tags 6822 +cue-gen:DestinationRule:groupName:networking.istio.io 6823 +cue-gen:DestinationRule:version:v1beta1 6824 +cue-gen:DestinationRule:annotations:helm.sh/resource-policy=keep 6825 +cue-gen:DestinationRule:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 6826 +cue-gen:DestinationRule:subresource:status 6827 +cue-gen:DestinationRule:scope:Namespaced 6828 +cue-gen:DestinationRule:resource:categories=istio-io,networking-istio-io,shortNames=dr 6829 +cue-gen:DestinationRule:printerColumn:name=Host,type=string,JSONPath=.spec.host,description="The name of a service from the service registry" 6830 +cue-gen:DestinationRule:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp 6831 representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. 6832 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 6833 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" 6834 +cue-gen:DestinationRule:preserveUnknownFields:false 6835 > 6836 6837 <!-- go code generation tags 6838 +kubetype-gen 6839 +kubetype-gen:groupVersion=networking.istio.io/v1beta1 6840 +genclient 6841 +k8s:deepcopy-gen=true 6842 > 6843 <!-- istio code generation tags 6844 +istio.io/sync-from:networking/v1alpha3/destination_rule.proto 6845 > 6846 6847 6848 6849 6850 6851 6852 **Properties** 6853 6854 | Name | Type | Go type | Required | Default | Description | Example | 6855 |------|------|---------|:--------:| ------- |-------------|---------| 6856 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 6857 Servers should convert recognized schemas to the latest internal value, and 6858 may reject unrecognized values. 6859 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 6860 +optional | | 6861 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 6862 set by external tools to store and retrieve arbitrary metadata. They are not 6863 queryable and should be preserved when modifying objects. 6864 More info: http://kubernetes.io/docs/user-guide/annotations 6865 +optional | | 6866 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 6867 created. It is not guaranteed to be set in happens-before order across separate operations. 6868 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 6869 6870 Populated by the system. 6871 Read-only. 6872 Null for lists. 6873 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 6874 +optional | | 6875 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 6876 it will be removed from the system. Only set when deletionTimestamp is also set. 6877 May only be shortened. 6878 Read-only. 6879 +optional | | 6880 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 6881 field is set by the server when a graceful deletion is requested by the user, and is not 6882 directly settable by a client. The resource is expected to be deleted (no longer visible 6883 from resource lists, and not reachable by name) after the time in this field, once the 6884 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 6885 Once the deletionTimestamp is set, this value may not be unset or be set further into the 6886 future, although it may be shortened or the resource may be deleted prior to this time. 6887 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 6888 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 6889 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 6890 remove the pod from the API. In the presence of network partitions, this object may still 6891 exist after this timestamp, until an administrator or automated process can determine the 6892 resource is fully terminated. 6893 If not set, graceful deletion of the object has not been requested. 6894 6895 Populated by the system when a graceful deletion is requested. 6896 Read-only. 6897 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 6898 +optional | | 6899 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 6900 is an identifier for the responsible component that will remove the entry 6901 from the list. If the deletionTimestamp of the object is non-nil, entries 6902 in this list can only be removed. 6903 Finalizers may be processed and removed in any order. Order is NOT enforced 6904 because it introduces significant risk of stuck finalizers. 6905 finalizers is a shared field, any actor with permission can reorder it. 6906 If the finalizer list is processed in order, then this can lead to a situation 6907 in which the component responsible for the first finalizer in the list is 6908 waiting for a signal (field value, external system, or other) produced by a 6909 component responsible for a finalizer later in the list, resulting in a deadlock. 6910 Without enforced ordering finalizers are free to order amongst themselves and 6911 are not vulnerable to ordering changes in the list. 6912 +optional 6913 +patchStrategy=merge | | 6914 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 6915 name ONLY IF the Name field has not been provided. 6916 If this field is used, the name returned to the client will be different 6917 than the name passed. This value will also be combined with a unique suffix. 6918 The provided value has the same validation rules as the Name field, 6919 and may be truncated by the length of the suffix required to make the value 6920 unique on the server. 6921 6922 If this field is specified and the generated name exists, the server will return a 409. 6923 6924 Applied only if Name is not specified. 6925 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 6926 +optional | | 6927 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 6928 Populated by the system. Read-only. 6929 +optional | | 6930 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 6931 Servers may infer this from the endpoint the client submits requests to. 6932 Cannot be updated. 6933 In CamelCase. 6934 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 6935 +optional | | 6936 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 6937 (scope and select) objects. May match selectors of replication controllers 6938 and services. 6939 More info: http://kubernetes.io/docs/user-guide/labels 6940 +optional | | 6941 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 6942 that are managed by that workflow. This is mostly for internal 6943 housekeeping, and users typically shouldn't need to set or 6944 understand this field. A workflow can be the user's name, a 6945 controller's name, or the name of a specific apply path like 6946 "ci-cd". The set of fields is always in the version that the 6947 workflow used when modifying the object. 6948 6949 +optional | | 6950 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 6951 some resources may allow a client to request the generation of an appropriate name 6952 automatically. Name is primarily intended for creation idempotence and configuration 6953 definition. 6954 Cannot be updated. 6955 More info: http://kubernetes.io/docs/user-guide/identifiers#names 6956 +optional | | 6957 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 6958 equivalent to the "default" namespace, but "default" is the canonical representation. 6959 Not all objects are required to be scoped to a namespace - the value of this field for 6960 those objects will be empty. 6961 6962 Must be a DNS_LABEL. 6963 Cannot be updated. 6964 More info: http://kubernetes.io/docs/user-guide/namespaces 6965 +optional | | 6966 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 6967 been deleted, this object will be garbage collected. If this object is managed by a controller, 6968 then an entry in this list will point to this controller, with the controller field set to true. 6969 There cannot be more than one managing controller. 6970 +optional 6971 +patchMergeKey=uid 6972 +patchStrategy=merge | | 6973 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 6974 be used by clients to determine when objects have changed. May be used for optimistic 6975 concurrency, change detection, and the watch operation on a resource or set of resources. 6976 Clients must treat these values as opaque and passed unmodified back to the server. 6977 They may only be valid for a particular resource or set of resources. 6978 6979 Populated by the system. 6980 Read-only. 6981 Value must be treated as opaque by clients and . 6982 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 6983 +optional | | 6984 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 6985 +optional | | 6986 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 6987 the system and never used; it will be removed completely in 1.25. 6988 6989 The name in the go struct is changed to help clients detect 6990 accidental use. 6991 6992 +optional | | 6993 | spec | [DestinationRule](#destination-rule)| `DestinationRule` | | | | | 6994 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 6995 | uid | [UID](#uid)| `UID` | | | | | 6996 6997 6998 6999 ### <span id="edge-data"></span> EdgeData 7000 7001 7002 7003 7004 7005 7006 **Properties** 7007 7008 | Name | Type | Go type | Required | Default | Description | Example | 7009 |------|------|---------|:--------:| ------- |-------------|---------| 7010 | DestPrincipal | string| `string` | | | App Fields (not required by Cytoscape) | | 7011 | ID | string| `string` | | | Cytoscape Fields | | 7012 | IsMTLS | string| `string` | | | | | 7013 | ResponseTime | string| `string` | | | | | 7014 | Source | string| `string` | | | | | 7015 | SourcePrincipal | string| `string` | | | | | 7016 | Target | string| `string` | | | | | 7017 | Throughput | string| `string` | | | | | 7018 | traffic | [ProtocolTraffic](#protocol-traffic)| `ProtocolTraffic` | | | | | 7019 7020 7021 7022 ### <span id="edge-wrapper"></span> EdgeWrapper 7023 7024 7025 7026 7027 7028 7029 **Properties** 7030 7031 | Name | Type | Go type | Required | Default | Description | Example | 7032 |------|------|---------|:--------:| ------- |-------------|---------| 7033 | data | [EdgeData](#edge-data)| `EdgeData` | | | | | 7034 7035 7036 7037 ### <span id="elements"></span> Elements 7038 7039 7040 7041 7042 7043 7044 **Properties** 7045 7046 | Name | Type | Go type | Required | Default | Description | Example | 7047 |------|------|---------|:--------:| ------- |-------------|---------| 7048 | Edges | [][EdgeWrapper](#edge-wrapper)| `[]*EdgeWrapper` | | | | | 7049 | Nodes | [][NodeWrapper](#node-wrapper)| `[]*NodeWrapper` | | | | | 7050 7051 7052 7053 ### <span id="endpoint"></span> Endpoint 7054 7055 7056 7057 7058 7059 7060 **Properties** 7061 7062 | Name | Type | Go type | Required | Default | Description | Example | 7063 |------|------|---------|:--------:| ------- |-------------|---------| 7064 | addresses | [Addresses](#addresses)| `Addresses` | | | | | 7065 | ports | [Ports](#ports)| `Ports` | | | | | 7066 7067 7068 7069 ### <span id="endpoints"></span> Endpoints 7070 7071 7072 7073 7074 [][Endpoint](#endpoint) 7075 7076 ### <span id="envoy-filter"></span> EnvoyFilter 7077 7078 7079 > <!-- crd generation tags 7080 +cue-gen:EnvoyFilter:groupName:networking.istio.io 7081 +cue-gen:EnvoyFilter:version:v1alpha3 7082 +cue-gen:EnvoyFilter:storageVersion 7083 +cue-gen:EnvoyFilter:annotations:helm.sh/resource-policy=keep 7084 +cue-gen:EnvoyFilter:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 7085 +cue-gen:EnvoyFilter:subresource:status 7086 +cue-gen:EnvoyFilter:scope:Namespaced 7087 +cue-gen:EnvoyFilter:resource:categories=istio-io,networking-istio-io 7088 +cue-gen:EnvoyFilter:preserveUnknownFields:configPatches.[].patch.value 7089 > 7090 7091 <!-- go code generation tags 7092 +kubetype-gen 7093 +kubetype-gen:groupVersion=networking.istio.io/v1alpha3 7094 +genclient 7095 +k8s:deepcopy-gen=true 7096 > 7097 7098 7099 7100 7101 7102 7103 **Properties** 7104 7105 | Name | Type | Go type | Required | Default | Description | Example | 7106 |------|------|---------|:--------:| ------- |-------------|---------| 7107 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 7108 Servers should convert recognized schemas to the latest internal value, and 7109 may reject unrecognized values. 7110 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 7111 +optional | | 7112 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 7113 set by external tools to store and retrieve arbitrary metadata. They are not 7114 queryable and should be preserved when modifying objects. 7115 More info: http://kubernetes.io/docs/user-guide/annotations 7116 +optional | | 7117 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 7118 created. It is not guaranteed to be set in happens-before order across separate operations. 7119 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 7120 7121 Populated by the system. 7122 Read-only. 7123 Null for lists. 7124 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 7125 +optional | | 7126 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 7127 it will be removed from the system. Only set when deletionTimestamp is also set. 7128 May only be shortened. 7129 Read-only. 7130 +optional | | 7131 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 7132 field is set by the server when a graceful deletion is requested by the user, and is not 7133 directly settable by a client. The resource is expected to be deleted (no longer visible 7134 from resource lists, and not reachable by name) after the time in this field, once the 7135 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 7136 Once the deletionTimestamp is set, this value may not be unset or be set further into the 7137 future, although it may be shortened or the resource may be deleted prior to this time. 7138 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 7139 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 7140 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 7141 remove the pod from the API. In the presence of network partitions, this object may still 7142 exist after this timestamp, until an administrator or automated process can determine the 7143 resource is fully terminated. 7144 If not set, graceful deletion of the object has not been requested. 7145 7146 Populated by the system when a graceful deletion is requested. 7147 Read-only. 7148 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 7149 +optional | | 7150 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 7151 is an identifier for the responsible component that will remove the entry 7152 from the list. If the deletionTimestamp of the object is non-nil, entries 7153 in this list can only be removed. 7154 Finalizers may be processed and removed in any order. Order is NOT enforced 7155 because it introduces significant risk of stuck finalizers. 7156 finalizers is a shared field, any actor with permission can reorder it. 7157 If the finalizer list is processed in order, then this can lead to a situation 7158 in which the component responsible for the first finalizer in the list is 7159 waiting for a signal (field value, external system, or other) produced by a 7160 component responsible for a finalizer later in the list, resulting in a deadlock. 7161 Without enforced ordering finalizers are free to order amongst themselves and 7162 are not vulnerable to ordering changes in the list. 7163 +optional 7164 +patchStrategy=merge | | 7165 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 7166 name ONLY IF the Name field has not been provided. 7167 If this field is used, the name returned to the client will be different 7168 than the name passed. This value will also be combined with a unique suffix. 7169 The provided value has the same validation rules as the Name field, 7170 and may be truncated by the length of the suffix required to make the value 7171 unique on the server. 7172 7173 If this field is specified and the generated name exists, the server will return a 409. 7174 7175 Applied only if Name is not specified. 7176 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 7177 +optional | | 7178 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 7179 Populated by the system. Read-only. 7180 +optional | | 7181 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 7182 Servers may infer this from the endpoint the client submits requests to. 7183 Cannot be updated. 7184 In CamelCase. 7185 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 7186 +optional | | 7187 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 7188 (scope and select) objects. May match selectors of replication controllers 7189 and services. 7190 More info: http://kubernetes.io/docs/user-guide/labels 7191 +optional | | 7192 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 7193 that are managed by that workflow. This is mostly for internal 7194 housekeeping, and users typically shouldn't need to set or 7195 understand this field. A workflow can be the user's name, a 7196 controller's name, or the name of a specific apply path like 7197 "ci-cd". The set of fields is always in the version that the 7198 workflow used when modifying the object. 7199 7200 +optional | | 7201 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 7202 some resources may allow a client to request the generation of an appropriate name 7203 automatically. Name is primarily intended for creation idempotence and configuration 7204 definition. 7205 Cannot be updated. 7206 More info: http://kubernetes.io/docs/user-guide/identifiers#names 7207 +optional | | 7208 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 7209 equivalent to the "default" namespace, but "default" is the canonical representation. 7210 Not all objects are required to be scoped to a namespace - the value of this field for 7211 those objects will be empty. 7212 7213 Must be a DNS_LABEL. 7214 Cannot be updated. 7215 More info: http://kubernetes.io/docs/user-guide/namespaces 7216 +optional | | 7217 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 7218 been deleted, this object will be garbage collected. If this object is managed by a controller, 7219 then an entry in this list will point to this controller, with the controller field set to true. 7220 There cannot be more than one managing controller. 7221 +optional 7222 +patchMergeKey=uid 7223 +patchStrategy=merge | | 7224 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 7225 be used by clients to determine when objects have changed. May be used for optimistic 7226 concurrency, change detection, and the watch operation on a resource or set of resources. 7227 Clients must treat these values as opaque and passed unmodified back to the server. 7228 They may only be valid for a particular resource or set of resources. 7229 7230 Populated by the system. 7231 Read-only. 7232 Value must be treated as opaque by clients and . 7233 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 7234 +optional | | 7235 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 7236 +optional | | 7237 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 7238 the system and never used; it will be removed completely in 1.25. 7239 7240 The name in the go struct is changed to help clients detect 7241 accidental use. 7242 7243 +optional | | 7244 | spec | [EnvoyFilter](#envoy-filter)| `EnvoyFilter` | | | | | 7245 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 7246 | uid | [UID](#uid)| `UID` | | | | | 7247 7248 7249 7250 ### <span id="envoy-proxy-dump"></span> EnvoyProxyDump 7251 7252 7253 7254 7255 7256 7257 **Properties** 7258 7259 | Name | Type | Go type | Required | Default | Description | Example | 7260 |------|------|---------|:--------:| ------- |-------------|---------| 7261 | bootstrap | [Bootstrap](#bootstrap)| `Bootstrap` | | | | | 7262 | clusters | [Clusters](#clusters)| `Clusters` | | | | | 7263 | config_dump | [ConfigDump](#config-dump)| `ConfigDump` | | | | | 7264 | listeners | [Listeners](#listeners)| `Listeners` | | | | | 7265 | routes | [Routes](#routes)| `Routes` | | | | | 7266 7267 7268 7269 ### <span id="external-link"></span> ExternalLink 7270 7271 7272 > ExternalLink provides links to external dashboards (e.g. to Grafana) 7273 7274 7275 7276 7277 7278 7279 **Properties** 7280 7281 | Name | Type | Go type | Required | Default | Description | Example | 7282 |------|------|---------|:--------:| ------- |-------------|---------| 7283 | Name | string| `string` | | | | | 7284 | URL | string| `string` | | | | | 7285 | variables | [MonitoringDashboardExternalLinkVariables](#monitoring-dashboard-external-link-variables)| `MonitoringDashboardExternalLinkVariables` | | | | | 7286 7287 7288 7289 ### <span id="external-service-info"></span> ExternalServiceInfo 7290 7291 7292 > Status response model 7293 This is used for returning a response of Kiali Status 7294 7295 7296 7297 7298 7299 7300 **Properties** 7301 7302 | Name | Type | Go type | Required | Default | Description | Example | 7303 |------|------|---------|:--------:| ------- |-------------|---------| 7304 | Name | string| `string` | ✓ | | The name of the service | `Istio` | 7305 | Url | string| `string` | | | The service url | `jaeger-query-istio-system.127.0.0.1.nip.io` | 7306 | Version | string| `string` | | | The installed version of the service | `0.8.0` | 7307 7308 7309 7310 ### <span id="fields-v1"></span> FieldsV1 7311 7312 7313 > Each key is either a '.' representing the field itself, and will always map to an empty set, 7314 or a string representing a sub-field or item. The string will follow one of these four formats: 7315 'f:<name>', where <name> is the name of a field in a struct, or key in a map 7316 'v:<value>', where <value> is the exact json formatted value of a list item 7317 'i:<index>', where <index> is position of a item in a list 7318 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values 7319 If a key maps to an empty Fields value, the field that key represents is part of the set. 7320 7321 The exact format is defined in sigs.k8s.io/structured-merge-diff 7322 +protobuf.options.(gogoproto.goproto_stringer)=false 7323 7324 7325 7326 7327 [interface{}](#interface) 7328 7329 ### <span id="g-w-info"></span> GWInfo 7330 7331 7332 > GWInfo contains the resolved gateway configuration if the node represents an Istio gateway 7333 7334 7335 7336 7337 7338 7339 **Properties** 7340 7341 | Name | Type | Go type | Required | Default | Description | Example | 7342 |------|------|---------|:--------:| ------- |-------------|---------| 7343 | egressInfo | [GWInfoIngress](#g-w-info-ingress)| `GWInfoIngress` | | | | | 7344 | gatewayAPIInfo | [GWInfoIngress](#g-w-info-ingress)| `GWInfoIngress` | | | | | 7345 | ingressInfo | [GWInfoIngress](#g-w-info-ingress)| `GWInfoIngress` | | | | | 7346 7347 7348 7349 ### <span id="g-w-info-ingress"></span> GWInfoIngress 7350 7351 7352 > GWInfoIngress contains the resolved gateway configuration if the node represents an Istio ingress gateway 7353 7354 7355 7356 7357 7358 7359 **Properties** 7360 7361 | Name | Type | Go type | Required | Default | Description | Example | 7362 |------|------|---------|:--------:| ------- |-------------|---------| 7363 | Hostnames | []string| `[]string` | | | Hostnames is the list of hosts being served by the associated Istio gateways. | | 7364 7365 7366 7367 ### <span id="gateway"></span> Gateway 7368 7369 7370 > Gateway represents an instance of a service-traffic handling infrastructure 7371 by binding Listeners to a set of IP addresses. 7372 7373 7374 7375 7376 7377 7378 **Properties** 7379 7380 | Name | Type | Go type | Required | Default | Description | Example | 7381 |------|------|---------|:--------:| ------- |-------------|---------| 7382 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 7383 Servers should convert recognized schemas to the latest internal value, and 7384 may reject unrecognized values. 7385 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 7386 +optional | | 7387 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 7388 set by external tools to store and retrieve arbitrary metadata. They are not 7389 queryable and should be preserved when modifying objects. 7390 More info: http://kubernetes.io/docs/user-guide/annotations 7391 +optional | | 7392 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 7393 created. It is not guaranteed to be set in happens-before order across separate operations. 7394 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 7395 7396 Populated by the system. 7397 Read-only. 7398 Null for lists. 7399 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 7400 +optional | | 7401 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 7402 it will be removed from the system. Only set when deletionTimestamp is also set. 7403 May only be shortened. 7404 Read-only. 7405 +optional | | 7406 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 7407 field is set by the server when a graceful deletion is requested by the user, and is not 7408 directly settable by a client. The resource is expected to be deleted (no longer visible 7409 from resource lists, and not reachable by name) after the time in this field, once the 7410 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 7411 Once the deletionTimestamp is set, this value may not be unset or be set further into the 7412 future, although it may be shortened or the resource may be deleted prior to this time. 7413 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 7414 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 7415 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 7416 remove the pod from the API. In the presence of network partitions, this object may still 7417 exist after this timestamp, until an administrator or automated process can determine the 7418 resource is fully terminated. 7419 If not set, graceful deletion of the object has not been requested. 7420 7421 Populated by the system when a graceful deletion is requested. 7422 Read-only. 7423 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 7424 +optional | | 7425 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 7426 is an identifier for the responsible component that will remove the entry 7427 from the list. If the deletionTimestamp of the object is non-nil, entries 7428 in this list can only be removed. 7429 Finalizers may be processed and removed in any order. Order is NOT enforced 7430 because it introduces significant risk of stuck finalizers. 7431 finalizers is a shared field, any actor with permission can reorder it. 7432 If the finalizer list is processed in order, then this can lead to a situation 7433 in which the component responsible for the first finalizer in the list is 7434 waiting for a signal (field value, external system, or other) produced by a 7435 component responsible for a finalizer later in the list, resulting in a deadlock. 7436 Without enforced ordering finalizers are free to order amongst themselves and 7437 are not vulnerable to ordering changes in the list. 7438 +optional 7439 +patchStrategy=merge | | 7440 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 7441 name ONLY IF the Name field has not been provided. 7442 If this field is used, the name returned to the client will be different 7443 than the name passed. This value will also be combined with a unique suffix. 7444 The provided value has the same validation rules as the Name field, 7445 and may be truncated by the length of the suffix required to make the value 7446 unique on the server. 7447 7448 If this field is specified and the generated name exists, the server will return a 409. 7449 7450 Applied only if Name is not specified. 7451 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 7452 +optional | | 7453 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 7454 Populated by the system. Read-only. 7455 +optional | | 7456 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 7457 Servers may infer this from the endpoint the client submits requests to. 7458 Cannot be updated. 7459 In CamelCase. 7460 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 7461 +optional | | 7462 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 7463 (scope and select) objects. May match selectors of replication controllers 7464 and services. 7465 More info: http://kubernetes.io/docs/user-guide/labels 7466 +optional | | 7467 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 7468 that are managed by that workflow. This is mostly for internal 7469 housekeeping, and users typically shouldn't need to set or 7470 understand this field. A workflow can be the user's name, a 7471 controller's name, or the name of a specific apply path like 7472 "ci-cd". The set of fields is always in the version that the 7473 workflow used when modifying the object. 7474 7475 +optional | | 7476 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 7477 some resources may allow a client to request the generation of an appropriate name 7478 automatically. Name is primarily intended for creation idempotence and configuration 7479 definition. 7480 Cannot be updated. 7481 More info: http://kubernetes.io/docs/user-guide/identifiers#names 7482 +optional | | 7483 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 7484 equivalent to the "default" namespace, but "default" is the canonical representation. 7485 Not all objects are required to be scoped to a namespace - the value of this field for 7486 those objects will be empty. 7487 7488 Must be a DNS_LABEL. 7489 Cannot be updated. 7490 More info: http://kubernetes.io/docs/user-guide/namespaces 7491 +optional | | 7492 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 7493 been deleted, this object will be garbage collected. If this object is managed by a controller, 7494 then an entry in this list will point to this controller, with the controller field set to true. 7495 There cannot be more than one managing controller. 7496 +optional 7497 +patchMergeKey=uid 7498 +patchStrategy=merge | | 7499 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 7500 be used by clients to determine when objects have changed. May be used for optimistic 7501 concurrency, change detection, and the watch operation on a resource or set of resources. 7502 Clients must treat these values as opaque and passed unmodified back to the server. 7503 They may only be valid for a particular resource or set of resources. 7504 7505 Populated by the system. 7506 Read-only. 7507 Value must be treated as opaque by clients and . 7508 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 7509 +optional | | 7510 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 7511 +optional | | 7512 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 7513 the system and never used; it will be removed completely in 1.25. 7514 7515 The name in the go struct is changed to help clients detect 7516 accidental use. 7517 7518 +optional | | 7519 | spec | [GatewaySpec](#gateway-spec)| `GatewaySpec` | | | | | 7520 | status | [GatewayStatus](#gateway-status)| `GatewayStatus` | | | | | 7521 | uid | [UID](#uid)| `UID` | | | | | 7522 7523 7524 7525 ### <span id="gateway-address"></span> GatewayAddress 7526 7527 7528 7529 7530 7531 7532 **Properties** 7533 7534 | Name | Type | Go type | Required | Default | Description | Example | 7535 |------|------|---------|:--------:| ------- |-------------|---------| 7536 | Value | string| `string` | | | Value of the address. The validity of the values will depend 7537 on the type and support by the controller. 7538 7539 Examples: `1.2.3.4`, `128::1`, `my-ip-address`. 7540 7541 +kubebuilder:validation:MinLength=1 7542 +kubebuilder:validation:MaxLength=253 | | 7543 | type | [AddressType](#address-type)| `AddressType` | | | | | 7544 7545 7546 7547 ### <span id="gateway-controller"></span> GatewayController 7548 7549 7550 > Valid values include: 7551 7552 "example.com/bar" 7553 7554 Invalid values include: 7555 7556 "example.com" - must include path 7557 "foo.example.com" - must include path 7558 7559 +kubebuilder:validation:MinLength=1 7560 +kubebuilder:validation:MaxLength=253 7561 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$` 7562 7563 7564 7565 7566 | Name | Type | Go type | Default | Description | Example | 7567 |------|------|---------| ------- |-------------|---------| 7568 | GatewayController | string| string | | Valid values include: 7569 7570 "example.com/bar" 7571 7572 Invalid values include: 7573 7574 "example.com" - must include path 7575 "foo.example.com" - must include path 7576 7577 +kubebuilder:validation:MinLength=1 7578 +kubebuilder:validation:MaxLength=253 7579 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$` | | 7580 7581 7582 7583 ### <span id="gateway-spec"></span> GatewaySpec 7584 7585 7586 > Not all possible combinations of options specified in the Spec are 7587 valid. Some invalid configurations can be caught synchronously via a 7588 webhook, but there are many cases that will require asynchronous 7589 signaling via the GatewayStatus block. 7590 7591 7592 7593 7594 7595 7596 **Properties** 7597 7598 | Name | Type | Go type | Required | Default | Description | Example | 7599 |------|------|---------|:--------:| ------- |-------------|---------| 7600 | Addresses | [][GatewayAddress](#gateway-address)| `[]*GatewayAddress` | | | Addresses requested for this Gateway. This is optional and behavior can 7601 depend on the implementation. If a value is set in the spec and the 7602 requested address is invalid or unavailable, the implementation MUST 7603 indicate this in the associated entry in GatewayStatus.Addresses. 7604 7605 The Addresses field represents a request for the address(es) on the 7606 "outside of the Gateway", that traffic bound for this Gateway will use. 7607 This could be the IP address or hostname of an external load balancer or 7608 other networking infrastructure, or some other address that traffic will 7609 be sent to. 7610 7611 The .listener.hostname field is used to route traffic that has already 7612 arrived at the Gateway to the correct in-cluster destination. 7613 7614 If no Addresses are specified, the implementation MAY schedule the 7615 Gateway in an implementation-specific manner, assigning an appropriate 7616 set of Addresses. 7617 7618 The implementation MUST bind all Listeners to every GatewayAddress that 7619 it assigns to the Gateway and add a corresponding entry in 7620 GatewayStatus.Addresses. 7621 7622 Support: Extended 7623 7624 +optional 7625 +kubebuilder:validation:MaxItems=16 | | 7626 | Listeners | [][Listener](#listener)| `[]*Listener` | | | Listeners associated with this Gateway. Listeners define 7627 logical endpoints that are bound on this Gateway's addresses. 7628 At least one Listener MUST be specified. 7629 7630 Each listener in a Gateway must have a unique combination of Hostname, 7631 Port, and Protocol. 7632 7633 An implementation MAY group Listeners by Port and then collapse each 7634 group of Listeners into a single Listener if the implementation 7635 determines that the Listeners in the group are "compatible". An 7636 implementation MAY also group together and collapse compatible 7637 Listeners belonging to different Gateways. 7638 7639 For example, an implementation might consider Listeners to be 7640 compatible with each other if all of the following conditions are 7641 met: 7642 7643 1. Either each Listener within the group specifies the "HTTP" 7644 Protocol or each Listener within the group specifies either 7645 the "HTTPS" or "TLS" Protocol. 7646 7647 2. Each Listener within the group specifies a Hostname that is unique 7648 within the group. 7649 7650 3. As a special case, one Listener within a group may omit Hostname, 7651 in which case this Listener matches when no other Listener 7652 matches. 7653 7654 If the implementation does collapse compatible Listeners, the 7655 hostname provided in the incoming client request MUST be 7656 matched to a Listener to find the correct set of Routes. 7657 The incoming hostname MUST be matched using the Hostname 7658 field for each Listener in order of most to least specific. 7659 That is, exact matches must be processed before wildcard 7660 matches. 7661 7662 If this field specifies multiple Listeners that have the same 7663 Port value but are not compatible, the implementation must raise 7664 a "Conflicted" condition in the Listener status. 7665 7666 Support: Core 7667 7668 +listType=map 7669 +listMapKey=name 7670 +kubebuilder:validation:MinItems=1 7671 +kubebuilder:validation:MaxItems=64 | | 7672 | gatewayClassName | [ObjectName](#object-name)| `ObjectName` | | | | | 7673 7674 7675 7676 ### <span id="gateway-status"></span> GatewayStatus 7677 7678 7679 7680 7681 7682 7683 **Properties** 7684 7685 | Name | Type | Go type | Required | Default | Description | Example | 7686 |------|------|---------|:--------:| ------- |-------------|---------| 7687 | Addresses | [][GatewayAddress](#gateway-address)| `[]*GatewayAddress` | | | Addresses lists the IP addresses that have actually been 7688 bound to the Gateway. These addresses may differ from the 7689 addresses in the Spec, e.g. if the Gateway automatically 7690 assigns an address from a reserved pool. 7691 7692 +optional 7693 +kubebuilder:validation:MaxItems=16 | | 7694 | Conditions | [][Condition](#condition)| `[]*Condition` | | | Conditions describe the current conditions of the Gateway. 7695 7696 Implementations should prefer to express Gateway conditions 7697 using the `GatewayConditionType` and `GatewayConditionReason` 7698 constants so that operators and tools can converge on a common 7699 vocabulary to describe Gateway state. 7700 7701 Known condition types are: 7702 7703 "Scheduled" 7704 "Ready" 7705 7706 +optional 7707 +listType=map 7708 +listMapKey=type 7709 +kubebuilder:validation:MaxItems=8 7710 +kubebuilder:default={{type: "Scheduled", status: "Unknown", reason:"NotReconciled", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}} | | 7711 | Listeners | [][ListenerStatus](#listener-status)| `[]*ListenerStatus` | | | Listeners provide status for each unique listener port defined in the Spec. 7712 7713 +optional 7714 +listType=map 7715 +listMapKey=name 7716 +kubebuilder:validation:MaxItems=64 | | 7717 7718 7719 7720 ### <span id="grafana-info"></span> GrafanaInfo 7721 7722 7723 > GrafanaInfo provides information to access Grafana dashboards 7724 7725 7726 7727 7728 7729 7730 **Properties** 7731 7732 | Name | Type | Go type | Required | Default | Description | Example | 7733 |------|------|---------|:--------:| ------- |-------------|---------| 7734 | ExternalLinks | [][ExternalLink](#external-link)| `[]*ExternalLink` | | | | | 7735 7736 7737 7738 ### <span id="group"></span> Group 7739 7740 7741 > This validation is based off of the corresponding Kubernetes validation: 7742 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 7743 7744 Valid values include: 7745 7746 "" - empty string implies core Kubernetes API group 7747 "networking.k8s.io" 7748 "foo.example.com" 7749 7750 Invalid values include: 7751 7752 "example.com/bar" - "/" is an invalid character 7753 7754 +kubebuilder:validation:MaxLength=253 7755 +kubebuilder:validation:Pattern=`^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` 7756 7757 7758 7759 7760 | Name | Type | Go type | Default | Description | Example | 7761 |------|------|---------| ------- |-------------|---------| 7762 | Group | string| string | | This validation is based off of the corresponding Kubernetes validation: 7763 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 7764 7765 Valid values include: 7766 7767 "" - empty string implies core Kubernetes API group 7768 "networking.k8s.io" 7769 "foo.example.com" 7770 7771 Invalid values include: 7772 7773 "example.com/bar" - "/" is an invalid character 7774 7775 +kubebuilder:validation:MaxLength=253 7776 +kubebuilder:validation:Pattern=`^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` | | 7777 7778 7779 7780 ### <span id="http-backend-ref"></span> HTTPBackendRef 7781 7782 7783 7784 7785 7786 7787 **Properties** 7788 7789 | Name | Type | Go type | Required | Default | Description | Example | 7790 |------|------|---------|:--------:| ------- |-------------|---------| 7791 | Filters | [][HTTPRouteFilter](#http-route-filter)| `[]*HTTPRouteFilter` | | | Filters defined at this level should be executed if and only if the 7792 request is being forwarded to the backend defined here. 7793 7794 Support: Custom (For broader support of filters, use the Filters field 7795 in HTTPRouteRule.) 7796 7797 +optional 7798 +kubebuilder:validation:MaxItems=16 | | 7799 | Weight | int32 (formatted integer)| `int32` | | | Weight specifies the proportion of requests forwarded to the referenced 7800 backend. This is computed as weight/(sum of all weights in this 7801 BackendRefs list). For non-zero values, there may be some epsilon from 7802 the exact proportion defined here depending on the precision an 7803 implementation supports. Weight is not a percentage and the sum of 7804 weights does not need to equal 100. 7805 7806 If only one backend is specified and it has a weight greater than 0, 100% 7807 of the traffic is forwarded to that backend. If weight is set to 0, no 7808 traffic should be forwarded for this entry. If unspecified, weight 7809 defaults to 1. 7810 7811 Support for this field varies based on the context where used. 7812 7813 +optional 7814 +kubebuilder:default=1 7815 +kubebuilder:validation:Minimum=0 7816 +kubebuilder:validation:Maximum=1000000 | | 7817 | group | [Group](#group)| `Group` | | | | | 7818 | kind | [Kind](#kind)| `Kind` | | | | | 7819 | name | [ObjectName](#object-name)| `ObjectName` | | | | | 7820 | namespace | [Namespace](#namespace)| `Namespace` | | | | | 7821 | port | [PortNumber](#port-number)| `PortNumber` | | | | | 7822 7823 7824 7825 ### <span id="http-header"></span> HTTPHeader 7826 7827 7828 7829 7830 7831 7832 **Properties** 7833 7834 | Name | Type | Go type | Required | Default | Description | Example | 7835 |------|------|---------|:--------:| ------- |-------------|---------| 7836 | Value | string| `string` | | | Value is the value of HTTP Header to be matched. 7837 7838 +kubebuilder:validation:MinLength=1 7839 +kubebuilder:validation:MaxLength=4096 | | 7840 | name | [HTTPHeaderName](#http-header-name)| `HTTPHeaderName` | | | | | 7841 7842 7843 7844 ### <span id="http-header-match"></span> HTTPHeaderMatch 7845 7846 7847 > HTTPHeaderMatch describes how to select a HTTP route by matching HTTP request 7848 headers. 7849 7850 7851 7852 7853 7854 7855 **Properties** 7856 7857 | Name | Type | Go type | Required | Default | Description | Example | 7858 |------|------|---------|:--------:| ------- |-------------|---------| 7859 | Value | string| `string` | | | Value is the value of HTTP Header to be matched. 7860 7861 +kubebuilder:validation:MinLength=1 7862 +kubebuilder:validation:MaxLength=4096 | | 7863 | name | [HTTPHeaderName](#http-header-name)| `HTTPHeaderName` | | | | | 7864 | type | [HeaderMatchType](#header-match-type)| `HeaderMatchType` | | | | | 7865 7866 7867 7868 ### <span id="http-header-name"></span> HTTPHeaderName 7869 7870 7871 > Valid values include: 7872 7873 "Authorization" 7874 "Set-Cookie" 7875 7876 Invalid values include: 7877 7878 ":method" - ":" is an invalid character. This means that HTTP/2 pseudo 7879 headers are not currently supported by this type. 7880 "/invalid" - "/" is an invalid character 7881 7882 +kubebuilder:validation:MinLength=1 7883 +kubebuilder:validation:MaxLength=256 7884 +kubebuilder:validation:Pattern=`^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$` 7885 7886 7887 7888 7889 | Name | Type | Go type | Default | Description | Example | 7890 |------|------|---------| ------- |-------------|---------| 7891 | HTTPHeaderName | string| string | | Valid values include: 7892 7893 "Authorization" 7894 "Set-Cookie" 7895 7896 Invalid values include: 7897 7898 ":method" - ":" is an invalid character. This means that HTTP/2 pseudo 7899 headers are not currently supported by this type. 7900 "/invalid" - "/" is an invalid character 7901 7902 +kubebuilder:validation:MinLength=1 7903 +kubebuilder:validation:MaxLength=256 7904 +kubebuilder:validation:Pattern=`^[A-Za-z0-9!#$%&'*+\-.^_\x60|~]+$` | | 7905 7906 7907 7908 ### <span id="http-method"></span> HTTPMethod 7909 7910 7911 > Note that values may be added to this enum, implementations 7912 must ensure that unknown values will not cause a crash. 7913 7914 Unknown values here must result in the implementation setting the 7915 Attached Condition for the Route to `status: False`, with a 7916 Reason of `UnsupportedValue`. 7917 7918 +kubebuilder:validation:Enum=GET;HEAD;POST;PUT;DELETE;CONNECT;OPTIONS;TRACE;PATCH 7919 7920 7921 7922 7923 | Name | Type | Go type | Default | Description | Example | 7924 |------|------|---------| ------- |-------------|---------| 7925 | HTTPMethod | string| string | | Note that values may be added to this enum, implementations 7926 must ensure that unknown values will not cause a crash. 7927 7928 Unknown values here must result in the implementation setting the 7929 Attached Condition for the Route to `status: False`, with a 7930 Reason of `UnsupportedValue`. 7931 7932 +kubebuilder:validation:Enum=GET;HEAD;POST;PUT;DELETE;CONNECT;OPTIONS;TRACE;PATCH | | 7933 7934 7935 7936 ### <span id="http-path-match"></span> HTTPPathMatch 7937 7938 7939 7940 7941 7942 7943 **Properties** 7944 7945 | Name | Type | Go type | Required | Default | Description | Example | 7946 |------|------|---------|:--------:| ------- |-------------|---------| 7947 | Value | string| `string` | | | Value of the HTTP path to match against. 7948 7949 +optional 7950 +kubebuilder:default="/" 7951 +kubebuilder:validation:MaxLength=1024 | | 7952 | type | [PathMatchType](#path-match-type)| `PathMatchType` | | | | | 7953 7954 7955 7956 ### <span id="http-path-modifier"></span> HTTPPathModifier 7957 7958 7959 > <gateway:experimental> 7960 7961 7962 7963 7964 7965 7966 **Properties** 7967 7968 | Name | Type | Go type | Required | Default | Description | Example | 7969 |------|------|---------|:--------:| ------- |-------------|---------| 7970 | ReplaceFullPath | string| `string` | | | ReplaceFullPath specifies the value with which to replace the full path 7971 of a request during a rewrite or redirect. 7972 7973 <gateway:experimental> 7974 +kubebuilder:validation:MaxLength=1024 7975 +optional | | 7976 | ReplacePrefixMatch | string| `string` | | | ReplacePrefixMatch specifies the value with which to replace the prefix 7977 match of a request during a rewrite or redirect. For example, a request 7978 to "/foo/bar" with a prefix match of "/foo" would be modified to "/bar". 7979 7980 Note that this matches the behavior of the PathPrefix match type. This 7981 matches full path elements. A path element refers to the list of labels 7982 in the path split by the `/` separator. When specified, a trailing `/` is 7983 ignored. For example, the paths `/abc`, `/abc/`, and `/abc/def` would all 7984 match the prefix `/abc`, but the path `/abcd` would not. 7985 7986 <gateway:experimental> 7987 +kubebuilder:validation:MaxLength=1024 7988 +optional | | 7989 | type | [HTTPPathModifierType](#http-path-modifier-type)| `HTTPPathModifierType` | | | | | 7990 7991 7992 7993 ### <span id="http-path-modifier-type"></span> HTTPPathModifierType 7994 7995 7996 7997 7998 | Name | Type | Go type | Default | Description | Example | 7999 |------|------|---------| ------- |-------------|---------| 8000 | HTTPPathModifierType | string| string | | | | 8001 8002 8003 8004 ### <span id="http-query-param-match"></span> HTTPQueryParamMatch 8005 8006 8007 > HTTPQueryParamMatch describes how to select a HTTP route by matching HTTP 8008 query parameters. 8009 8010 8011 8012 8013 8014 8015 **Properties** 8016 8017 | Name | Type | Go type | Required | Default | Description | Example | 8018 |------|------|---------|:--------:| ------- |-------------|---------| 8019 | Name | string| `string` | | | Name is the name of the HTTP query param to be matched. This must be an 8020 exact string match. (See 8021 https://tools.ietf.org/html/rfc7230#section-2.7.3). 8022 8023 If multiple entries specify equivalent query param names, only the first 8024 entry with an equivalent name MUST be considered for a match. Subsequent 8025 entries with an equivalent query param name MUST be ignored. 8026 8027 +kubebuilder:validation:MinLength=1 8028 +kubebuilder:validation:MaxLength=256 | | 8029 | Value | string| `string` | | | Value is the value of HTTP query param to be matched. 8030 8031 +kubebuilder:validation:MinLength=1 8032 +kubebuilder:validation:MaxLength=1024 | | 8033 | type | [QueryParamMatchType](#query-param-match-type)| `QueryParamMatchType` | | | | | 8034 8035 8036 8037 ### <span id="http-request-header-filter"></span> HTTPRequestHeaderFilter 8038 8039 8040 > HTTPRequestHeaderFilter defines configuration for the RequestHeaderModifier 8041 filter. 8042 8043 8044 8045 8046 8047 8048 **Properties** 8049 8050 | Name | Type | Go type | Required | Default | Description | Example | 8051 |------|------|---------|:--------:| ------- |-------------|---------| 8052 | Add | [][HTTPHeader](#http-header)| `[]*HTTPHeader` | | | Add adds the given header(s) (name, value) to the request 8053 before the action. It appends to any existing values associated 8054 with the header name. 8055 8056 Input: 8057 GET /foo HTTP/1.1 8058 my-header: foo 8059 8060 Config: 8061 add: 8062 name: "my-header" 8063 value: "bar" 8064 8065 Output: 8066 GET /foo HTTP/1.1 8067 my-header: foo 8068 my-header: bar 8069 8070 +optional 8071 +listType=map 8072 +listMapKey=name 8073 +kubebuilder:validation:MaxItems=16 | | 8074 | Remove | []string| `[]string` | | | Remove the given header(s) from the HTTP request before the action. The 8075 value of Remove is a list of HTTP header names. Note that the header 8076 names are case-insensitive (see 8077 https://datatracker.ietf.org/doc/html/rfc2616#section-4.2). 8078 8079 Input: 8080 GET /foo HTTP/1.1 8081 my-header1: foo 8082 my-header2: bar 8083 my-header3: baz 8084 8085 Config: 8086 remove: ["my-header1", "my-header3"] 8087 8088 Output: 8089 GET /foo HTTP/1.1 8090 my-header2: bar 8091 8092 +optional 8093 +kubebuilder:validation:MaxItems=16 | | 8094 | Set | [][HTTPHeader](#http-header)| `[]*HTTPHeader` | | | Set overwrites the request with the given header (name, value) 8095 before the action. 8096 8097 Input: 8098 GET /foo HTTP/1.1 8099 my-header: foo 8100 8101 Config: 8102 set: 8103 name: "my-header" 8104 value: "bar" 8105 8106 Output: 8107 GET /foo HTTP/1.1 8108 my-header: bar 8109 8110 +optional 8111 +listType=map 8112 +listMapKey=name 8113 +kubebuilder:validation:MaxItems=16 | | 8114 8115 8116 8117 ### <span id="http-request-mirror-filter"></span> HTTPRequestMirrorFilter 8118 8119 8120 8121 8122 8123 8124 **Properties** 8125 8126 | Name | Type | Go type | Required | Default | Description | Example | 8127 |------|------|---------|:--------:| ------- |-------------|---------| 8128 | backendRef | [BackendObjectReference](#backend-object-reference)| `BackendObjectReference` | | | | | 8129 8130 8131 8132 ### <span id="http-request-redirect-filter"></span> HTTPRequestRedirectFilter 8133 8134 8135 > HTTPRequestRedirect defines a filter that redirects a request. This filter 8136 MUST NOT be used on the same Route rule as a HTTPURLRewrite filter. 8137 8138 8139 8140 8141 8142 8143 **Properties** 8144 8145 | Name | Type | Go type | Required | Default | Description | Example | 8146 |------|------|---------|:--------:| ------- |-------------|---------| 8147 | Scheme | string| `string` | | | Scheme is the scheme to be used in the value of the `Location` 8148 header in the response. 8149 When empty, the scheme of the request is used. 8150 8151 Support: Extended 8152 8153 Note that values may be added to this enum, implementations 8154 must ensure that unknown values will not cause a crash. 8155 8156 Unknown values here must result in the implementation setting the 8157 Attached Condition for the Route to `status: False`, with a 8158 Reason of `UnsupportedValue`. 8159 8160 +optional 8161 +kubebuilder:validation:Enum=http;https | | 8162 | StatusCode | int64 (formatted integer)| `int64` | | | StatusCode is the HTTP status code to be used in response. 8163 8164 Support: Core 8165 8166 Note that values may be added to this enum, implementations 8167 must ensure that unknown values will not cause a crash. 8168 8169 Unknown values here must result in the implementation setting the 8170 Attached Condition for the Route to `status: False`, with a 8171 Reason of `UnsupportedValue`. 8172 8173 +optional 8174 +kubebuilder:default=302 8175 +kubebuilder:validation:Enum=301;302 | | 8176 | hostname | [PreciseHostname](#precise-hostname)| `PreciseHostname` | | | | | 8177 | path | [HTTPPathModifier](#http-path-modifier)| `HTTPPathModifier` | | | | | 8178 | port | [PortNumber](#port-number)| `PortNumber` | | | | | 8179 8180 8181 8182 ### <span id="http-route"></span> HTTPRoute 8183 8184 8185 > HTTPRoute provides a way to route HTTP requests. This includes the capability 8186 to match requests by hostname, path, header, or query param. Filters can be 8187 used to specify additional processing steps. Backends specify where matching 8188 requests should be routed. 8189 8190 8191 8192 8193 8194 8195 **Properties** 8196 8197 | Name | Type | Go type | Required | Default | Description | Example | 8198 |------|------|---------|:--------:| ------- |-------------|---------| 8199 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 8200 Servers should convert recognized schemas to the latest internal value, and 8201 may reject unrecognized values. 8202 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 8203 +optional | | 8204 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 8205 set by external tools to store and retrieve arbitrary metadata. They are not 8206 queryable and should be preserved when modifying objects. 8207 More info: http://kubernetes.io/docs/user-guide/annotations 8208 +optional | | 8209 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 8210 created. It is not guaranteed to be set in happens-before order across separate operations. 8211 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 8212 8213 Populated by the system. 8214 Read-only. 8215 Null for lists. 8216 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 8217 +optional | | 8218 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 8219 it will be removed from the system. Only set when deletionTimestamp is also set. 8220 May only be shortened. 8221 Read-only. 8222 +optional | | 8223 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 8224 field is set by the server when a graceful deletion is requested by the user, and is not 8225 directly settable by a client. The resource is expected to be deleted (no longer visible 8226 from resource lists, and not reachable by name) after the time in this field, once the 8227 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 8228 Once the deletionTimestamp is set, this value may not be unset or be set further into the 8229 future, although it may be shortened or the resource may be deleted prior to this time. 8230 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 8231 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 8232 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 8233 remove the pod from the API. In the presence of network partitions, this object may still 8234 exist after this timestamp, until an administrator or automated process can determine the 8235 resource is fully terminated. 8236 If not set, graceful deletion of the object has not been requested. 8237 8238 Populated by the system when a graceful deletion is requested. 8239 Read-only. 8240 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 8241 +optional | | 8242 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 8243 is an identifier for the responsible component that will remove the entry 8244 from the list. If the deletionTimestamp of the object is non-nil, entries 8245 in this list can only be removed. 8246 Finalizers may be processed and removed in any order. Order is NOT enforced 8247 because it introduces significant risk of stuck finalizers. 8248 finalizers is a shared field, any actor with permission can reorder it. 8249 If the finalizer list is processed in order, then this can lead to a situation 8250 in which the component responsible for the first finalizer in the list is 8251 waiting for a signal (field value, external system, or other) produced by a 8252 component responsible for a finalizer later in the list, resulting in a deadlock. 8253 Without enforced ordering finalizers are free to order amongst themselves and 8254 are not vulnerable to ordering changes in the list. 8255 +optional 8256 +patchStrategy=merge | | 8257 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 8258 name ONLY IF the Name field has not been provided. 8259 If this field is used, the name returned to the client will be different 8260 than the name passed. This value will also be combined with a unique suffix. 8261 The provided value has the same validation rules as the Name field, 8262 and may be truncated by the length of the suffix required to make the value 8263 unique on the server. 8264 8265 If this field is specified and the generated name exists, the server will return a 409. 8266 8267 Applied only if Name is not specified. 8268 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 8269 +optional | | 8270 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 8271 Populated by the system. Read-only. 8272 +optional | | 8273 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 8274 Servers may infer this from the endpoint the client submits requests to. 8275 Cannot be updated. 8276 In CamelCase. 8277 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 8278 +optional | | 8279 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 8280 (scope and select) objects. May match selectors of replication controllers 8281 and services. 8282 More info: http://kubernetes.io/docs/user-guide/labels 8283 +optional | | 8284 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 8285 that are managed by that workflow. This is mostly for internal 8286 housekeeping, and users typically shouldn't need to set or 8287 understand this field. A workflow can be the user's name, a 8288 controller's name, or the name of a specific apply path like 8289 "ci-cd". The set of fields is always in the version that the 8290 workflow used when modifying the object. 8291 8292 +optional | | 8293 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 8294 some resources may allow a client to request the generation of an appropriate name 8295 automatically. Name is primarily intended for creation idempotence and configuration 8296 definition. 8297 Cannot be updated. 8298 More info: http://kubernetes.io/docs/user-guide/identifiers#names 8299 +optional | | 8300 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 8301 equivalent to the "default" namespace, but "default" is the canonical representation. 8302 Not all objects are required to be scoped to a namespace - the value of this field for 8303 those objects will be empty. 8304 8305 Must be a DNS_LABEL. 8306 Cannot be updated. 8307 More info: http://kubernetes.io/docs/user-guide/namespaces 8308 +optional | | 8309 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 8310 been deleted, this object will be garbage collected. If this object is managed by a controller, 8311 then an entry in this list will point to this controller, with the controller field set to true. 8312 There cannot be more than one managing controller. 8313 +optional 8314 +patchMergeKey=uid 8315 +patchStrategy=merge | | 8316 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 8317 be used by clients to determine when objects have changed. May be used for optimistic 8318 concurrency, change detection, and the watch operation on a resource or set of resources. 8319 Clients must treat these values as opaque and passed unmodified back to the server. 8320 They may only be valid for a particular resource or set of resources. 8321 8322 Populated by the system. 8323 Read-only. 8324 Value must be treated as opaque by clients and . 8325 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 8326 +optional | | 8327 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 8328 +optional | | 8329 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 8330 the system and never used; it will be removed completely in 1.25. 8331 8332 The name in the go struct is changed to help clients detect 8333 accidental use. 8334 8335 +optional | | 8336 | spec | [HTTPRouteSpec](#http-route-spec)| `HTTPRouteSpec` | | | | | 8337 | status | [HTTPRouteStatus](#http-route-status)| `HTTPRouteStatus` | | | | | 8338 | uid | [UID](#uid)| `UID` | | | | | 8339 8340 8341 8342 ### <span id="http-route-filter"></span> HTTPRouteFilter 8343 8344 8345 > HTTPRouteFilter defines processing steps that must be completed during the 8346 request or response lifecycle. HTTPRouteFilters are meant as an extension 8347 point to express processing that may be done in Gateway implementations. Some 8348 examples include request or response modification, implementing 8349 authentication strategies, rate-limiting, and traffic shaping. API 8350 guarantee/conformance is defined based on the type of the filter. 8351 8352 8353 8354 8355 8356 8357 **Properties** 8358 8359 | Name | Type | Go type | Required | Default | Description | Example | 8360 |------|------|---------|:--------:| ------- |-------------|---------| 8361 | extensionRef | [LocalObjectReference](#local-object-reference)| `LocalObjectReference` | | | | | 8362 | requestHeaderModifier | [HTTPRequestHeaderFilter](#http-request-header-filter)| `HTTPRequestHeaderFilter` | | | | | 8363 | requestMirror | [HTTPRequestMirrorFilter](#http-request-mirror-filter)| `HTTPRequestMirrorFilter` | | | | | 8364 | requestRedirect | [HTTPRequestRedirectFilter](#http-request-redirect-filter)| `HTTPRequestRedirectFilter` | | | | | 8365 | type | [HTTPRouteFilterType](#http-route-filter-type)| `HTTPRouteFilterType` | | | | | 8366 | urlRewrite | [HTTPURLRewriteFilter](#http-url-rewrite-filter)| `HTTPURLRewriteFilter` | | | | | 8367 8368 8369 8370 ### <span id="http-route-filter-type"></span> HTTPRouteFilterType 8371 8372 8373 8374 8375 | Name | Type | Go type | Default | Description | Example | 8376 |------|------|---------| ------- |-------------|---------| 8377 | HTTPRouteFilterType | string| string | | | | 8378 8379 8380 8381 ### <span id="http-route-match"></span> HTTPRouteMatch 8382 8383 8384 > For example, the match below will match a HTTP request only if its path 8385 starts with `/foo` AND it contains the `version: v1` header: 8386 8387 ``` 8388 match: 8389 path: 8390 value: "/foo" 8391 headers: 8392 name: "version" 8393 value "v1" 8394 ``` 8395 8396 8397 8398 8399 8400 8401 **Properties** 8402 8403 | Name | Type | Go type | Required | Default | Description | Example | 8404 |------|------|---------|:--------:| ------- |-------------|---------| 8405 | Headers | [][HTTPHeaderMatch](#http-header-match)| `[]*HTTPHeaderMatch` | | | Headers specifies HTTP request header matchers. Multiple match values are 8406 ANDed together, meaning, a request must match all the specified headers 8407 to select the route. 8408 8409 +listType=map 8410 +listMapKey=name 8411 +optional 8412 +kubebuilder:validation:MaxItems=16 | | 8413 | QueryParams | [][HTTPQueryParamMatch](#http-query-param-match)| `[]*HTTPQueryParamMatch` | | | QueryParams specifies HTTP query parameter matchers. Multiple match 8414 values are ANDed together, meaning, a request must match all the 8415 specified query parameters to select the route. 8416 8417 +listType=map 8418 +listMapKey=name 8419 +optional 8420 +kubebuilder:validation:MaxItems=16 | | 8421 | method | [HTTPMethod](#http-method)| `HTTPMethod` | | | | | 8422 | path | [HTTPPathMatch](#http-path-match)| `HTTPPathMatch` | | | | | 8423 8424 8425 8426 ### <span id="http-route-rule"></span> HTTPRouteRule 8427 8428 8429 > HTTPRouteRule defines semantics for matching an HTTP request based on 8430 conditions (matches), processing it (filters), and forwarding the request to 8431 an API object (backendRefs). 8432 8433 8434 8435 8436 8437 8438 **Properties** 8439 8440 | Name | Type | Go type | Required | Default | Description | Example | 8441 |------|------|---------|:--------:| ------- |-------------|---------| 8442 | BackendRefs | [][HTTPBackendRef](#http-backend-ref)| `[]*HTTPBackendRef` | | | BackendRefs defines the backend(s) where matching requests should be 8443 sent. 8444 8445 Failure behavior here depends on how many BackendRefs are specified and 8446 how many are invalid. 8447 8448 If *all* entries in BackendRefs are invalid, and there are also no filters 8449 specified in this route rule, *all* traffic which matches this rule MUST 8450 receive a 500 status code. 8451 8452 See the HTTPBackendRef definition for the rules about what makes a single 8453 HTTPBackendRef invalid. 8454 8455 When a HTTPBackendRef is invalid, 500 status codes MUST be returned for 8456 requests that would have otherwise been routed to an invalid backend. If 8457 multiple backends are specified, and some are invalid, the proportion of 8458 requests that would otherwise have been routed to an invalid backend 8459 MUST receive a 500 status code. 8460 8461 For example, if two backends are specified with equal weights, and one is 8462 invalid, 50 percent of traffic must receive a 500. Implementations may 8463 choose how that 50 percent is determined. 8464 8465 Support: Core for Kubernetes Service 8466 8467 Support: Custom for any other resource 8468 8469 Support for weight: Core 8470 8471 +optional 8472 +kubebuilder:validation:MaxItems=16 | | 8473 | Filters | [][HTTPRouteFilter](#http-route-filter)| `[]*HTTPRouteFilter` | | | Filters define the filters that are applied to requests that match 8474 this rule. 8475 8476 The effects of ordering of multiple behaviors are currently unspecified. 8477 This can change in the future based on feedback during the alpha stage. 8478 8479 Conformance-levels at this level are defined based on the type of filter: 8480 8481 ALL core filters MUST be supported by all implementations. 8482 Implementers are encouraged to support extended filters. 8483 Implementation-specific custom filters have no API guarantees across 8484 implementations. 8485 8486 Specifying a core filter multiple times has unspecified or custom 8487 conformance. 8488 8489 All filters are expected to be compatible with each other except for the 8490 URLRewrite and RequestRedirect filters, which may not be combined. If an 8491 implementation can not support other combinations of filters, they must clearly 8492 document that limitation. In all cases where incompatible or unsupported 8493 filters are specified, implementations MUST add a warning condition to status. 8494 8495 Support: Core 8496 8497 +optional 8498 +kubebuilder:validation:MaxItems=16 | | 8499 | Matches | [][HTTPRouteMatch](#http-route-match)| `[]*HTTPRouteMatch` | | | Matches define conditions used for matching the rule against incoming 8500 HTTP requests. Each match is independent, i.e. this rule will be matched 8501 if **any** one of the matches is satisfied. 8502 8503 For example, take the following matches configuration: 8504 8505 ``` 8506 matches: 8507 path: 8508 value: "/foo" 8509 headers: 8510 name: "version" 8511 value: "v2" 8512 path: 8513 value: "/v2/foo" 8514 ``` 8515 8516 For a request to match against this rule, a request must satisfy 8517 EITHER of the two conditions: 8518 8519 path prefixed with `/foo` AND contains the header `version: v2` 8520 path prefix of `/v2/foo` 8521 8522 See the documentation for HTTPRouteMatch on how to specify multiple 8523 match conditions that should be ANDed together. 8524 8525 If no matches are specified, the default is a prefix 8526 path match on "/", which has the effect of matching every 8527 HTTP request. 8528 8529 Proxy or Load Balancer routing configuration generated from HTTPRoutes 8530 MUST prioritize rules based on the following criteria, continuing on 8531 ties. Precedence must be given to the Rule with the largest number 8532 of: 8533 8534 Characters in a matching non-wildcard hostname. 8535 Characters in a matching hostname. 8536 Characters in a matching path. 8537 Header matches. 8538 Query param matches. 8539 8540 If ties still exist across multiple Routes, matching precedence MUST be 8541 determined in order of the following criteria, continuing on ties: 8542 8543 The oldest Route based on creation timestamp. 8544 The Route appearing first in alphabetical order by 8545 "{namespace}/{name}". 8546 8547 If ties still exist within the Route that has been given precedence, 8548 matching precedence MUST be granted to the first matching rule meeting 8549 the above criteria. 8550 8551 When no rules matching a request have been successfully attached to the 8552 parent a request is coming from, a HTTP 404 status code MUST be returned. 8553 8554 +optional 8555 +kubebuilder:validation:MaxItems=8 8556 +kubebuilder:default={{path:{ type: "PathPrefix", value: "/"}}} | | 8557 8558 8559 8560 ### <span id="http-route-spec"></span> HTTPRouteSpec 8561 8562 8563 > HTTPRouteSpec defines the desired state of HTTPRoute 8564 8565 8566 8567 8568 8569 8570 **Properties** 8571 8572 | Name | Type | Go type | Required | Default | Description | Example | 8573 |------|------|---------|:--------:| ------- |-------------|---------| 8574 | Hostnames | [][Hostname](#hostname)| `[]Hostname` | | | Hostnames defines a set of hostname that should match against the HTTP 8575 Host header to select a HTTPRoute to process the request. This matches 8576 the RFC 1123 definition of a hostname with 2 notable exceptions: 8577 8578 1. IPs are not allowed. 8579 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard 8580 label must appear by itself as the first label. 8581 8582 If a hostname is specified by both the Listener and HTTPRoute, there 8583 must be at least one intersecting hostname for the HTTPRoute to be | | 8584 | ParentRefs | [][ParentReference](#parent-reference)| `[]*ParentReference` | | | ParentRefs references the resources (usually Gateways) that a Route wants 8585 to be attached to. Note that the referenced parent resource needs to 8586 allow this for the attachment to be complete. For Gateways, that means 8587 the Gateway needs to allow attachment from Routes of this kind and 8588 namespace. 8589 8590 The only kind of parent resource with "Core" support is Gateway. This API 8591 may be extended in the future to support additional kinds of parent 8592 resources such as one of the route kinds. 8593 8594 It is invalid to reference an identical parent more than once. It is 8595 valid to reference multiple distinct sections within the same parent 8596 resource, such as 2 Listeners within a Gateway. 8597 8598 It is possible to separately reference multiple distinct objects that may 8599 be collapsed by an implementation. For example, some implementations may 8600 choose to merge compatible Gateway Listeners together. If that is the 8601 case, the list of routes attached to those resources should also be 8602 merged. 8603 8604 +optional 8605 +kubebuilder:validation:MaxItems=32 | | 8606 | Rules | [][HTTPRouteRule](#http-route-rule)| `[]*HTTPRouteRule` | | | Rules are a list of HTTP matchers, filters and actions. 8607 8608 +optional 8609 +kubebuilder:validation:MaxItems=16 8610 +kubebuilder:default={{matches: {{path: {type: "PathPrefix", value: "/"}}}}} | | 8611 8612 8613 8614 ### <span id="http-route-status"></span> HTTPRouteStatus 8615 8616 8617 8618 8619 8620 8621 **Properties** 8622 8623 | Name | Type | Go type | Required | Default | Description | Example | 8624 |------|------|---------|:--------:| ------- |-------------|---------| 8625 | Parents | [][RouteParentStatus](#route-parent-status)| `[]*RouteParentStatus` | | | Parents is a list of parent resources (usually Gateways) that are 8626 associated with the route, and the status of the route with respect to 8627 each parent. When this route attaches to a parent, the controller that 8628 manages the parent must add an entry to this list when the controller 8629 first sees the route and should update the entry as appropriate when the 8630 route or gateway is modified. 8631 8632 Note that parent references that cannot be resolved by an implementation 8633 of this API will not be added to this list. Implementations of this API 8634 can only populate Route status for the Gateways/parent resources they are 8635 responsible for. 8636 8637 A maximum of 32 Gateways will be represented in this list. An empty list 8638 means the route has not been attached to any Gateway. 8639 8640 +kubebuilder:validation:MaxItems=32 | | 8641 8642 8643 8644 ### <span id="http-url-rewrite-filter"></span> HTTPURLRewriteFilter 8645 8646 8647 > Support: Extended 8648 8649 <gateway:experimental> 8650 8651 8652 8653 8654 8655 8656 **Properties** 8657 8658 | Name | Type | Go type | Required | Default | Description | Example | 8659 |------|------|---------|:--------:| ------- |-------------|---------| 8660 | hostname | [PreciseHostname](#precise-hostname)| `PreciseHostname` | | | | | 8661 | path | [HTTPPathModifier](#http-path-modifier)| `HTTPPathModifier` | | | | | 8662 8663 8664 8665 ### <span id="header-match-type"></span> HeaderMatchType 8666 8667 8668 > "Exact" 8669 "RegularExpression" 8670 8671 Note that values may be added to this enum, implementations 8672 must ensure that unknown values will not cause a crash. 8673 8674 Unknown values here must result in the implementation setting the 8675 Attached Condition for the Route to `status: False`, with a 8676 Reason of `UnsupportedValue`. 8677 8678 +kubebuilder:validation:Enum=Exact;RegularExpression 8679 8680 8681 8682 8683 | Name | Type | Go type | Default | Description | Example | 8684 |------|------|---------| ------- |-------------|---------| 8685 | HeaderMatchType | string| string | | "Exact" 8686 "RegularExpression" 8687 8688 Note that values may be added to this enum, implementations 8689 must ensure that unknown values will not cause a crash. 8690 8691 Unknown values here must result in the implementation setting the 8692 Attached Condition for the Route to `status: False`, with a 8693 Reason of `UnsupportedValue`. 8694 8695 +kubebuilder:validation:Enum=Exact;RegularExpression | | 8696 8697 8698 8699 ### <span id="health-config"></span> HealthConfig 8700 8701 8702 > HealthConfig maps annotations information for health 8703 8704 8705 8706 8707 [HealthConfig](#health-config) 8708 8709 ### <span id="host"></span> Host 8710 8711 8712 > Host represents the FQDN format for Istio hostnames 8713 8714 8715 8716 8717 8718 8719 **Properties** 8720 8721 | Name | Type | Go type | Required | Default | Description | Example | 8722 |------|------|---------|:--------:| ------- |-------------|---------| 8723 | Cluster | string| `string` | | | | | 8724 | CompleteInput | boolean| `bool` | | | CompleteInput is true when Service, Namespace and Cluster fields are present. 8725 It is true for simple service names and FQDN services. 8726 It is false for service.namespace format and service entries. | | 8727 | Namespace | string| `string` | | | | | 8728 | Service | string| `string` | | | | | 8729 8730 8731 8732 ### <span id="hostname"></span> Hostname 8733 8734 8735 > 1. IPs are not allowed. 8736 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard 8737 label must appear by itself as the first label. 8738 8739 Hostname can be "precise" which is a domain name without the terminating 8740 dot of a network host (e.g. "foo.example.com") or "wildcard", which is a 8741 domain name prefixed with a single wildcard label (e.g. `*.example.com`). 8742 8743 Note that as per RFC1035 and RFC1123, a *label* must consist of lower case 8744 alphanumeric characters or '-', and must start and end with an alphanumeric 8745 character. No other punctuation is allowed. 8746 8747 +kubebuilder:validation:MinLength=1 8748 +kubebuilder:validation:MaxLength=253 8749 +kubebuilder:validation:Pattern=`^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` 8750 8751 8752 8753 8754 | Name | Type | Go type | Default | Description | Example | 8755 |------|------|---------| ------- |-------------|---------| 8756 | Hostname | string| string | | 1. IPs are not allowed. 8757 2. A hostname may be prefixed with a wildcard label (`*.`). The wildcard 8758 label must appear by itself as the first label. 8759 8760 Hostname can be "precise" which is a domain name without the terminating 8761 dot of a network host (e.g. "foo.example.com") or "wildcard", which is a 8762 domain name prefixed with a single wildcard label (e.g. `*.example.com`). 8763 8764 Note that as per RFC1035 and RFC1123, a *label* must consist of lower case 8765 alphanumeric characters or '-', and must start and end with an alphanumeric 8766 character. No other punctuation is allowed. 8767 8768 +kubebuilder:validation:MinLength=1 8769 +kubebuilder:validation:MaxLength=253 8770 +kubebuilder:validation:Pattern=`^(\*\.)?[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` | | 8771 8772 8773 8774 ### <span id="istio-check"></span> IstioCheck 8775 8776 8777 8778 8779 8780 8781 **Properties** 8782 8783 | Name | Type | Go type | Required | Default | Description | Example | 8784 |------|------|---------|:--------:| ------- |-------------|---------| 8785 | Code | string| `string` | ✓ | | The check code used to identify a check | `KIA0001` | 8786 | Message | string| `string` | ✓ | | Description of the check | `Weight sum should be 100` | 8787 | Path | string| `string` | | | String that describes where in the yaml file is the check located | `spec/http[0]/route` | 8788 | severity | [SeverityLevel](#severity-level)| `SeverityLevel` | ✓ | | | | 8789 8790 8791 8792 ### <span id="istio-component-status"></span> IstioComponentStatus 8793 8794 8795 8796 8797 [][ComponentStatus](#component-status) 8798 8799 ### <span id="istio-condition"></span> IstioCondition 8800 8801 8802 8803 8804 8805 8806 **Properties** 8807 8808 | Name | Type | Go type | Required | Default | Description | Example | 8809 |------|------|---------|:--------:| ------- |-------------|---------| 8810 | Message | string| `string` | | | Human-readable message indicating details about last transition. 8811 +optional | | 8812 | Reason | string| `string` | | | Unique, one-word, CamelCase reason for the condition's last transition. 8813 +optional | | 8814 | Status | string| `string` | | | Status is the status of the condition. 8815 Can be True, False, Unknown. | | 8816 | Type | string| `string` | | | Type is the type of the condition. | | 8817 | last_probe_time | [Timestamp](#timestamp)| `Timestamp` | | | | | 8818 | last_transition_time | [Timestamp](#timestamp)| `Timestamp` | | | | | 8819 8820 8821 8822 ### <span id="istio-config-details"></span> IstioConfigDetails 8823 8824 8825 8826 8827 8828 8829 **Properties** 8830 8831 | Name | Type | Go type | Required | Default | Description | Example | 8832 |------|------|---------|:--------:| ------- |-------------|---------| 8833 | IstioConfigHelpFields | [][IstioConfigHelp](#istio-config-help)| `[]*IstioConfigHelp` | | | | | 8834 | ObjectType | string| `string` | | | | | 8835 | authorizationPolicy | [AuthorizationPolicy](#authorization-policy)| `AuthorizationPolicy` | | | | | 8836 | destinationRule | [DestinationRule](#destination-rule)| `DestinationRule` | | | | | 8837 | envoyFilter | [EnvoyFilter](#envoy-filter)| `EnvoyFilter` | | | | | 8838 | gateway | [Gateway](#gateway)| `Gateway` | | | | | 8839 | k8sGateway | [Gateway](#gateway)| `Gateway` | | | | | 8840 | k8sHTTPRoute | [HTTPRoute](#http-route)| `HTTPRoute` | | | | | 8841 | namespace | [Namespace](#namespace)| `Namespace` | | | | | 8842 | peerAuthentication | [PeerAuthentication](#peer-authentication)| `PeerAuthentication` | | | | | 8843 | permissions | [ResourcePermissions](#resource-permissions)| `ResourcePermissions` | | | | | 8844 | references | [IstioReferences](#istio-references)| `IstioReferences` | | | | | 8845 | requestAuthentication | [RequestAuthentication](#request-authentication)| `RequestAuthentication` | | | | | 8846 | serviceEntry | [ServiceEntry](#service-entry)| `ServiceEntry` | | | | | 8847 | sidecar | [Sidecar](#sidecar)| `Sidecar` | | | | | 8848 | telemetry | [Telemetry](#telemetry)| `Telemetry` | | | | | 8849 | validation | [IstioValidation](#istio-validation)| `IstioValidation` | | | | | 8850 | virtualService | [VirtualService](#virtual-service)| `VirtualService` | | | | | 8851 | wasmPlugin | [WasmPlugin](#wasm-plugin)| `WasmPlugin` | | | | | 8852 | workloadEntry | [WorkloadEntry](#workload-entry)| `WorkloadEntry` | | | | | 8853 | workloadGroup | [WorkloadGroup](#workload-group)| `WorkloadGroup` | | | | | 8854 8855 8856 8857 ### <span id="istio-config-help"></span> IstioConfigHelp 8858 8859 8860 > IstioConfigHelp represents a help message for a given Istio object type and field 8861 8862 8863 8864 8865 8866 8867 **Properties** 8868 8869 | Name | Type | Go type | Required | Default | Description | Example | 8870 |------|------|---------|:--------:| ------- |-------------|---------| 8871 | Message | string| `string` | | | | | 8872 | ObjectField | string| `string` | | | | | 8873 8874 8875 8876 ### <span id="istio-config-list"></span> IstioConfigList 8877 8878 8879 > IstioConfigList istioConfigList 8880 This type is used for returning a response of IstioConfigList 8881 8882 8883 8884 8885 8886 8887 **Properties** 8888 8889 | Name | Type | Go type | Required | Default | Description | Example | 8890 |------|------|---------|:--------:| ------- |-------------|---------| 8891 | AuthorizationPolicies | [][AuthorizationPolicy](#authorization-policy)| `[]*AuthorizationPolicy` | | | | | 8892 | DestinationRules | [][DestinationRule](#destination-rule)| `[]*DestinationRule` | | | | | 8893 | EnvoyFilters | [][EnvoyFilter](#envoy-filter)| `[]*EnvoyFilter` | | | | | 8894 | Gateways | [][Gateway](#gateway)| `[]*Gateway` | | | | | 8895 | K8sGateways | [][Gateway](#gateway)| `[]*Gateway` | | | | | 8896 | K8sHTTPRoutes | [][HTTPRoute](#http-route)| `[]*HTTPRoute` | | | | | 8897 | K8sReferenceGrants | [][ReferenceGrant](#reference-grant)| `[]*ReferenceGrant` | | | | | 8898 | PeerAuthentications | [][PeerAuthentication](#peer-authentication)| `[]*PeerAuthentication` | | | | | 8899 | RequestAuthentications | [][RequestAuthentication](#request-authentication)| `[]*RequestAuthentication` | | | | | 8900 | ServiceEntries | [][ServiceEntry](#service-entry)| `[]*ServiceEntry` | | | | | 8901 | Sidecars | [][Sidecar](#sidecar)| `[]*Sidecar` | | | | | 8902 | Telemetries | [][Telemetry](#telemetry)| `[]*Telemetry` | | | | | 8903 | VirtualServices | [][VirtualService](#virtual-service)| `[]*VirtualService` | | | | | 8904 | WasmPlugins | [][WasmPlugin](#wasm-plugin)| `[]*WasmPlugin` | | | | | 8905 | WorkloadEntries | [][WorkloadEntry](#workload-entry)| `[]*WorkloadEntry` | | | | | 8906 | WorkloadGroups | [][WorkloadGroup](#workload-group)| `[]*WorkloadGroup` | | | | | 8907 | namespace | [Namespace](#namespace)| `Namespace` | ✓ | | | | 8908 | validations | [IstioValidations](#istio-validations)| `IstioValidations` | | | | | 8909 8910 8911 8912 ### <span id="istio-config-permissions"></span> IstioConfigPermissions 8913 8914 8915 > IstioConfigPermissions holds a map of ResourcesPermissions per namespace 8916 8917 8918 8919 8920 [IstioConfigPermissions](#istio-config-permissions) 8921 8922 ### <span id="istio-environment"></span> IstioEnvironment 8923 8924 8925 > IstioEnvironment describes the Istio implementation environment 8926 8927 8928 8929 8930 8931 8932 **Properties** 8933 8934 | Name | Type | Go type | Required | Default | Description | Example | 8935 |------|------|---------|:--------:| ------- |-------------|---------| 8936 | IstioAPIEnabled | boolean| `bool` | | | Is api enabled | | 8937 8938 8939 8940 ### <span id="istio-reference"></span> IstioReference 8941 8942 8943 8944 8945 8946 8947 **Properties** 8948 8949 | Name | Type | Go type | Required | Default | Description | Example | 8950 |------|------|---------|:--------:| ------- |-------------|---------| 8951 | Name | string| `string` | | | | | 8952 | Namespace | string| `string` | | | | | 8953 | ObjectType | string| `string` | | | | | 8954 8955 8956 8957 ### <span id="istio-references"></span> IstioReferences 8958 8959 8960 > IstioReferences represents a sets of different references 8961 8962 8963 8964 8965 8966 8967 **Properties** 8968 8969 | Name | Type | Go type | Required | Default | Description | Example | 8970 |------|------|---------|:--------:| ------- |-------------|---------| 8971 | ObjectReferences | [][IstioReference](#istio-reference)| `[]*IstioReference` | | | Related Istio objects | | 8972 | ServiceReferences | [][ServiceReference](#service-reference)| `[]*ServiceReference` | | | Related Istio objects | | 8973 | WorkloadReferences | [][WorkloadReference](#workload-reference)| `[]*WorkloadReference` | | | Related Istio objects | | 8974 8975 8976 8977 ### <span id="istio-status"></span> IstioStatus 8978 8979 8980 8981 8982 8983 8984 **Properties** 8985 8986 | Name | Type | Go type | Required | Default | Description | Example | 8987 |------|------|---------|:--------:| ------- |-------------|---------| 8988 | Conditions | [][IstioCondition](#istio-condition)| `[]*IstioCondition` | | | Current service state of pod. 8989 More info: https://istio.io/docs/reference/config/config-status/ 8990 +optional 8991 +patchMergeKey=type 8992 +patchStrategy=merge | | 8993 | ObservedGeneration | int64 (formatted integer)| `int64` | | | Resource Generation to which the Reconciled Condition refers. 8994 When this value is not equal to the object's metadata generation, reconciled condition calculation for the current 8995 generation is still in progress. See https://istio.io/latest/docs/reference/config/config-status/ for more info. 8996 +optional | | 8997 | ValidationMessages | [][AnalysisMessageBase](#analysis-message-base)| `[]*AnalysisMessageBase` | | | Includes any errors or warnings detected by Istio's analyzers. 8998 +optional 8999 +patchMergeKey=type 9000 +patchStrategy=merge | | 9001 9002 9003 9004 ### <span id="istio-validation"></span> IstioValidation 9005 9006 9007 9008 9009 9010 9011 **Properties** 9012 9013 | Name | Type | Go type | Required | Default | Description | Example | 9014 |------|------|---------|:--------:| ------- |-------------|---------| 9015 | Checks | [][IstioCheck](#istio-check)| `[]*IstioCheck` | | | Array of checks. It might be empty. | | 9016 | Name | string| `string` | ✓ | | Name of the object itself | `reviews` | 9017 | ObjectType | string| `string` | ✓ | | Type of the object | `virtualservice` | 9018 | References | [][IstioValidationKey](#istio-validation-key)| `[]*IstioValidationKey` | | | Related objects (only validation errors) | | 9019 | Valid | boolean| `bool` | ✓ | | Represents validity of the object: in case of warning, validity remains as true | `false` | 9020 9021 9022 9023 ### <span id="istio-validation-key"></span> IstioValidationKey 9024 9025 9026 9027 9028 9029 9030 **Properties** 9031 9032 | Name | Type | Go type | Required | Default | Description | Example | 9033 |------|------|---------|:--------:| ------- |-------------|---------| 9034 | Name | string| `string` | | | | | 9035 | Namespace | string| `string` | | | | | 9036 | ObjectType | string| `string` | | | | | 9037 9038 9039 9040 ### <span id="istio-validation-summary"></span> IstioValidationSummary 9041 9042 9043 9044 9045 9046 9047 **Properties** 9048 9049 | Name | Type | Go type | Required | Default | Description | Example | 9050 |------|------|---------|:--------:| ------- |-------------|---------| 9051 | Errors | int64 (formatted integer)| `int64` | ✓ | | Number of validations with error severity | `2` | 9052 | ObjectCount | int64 (formatted integer)| `int64` | ✓ | | Number of Istio Objects analyzed | `6` | 9053 | Warnings | int64 (formatted integer)| `int64` | ✓ | | Number of validations with warning severity | `4` | 9054 9055 9056 9057 ### <span id="istio-validations"></span> IstioValidations 9058 9059 9060 9061 9062 [interface{}](#interface) 9063 9064 ### <span id="jaeger-info"></span> TracingInfo 9065 9066 9067 9068 9069 9070 9071 **Properties** 9072 9073 | Name | Type | Go type | Required | Default | Description | Example | 9074 |------|------|---------|:--------:| ------- |-------------|---------| 9075 | Enabled | boolean| `bool` | | | | | 9076 | Integration | boolean| `bool` | | | | | 9077 | NamespaceSelector | boolean| `bool` | | | | | 9078 | URL | string| `string` | | | | | 9079 | WhiteListIstioSystem | []string| `[]string` | | | | | 9080 9081 9082 9083 ### <span id="jaeger-span"></span> JaegerSpan 9084 9085 9086 9087 9088 9089 9090 **Properties** 9091 9092 | Name | Type | Go type | Required | Default | Description | Example | 9093 |------|------|---------|:--------:| ------- |-------------|---------| 9094 | Duration | uint64 (formatted integer)| `uint64` | | | | | 9095 | Flags | uint32 (formatted integer)| `uint32` | | | | | 9096 | Logs | [][Log](#log)| `[]*Log` | | | | | 9097 | OperationName | string| `string` | | | | | 9098 | References | [][Reference](#reference)| `[]*Reference` | | | | | 9099 | StartTime | uint64 (formatted integer)| `uint64` | | | | | 9100 | Tags | [][KeyValue](#key-value)| `[]*KeyValue` | | | | | 9101 | TraceSize | int64 (formatted integer)| `int64` | | | | | 9102 | Warnings | []string| `[]string` | | | | | 9103 | parentSpanID | [SpanID](#span-id)| `SpanID` | | | | | 9104 | process | [Process](#process)| `Process` | | | | | 9105 | processID | [ProcessID](#process-id)| `ProcessID` | | | | | 9106 | spanID | [SpanID](#span-id)| `SpanID` | | | | | 9107 | traceID | [TraceID](#trace-id)| `TraceID` | | | | | 9108 9109 9110 9111 ### <span id="key-value"></span> KeyValue 9112 9113 9114 9115 9116 9117 9118 **Properties** 9119 9120 | Name | Type | Go type | Required | Default | Description | Example | 9121 |------|------|---------|:--------:| ------- |-------------|---------| 9122 | Key | string| `string` | | | | | 9123 | Value | [interface{}](#interface)| `interface{}` | | | | | 9124 | type | [ValueType](#value-type)| `ValueType` | | | | | 9125 9126 9127 9128 ### <span id="kind"></span> Kind 9129 9130 9131 > Valid values include: 9132 9133 "Service" 9134 "HTTPRoute" 9135 9136 Invalid values include: 9137 9138 "invalid/kind" - "/" is an invalid character 9139 9140 +kubebuilder:validation:MinLength=1 9141 +kubebuilder:validation:MaxLength=63 9142 +kubebuilder:validation:Pattern=`^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$` 9143 9144 9145 9146 9147 | Name | Type | Go type | Default | Description | Example | 9148 |------|------|---------| ------- |-------------|---------| 9149 | Kind | string| string | | Valid values include: 9150 9151 "Service" 9152 "HTTPRoute" 9153 9154 Invalid values include: 9155 9156 "invalid/kind" - "/" is an invalid character 9157 9158 +kubebuilder:validation:MinLength=1 9159 +kubebuilder:validation:MaxLength=63 9160 +kubebuilder:validation:Pattern=`^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$` | | 9161 9162 9163 9164 ### <span id="listener"></span> Listener 9165 9166 9167 9168 9169 9170 9171 **Properties** 9172 9173 | Name | Type | Go type | Required | Default | Description | Example | 9174 |------|------|---------|:--------:| ------- |-------------|---------| 9175 | Address | string| `string` | | | | | 9176 | Destination | string| `string` | | | | | 9177 | Match | string| `string` | | | | | 9178 | Port | double (formatted number)| `float64` | | | | | 9179 9180 9181 9182 ### <span id="listener-status"></span> ListenerStatus 9183 9184 9185 9186 9187 9188 9189 **Properties** 9190 9191 | Name | Type | Go type | Required | Default | Description | Example | 9192 |------|------|---------|:--------:| ------- |-------------|---------| 9193 | AttachedRoutes | int32 (formatted integer)| `int32` | | | AttachedRoutes represents the total number of Routes that have been 9194 successfully attached to this Listener. | | 9195 | Conditions | [][Condition](#condition)| `[]*Condition` | | | Conditions describe the current condition of this listener. 9196 9197 +listType=map 9198 +listMapKey=type 9199 +kubebuilder:validation:MaxItems=8 | | 9200 | SupportedKinds | [][RouteGroupKind](#route-group-kind)| `[]*RouteGroupKind` | | | SupportedKinds is the list indicating the Kinds supported by this 9201 listener. This MUST represent the kinds an implementation supports for 9202 that Listener configuration. 9203 9204 If kinds are specified in Spec that are not supported, they MUST NOT 9205 appear in this list and an implementation MUST set the "ResolvedRefs" 9206 condition to "False" with the "InvalidRouteKinds" reason. If both valid 9207 and invalid Route kinds are specified, the implementation MUST 9208 reference the valid Route kinds that have been specified. 9209 9210 +kubebuilder:validation:MaxItems=8 | | 9211 | name | [SectionName](#section-name)| `SectionName` | | | | | 9212 9213 9214 9215 ### <span id="listeners"></span> Listeners 9216 9217 9218 9219 9220 [][Listener](#listener) 9221 9222 ### <span id="local-object-reference"></span> LocalObjectReference 9223 9224 9225 > References to objects with invalid Group and Kind are not valid, and must 9226 be rejected by the implementation, with appropriate Conditions set 9227 on the containing object. 9228 9229 9230 9231 9232 9233 9234 **Properties** 9235 9236 | Name | Type | Go type | Required | Default | Description | Example | 9237 |------|------|---------|:--------:| ------- |-------------|---------| 9238 | group | [Group](#group)| `Group` | | | | | 9239 | kind | [Kind](#kind)| `Kind` | | | | | 9240 | name | [ObjectName](#object-name)| `ObjectName` | | | | | 9241 9242 9243 9244 ### <span id="log"></span> Log 9245 9246 9247 > Log is a log emitted in a span 9248 9249 9250 9251 9252 9253 9254 **Properties** 9255 9256 | Name | Type | Go type | Required | Default | Description | Example | 9257 |------|------|---------|:--------:| ------- |-------------|---------| 9258 | Fields | [][KeyValue](#key-value)| `[]*KeyValue` | | | | | 9259 | Timestamp | uint64 (formatted integer)| `uint64` | | | | | 9260 9261 9262 9263 ### <span id="m-tls-status"></span> MTLSStatus 9264 9265 9266 > MTLSStatus describes the current mTLS status of a mesh entity 9267 9268 9269 9270 9271 9272 9273 **Properties** 9274 9275 | Name | Type | Go type | Required | Default | Description | Example | 9276 |------|------|---------|:--------:| ------- |-------------|---------| 9277 | AutoMTLSEnabled | boolean| `bool` | | | | | 9278 | MinTLS | string| `string` | | | | | 9279 | Status | string| `string` | ✓ | | mTLS status: MTLS_ENABLED, MTLS_PARTIALLY_ENABLED, MTLS_NOT_ENABLED | `MTLS_ENABLED` | 9280 9281 9282 9283 ### <span id="managed-fields-entry"></span> ManagedFieldsEntry 9284 9285 9286 > ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource 9287 that the fieldset applies to. 9288 9289 9290 9291 9292 9293 9294 **Properties** 9295 9296 | Name | Type | Go type | Required | Default | Description | Example | 9297 |------|------|---------|:--------:| ------- |-------------|---------| 9298 | APIVersion | string| `string` | | | APIVersion defines the version of this resource that this field set 9299 applies to. The format is "group/version" just like the top-level 9300 APIVersion field. It is necessary to track the version of a field 9301 set because it cannot be automatically converted. | | 9302 | FieldsType | string| `string` | | | FieldsType is the discriminator for the different fields format and version. 9303 There is currently only one possible value: "FieldsV1" | | 9304 | Manager | string| `string` | | | Manager is an identifier of the workflow managing these fields. | | 9305 | Subresource | string| `string` | | | Subresource is the name of the subresource used to update that object, or 9306 empty string if the object was updated through the main resource. The 9307 value of this field is used to distinguish between managers, even if they 9308 share the same name. For example, a status update will be distinct from a 9309 regular update using the same manager name. 9310 Note that the APIVersion field is not related to the Subresource field and 9311 it always corresponds to the version of the main resource. | | 9312 | Time | string| `string` | | | Time is the timestamp of when the ManagedFields entry was added. The 9313 timestamp will also be updated if a field is added, the manager 9314 changes any of the owned fields value or removes a field. The 9315 timestamp does not update when a field is removed from the entry 9316 because another manager took it over. 9317 +optional | | 9318 | fieldsV1 | [FieldsV1](#fields-v1)| `FieldsV1` | | | | | 9319 | operation | [ManagedFieldsOperationType](#managed-fields-operation-type)| `ManagedFieldsOperationType` | | | | | 9320 9321 9322 9323 ### <span id="managed-fields-operation-type"></span> ManagedFieldsOperationType 9324 9325 9326 9327 9328 | Name | Type | Go type | Default | Description | Example | 9329 |------|------|---------| ------- |-------------|---------| 9330 | ManagedFieldsOperationType | string| string | | | | 9331 9332 9333 9334 ### <span id="metric"></span> Metric 9335 9336 9337 9338 9339 9340 9341 **Properties** 9342 9343 | Name | Type | Go type | Required | Default | Description | Example | 9344 |------|------|---------|:--------:| ------- |-------------|---------| 9345 | Datapoints | [][Datapoint](#datapoint)| `[]*Datapoint` | | | | | 9346 | Labels | map of string| `map[string]string` | | | | | 9347 | Name | string| `string` | | | | | 9348 | Stat | string| `string` | | | | | 9349 9350 9351 9352 ### <span id="metrics-stats"></span> MetricsStats 9353 9354 9355 > MetricsStats contains opinionated statistics on metrics on a single target. Currently limited to response times (avg/percentiles over interval) 9356 9357 9358 9359 9360 9361 9362 **Properties** 9363 9364 | Name | Type | Go type | Required | Default | Description | Example | 9365 |------|------|---------|:--------:| ------- |-------------|---------| 9366 | ResponseTimes | [][Stat](#stat)| `[]*Stat` | | | | | 9367 9368 9369 9370 ### <span id="metrics-stats-queries"></span> MetricsStatsQueries 9371 9372 9373 9374 9375 9376 9377 **Properties** 9378 9379 | Name | Type | Go type | Required | Default | Description | Example | 9380 |------|------|---------|:--------:| ------- |-------------|---------| 9381 | Queries | [][MetricsStatsQuery](#metrics-stats-query)| `[]*MetricsStatsQuery` | | | | | 9382 9383 9384 9385 ### <span id="metrics-stats-query"></span> MetricsStatsQuery 9386 9387 9388 9389 9390 9391 9392 **Properties** 9393 9394 | Name | Type | Go type | Required | Default | Description | Example | 9395 |------|------|---------|:--------:| ------- |-------------|---------| 9396 | Avg | boolean| `bool` | | | | | 9397 | Direction | string| `string` | | | | | 9398 | PeerTarget | [Target](#target)| `Target` | | | | | 9399 | Quantiles | []string| `[]string` | | | | | 9400 | RawInterval | string| `string` | | | | | 9401 | RawQueryTime | int64 (formatted integer)| `int64` | | | | | 9402 | Target | [Target](#target)| `Target` | | | | | 9403 9404 9405 9406 ### <span id="monitoring-dashboard"></span> MonitoringDashboard 9407 9408 9409 > MonitoringDashboard is the model representing custom monitoring dashboard, transformed from MonitoringDashboard config resource 9410 9411 9412 9413 9414 9415 9416 **Properties** 9417 9418 | Name | Type | Go type | Required | Default | Description | Example | 9419 |------|------|---------|:--------:| ------- |-------------|---------| 9420 | Aggregations | [][Aggregation](#aggregation)| `[]*Aggregation` | | | | | 9421 | Charts | [][Chart](#chart)| `[]*Chart` | | | | | 9422 | ExternalLinks | [][ExternalLink](#external-link)| `[]*ExternalLink` | | | | | 9423 | Name | string| `string` | | | | | 9424 | Rows | int64 (formatted integer)| `int64` | | | | | 9425 | Title | string| `string` | | | | | 9426 9427 9428 9429 ### <span id="monitoring-dashboard-external-link-variables"></span> MonitoringDashboardExternalLinkVariables 9430 9431 9432 9433 9434 9435 9436 **Properties** 9437 9438 | Name | Type | Go type | Required | Default | Description | Example | 9439 |------|------|---------|:--------:| ------- |-------------|---------| 9440 | App | string| `string` | | | | | 9441 | Namespace | string| `string` | | | | | 9442 | Service | string| `string` | | | | | 9443 | Version | string| `string` | | | | | 9444 | Workload | string| `string` | | | | | 9445 9446 9447 9448 ### <span id="namespace"></span> Namespace 9449 9450 9451 > A Namespace provide a scope for names 9452 This type is used to describe a set of objects. 9453 9454 9455 9456 9457 9458 9459 **Properties** 9460 9461 | Name | Type | Go type | Required | Default | Description | Example | 9462 |------|------|---------|:--------:| ------- |-------------|---------| 9463 | Annotations | map of string| `map[string]string` | | | Specific annotations used in Kiali | | 9464 | Labels | map of string| `map[string]string` | | | Labels for Namespace | | 9465 | Name | string| `string` | ✓ | | The id of the namespace. | `istio-system` | 9466 9467 9468 9469 ### <span id="namespace"></span> Namespace 9470 9471 9472 > This validation is based off of the corresponding Kubernetes validation: 9473 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L187 9474 9475 This is used for Namespace name validation here: 9476 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/api/validation/generic.go#L63 9477 9478 Valid values include: 9479 9480 "example" 9481 9482 Invalid values include: 9483 9484 "example.com" - "." is an invalid character 9485 9486 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$` 9487 +kubebuilder:validation:MinLength=1 9488 +kubebuilder:validation:MaxLength=63 9489 9490 9491 9492 9493 | Name | Type | Go type | Default | Description | Example | 9494 |------|------|---------| ------- |-------------|---------| 9495 | Namespace | string| string | | This validation is based off of the corresponding Kubernetes validation: 9496 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L187 9497 9498 This is used for Namespace name validation here: 9499 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/api/validation/generic.go#L63 9500 9501 Valid values include: 9502 9503 "example" 9504 9505 Invalid values include: 9506 9507 "example.com" - "." is an invalid character 9508 9509 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$` 9510 +kubebuilder:validation:MinLength=1 9511 +kubebuilder:validation:MaxLength=63 | | 9512 9513 9514 9515 ### <span id="namespace-app-health"></span> NamespaceAppHealth 9516 9517 9518 > NamespaceAppHealth is an alias of map of app name x health 9519 9520 9521 9522 9523 [NamespaceAppHealth](#namespace-app-health) 9524 9525 ### <span id="node-data"></span> NodeData 9526 9527 9528 9529 9530 9531 9532 **Properties** 9533 9534 | Name | Type | Go type | Required | Default | Description | Example | 9535 |------|------|---------|:--------:| ------- |-------------|---------| 9536 | Aggregate | string| `string` | | | | | 9537 | App | string| `string` | | | | | 9538 | Cluster | string| `string` | | | | | 9539 | DestServices | [][ServiceName](#service-name)| `[]*ServiceName` | | | | | 9540 | HasCB | boolean| `bool` | | | | | 9541 | HasFaultInjection | boolean| `bool` | | | | | 9542 | HasMirroring | boolean| `bool` | | | | | 9543 | HasMissingSC | boolean| `bool` | | | | | 9544 | HasRequestRouting | boolean| `bool` | | | | | 9545 | HasRequestTimeout | boolean| `bool` | | | | | 9546 | HasTCPTrafficShifting | boolean| `bool` | | | | | 9547 | HasTrafficShifting | boolean| `bool` | | | | | 9548 | HasWorkloadEntry | [][WEInfo](#w-e-info)| `[]*WEInfo` | | | | | 9549 | HealthData | [interface{}](#interface)| `interface{}` | | | | | 9550 | ID | string| `string` | | | Cytoscape Fields | | 9551 | IsBox | string| `string` | | | | | 9552 | IsDead | boolean| `bool` | | | | | 9553 | IsIdle | boolean| `bool` | | | | | 9554 | IsInaccessible | boolean| `bool` | | | | | 9555 | IsOutside | boolean| `bool` | | | | | 9556 | IsRoot | boolean| `bool` | | | | | 9557 | Labels | map of string| `map[string]string` | | | | | 9558 | Namespace | string| `string` | | | | | 9559 | NodeType | string| `string` | | | App Fields (not required by Cytoscape) | | 9560 | Parent | string| `string` | | | | | 9561 | Service | string| `string` | | | | | 9562 | Traffic | [][ProtocolTraffic](#protocol-traffic)| `[]*ProtocolTraffic` | | | | | 9563 | Version | string| `string` | | | | | 9564 | Workload | string| `string` | | | | | 9565 | hasHealthConfig | [HealthConfig](#health-config)| `HealthConfig` | | | | | 9566 | hasVS | [VSInfo](#v-s-info)| `VSInfo` | | | | | 9567 | isGateway | [GWInfo](#g-w-info)| `GWInfo` | | | | | 9568 | isServiceEntry | [SEInfo](#s-e-info)| `SEInfo` | | | | | 9569 9570 9571 9572 ### <span id="node-wrapper"></span> NodeWrapper 9573 9574 9575 9576 9577 9578 9579 **Properties** 9580 9581 | Name | Type | Go type | Required | Default | Description | Example | 9582 |------|------|---------|:--------:| ------- |-------------|---------| 9583 | data | [NodeData](#node-data)| `NodeData` | | | | | 9584 9585 9586 9587 ### <span id="object-name"></span> ObjectName 9588 9589 9590 > +kubebuilder:validation:MinLength=1 9591 +kubebuilder:validation:MaxLength=253 9592 9593 9594 9595 9596 | Name | Type | Go type | Default | Description | Example | 9597 |------|------|---------| ------- |-------------|---------| 9598 | ObjectName | string| string | | +kubebuilder:validation:MinLength=1 9599 +kubebuilder:validation:MaxLength=253 | | 9600 9601 9602 9603 ### <span id="owner-reference"></span> OwnerReference 9604 9605 9606 > OwnerReference contains enough information to let you identify an owning 9607 object. An owning object must be in the same namespace as the dependent, or 9608 be cluster-scoped, so there is no namespace field. 9609 +structType=atomic 9610 9611 9612 9613 9614 9615 9616 **Properties** 9617 9618 | Name | Type | Go type | Required | Default | Description | Example | 9619 |------|------|---------|:--------:| ------- |-------------|---------| 9620 | APIVersion | string| `string` | | | API version of the referent. | | 9621 | BlockOwnerDeletion | boolean| `bool` | | | If true, AND if the owner has the "foregroundDeletion" finalizer, then 9622 the owner cannot be deleted from the key-value store until this 9623 reference is removed. 9624 See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion 9625 for how the garbage collector interacts with this field and enforces the foreground deletion. 9626 Defaults to false. 9627 To set this field, a user needs "delete" permission of the owner, 9628 otherwise 422 (Unprocessable Entity) will be returned. 9629 +optional | | 9630 | Controller | boolean| `bool` | | | If true, this reference points to the managing controller. 9631 +optional | | 9632 | Kind | string| `string` | | | Kind of the referent. 9633 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | 9634 | Name | string| `string` | | | Name of the referent. 9635 More info: http://kubernetes.io/docs/user-guide/identifiers#names | | 9636 | uid | [UID](#uid)| `UID` | | | | | 9637 9638 9639 9640 ### <span id="parent-reference"></span> ParentReference 9641 9642 9643 > The API object must be valid in the cluster; the Group and Kind must 9644 be registered in the cluster for this reference to be valid. 9645 9646 9647 9648 9649 9650 9651 **Properties** 9652 9653 | Name | Type | Go type | Required | Default | Description | Example | 9654 |------|------|---------|:--------:| ------- |-------------|---------| 9655 | group | [Group](#group)| `Group` | | | | | 9656 | kind | [Kind](#kind)| `Kind` | | | | | 9657 | name | [ObjectName](#object-name)| `ObjectName` | | | | | 9658 | namespace | [Namespace](#namespace)| `Namespace` | | | | | 9659 | port | [PortNumber](#port-number)| `PortNumber` | | | | | 9660 | sectionName | [SectionName](#section-name)| `SectionName` | | | | | 9661 9662 9663 9664 ### <span id="path-match-type"></span> PathMatchType 9665 9666 9667 > "Exact" 9668 "PathPrefix" 9669 "RegularExpression" 9670 9671 PathPrefix and Exact paths must be syntactically valid: 9672 9673 Must begin with the `/` character 9674 Must not contain consecutive `/` characters (e.g. `/foo///`, `//`). 9675 9676 Note that values may be added to this enum, implementations 9677 must ensure that unknown values will not cause a crash. 9678 9679 Unknown values here must result in the implementation setting the 9680 Attached Condition for the Route to `status: False`, with a 9681 Reason of `UnsupportedValue`. 9682 9683 +kubebuilder:validation:Enum=Exact;PathPrefix;RegularExpression 9684 9685 9686 9687 9688 | Name | Type | Go type | Default | Description | Example | 9689 |------|------|---------| ------- |-------------|---------| 9690 | PathMatchType | string| string | | "Exact" 9691 "PathPrefix" 9692 "RegularExpression" 9693 9694 PathPrefix and Exact paths must be syntactically valid: 9695 9696 Must begin with the `/` character 9697 Must not contain consecutive `/` characters (e.g. `/foo///`, `//`). 9698 9699 Note that values may be added to this enum, implementations 9700 must ensure that unknown values will not cause a crash. 9701 9702 Unknown values here must result in the implementation setting the 9703 Attached Condition for the Route to `status: False`, with a 9704 Reason of `UnsupportedValue`. 9705 9706 +kubebuilder:validation:Enum=Exact;PathPrefix;RegularExpression | | 9707 9708 9709 9710 ### <span id="peer-authentication"></span> PeerAuthentication 9711 9712 9713 > Examples: 9714 9715 Policy to allow mTLS traffic for all workloads under namespace `foo`: 9716 ```yaml 9717 apiVersion: security.istio.io/v1beta1 9718 kind: PeerAuthentication 9719 metadata: 9720 9721 name: default 9722 namespace: foo 9723 9724 spec: 9725 9726 mtls: 9727 mode: STRICT 9728 9729 ``` 9730 For mesh level, put the policy in root-namespace according to your Istio installation. 9731 9732 Policies to allow both mTLS & plaintext traffic for all workloads under namespace `foo`, but 9733 require mTLS for workload `finance`. 9734 ```yaml 9735 apiVersion: security.istio.io/v1beta1 9736 kind: PeerAuthentication 9737 metadata: 9738 9739 name: default 9740 namespace: foo 9741 9742 spec: 9743 9744 mtls: 9745 mode: PERMISSIVE 9746 9747 9748 apiVersion: security.istio.io/v1beta1 9749 kind: PeerAuthentication 9750 metadata: 9751 9752 name: default 9753 namespace: foo 9754 9755 spec: 9756 9757 selector: 9758 matchLabels: 9759 app: finance 9760 mtls: 9761 mode: STRICT 9762 9763 ``` 9764 Policy to allow mTLS strict for all workloads, but leave port 8080 to 9765 plaintext: 9766 ```yaml 9767 apiVersion: security.istio.io/v1beta1 9768 kind: PeerAuthentication 9769 metadata: 9770 9771 name: default 9772 namespace: foo 9773 9774 spec: 9775 9776 selector: 9777 matchLabels: 9778 app: finance 9779 mtls: 9780 mode: STRICT 9781 portLevelMtls: 9782 8080: 9783 mode: DISABLE 9784 9785 ``` 9786 Policy to inherit mTLS mode from namespace (or mesh) settings, and overwrite 9787 settings for port 8080 9788 ```yaml 9789 apiVersion: security.istio.io/v1beta1 9790 kind: PeerAuthentication 9791 metadata: 9792 9793 name: default 9794 namespace: foo 9795 9796 spec: 9797 9798 selector: 9799 matchLabels: 9800 app: finance 9801 mtls: 9802 mode: UNSET 9803 portLevelMtls: 9804 8080: 9805 mode: DISABLE 9806 9807 ``` 9808 9809 <!-- crd generation tags 9810 +cue-gen:PeerAuthentication:groupName:security.istio.io 9811 +cue-gen:PeerAuthentication:version:v1beta1 9812 +cue-gen:PeerAuthentication:storageVersion 9813 +cue-gen:PeerAuthentication:annotations:helm.sh/resource-policy=keep 9814 +cue-gen:PeerAuthentication:labels:app=istio-pilot,chart=istio,istio=security,heritage=Tiller,release=istio 9815 +cue-gen:PeerAuthentication:subresource:status 9816 +cue-gen:PeerAuthentication:scope:Namespaced 9817 +cue-gen:PeerAuthentication:resource:categories=istio-io,security-istio-io,shortNames=pa 9818 +cue-gen:PeerAuthentication:preserveUnknownFields:false 9819 +cue-gen:PeerAuthentication:printerColumn:name=Mode,type=string,JSONPath=.spec.mtls.mode,description="Defines the mTLS mode used for peer authentication." 9820 +cue-gen:PeerAuthentication:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp 9821 representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. 9822 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 9823 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" 9824 > 9825 9826 <!-- go code generation tags 9827 +kubetype-gen 9828 +kubetype-gen:groupVersion=security.istio.io/v1beta1 9829 +genclient 9830 +k8s:deepcopy-gen=true 9831 > 9832 9833 9834 9835 9836 9837 9838 **Properties** 9839 9840 | Name | Type | Go type | Required | Default | Description | Example | 9841 |------|------|---------|:--------:| ------- |-------------|---------| 9842 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 9843 Servers should convert recognized schemas to the latest internal value, and 9844 may reject unrecognized values. 9845 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 9846 +optional | | 9847 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 9848 set by external tools to store and retrieve arbitrary metadata. They are not 9849 queryable and should be preserved when modifying objects. 9850 More info: http://kubernetes.io/docs/user-guide/annotations 9851 +optional | | 9852 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 9853 created. It is not guaranteed to be set in happens-before order across separate operations. 9854 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 9855 9856 Populated by the system. 9857 Read-only. 9858 Null for lists. 9859 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 9860 +optional | | 9861 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 9862 it will be removed from the system. Only set when deletionTimestamp is also set. 9863 May only be shortened. 9864 Read-only. 9865 +optional | | 9866 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 9867 field is set by the server when a graceful deletion is requested by the user, and is not 9868 directly settable by a client. The resource is expected to be deleted (no longer visible 9869 from resource lists, and not reachable by name) after the time in this field, once the 9870 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 9871 Once the deletionTimestamp is set, this value may not be unset or be set further into the 9872 future, although it may be shortened or the resource may be deleted prior to this time. 9873 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 9874 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 9875 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 9876 remove the pod from the API. In the presence of network partitions, this object may still 9877 exist after this timestamp, until an administrator or automated process can determine the 9878 resource is fully terminated. 9879 If not set, graceful deletion of the object has not been requested. 9880 9881 Populated by the system when a graceful deletion is requested. 9882 Read-only. 9883 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 9884 +optional | | 9885 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 9886 is an identifier for the responsible component that will remove the entry 9887 from the list. If the deletionTimestamp of the object is non-nil, entries 9888 in this list can only be removed. 9889 Finalizers may be processed and removed in any order. Order is NOT enforced 9890 because it introduces significant risk of stuck finalizers. 9891 finalizers is a shared field, any actor with permission can reorder it. 9892 If the finalizer list is processed in order, then this can lead to a situation 9893 in which the component responsible for the first finalizer in the list is 9894 waiting for a signal (field value, external system, or other) produced by a 9895 component responsible for a finalizer later in the list, resulting in a deadlock. 9896 Without enforced ordering finalizers are free to order amongst themselves and 9897 are not vulnerable to ordering changes in the list. 9898 +optional 9899 +patchStrategy=merge | | 9900 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 9901 name ONLY IF the Name field has not been provided. 9902 If this field is used, the name returned to the client will be different 9903 than the name passed. This value will also be combined with a unique suffix. 9904 The provided value has the same validation rules as the Name field, 9905 and may be truncated by the length of the suffix required to make the value 9906 unique on the server. 9907 9908 If this field is specified and the generated name exists, the server will return a 409. 9909 9910 Applied only if Name is not specified. 9911 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 9912 +optional | | 9913 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 9914 Populated by the system. Read-only. 9915 +optional | | 9916 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 9917 Servers may infer this from the endpoint the client submits requests to. 9918 Cannot be updated. 9919 In CamelCase. 9920 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 9921 +optional | | 9922 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 9923 (scope and select) objects. May match selectors of replication controllers 9924 and services. 9925 More info: http://kubernetes.io/docs/user-guide/labels 9926 +optional | | 9927 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 9928 that are managed by that workflow. This is mostly for internal 9929 housekeeping, and users typically shouldn't need to set or 9930 understand this field. A workflow can be the user's name, a 9931 controller's name, or the name of a specific apply path like 9932 "ci-cd". The set of fields is always in the version that the 9933 workflow used when modifying the object. 9934 9935 +optional | | 9936 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 9937 some resources may allow a client to request the generation of an appropriate name 9938 automatically. Name is primarily intended for creation idempotence and configuration 9939 definition. 9940 Cannot be updated. 9941 More info: http://kubernetes.io/docs/user-guide/identifiers#names 9942 +optional | | 9943 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 9944 equivalent to the "default" namespace, but "default" is the canonical representation. 9945 Not all objects are required to be scoped to a namespace - the value of this field for 9946 those objects will be empty. 9947 9948 Must be a DNS_LABEL. 9949 Cannot be updated. 9950 More info: http://kubernetes.io/docs/user-guide/namespaces 9951 +optional | | 9952 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 9953 been deleted, this object will be garbage collected. If this object is managed by a controller, 9954 then an entry in this list will point to this controller, with the controller field set to true. 9955 There cannot be more than one managing controller. 9956 +optional 9957 +patchMergeKey=uid 9958 +patchStrategy=merge | | 9959 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 9960 be used by clients to determine when objects have changed. May be used for optimistic 9961 concurrency, change detection, and the watch operation on a resource or set of resources. 9962 Clients must treat these values as opaque and passed unmodified back to the server. 9963 They may only be valid for a particular resource or set of resources. 9964 9965 Populated by the system. 9966 Read-only. 9967 Value must be treated as opaque by clients and . 9968 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 9969 +optional | | 9970 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 9971 +optional | | 9972 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 9973 the system and never used; it will be removed completely in 1.25. 9974 9975 The name in the go struct is changed to help clients detect 9976 accidental use. 9977 9978 +optional | | 9979 | spec | [PeerAuthentication](#peer-authentication)| `PeerAuthentication` | | | | | 9980 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 9981 | uid | [UID](#uid)| `UID` | | | | | 9982 9983 9984 9985 ### <span id="pod"></span> Pod 9986 9987 9988 > Pod holds a subset of v1.Pod data that is meaningful in Kiali 9989 9990 9991 9992 9993 9994 9995 **Properties** 9996 9997 | Name | Type | Go type | Required | Default | Description | Example | 9998 |------|------|---------|:--------:| ------- |-------------|---------| 9999 | Annotations | map of string| `map[string]string` | | | | | 10000 | AppLabel | boolean| `bool` | | | | | 10001 | Containers | [][ContainerInfo](#container-info)| `[]*ContainerInfo` | | | | | 10002 | CreatedAt | string| `string` | | | | | 10003 | CreatedBy | [][Reference](#reference)| `[]*Reference` | | | | | 10004 | IstioContainers | [][ContainerInfo](#container-info)| `[]*ContainerInfo` | | | | | 10005 | IstioInitContainers | [][ContainerInfo](#container-info)| `[]*ContainerInfo` | | | | | 10006 | Labels | map of string| `map[string]string` | | | | | 10007 | Name | string| `string` | | | | | 10008 | ServiceAccountName | string| `string` | | | | | 10009 | Status | string| `string` | | | | | 10010 | StatusMessage | string| `string` | | | | | 10011 | StatusReason | string| `string` | | | | | 10012 | VersionLabel | boolean| `bool` | | | | | 10013 | proxyStatus | [ProxyStatus](#proxy-status)| `ProxyStatus` | | | | | 10014 10015 10016 10017 ### <span id="pods"></span> Pods 10018 10019 10020 > Pods alias for list of Pod structs 10021 10022 10023 10024 10025 [][Pod](#pod) 10026 10027 ### <span id="port"></span> Port 10028 10029 10030 10031 10032 10033 10034 **Properties** 10035 10036 | Name | Type | Go type | Required | Default | Description | Example | 10037 |------|------|---------|:--------:| ------- |-------------|---------| 10038 | AppProtocol | string| `string` | | | | | 10039 | IstioProtocol | string| `string` | | | | | 10040 | Name | string| `string` | | | | | 10041 | Port | int32 (formatted integer)| `int32` | | | | | 10042 | Protocol | string| `string` | | | | | 10043 | TLSMode | string| `string` | | | TLSMode endpoint is injected with istio sidecar and ready to configure Istio mTLS 10044 DisabledTLSModeLabel implies that this endpoint should receive traffic as is (mostly plaintext) 10045 DisabledTLSModeLabel = "disabled" 10046 IstioMutualTLSModeLabel implies that the endpoint is ready to receive Istio mTLS connections. 10047 IstioMutualTLSModeLabel = "istio" | | 10048 10049 10050 10051 ### <span id="port-number"></span> PortNumber 10052 10053 10054 > +kubebuilder:validation:Minimum=1 10055 +kubebuilder:validation:Maximum=65535 10056 10057 10058 10059 10060 | Name | Type | Go type | Default | Description | Example | 10061 |------|------|---------| ------- |-------------|---------| 10062 | PortNumber | int32 (formatted integer)| int32 | | +kubebuilder:validation:Minimum=1 10063 +kubebuilder:validation:Maximum=65535 | | 10064 10065 10066 10067 ### <span id="ports"></span> Ports 10068 10069 10070 10071 10072 [][Port](#port) 10073 10074 ### <span id="precise-hostname"></span> PreciseHostname 10075 10076 10077 > Note that as per RFC1035 and RFC1123, a *label* must consist of lower case 10078 alphanumeric characters or '-', and must start and end with an alphanumeric 10079 character. No other punctuation is allowed. 10080 10081 +kubebuilder:validation:MinLength=1 10082 +kubebuilder:validation:MaxLength=253 10083 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` 10084 10085 10086 10087 10088 | Name | Type | Go type | Default | Description | Example | 10089 |------|------|---------| ------- |-------------|---------| 10090 | PreciseHostname | string| string | | Note that as per RFC1035 and RFC1123, a *label* must consist of lower case 10091 alphanumeric characters or '-', and must start and end with an alphanumeric 10092 character. No other punctuation is allowed. 10093 10094 +kubebuilder:validation:MinLength=1 10095 +kubebuilder:validation:MaxLength=253 10096 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` | | 10097 10098 10099 10100 ### <span id="process"></span> Process 10101 10102 10103 > Process is the process emitting a set of spans 10104 10105 10106 10107 10108 10109 10110 **Properties** 10111 10112 | Name | Type | Go type | Required | Default | Description | Example | 10113 |------|------|---------|:--------:| ------- |-------------|---------| 10114 | ServiceName | string| `string` | | | | | 10115 | Tags | [][KeyValue](#key-value)| `[]*KeyValue` | | | | | 10116 10117 10118 10119 ### <span id="process-id"></span> ProcessID 10120 10121 10122 10123 10124 | Name | Type | Go type | Default | Description | Example | 10125 |------|------|---------| ------- |-------------|---------| 10126 | ProcessID | string| string | | | | 10127 10128 10129 10130 ### <span id="protocol-traffic"></span> ProtocolTraffic 10131 10132 10133 > ProtocolTraffic supplies all of the traffic information for a single protocol 10134 10135 10136 10137 10138 10139 10140 **Properties** 10141 10142 | Name | Type | Go type | Required | Default | Description | Example | 10143 |------|------|---------|:--------:| ------- |-------------|---------| 10144 | Protocol | string| `string` | | | | | 10145 | Rates | map of string| `map[string]string` | | | | | 10146 | responses | [Responses](#responses)| `Responses` | | | | | 10147 10148 10149 10150 ### <span id="proxy-status"></span> ProxyStatus 10151 10152 10153 > In healthy scenarios all variables should be true. 10154 If at least one variable is false, then the proxy isn't fully sync'ed with pilot. 10155 10156 10157 10158 10159 10160 10161 **Properties** 10162 10163 | Name | Type | Go type | Required | Default | Description | Example | 10164 |------|------|---------|:--------:| ------- |-------------|---------| 10165 | CDS | string| `string` | | | | | 10166 | EDS | string| `string` | | | | | 10167 | LDS | string| `string` | | | | | 10168 | RDS | string| `string` | | | | | 10169 10170 10171 10172 ### <span id="query-param-match-type"></span> QueryParamMatchType 10173 10174 10175 > "Exact" 10176 "RegularExpression" 10177 10178 Note that values may be added to this enum, implementations 10179 must ensure that unknown values will not cause a crash. 10180 10181 Unknown values here must result in the implementation setting the 10182 Attached Condition for the Route to `status: False`, with a 10183 Reason of `UnsupportedValue`. 10184 10185 +kubebuilder:validation:Enum=Exact;RegularExpression 10186 10187 10188 10189 10190 | Name | Type | Go type | Default | Description | Example | 10191 |------|------|---------| ------- |-------------|---------| 10192 | QueryParamMatchType | string| string | | "Exact" 10193 "RegularExpression" 10194 10195 Note that values may be added to this enum, implementations 10196 must ensure that unknown values will not cause a crash. 10197 10198 Unknown values here must result in the implementation setting the 10199 Attached Condition for the Route to `status: False`, with a 10200 Reason of `UnsupportedValue`. 10201 10202 +kubebuilder:validation:Enum=Exact;RegularExpression | | 10203 10204 10205 10206 ### <span id="reference"></span> Reference 10207 10208 10209 > Reference is a reference from one span to another 10210 10211 10212 10213 10214 10215 10216 **Properties** 10217 10218 | Name | Type | Go type | Required | Default | Description | Example | 10219 |------|------|---------|:--------:| ------- |-------------|---------| 10220 | refType | [ReferenceType](#reference-type)| `ReferenceType` | | | | | 10221 | spanID | [SpanID](#span-id)| `SpanID` | | | | | 10222 | traceID | [TraceID](#trace-id)| `TraceID` | | | | | 10223 10224 10225 10226 ### <span id="reference-type"></span> ReferenceType 10227 10228 10229 > ReferenceType is the reference type of one span to another 10230 10231 10232 10233 10234 | Name | Type | Go type | Default | Description | Example | 10235 |------|------|---------| ------- |-------------|---------| 10236 | ReferenceType | string| string | | ReferenceType is the reference type of one span to another | | 10237 10238 10239 10240 ### <span id="request-authentication"></span> RequestAuthentication 10241 10242 10243 > Require JWT for all request for workloads that have label `app:httpbin` 10244 10245 ```yaml 10246 apiVersion: security.istio.io/v1beta1 10247 kind: RequestAuthentication 10248 metadata: 10249 10250 name: httpbin 10251 namespace: foo 10252 10253 spec: 10254 10255 selector: 10256 matchLabels: 10257 app: httpbin 10258 jwtRules: 10259 issuer: "issuer-foo" 10260 jwksUri: https://example.com/.well-known/jwks.json 10261 10262 10263 apiVersion: security.istio.io/v1beta1 10264 kind: AuthorizationPolicy 10265 metadata: 10266 10267 name: httpbin 10268 namespace: foo 10269 10270 spec: 10271 10272 selector: 10273 matchLabels: 10274 app: httpbin 10275 rules: 10276 from: 10277 source: 10278 requestPrincipals: ["*"] 10279 10280 ``` 10281 10282 A policy in the root namespace ("istio-system" by default) applies to workloads in all namespaces 10283 in a mesh. The following policy makes all workloads only accept requests that contain a 10284 valid JWT token. 10285 10286 ```yaml 10287 apiVersion: security.istio.io/v1beta1 10288 kind: RequestAuthentication 10289 metadata: 10290 10291 name: req-authn-for-all 10292 namespace: istio-system 10293 10294 spec: 10295 10296 jwtRules: 10297 issuer: "issuer-foo" 10298 jwksUri: https://example.com/.well-known/jwks.json 10299 10300 10301 apiVersion: security.istio.io/v1beta1 10302 kind: AuthorizationPolicy 10303 metadata: 10304 10305 name: require-jwt-for-all 10306 namespace: istio-system 10307 10308 spec: 10309 10310 rules: 10311 from: 10312 source: 10313 requestPrincipals: ["*"] 10314 10315 ``` 10316 10317 The next example shows how to set a different JWT requirement for a different `host`. The `RequestAuthentication` 10318 declares it can accept JWTs issued by either `issuer-foo` or `issuer-bar` (the public key set is implicitly 10319 set from the OpenID Connect spec). 10320 10321 ```yaml 10322 apiVersion: security.istio.io/v1beta1 10323 kind: RequestAuthentication 10324 metadata: 10325 10326 name: httpbin 10327 namespace: foo 10328 10329 spec: 10330 10331 selector: 10332 matchLabels: 10333 app: httpbin 10334 jwtRules: 10335 issuer: "issuer-foo" 10336 issuer: "issuer-bar" 10337 10338 10339 apiVersion: security.istio.io/v1beta1 10340 kind: AuthorizationPolicy 10341 metadata: 10342 10343 name: httpbin 10344 namespace: foo 10345 10346 spec: 10347 10348 selector: 10349 matchLabels: 10350 app: httpbin 10351 rules: 10352 from: 10353 source: 10354 requestPrincipals: ["issuer-foo/*"] 10355 to: 10356 operation: 10357 hosts: ["example.com"] 10358 from: 10359 source: 10360 requestPrincipals: ["issuer-bar/*"] 10361 to: 10362 operation: 10363 hosts: ["another-host.com"] 10364 10365 ``` 10366 10367 You can fine tune the authorization policy to set different requirement per path. For example, 10368 to require JWT on all paths, except /healthz, the same `RequestAuthentication` can be used, but the 10369 authorization policy could be: 10370 10371 ```yaml 10372 apiVersion: security.istio.io/v1beta1 10373 kind: AuthorizationPolicy 10374 metadata: 10375 10376 name: httpbin 10377 namespace: foo 10378 10379 spec: 10380 10381 selector: 10382 matchLabels: 10383 app: httpbin 10384 rules: 10385 from: 10386 source: 10387 requestPrincipals: ["*"] 10388 to: 10389 operation: 10390 paths: ["/healthz"] 10391 10392 ``` 10393 10394 [Experimental] Routing based on derived [metadata](https://istio.io/latest/docs/reference/config/security/conditions/) 10395 is now supported. A prefix '@' is used to denote a match against internal metadata instead of the headers in the request. 10396 Currently this feature is only supported for the following metadata: 10397 10398 `request.auth.claims.{claim-name}[.{sub-claim}]*` which are extracted from validated JWT tokens. The claim name 10399 currently does not support the `.` character. Examples: `request.auth.claims.sub` and `request.auth.claims.name.givenName`. 10400 10401 The use of matches against JWT claim metadata is only supported in Gateways. The following example shows: 10402 10403 RequestAuthentication to decode and validate a JWT. This also makes the `@request.auth.claims` available for use in the VirtualService. 10404 AuthorizationPolicy to check for valid principals in the request. This makes the JWT required for the request. 10405 VirtualService to route the request based on the "sub" claim. 10406 10407 ```yaml 10408 apiVersion: security.istio.io/v1beta1 10409 kind: RequestAuthentication 10410 metadata: 10411 10412 name: jwt-on-ingress 10413 namespace: istio-system 10414 10415 spec: 10416 10417 selector: 10418 matchLabels: 10419 app: istio-ingressgateway 10420 jwtRules: 10421 issuer: "example.com" 10422 jwksUri: https://example.com/.well-known/jwks.json 10423 10424 10425 apiVersion: security.istio.io/v1beta1 10426 kind: AuthorizationPolicy 10427 metadata: 10428 10429 name: require-jwt 10430 namespace: istio-system 10431 10432 spec: 10433 10434 selector: 10435 matchLabels: 10436 app: istio-ingressgateway 10437 rules: 10438 from: 10439 source: 10440 requestPrincipals: ["*"] 10441 10442 10443 apiVersion: networking.istio.io/v1alpha3 10444 kind: VirtualService 10445 metadata: 10446 10447 name: route-jwt 10448 10449 spec: 10450 10451 hosts: 10452 foo.prod.svc.cluster.local 10453 gateways: 10454 istio-ingressgateway 10455 http: 10456 name: "v2" 10457 match: 10458 headers: 10459 "@request.auth.claims.sub": 10460 exact: "dev" 10461 route: 10462 destination: 10463 host: foo.prod.svc.cluster.local 10464 subset: v2 10465 name: "default" 10466 route: 10467 destination: 10468 host: foo.prod.svc.cluster.local 10469 subset: v1 10470 10471 ``` 10472 10473 <!-- crd generation tags 10474 +cue-gen:RequestAuthentication:groupName:security.istio.io 10475 +cue-gen:RequestAuthentication:version:v1beta1 10476 +cue-gen:RequestAuthentication:storageVersion 10477 +cue-gen:RequestAuthentication:annotations:helm.sh/resource-policy=keep 10478 +cue-gen:RequestAuthentication:labels:app=istio-pilot,chart=istio,istio=security,heritage=Tiller,release=istio 10479 +cue-gen:RequestAuthentication:subresource:status 10480 +cue-gen:RequestAuthentication:scope:Namespaced 10481 +cue-gen:RequestAuthentication:resource:categories=istio-io,security-istio-io,shortNames=ra 10482 +cue-gen:RequestAuthentication:preserveUnknownFields:false 10483 > 10484 10485 <!-- go code generation tags 10486 +kubetype-gen 10487 +kubetype-gen:groupVersion=security.istio.io/v1beta1 10488 +genclient 10489 +k8s:deepcopy-gen=true 10490 > 10491 10492 10493 10494 10495 10496 10497 **Properties** 10498 10499 | Name | Type | Go type | Required | Default | Description | Example | 10500 |------|------|---------|:--------:| ------- |-------------|---------| 10501 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 10502 Servers should convert recognized schemas to the latest internal value, and 10503 may reject unrecognized values. 10504 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 10505 +optional | | 10506 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 10507 set by external tools to store and retrieve arbitrary metadata. They are not 10508 queryable and should be preserved when modifying objects. 10509 More info: http://kubernetes.io/docs/user-guide/annotations 10510 +optional | | 10511 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 10512 created. It is not guaranteed to be set in happens-before order across separate operations. 10513 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 10514 10515 Populated by the system. 10516 Read-only. 10517 Null for lists. 10518 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 10519 +optional | | 10520 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 10521 it will be removed from the system. Only set when deletionTimestamp is also set. 10522 May only be shortened. 10523 Read-only. 10524 +optional | | 10525 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 10526 field is set by the server when a graceful deletion is requested by the user, and is not 10527 directly settable by a client. The resource is expected to be deleted (no longer visible 10528 from resource lists, and not reachable by name) after the time in this field, once the 10529 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 10530 Once the deletionTimestamp is set, this value may not be unset or be set further into the 10531 future, although it may be shortened or the resource may be deleted prior to this time. 10532 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 10533 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 10534 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 10535 remove the pod from the API. In the presence of network partitions, this object may still 10536 exist after this timestamp, until an administrator or automated process can determine the 10537 resource is fully terminated. 10538 If not set, graceful deletion of the object has not been requested. 10539 10540 Populated by the system when a graceful deletion is requested. 10541 Read-only. 10542 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 10543 +optional | | 10544 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 10545 is an identifier for the responsible component that will remove the entry 10546 from the list. If the deletionTimestamp of the object is non-nil, entries 10547 in this list can only be removed. 10548 Finalizers may be processed and removed in any order. Order is NOT enforced 10549 because it introduces significant risk of stuck finalizers. 10550 finalizers is a shared field, any actor with permission can reorder it. 10551 If the finalizer list is processed in order, then this can lead to a situation 10552 in which the component responsible for the first finalizer in the list is 10553 waiting for a signal (field value, external system, or other) produced by a 10554 component responsible for a finalizer later in the list, resulting in a deadlock. 10555 Without enforced ordering finalizers are free to order amongst themselves and 10556 are not vulnerable to ordering changes in the list. 10557 +optional 10558 +patchStrategy=merge | | 10559 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 10560 name ONLY IF the Name field has not been provided. 10561 If this field is used, the name returned to the client will be different 10562 than the name passed. This value will also be combined with a unique suffix. 10563 The provided value has the same validation rules as the Name field, 10564 and may be truncated by the length of the suffix required to make the value 10565 unique on the server. 10566 10567 If this field is specified and the generated name exists, the server will return a 409. 10568 10569 Applied only if Name is not specified. 10570 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 10571 +optional | | 10572 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 10573 Populated by the system. Read-only. 10574 +optional | | 10575 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 10576 Servers may infer this from the endpoint the client submits requests to. 10577 Cannot be updated. 10578 In CamelCase. 10579 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 10580 +optional | | 10581 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 10582 (scope and select) objects. May match selectors of replication controllers 10583 and services. 10584 More info: http://kubernetes.io/docs/user-guide/labels 10585 +optional | | 10586 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 10587 that are managed by that workflow. This is mostly for internal 10588 housekeeping, and users typically shouldn't need to set or 10589 understand this field. A workflow can be the user's name, a 10590 controller's name, or the name of a specific apply path like 10591 "ci-cd". The set of fields is always in the version that the 10592 workflow used when modifying the object. 10593 10594 +optional | | 10595 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 10596 some resources may allow a client to request the generation of an appropriate name 10597 automatically. Name is primarily intended for creation idempotence and configuration 10598 definition. 10599 Cannot be updated. 10600 More info: http://kubernetes.io/docs/user-guide/identifiers#names 10601 +optional | | 10602 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 10603 equivalent to the "default" namespace, but "default" is the canonical representation. 10604 Not all objects are required to be scoped to a namespace - the value of this field for 10605 those objects will be empty. 10606 10607 Must be a DNS_LABEL. 10608 Cannot be updated. 10609 More info: http://kubernetes.io/docs/user-guide/namespaces 10610 +optional | | 10611 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 10612 been deleted, this object will be garbage collected. If this object is managed by a controller, 10613 then an entry in this list will point to this controller, with the controller field set to true. 10614 There cannot be more than one managing controller. 10615 +optional 10616 +patchMergeKey=uid 10617 +patchStrategy=merge | | 10618 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 10619 be used by clients to determine when objects have changed. May be used for optimistic 10620 concurrency, change detection, and the watch operation on a resource or set of resources. 10621 Clients must treat these values as opaque and passed unmodified back to the server. 10622 They may only be valid for a particular resource or set of resources. 10623 10624 Populated by the system. 10625 Read-only. 10626 Value must be treated as opaque by clients and . 10627 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 10628 +optional | | 10629 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 10630 +optional | | 10631 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 10632 the system and never used; it will be removed completely in 1.25. 10633 10634 The name in the go struct is changed to help clients detect 10635 accidental use. 10636 10637 +optional | | 10638 | spec | [RequestAuthentication](#request-authentication)| `RequestAuthentication` | | | | | 10639 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 10640 | uid | [UID](#uid)| `UID` | | | | | 10641 10642 10643 10644 ### <span id="request-health"></span> RequestHealth 10645 10646 10647 > RequestHealth holds several stats about recent request errors 10648 Inbound//Outbound are the rates of requests by protocol and status_code. 10649 Example: Inbound: { "http": {"200": 1.5, "400": 2.3}, "grpc": {"1": 1.2} } 10650 10651 10652 10653 10654 10655 10656 **Properties** 10657 10658 | Name | Type | Go type | Required | Default | Description | Example | 10659 |------|------|---------|:--------:| ------- |-------------|---------| 10660 | HealthAnnotations | map of string| `map[string]string` | | | | | 10661 | Inbound | map of [map[string]float64](#map-string-float64)| `map[string]map[string]float64` | | | | | 10662 | Outbound | map of [map[string]float64](#map-string-float64)| `map[string]map[string]float64` | | | | | 10663 10664 10665 10666 ### <span id="resource-permissions"></span> ResourcePermissions 10667 10668 10669 > ResourcePermissions holds permission flags for an object type 10670 True means allowed. 10671 10672 10673 10674 10675 10676 10677 **Properties** 10678 10679 | Name | Type | Go type | Required | Default | Description | Example | 10680 |------|------|---------|:--------:| ------- |-------------|---------| 10681 | Create | boolean| `bool` | | | | | 10682 | Delete | boolean| `bool` | | | | | 10683 | Update | boolean| `bool` | | | | | 10684 10685 10686 10687 ### <span id="resources-permissions"></span> ResourcesPermissions 10688 10689 10690 > ResourcesPermissions holds a map of permission flags per resource 10691 10692 10693 10694 10695 [ResourcesPermissions](#resources-permissions) 10696 10697 ### <span id="response-detail"></span> ResponseDetail 10698 10699 10700 10701 10702 10703 10704 **Properties** 10705 10706 | Name | Type | Go type | Required | Default | Description | Example | 10707 |------|------|---------|:--------:| ------- |-------------|---------| 10708 | flags | [ResponseFlags](#response-flags)| `ResponseFlags` | | | | | 10709 | hosts | [ResponseHosts](#response-hosts)| `ResponseHosts` | | | | | 10710 10711 10712 10713 ### <span id="response-flags"></span> ResponseFlags 10714 10715 10716 10717 10718 [ResponseFlags](#response-flags) 10719 10720 ### <span id="response-hosts"></span> ResponseHosts 10721 10722 10723 > "200" : { 10724 "www.google.com" : "80.0", 10725 "www.yahoo.com" : "20.0" 10726 }, ... 10727 10728 10729 10730 10731 [ResponseHosts](#response-hosts) 10732 10733 ### <span id="responses"></span> Responses 10734 10735 10736 > Responses maps responseCodes to detailed information for that code 10737 10738 10739 10740 10741 [Responses](#responses) 10742 10743 ### <span id="route"></span> Route 10744 10745 10746 10747 10748 10749 10750 **Properties** 10751 10752 | Name | Type | Go type | Required | Default | Description | Example | 10753 |------|------|---------|:--------:| ------- |-------------|---------| 10754 | Match | string| `string` | | | | | 10755 | Name | string| `string` | | | | | 10756 | VirtualService | string| `string` | | | | | 10757 | domains | [Host](#host)| `Host` | | | | | 10758 10759 10760 10761 ### <span id="route-group-kind"></span> RouteGroupKind 10762 10763 10764 10765 10766 10767 10768 **Properties** 10769 10770 | Name | Type | Go type | Required | Default | Description | Example | 10771 |------|------|---------|:--------:| ------- |-------------|---------| 10772 | group | [Group](#group)| `Group` | | | | | 10773 | kind | [Kind](#kind)| `Kind` | | | | | 10774 10775 10776 10777 ### <span id="route-parent-status"></span> RouteParentStatus 10778 10779 10780 > RouteParentStatus describes the status of a route with respect to an 10781 associated Parent. 10782 10783 10784 10785 10786 10787 10788 **Properties** 10789 10790 | Name | Type | Go type | Required | Default | Description | Example | 10791 |------|------|---------|:--------:| ------- |-------------|---------| 10792 | Conditions | [][Condition](#condition)| `[]*Condition` | | | Conditions describes the status of the route with respect to the Gateway. 10793 Note that the route's availability is also subject to the Gateway's own 10794 status conditions and listener status. 10795 10796 If the Route's ParentRef specifies an existing Gateway that supports 10797 Routes of this kind AND that Gateway's controller has sufficient access, 10798 then that Gateway's controller MUST set the "Accepted" condition on the 10799 Route, to indicate whether the route has been accepted or rejected by the 10800 Gateway, and why. 10801 10802 A Route MUST be considered "Accepted" if at least one of the Route's 10803 rules is implemented by the Gateway. 10804 10805 There are a number of cases where the "Accepted" condition may not be set 10806 due to lack of controller visibility, that includes when: 10807 10808 The Route refers to a non-existent parent. 10809 The Route is of a type that the controller does not support. 10810 The Route is in a namespace the controller does not have access to. 10811 10812 +listType=map 10813 +listMapKey=type 10814 +kubebuilder:validation:MinItems=1 10815 +kubebuilder:validation:MaxItems=8 | | 10816 | controllerName | [GatewayController](#gateway-controller)| `GatewayController` | | | | | 10817 | parentRef | [ParentReference](#parent-reference)| `ParentReference` | | | | | 10818 10819 10820 10821 ### <span id="routes"></span> Routes 10822 10823 10824 10825 10826 [][Route](#route) 10827 10828 ### <span id="runtime"></span> Runtime 10829 10830 10831 > Runtime holds the runtime title and associated dashboard template(s) 10832 10833 10834 10835 10836 10837 10838 **Properties** 10839 10840 | Name | Type | Go type | Required | Default | Description | Example | 10841 |------|------|---------|:--------:| ------- |-------------|---------| 10842 | DashboardRefs | [][DashboardRef](#dashboard-ref)| `[]*DashboardRef` | | | | | 10843 | Name | string| `string` | | | | | 10844 10845 10846 10847 ### <span id="s-e-info"></span> SEInfo 10848 10849 10850 > SEInfo provides static information about the service entry 10851 10852 10853 10854 10855 10856 10857 **Properties** 10858 10859 | Name | Type | Go type | Required | Default | Description | Example | 10860 |------|------|---------|:--------:| ------- |-------------|---------| 10861 | Hosts | []string| `[]string` | | | | | 10862 | Location | string| `string` | | | | | 10863 | Namespace | string| `string` | | | | | 10864 10865 10866 10867 ### <span id="section-name"></span> SectionName 10868 10869 10870 > This validation is based off of the corresponding Kubernetes validation: 10871 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 10872 10873 Valid values include: 10874 10875 "example.com" 10876 "foo.example.com" 10877 10878 Invalid values include: 10879 10880 "example.com/bar" - "/" is an invalid character 10881 10882 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` 10883 +kubebuilder:validation:MinLength=1 10884 +kubebuilder:validation:MaxLength=253 10885 10886 10887 10888 10889 | Name | Type | Go type | Default | Description | Example | 10890 |------|------|---------| ------- |-------------|---------| 10891 | SectionName | string| string | | This validation is based off of the corresponding Kubernetes validation: 10892 https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208 10893 10894 Valid values include: 10895 10896 "example.com" 10897 "foo.example.com" 10898 10899 Invalid values include: 10900 10901 "example.com/bar" - "/" is an invalid character 10902 10903 +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` 10904 +kubebuilder:validation:MinLength=1 10905 +kubebuilder:validation:MaxLength=253 | | 10906 10907 10908 10909 ### <span id="service"></span> Service 10910 10911 10912 10913 10914 10915 10916 **Properties** 10917 10918 | Name | Type | Go type | Required | Default | Description | Example | 10919 |------|------|---------|:--------:| ------- |-------------|---------| 10920 | AdditionalDetails | [][AdditionalItem](#additional-item)| `[]*AdditionalItem` | | | | | 10921 | CreatedAt | string| `string` | | | | | 10922 | ExternalName | string| `string` | | | | | 10923 | HealthAnnotations | map of string| `map[string]string` | | | | | 10924 | Ip | string| `string` | | | | | 10925 | Labels | map of string| `map[string]string` | | | | | 10926 | Name | string| `string` | | | | | 10927 | ResourceVersion | string| `string` | | | | | 10928 | Selectors | map of string| `map[string]string` | | | | | 10929 | Type | string| `string` | | | | | 10930 | namespace | [Namespace](#namespace)| `Namespace` | | | | | 10931 | ports | [Ports](#ports)| `Ports` | | | | | 10932 10933 10934 10935 ### <span id="service-details"></span> ServiceDetails 10936 10937 10938 10939 10940 10941 10942 **Properties** 10943 10944 | Name | Type | Go type | Required | Default | Description | Example | 10945 |------|------|---------|:--------:| ------- |-------------|---------| 10946 | DestinationRules | [][DestinationRule](#destination-rule)| `[]*DestinationRule` | | | | | 10947 | IstioSidecar | boolean| `bool` | | | | | 10948 | K8sHTTPRoutes | [][HTTPRoute](#http-route)| `[]*HTTPRoute` | | | | | 10949 | K8sReferenceGrants | [][ReferenceGrant](#reference-grant)| `[]*ReferenceGrant` | | | | | 10950 | ServiceEntries | [][ServiceEntry](#service-entry)| `[]*ServiceEntry` | | | | | 10951 | SubServices | [][ServiceOverview](#service-overview)| `[]*ServiceOverview` | | | Services with same app labels (different versions or a single version) | | 10952 | VirtualServices | [][VirtualService](#virtual-service)| `[]*VirtualService` | | | | | 10953 | endpoints | [Endpoints](#endpoints)| `Endpoints` | | | | | 10954 | health | [ServiceHealth](#service-health)| `ServiceHealth` | | | | | 10955 | istioPermissions | [ResourcePermissions](#resource-permissions)| `ResourcePermissions` | | | | | 10956 | namespaceMTLS | [MTLSStatus](#m-tls-status)| `MTLSStatus` | | | | | 10957 | service | [Service](#service)| `Service` | | | | | 10958 | validations | [IstioValidations](#istio-validations)| `IstioValidations` | | | | | 10959 | workloads | [WorkloadOverviews](#workload-overviews)| `WorkloadOverviews` | | | | | 10960 10961 10962 10963 ### <span id="service-entry"></span> ServiceEntry 10964 10965 10966 > <!-- crd generation tags 10967 +cue-gen:ServiceEntry:groupName:networking.istio.io 10968 +cue-gen:ServiceEntry:version:v1beta1 10969 +cue-gen:ServiceEntry:annotations:helm.sh/resource-policy=keep 10970 +cue-gen:ServiceEntry:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 10971 +cue-gen:ServiceEntry:subresource:status 10972 +cue-gen:ServiceEntry:scope:Namespaced 10973 +cue-gen:ServiceEntry:resource:categories=istio-io,networking-istio-io,shortNames=se,plural=serviceentries 10974 +cue-gen:ServiceEntry:printerColumn:name=Hosts,type=string,JSONPath=.spec.hosts,description="The hosts associated with the ServiceEntry" 10975 +cue-gen:ServiceEntry:printerColumn:name=Location,type=string,JSONPath=.spec.location,description="Whether the service is external to the 10976 mesh or part of the mesh (MESH_EXTERNAL or MESH_INTERNAL)" 10977 +cue-gen:ServiceEntry:printerColumn:name=Resolution,type=string,JSONPath=.spec.resolution,description="Service discovery mode for the hosts 10978 (NONE, STATIC, or DNS)" 10979 +cue-gen:ServiceEntry:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp 10980 representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. 10981 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 10982 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" 10983 +cue-gen:ServiceEntry:preserveUnknownFields:false 10984 > 10985 10986 <!-- go code generation tags 10987 +kubetype-gen 10988 +kubetype-gen:groupVersion=networking.istio.io/v1beta1 10989 +genclient 10990 +k8s:deepcopy-gen=true 10991 > 10992 <!-- istio code generation tags 10993 +istio.io/sync-from:networking/v1alpha3/service_entry.proto 10994 > 10995 10996 10997 10998 10999 11000 11001 **Properties** 11002 11003 | Name | Type | Go type | Required | Default | Description | Example | 11004 |------|------|---------|:--------:| ------- |-------------|---------| 11005 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 11006 Servers should convert recognized schemas to the latest internal value, and 11007 may reject unrecognized values. 11008 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 11009 +optional | | 11010 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 11011 set by external tools to store and retrieve arbitrary metadata. They are not 11012 queryable and should be preserved when modifying objects. 11013 More info: http://kubernetes.io/docs/user-guide/annotations 11014 +optional | | 11015 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 11016 created. It is not guaranteed to be set in happens-before order across separate operations. 11017 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 11018 11019 Populated by the system. 11020 Read-only. 11021 Null for lists. 11022 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11023 +optional | | 11024 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 11025 it will be removed from the system. Only set when deletionTimestamp is also set. 11026 May only be shortened. 11027 Read-only. 11028 +optional | | 11029 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 11030 field is set by the server when a graceful deletion is requested by the user, and is not 11031 directly settable by a client. The resource is expected to be deleted (no longer visible 11032 from resource lists, and not reachable by name) after the time in this field, once the 11033 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 11034 Once the deletionTimestamp is set, this value may not be unset or be set further into the 11035 future, although it may be shortened or the resource may be deleted prior to this time. 11036 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 11037 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 11038 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 11039 remove the pod from the API. In the presence of network partitions, this object may still 11040 exist after this timestamp, until an administrator or automated process can determine the 11041 resource is fully terminated. 11042 If not set, graceful deletion of the object has not been requested. 11043 11044 Populated by the system when a graceful deletion is requested. 11045 Read-only. 11046 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11047 +optional | | 11048 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 11049 is an identifier for the responsible component that will remove the entry 11050 from the list. If the deletionTimestamp of the object is non-nil, entries 11051 in this list can only be removed. 11052 Finalizers may be processed and removed in any order. Order is NOT enforced 11053 because it introduces significant risk of stuck finalizers. 11054 finalizers is a shared field, any actor with permission can reorder it. 11055 If the finalizer list is processed in order, then this can lead to a situation 11056 in which the component responsible for the first finalizer in the list is 11057 waiting for a signal (field value, external system, or other) produced by a 11058 component responsible for a finalizer later in the list, resulting in a deadlock. 11059 Without enforced ordering finalizers are free to order amongst themselves and 11060 are not vulnerable to ordering changes in the list. 11061 +optional 11062 +patchStrategy=merge | | 11063 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 11064 name ONLY IF the Name field has not been provided. 11065 If this field is used, the name returned to the client will be different 11066 than the name passed. This value will also be combined with a unique suffix. 11067 The provided value has the same validation rules as the Name field, 11068 and may be truncated by the length of the suffix required to make the value 11069 unique on the server. 11070 11071 If this field is specified and the generated name exists, the server will return a 409. 11072 11073 Applied only if Name is not specified. 11074 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 11075 +optional | | 11076 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 11077 Populated by the system. Read-only. 11078 +optional | | 11079 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 11080 Servers may infer this from the endpoint the client submits requests to. 11081 Cannot be updated. 11082 In CamelCase. 11083 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 11084 +optional | | 11085 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 11086 (scope and select) objects. May match selectors of replication controllers 11087 and services. 11088 More info: http://kubernetes.io/docs/user-guide/labels 11089 +optional | | 11090 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 11091 that are managed by that workflow. This is mostly for internal 11092 housekeeping, and users typically shouldn't need to set or 11093 understand this field. A workflow can be the user's name, a 11094 controller's name, or the name of a specific apply path like 11095 "ci-cd". The set of fields is always in the version that the 11096 workflow used when modifying the object. 11097 11098 +optional | | 11099 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 11100 some resources may allow a client to request the generation of an appropriate name 11101 automatically. Name is primarily intended for creation idempotence and configuration 11102 definition. 11103 Cannot be updated. 11104 More info: http://kubernetes.io/docs/user-guide/identifiers#names 11105 +optional | | 11106 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 11107 equivalent to the "default" namespace, but "default" is the canonical representation. 11108 Not all objects are required to be scoped to a namespace - the value of this field for 11109 those objects will be empty. 11110 11111 Must be a DNS_LABEL. 11112 Cannot be updated. 11113 More info: http://kubernetes.io/docs/user-guide/namespaces 11114 +optional | | 11115 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 11116 been deleted, this object will be garbage collected. If this object is managed by a controller, 11117 then an entry in this list will point to this controller, with the controller field set to true. 11118 There cannot be more than one managing controller. 11119 +optional 11120 +patchMergeKey=uid 11121 +patchStrategy=merge | | 11122 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 11123 be used by clients to determine when objects have changed. May be used for optimistic 11124 concurrency, change detection, and the watch operation on a resource or set of resources. 11125 Clients must treat these values as opaque and passed unmodified back to the server. 11126 They may only be valid for a particular resource or set of resources. 11127 11128 Populated by the system. 11129 Read-only. 11130 Value must be treated as opaque by clients and . 11131 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 11132 +optional | | 11133 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 11134 +optional | | 11135 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 11136 the system and never used; it will be removed completely in 1.25. 11137 11138 The name in the go struct is changed to help clients detect 11139 accidental use. 11140 11141 +optional | | 11142 | spec | [ServiceEntry](#service-entry)| `ServiceEntry` | | | | | 11143 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 11144 | uid | [UID](#uid)| `UID` | | | | | 11145 11146 11147 11148 ### <span id="service-health"></span> ServiceHealth 11149 11150 11151 > ServiceHealth contains aggregated health from various sources, for a given service 11152 11153 11154 11155 11156 11157 11158 **Properties** 11159 11160 | Name | Type | Go type | Required | Default | Description | Example | 11161 |------|------|---------|:--------:| ------- |-------------|---------| 11162 | requests | [RequestHealth](#request-health)| `RequestHealth` | | | | | 11163 11164 11165 11166 ### <span id="service-list"></span> ServiceList 11167 11168 11169 11170 11171 11172 11173 **Properties** 11174 11175 | Name | Type | Go type | Required | Default | Description | Example | 11176 |------|------|---------|:--------:| ------- |-------------|---------| 11177 | Services | [][ServiceOverview](#service-overview)| `[]*ServiceOverview` | | | | | 11178 | namespace | [Namespace](#namespace)| `Namespace` | | | | | 11179 | validations | [IstioValidations](#istio-validations)| `IstioValidations` | | | | | 11180 11181 11182 11183 ### <span id="service-name"></span> ServiceName 11184 11185 11186 11187 11188 11189 11190 **Properties** 11191 11192 | Name | Type | Go type | Required | Default | Description | Example | 11193 |------|------|---------|:--------:| ------- |-------------|---------| 11194 | Cluster | string| `string` | | | | | 11195 | Name | string| `string` | | | | | 11196 | Namespace | string| `string` | | | | | 11197 11198 11199 11200 ### <span id="service-overview"></span> ServiceOverview 11201 11202 11203 11204 11205 11206 11207 **Properties** 11208 11209 | Name | Type | Go type | Required | Default | Description | Example | 11210 |------|------|---------|:--------:| ------- |-------------|---------| 11211 | AppLabel | boolean| `bool` | ✓ | | Has label app | `true` | 11212 | HealthAnnotations | map of string| `map[string]string` | | | Annotations of the service | | 11213 | IstioReferences | [][IstioValidationKey](#istio-validation-key)| `[]*IstioValidationKey` | | | Istio References | | 11214 | IstioSidecar | boolean| `bool` | ✓ | | Define if Pods related to this Service has an IstioSidecar deployed | `true` | 11215 | KialiWizard | string| `string` | | | Kiali Wizard scenario, if any | | 11216 | Labels | map of string| `map[string]string` | | | Labels for Service | | 11217 | Name | string| `string` | ✓ | | Name of the Service | `reviews-v1` | 11218 | Namespace | string| `string` | | | Namespace of the Service | | 11219 | Ports | map of int64 (formatted integer)| `map[string]int64` | | | Names and Ports of Service | | 11220 | Selector | map of string| `map[string]string` | | | Selector for Service | | 11221 | ServiceRegistry | string| `string` | | | ServiceRegistry values: 11222 Kubernetes: is a service registry backed by k8s API server 11223 External: is a service registry for externally provided ServiceEntries 11224 Federation: special case when registry is provided from a federated environment | | 11225 | additionalDetailSample | [AdditionalItem](#additional-item)| `AdditionalItem` | | | | | 11226 | health | [ServiceHealth](#service-health)| `ServiceHealth` | | | | | 11227 11228 11229 11230 ### <span id="service-reference"></span> ServiceReference 11231 11232 11233 11234 11235 11236 11237 **Properties** 11238 11239 | Name | Type | Go type | Required | Default | Description | Example | 11240 |------|------|---------|:--------:| ------- |-------------|---------| 11241 | Name | string| `string` | | | | | 11242 | Namespace | string| `string` | | | | | 11243 11244 11245 11246 ### <span id="severity-level"></span> SeverityLevel 11247 11248 11249 11250 11251 | Name | Type | Go type | Default | Description | Example | 11252 |------|------|---------| ------- |-------------|---------| 11253 | SeverityLevel | string| string | | | | 11254 11255 11256 11257 ### <span id="sidecar"></span> Sidecar 11258 11259 11260 > <!-- crd generation tags 11261 +cue-gen:Sidecar:groupName:networking.istio.io 11262 +cue-gen:Sidecar:version:v1beta1 11263 +cue-gen:Sidecar:annotations:helm.sh/resource-policy=keep 11264 +cue-gen:Sidecar:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 11265 +cue-gen:Sidecar:subresource:status 11266 +cue-gen:Sidecar:scope:Namespaced 11267 +cue-gen:Sidecar:resource:categories=istio-io,networking-istio-io 11268 +cue-gen:Sidecar:preserveUnknownFields:false 11269 > 11270 11271 <!-- go code generation tags 11272 +kubetype-gen 11273 +kubetype-gen:groupVersion=networking.istio.io/v1beta1 11274 +genclient 11275 +k8s:deepcopy-gen=true 11276 > 11277 <!-- istio code generation tags 11278 +istio.io/sync-from:networking/v1alpha3/sidecar.proto 11279 > 11280 11281 11282 11283 11284 11285 11286 **Properties** 11287 11288 | Name | Type | Go type | Required | Default | Description | Example | 11289 |------|------|---------|:--------:| ------- |-------------|---------| 11290 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 11291 Servers should convert recognized schemas to the latest internal value, and 11292 may reject unrecognized values. 11293 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 11294 +optional | | 11295 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 11296 set by external tools to store and retrieve arbitrary metadata. They are not 11297 queryable and should be preserved when modifying objects. 11298 More info: http://kubernetes.io/docs/user-guide/annotations 11299 +optional | | 11300 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 11301 created. It is not guaranteed to be set in happens-before order across separate operations. 11302 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 11303 11304 Populated by the system. 11305 Read-only. 11306 Null for lists. 11307 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11308 +optional | | 11309 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 11310 it will be removed from the system. Only set when deletionTimestamp is also set. 11311 May only be shortened. 11312 Read-only. 11313 +optional | | 11314 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 11315 field is set by the server when a graceful deletion is requested by the user, and is not 11316 directly settable by a client. The resource is expected to be deleted (no longer visible 11317 from resource lists, and not reachable by name) after the time in this field, once the 11318 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 11319 Once the deletionTimestamp is set, this value may not be unset or be set further into the 11320 future, although it may be shortened or the resource may be deleted prior to this time. 11321 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 11322 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 11323 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 11324 remove the pod from the API. In the presence of network partitions, this object may still 11325 exist after this timestamp, until an administrator or automated process can determine the 11326 resource is fully terminated. 11327 If not set, graceful deletion of the object has not been requested. 11328 11329 Populated by the system when a graceful deletion is requested. 11330 Read-only. 11331 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11332 +optional | | 11333 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 11334 is an identifier for the responsible component that will remove the entry 11335 from the list. If the deletionTimestamp of the object is non-nil, entries 11336 in this list can only be removed. 11337 Finalizers may be processed and removed in any order. Order is NOT enforced 11338 because it introduces significant risk of stuck finalizers. 11339 finalizers is a shared field, any actor with permission can reorder it. 11340 If the finalizer list is processed in order, then this can lead to a situation 11341 in which the component responsible for the first finalizer in the list is 11342 waiting for a signal (field value, external system, or other) produced by a 11343 component responsible for a finalizer later in the list, resulting in a deadlock. 11344 Without enforced ordering finalizers are free to order amongst themselves and 11345 are not vulnerable to ordering changes in the list. 11346 +optional 11347 +patchStrategy=merge | | 11348 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 11349 name ONLY IF the Name field has not been provided. 11350 If this field is used, the name returned to the client will be different 11351 than the name passed. This value will also be combined with a unique suffix. 11352 The provided value has the same validation rules as the Name field, 11353 and may be truncated by the length of the suffix required to make the value 11354 unique on the server. 11355 11356 If this field is specified and the generated name exists, the server will return a 409. 11357 11358 Applied only if Name is not specified. 11359 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 11360 +optional | | 11361 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 11362 Populated by the system. Read-only. 11363 +optional | | 11364 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 11365 Servers may infer this from the endpoint the client submits requests to. 11366 Cannot be updated. 11367 In CamelCase. 11368 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 11369 +optional | | 11370 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 11371 (scope and select) objects. May match selectors of replication controllers 11372 and services. 11373 More info: http://kubernetes.io/docs/user-guide/labels 11374 +optional | | 11375 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 11376 that are managed by that workflow. This is mostly for internal 11377 housekeeping, and users typically shouldn't need to set or 11378 understand this field. A workflow can be the user's name, a 11379 controller's name, or the name of a specific apply path like 11380 "ci-cd". The set of fields is always in the version that the 11381 workflow used when modifying the object. 11382 11383 +optional | | 11384 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 11385 some resources may allow a client to request the generation of an appropriate name 11386 automatically. Name is primarily intended for creation idempotence and configuration 11387 definition. 11388 Cannot be updated. 11389 More info: http://kubernetes.io/docs/user-guide/identifiers#names 11390 +optional | | 11391 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 11392 equivalent to the "default" namespace, but "default" is the canonical representation. 11393 Not all objects are required to be scoped to a namespace - the value of this field for 11394 those objects will be empty. 11395 11396 Must be a DNS_LABEL. 11397 Cannot be updated. 11398 More info: http://kubernetes.io/docs/user-guide/namespaces 11399 +optional | | 11400 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 11401 been deleted, this object will be garbage collected. If this object is managed by a controller, 11402 then an entry in this list will point to this controller, with the controller field set to true. 11403 There cannot be more than one managing controller. 11404 +optional 11405 +patchMergeKey=uid 11406 +patchStrategy=merge | | 11407 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 11408 be used by clients to determine when objects have changed. May be used for optimistic 11409 concurrency, change detection, and the watch operation on a resource or set of resources. 11410 Clients must treat these values as opaque and passed unmodified back to the server. 11411 They may only be valid for a particular resource or set of resources. 11412 11413 Populated by the system. 11414 Read-only. 11415 Value must be treated as opaque by clients and . 11416 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 11417 +optional | | 11418 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 11419 +optional | | 11420 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 11421 the system and never used; it will be removed completely in 1.25. 11422 11423 The name in the go struct is changed to help clients detect 11424 accidental use. 11425 11426 +optional | | 11427 | spec | [Sidecar](#sidecar)| `Sidecar` | | | | | 11428 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 11429 | uid | [UID](#uid)| `UID` | | | | | 11430 11431 11432 11433 ### <span id="span"></span> Span 11434 11435 11436 > Span is a span denoting a piece of work in some infrastructure 11437 When converting to UI model, ParentSpanID and Process should be dereferenced into 11438 References and ProcessID, respectively. 11439 When converting to ES model, ProcessID and Warnings should be omitted. Even if 11440 included, ES with dynamic settings off will automatically ignore unneeded fields. 11441 11442 11443 11444 11445 11446 11447 **Properties** 11448 11449 | Name | Type | Go type | Required | Default | Description | Example | 11450 |------|------|---------|:--------:| ------- |-------------|---------| 11451 | Duration | uint64 (formatted integer)| `uint64` | | | | | 11452 | Flags | uint32 (formatted integer)| `uint32` | | | | | 11453 | Logs | [][Log](#log)| `[]*Log` | | | | | 11454 | OperationName | string| `string` | | | | | 11455 | References | [][Reference](#reference)| `[]*Reference` | | | | | 11456 | StartTime | uint64 (formatted integer)| `uint64` | | | | | 11457 | Tags | [][KeyValue](#key-value)| `[]*KeyValue` | | | | | 11458 | Warnings | []string| `[]string` | | | | | 11459 | parentSpanID | [SpanID](#span-id)| `SpanID` | | | | | 11460 | process | [Process](#process)| `Process` | | | | | 11461 | processID | [ProcessID](#process-id)| `ProcessID` | | | | | 11462 | spanID | [SpanID](#span-id)| `SpanID` | | | | | 11463 | traceID | [TraceID](#trace-id)| `TraceID` | | | | | 11464 11465 11466 11467 ### <span id="span-id"></span> SpanID 11468 11469 11470 > SpanID is the id of a span 11471 11472 11473 11474 11475 | Name | Type | Go type | Default | Description | Example | 11476 |------|------|---------| ------- |-------------|---------| 11477 | SpanID | string| string | | SpanID is the id of a span | | 11478 11479 11480 11481 ### <span id="stat"></span> Stat 11482 11483 11484 > Stat holds arbitrary stat name & value 11485 11486 11487 11488 11489 11490 11491 **Properties** 11492 11493 | Name | Type | Go type | Required | Default | Description | Example | 11494 |------|------|---------|:--------:| ------- |-------------|---------| 11495 | Name | string| `string` | | | | | 11496 | Value | double (formatted number)| `float64` | | | | | 11497 11498 11499 11500 ### <span id="status-info"></span> StatusInfo 11501 11502 11503 > StatusInfo statusInfo 11504 This is used for returning a response of Kiali Status 11505 11506 11507 11508 11509 11510 11511 **Properties** 11512 11513 | Name | Type | Go type | Required | Default | Description | Example | 11514 |------|------|---------|:--------:| ------- |-------------|---------| 11515 | ExternalServices | [][ExternalServiceInfo](#external-service-info)| `[]*ExternalServiceInfo` | ✓ | | An array of external services installed | | 11516 | Status | map of string| `map[string]string` | ✓ | | The state of Kiali 11517 A hash of key,values with versions of Kiali and state | | 11518 | WarningMessages | []string| `[]string` | | | An array of warningMessages. CAUTION: Please read the doc comments the in AddWarningMessages func. | | 11519 | istioEnvironment | [IstioEnvironment](#istio-environment)| `IstioEnvironment` | ✓ | | | | 11520 11521 11522 11523 ### <span id="target"></span> Target 11524 11525 11526 11527 11528 11529 11530 **Properties** 11531 11532 | Name | Type | Go type | Required | Default | Description | Example | 11533 |------|------|---------|:--------:| ------- |-------------|---------| 11534 | Kind | string| `string` | | | | | 11535 | Name | string| `string` | | | | | 11536 | Namespace | string| `string` | | | | | 11537 11538 11539 11540 ### <span id="telemetry"></span> Telemetry 11541 11542 11543 > <!-- go code generation tags 11544 +kubetype-gen 11545 +kubetype-gen:groupVersion=telemetry.istio.io/v1alpha1 11546 +genclient 11547 +k8s:deepcopy-gen=true 11548 > 11549 11550 11551 11552 11553 11554 11555 **Properties** 11556 11557 | Name | Type | Go type | Required | Default | Description | Example | 11558 |------|------|---------|:--------:| ------- |-------------|---------| 11559 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 11560 Servers should convert recognized schemas to the latest internal value, and 11561 may reject unrecognized values. 11562 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 11563 +optional | | 11564 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 11565 set by external tools to store and retrieve arbitrary metadata. They are not 11566 queryable and should be preserved when modifying objects. 11567 More info: http://kubernetes.io/docs/user-guide/annotations 11568 +optional | | 11569 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 11570 created. It is not guaranteed to be set in happens-before order across separate operations. 11571 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 11572 11573 Populated by the system. 11574 Read-only. 11575 Null for lists. 11576 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11577 +optional | | 11578 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 11579 it will be removed from the system. Only set when deletionTimestamp is also set. 11580 May only be shortened. 11581 Read-only. 11582 +optional | | 11583 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 11584 field is set by the server when a graceful deletion is requested by the user, and is not 11585 directly settable by a client. The resource is expected to be deleted (no longer visible 11586 from resource lists, and not reachable by name) after the time in this field, once the 11587 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 11588 Once the deletionTimestamp is set, this value may not be unset or be set further into the 11589 future, although it may be shortened or the resource may be deleted prior to this time. 11590 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 11591 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 11592 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 11593 remove the pod from the API. In the presence of network partitions, this object may still 11594 exist after this timestamp, until an administrator or automated process can determine the 11595 resource is fully terminated. 11596 If not set, graceful deletion of the object has not been requested. 11597 11598 Populated by the system when a graceful deletion is requested. 11599 Read-only. 11600 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11601 +optional | | 11602 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 11603 is an identifier for the responsible component that will remove the entry 11604 from the list. If the deletionTimestamp of the object is non-nil, entries 11605 in this list can only be removed. 11606 Finalizers may be processed and removed in any order. Order is NOT enforced 11607 because it introduces significant risk of stuck finalizers. 11608 finalizers is a shared field, any actor with permission can reorder it. 11609 If the finalizer list is processed in order, then this can lead to a situation 11610 in which the component responsible for the first finalizer in the list is 11611 waiting for a signal (field value, external system, or other) produced by a 11612 component responsible for a finalizer later in the list, resulting in a deadlock. 11613 Without enforced ordering finalizers are free to order amongst themselves and 11614 are not vulnerable to ordering changes in the list. 11615 +optional 11616 +patchStrategy=merge | | 11617 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 11618 name ONLY IF the Name field has not been provided. 11619 If this field is used, the name returned to the client will be different 11620 than the name passed. This value will also be combined with a unique suffix. 11621 The provided value has the same validation rules as the Name field, 11622 and may be truncated by the length of the suffix required to make the value 11623 unique on the server. 11624 11625 If this field is specified and the generated name exists, the server will return a 409. 11626 11627 Applied only if Name is not specified. 11628 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 11629 +optional | | 11630 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 11631 Populated by the system. Read-only. 11632 +optional | | 11633 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 11634 Servers may infer this from the endpoint the client submits requests to. 11635 Cannot be updated. 11636 In CamelCase. 11637 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 11638 +optional | | 11639 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 11640 (scope and select) objects. May match selectors of replication controllers 11641 and services. 11642 More info: http://kubernetes.io/docs/user-guide/labels 11643 +optional | | 11644 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 11645 that are managed by that workflow. This is mostly for internal 11646 housekeeping, and users typically shouldn't need to set or 11647 understand this field. A workflow can be the user's name, a 11648 controller's name, or the name of a specific apply path like 11649 "ci-cd". The set of fields is always in the version that the 11650 workflow used when modifying the object. 11651 11652 +optional | | 11653 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 11654 some resources may allow a client to request the generation of an appropriate name 11655 automatically. Name is primarily intended for creation idempotence and configuration 11656 definition. 11657 Cannot be updated. 11658 More info: http://kubernetes.io/docs/user-guide/identifiers#names 11659 +optional | | 11660 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 11661 equivalent to the "default" namespace, but "default" is the canonical representation. 11662 Not all objects are required to be scoped to a namespace - the value of this field for 11663 those objects will be empty. 11664 11665 Must be a DNS_LABEL. 11666 Cannot be updated. 11667 More info: http://kubernetes.io/docs/user-guide/namespaces 11668 +optional | | 11669 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 11670 been deleted, this object will be garbage collected. If this object is managed by a controller, 11671 then an entry in this list will point to this controller, with the controller field set to true. 11672 There cannot be more than one managing controller. 11673 +optional 11674 +patchMergeKey=uid 11675 +patchStrategy=merge | | 11676 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 11677 be used by clients to determine when objects have changed. May be used for optimistic 11678 concurrency, change detection, and the watch operation on a resource or set of resources. 11679 Clients must treat these values as opaque and passed unmodified back to the server. 11680 They may only be valid for a particular resource or set of resources. 11681 11682 Populated by the system. 11683 Read-only. 11684 Value must be treated as opaque by clients and . 11685 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 11686 +optional | | 11687 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 11688 +optional | | 11689 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 11690 the system and never used; it will be removed completely in 1.25. 11691 11692 The name in the go struct is changed to help clients detect 11693 accidental use. 11694 11695 +optional | | 11696 | spec | [Telemetry](#telemetry)| `Telemetry` | | | | | 11697 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 11698 | uid | [UID](#uid)| `UID` | | | | | 11699 11700 11701 11702 ### <span id="timestamp"></span> Timestamp 11703 11704 11705 > All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap 11706 second table is needed for interpretation, using a [24-hour linear 11707 smear](https://developers.google.com/time/smear). 11708 11709 The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By 11710 restricting to that range, we ensure that we can convert to and from [RFC 11711 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. 11712 11713 # Examples 11714 11715 Example 1: Compute Timestamp from POSIX `time()`. 11716 11717 Timestamp timestamp; 11718 timestamp.set_seconds(time(NULL)); 11719 timestamp.set_nanos(0); 11720 11721 Example 2: Compute Timestamp from POSIX `gettimeofday()`. 11722 11723 struct timeval tv; 11724 gettimeofday(&tv, NULL); 11725 11726 Timestamp timestamp; 11727 timestamp.set_seconds(tv.tv_sec); 11728 timestamp.set_nanos(tv.tv_usec * 1000); 11729 11730 Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. 11731 11732 FILETIME ft; 11733 GetSystemTimeAsFileTime(&ft); 11734 UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; 11735 11736 A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z 11737 is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. 11738 Timestamp timestamp; 11739 timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); 11740 timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); 11741 11742 Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. 11743 11744 long millis = System.currentTimeMillis(); 11745 11746 Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) 11747 .setNanos((int) ((millis % 1000) * 1000000)).build(); 11748 11749 11750 Example 5: Compute Timestamp from Java `Instant.now()`. 11751 11752 Instant now = Instant.now(); 11753 11754 Timestamp timestamp = 11755 Timestamp.newBuilder().setSeconds(now.getEpochSecond()) 11756 .setNanos(now.getNano()).build(); 11757 11758 11759 Example 6: Compute Timestamp from current time in Python. 11760 11761 timestamp = Timestamp() 11762 timestamp.GetCurrentTime() 11763 11764 # JSON Mapping 11765 11766 In JSON format, the Timestamp type is encoded as a string in the 11767 [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the 11768 format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" 11769 where {year} is always expressed using four digits while {month}, {day}, 11770 {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional 11771 seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), 11772 are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone 11773 is required. A proto3 JSON serializer should always use UTC (as indicated by 11774 "Z") when printing the Timestamp type and a proto3 JSON parser should be 11775 able to accept both UTC and other timezones (as indicated by an offset). 11776 11777 For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 11778 01:30 UTC on January 15, 2017. 11779 11780 In JavaScript, one can convert a Date object to this format using the 11781 standard 11782 [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) 11783 method. In Python, a standard `datetime.datetime` object can be converted 11784 to this format using 11785 [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with 11786 the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use 11787 the Joda Time's [`ISODateTimeFormat.dateTime()`]( 11788 http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D 11789 ) to obtain a formatter capable of generating timestamps in this format. 11790 11791 11792 11793 11794 11795 11796 **Properties** 11797 11798 | Name | Type | Go type | Required | Default | Description | Example | 11799 |------|------|---------|:--------:| ------- |-------------|---------| 11800 | Nanos | int32 (formatted integer)| `int32` | | | Non-negative fractions of a second at nanosecond resolution. Negative 11801 second values with fractions must still have non-negative nanos values 11802 that count forward in time. Must be from 0 to 999,999,999 11803 inclusive. | | 11804 | Seconds | int64 (formatted integer)| `int64` | | | Represents seconds of UTC time since Unix epoch 11805 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 11806 9999-12-31T23:59:59Z inclusive. | | 11807 11808 11809 11810 ### <span id="trace"></span> Trace 11811 11812 11813 > Trace is a list of spans 11814 11815 11816 11817 11818 11819 11820 **Properties** 11821 11822 | Name | Type | Go type | Required | Default | Description | Example | 11823 |------|------|---------|:--------:| ------- |-------------|---------| 11824 | Processes | map of [Process](#process)| `map[string]Process` | | | | | 11825 | Spans | [][Span](#span)| `[]*Span` | | | | | 11826 | Warnings | []string| `[]string` | | | | | 11827 | traceID | [TraceID](#trace-id)| `TraceID` | | | | | 11828 11829 11830 11831 ### <span id="trace-id"></span> TraceID 11832 11833 11834 11835 11836 | Name | Type | Go type | Default | Description | Example | 11837 |------|------|---------| ------- |-------------|---------| 11838 | TraceID | string| string | | | | 11839 11840 11841 11842 ### <span id="uid"></span> UID 11843 11844 11845 > UID is a type that holds unique ID values, including UUIDs. Because we 11846 don't ONLY use UUIDs, this is an alias to string. Being a type captures 11847 intent and helps make sure that UIDs and names do not get conflated. 11848 11849 11850 11851 11852 | Name | Type | Go type | Default | Description | Example | 11853 |------|------|---------| ------- |-------------|---------| 11854 | UID | string| string | | UID is a type that holds unique ID values, including UUIDs. Because we 11855 don't ONLY use UUIDs, this is an alias to string. Being a type captures 11856 intent and helps make sure that UIDs and names do not get conflated. | | 11857 11858 11859 11860 ### <span id="user-session-data"></span> UserSessionData 11861 11862 11863 > UserSessionData userSessionData 11864 This is used for returning the token 11865 11866 11867 11868 11869 11870 11871 **Properties** 11872 11873 | Name | Type | Go type | Required | Default | Description | Example | 11874 |------|------|---------|:--------:| ------- |-------------|---------| 11875 | ExpiresOn | date-time (formatted string)| `strfmt.DateTime` | ✓ | | The expired time for the token 11876 A string with the Datetime when the token will be expired | `Thu, 07 Mar 2019 17:50:26 +0000` | 11877 | Username | string| `string` | ✓ | | The username for the token 11878 A string with the user's username | `admin` | 11879 11880 11881 11882 ### <span id="v-s-info"></span> VSInfo 11883 11884 11885 11886 11887 11888 11889 **Properties** 11890 11891 | Name | Type | Go type | Required | Default | Description | Example | 11892 |------|------|---------|:--------:| ------- |-------------|---------| 11893 | Hostnames | []string| `[]string` | | | Hostnames is the list of hostnames configured in the associated VSs | | 11894 11895 11896 11897 ### <span id="value-type"></span> ValueType 11898 11899 11900 11901 11902 | Name | Type | Go type | Default | Description | Example | 11903 |------|------|---------| ------- |-------------|---------| 11904 | ValueType | string| string | | | | 11905 11906 11907 11908 ### <span id="virtual-service"></span> VirtualService 11909 11910 11911 > <!-- crd generation tags 11912 +cue-gen:VirtualService:groupName:networking.istio.io 11913 +cue-gen:VirtualService:version:v1beta1 11914 +cue-gen:VirtualService:annotations:helm.sh/resource-policy=keep 11915 +cue-gen:VirtualService:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 11916 +cue-gen:VirtualService:subresource:status 11917 +cue-gen:VirtualService:scope:Namespaced 11918 +cue-gen:VirtualService:resource:categories=istio-io,networking-istio-io,shortNames=vs 11919 +cue-gen:VirtualService:printerColumn:name=Gateways,type=string,JSONPath=.spec.gateways,description="The names of gateways and sidecars 11920 that should apply these routes" 11921 +cue-gen:VirtualService:printerColumn:name=Hosts,type=string,JSONPath=.spec.hosts,description="The destination hosts to which traffic is being sent" 11922 +cue-gen:VirtualService:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp 11923 representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. 11924 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 11925 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" 11926 +cue-gen:VirtualService:preserveUnknownFields:false 11927 > 11928 11929 <!-- go code generation tags 11930 +kubetype-gen 11931 +kubetype-gen:groupVersion=networking.istio.io/v1beta1 11932 +genclient 11933 +k8s:deepcopy-gen=true 11934 > 11935 <!-- istio code generation tags 11936 +istio.io/sync-from:networking/v1alpha3/virtual_service.proto 11937 > 11938 11939 11940 11941 11942 11943 11944 **Properties** 11945 11946 | Name | Type | Go type | Required | Default | Description | Example | 11947 |------|------|---------|:--------:| ------- |-------------|---------| 11948 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 11949 Servers should convert recognized schemas to the latest internal value, and 11950 may reject unrecognized values. 11951 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 11952 +optional | | 11953 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 11954 set by external tools to store and retrieve arbitrary metadata. They are not 11955 queryable and should be preserved when modifying objects. 11956 More info: http://kubernetes.io/docs/user-guide/annotations 11957 +optional | | 11958 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 11959 created. It is not guaranteed to be set in happens-before order across separate operations. 11960 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 11961 11962 Populated by the system. 11963 Read-only. 11964 Null for lists. 11965 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11966 +optional | | 11967 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 11968 it will be removed from the system. Only set when deletionTimestamp is also set. 11969 May only be shortened. 11970 Read-only. 11971 +optional | | 11972 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 11973 field is set by the server when a graceful deletion is requested by the user, and is not 11974 directly settable by a client. The resource is expected to be deleted (no longer visible 11975 from resource lists, and not reachable by name) after the time in this field, once the 11976 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 11977 Once the deletionTimestamp is set, this value may not be unset or be set further into the 11978 future, although it may be shortened or the resource may be deleted prior to this time. 11979 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 11980 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 11981 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 11982 remove the pod from the API. In the presence of network partitions, this object may still 11983 exist after this timestamp, until an administrator or automated process can determine the 11984 resource is fully terminated. 11985 If not set, graceful deletion of the object has not been requested. 11986 11987 Populated by the system when a graceful deletion is requested. 11988 Read-only. 11989 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 11990 +optional | | 11991 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 11992 is an identifier for the responsible component that will remove the entry 11993 from the list. If the deletionTimestamp of the object is non-nil, entries 11994 in this list can only be removed. 11995 Finalizers may be processed and removed in any order. Order is NOT enforced 11996 because it introduces significant risk of stuck finalizers. 11997 finalizers is a shared field, any actor with permission can reorder it. 11998 If the finalizer list is processed in order, then this can lead to a situation 11999 in which the component responsible for the first finalizer in the list is 12000 waiting for a signal (field value, external system, or other) produced by a 12001 component responsible for a finalizer later in the list, resulting in a deadlock. 12002 Without enforced ordering finalizers are free to order amongst themselves and 12003 are not vulnerable to ordering changes in the list. 12004 +optional 12005 +patchStrategy=merge | | 12006 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 12007 name ONLY IF the Name field has not been provided. 12008 If this field is used, the name returned to the client will be different 12009 than the name passed. This value will also be combined with a unique suffix. 12010 The provided value has the same validation rules as the Name field, 12011 and may be truncated by the length of the suffix required to make the value 12012 unique on the server. 12013 12014 If this field is specified and the generated name exists, the server will return a 409. 12015 12016 Applied only if Name is not specified. 12017 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 12018 +optional | | 12019 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 12020 Populated by the system. Read-only. 12021 +optional | | 12022 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 12023 Servers may infer this from the endpoint the client submits requests to. 12024 Cannot be updated. 12025 In CamelCase. 12026 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 12027 +optional | | 12028 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 12029 (scope and select) objects. May match selectors of replication controllers 12030 and services. 12031 More info: http://kubernetes.io/docs/user-guide/labels 12032 +optional | | 12033 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 12034 that are managed by that workflow. This is mostly for internal 12035 housekeeping, and users typically shouldn't need to set or 12036 understand this field. A workflow can be the user's name, a 12037 controller's name, or the name of a specific apply path like 12038 "ci-cd". The set of fields is always in the version that the 12039 workflow used when modifying the object. 12040 12041 +optional | | 12042 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 12043 some resources may allow a client to request the generation of an appropriate name 12044 automatically. Name is primarily intended for creation idempotence and configuration 12045 definition. 12046 Cannot be updated. 12047 More info: http://kubernetes.io/docs/user-guide/identifiers#names 12048 +optional | | 12049 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 12050 equivalent to the "default" namespace, but "default" is the canonical representation. 12051 Not all objects are required to be scoped to a namespace - the value of this field for 12052 those objects will be empty. 12053 12054 Must be a DNS_LABEL. 12055 Cannot be updated. 12056 More info: http://kubernetes.io/docs/user-guide/namespaces 12057 +optional | | 12058 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 12059 been deleted, this object will be garbage collected. If this object is managed by a controller, 12060 then an entry in this list will point to this controller, with the controller field set to true. 12061 There cannot be more than one managing controller. 12062 +optional 12063 +patchMergeKey=uid 12064 +patchStrategy=merge | | 12065 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 12066 be used by clients to determine when objects have changed. May be used for optimistic 12067 concurrency, change detection, and the watch operation on a resource or set of resources. 12068 Clients must treat these values as opaque and passed unmodified back to the server. 12069 They may only be valid for a particular resource or set of resources. 12070 12071 Populated by the system. 12072 Read-only. 12073 Value must be treated as opaque by clients and . 12074 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 12075 +optional | | 12076 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 12077 +optional | | 12078 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 12079 the system and never used; it will be removed completely in 1.25. 12080 12081 The name in the go struct is changed to help clients detect 12082 accidental use. 12083 12084 +optional | | 12085 | spec | [VirtualService](#virtual-service)| `VirtualService` | | | | | 12086 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 12087 | uid | [UID](#uid)| `UID` | | | | | 12088 12089 12090 12091 ### <span id="w-e-info"></span> WEInfo 12092 12093 12094 > WEInfo provides static information about a workload entry 12095 associated with a workload node. 12096 12097 12098 12099 12100 12101 12102 **Properties** 12103 12104 | Name | Type | Go type | Required | Default | Description | Example | 12105 |------|------|---------|:--------:| ------- |-------------|---------| 12106 | Name | string| `string` | ✓ | | Name of the workload entry object | | 12107 12108 12109 12110 ### <span id="wasm-plugin"></span> WasmPlugin 12111 12112 12113 > <!-- crd generation tags 12114 +cue-gen:WasmPlugin:groupName:extensions.istio.io 12115 +cue-gen:WasmPlugin:version:v1alpha1 12116 +cue-gen:WasmPlugin:storageVersion 12117 +cue-gen:WasmPlugin:annotations:helm.sh/resource-policy=keep 12118 +cue-gen:WasmPlugin:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 12119 +cue-gen:WasmPlugin:subresource:status 12120 +cue-gen:WasmPlugin:scope:Namespaced 12121 +cue-gen:WasmPlugin:resource:categories=istio-io,extensions-istio-io 12122 +cue-gen:WasmPlugin:preserveUnknownFields:pluginConfig 12123 +cue-gen:WasmPlugin:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp 12124 representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. 12125 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 12126 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" 12127 > 12128 12129 <!-- go code generation tags 12130 +kubetype-gen 12131 +kubetype-gen:groupVersion=extensions.istio.io/v1alpha1 12132 +genclient 12133 +k8s:deepcopy-gen=true 12134 > 12135 12136 12137 12138 12139 12140 12141 **Properties** 12142 12143 | Name | Type | Go type | Required | Default | Description | Example | 12144 |------|------|---------|:--------:| ------- |-------------|---------| 12145 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 12146 Servers should convert recognized schemas to the latest internal value, and 12147 may reject unrecognized values. 12148 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 12149 +optional | | 12150 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 12151 set by external tools to store and retrieve arbitrary metadata. They are not 12152 queryable and should be preserved when modifying objects. 12153 More info: http://kubernetes.io/docs/user-guide/annotations 12154 +optional | | 12155 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 12156 created. It is not guaranteed to be set in happens-before order across separate operations. 12157 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 12158 12159 Populated by the system. 12160 Read-only. 12161 Null for lists. 12162 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 12163 +optional | | 12164 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 12165 it will be removed from the system. Only set when deletionTimestamp is also set. 12166 May only be shortened. 12167 Read-only. 12168 +optional | | 12169 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 12170 field is set by the server when a graceful deletion is requested by the user, and is not 12171 directly settable by a client. The resource is expected to be deleted (no longer visible 12172 from resource lists, and not reachable by name) after the time in this field, once the 12173 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 12174 Once the deletionTimestamp is set, this value may not be unset or be set further into the 12175 future, although it may be shortened or the resource may be deleted prior to this time. 12176 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 12177 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 12178 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 12179 remove the pod from the API. In the presence of network partitions, this object may still 12180 exist after this timestamp, until an administrator or automated process can determine the 12181 resource is fully terminated. 12182 If not set, graceful deletion of the object has not been requested. 12183 12184 Populated by the system when a graceful deletion is requested. 12185 Read-only. 12186 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 12187 +optional | | 12188 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 12189 is an identifier for the responsible component that will remove the entry 12190 from the list. If the deletionTimestamp of the object is non-nil, entries 12191 in this list can only be removed. 12192 Finalizers may be processed and removed in any order. Order is NOT enforced 12193 because it introduces significant risk of stuck finalizers. 12194 finalizers is a shared field, any actor with permission can reorder it. 12195 If the finalizer list is processed in order, then this can lead to a situation 12196 in which the component responsible for the first finalizer in the list is 12197 waiting for a signal (field value, external system, or other) produced by a 12198 component responsible for a finalizer later in the list, resulting in a deadlock. 12199 Without enforced ordering finalizers are free to order amongst themselves and 12200 are not vulnerable to ordering changes in the list. 12201 +optional 12202 +patchStrategy=merge | | 12203 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 12204 name ONLY IF the Name field has not been provided. 12205 If this field is used, the name returned to the client will be different 12206 than the name passed. This value will also be combined with a unique suffix. 12207 The provided value has the same validation rules as the Name field, 12208 and may be truncated by the length of the suffix required to make the value 12209 unique on the server. 12210 12211 If this field is specified and the generated name exists, the server will return a 409. 12212 12213 Applied only if Name is not specified. 12214 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 12215 +optional | | 12216 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 12217 Populated by the system. Read-only. 12218 +optional | | 12219 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 12220 Servers may infer this from the endpoint the client submits requests to. 12221 Cannot be updated. 12222 In CamelCase. 12223 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 12224 +optional | | 12225 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 12226 (scope and select) objects. May match selectors of replication controllers 12227 and services. 12228 More info: http://kubernetes.io/docs/user-guide/labels 12229 +optional | | 12230 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 12231 that are managed by that workflow. This is mostly for internal 12232 housekeeping, and users typically shouldn't need to set or 12233 understand this field. A workflow can be the user's name, a 12234 controller's name, or the name of a specific apply path like 12235 "ci-cd". The set of fields is always in the version that the 12236 workflow used when modifying the object. 12237 12238 +optional | | 12239 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 12240 some resources may allow a client to request the generation of an appropriate name 12241 automatically. Name is primarily intended for creation idempotence and configuration 12242 definition. 12243 Cannot be updated. 12244 More info: http://kubernetes.io/docs/user-guide/identifiers#names 12245 +optional | | 12246 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 12247 equivalent to the "default" namespace, but "default" is the canonical representation. 12248 Not all objects are required to be scoped to a namespace - the value of this field for 12249 those objects will be empty. 12250 12251 Must be a DNS_LABEL. 12252 Cannot be updated. 12253 More info: http://kubernetes.io/docs/user-guide/namespaces 12254 +optional | | 12255 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 12256 been deleted, this object will be garbage collected. If this object is managed by a controller, 12257 then an entry in this list will point to this controller, with the controller field set to true. 12258 There cannot be more than one managing controller. 12259 +optional 12260 +patchMergeKey=uid 12261 +patchStrategy=merge | | 12262 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 12263 be used by clients to determine when objects have changed. May be used for optimistic 12264 concurrency, change detection, and the watch operation on a resource or set of resources. 12265 Clients must treat these values as opaque and passed unmodified back to the server. 12266 They may only be valid for a particular resource or set of resources. 12267 12268 Populated by the system. 12269 Read-only. 12270 Value must be treated as opaque by clients and . 12271 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 12272 +optional | | 12273 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 12274 +optional | | 12275 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 12276 the system and never used; it will be removed completely in 1.25. 12277 12278 The name in the go struct is changed to help clients detect 12279 accidental use. 12280 12281 +optional | | 12282 | spec | [WasmPlugin](#wasm-plugin)| `WasmPlugin` | | | | | 12283 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 12284 | uid | [UID](#uid)| `UID` | | | | | 12285 12286 12287 12288 ### <span id="workload"></span> Workload 12289 12290 12291 > Workload has the details of a workload 12292 12293 12294 12295 12296 12297 12298 **Properties** 12299 12300 | Name | Type | Go type | Required | Default | Description | Example | 12301 |------|------|---------|:--------:| ------- |-------------|---------| 12302 | AdditionalDetails | [][AdditionalItem](#additional-item)| `[]*AdditionalItem` | | | Additional details to display, such as configured annotations | | 12303 | AppLabel | boolean| `bool` | ✓ | | Define if Pods related to this Workload has the label App | `true` | 12304 | AvailableReplicas | int32 (formatted integer)| `int32` | ✓ | | Number of available replicas | `1` | 12305 | CreatedAt | string| `string` | ✓ | | Creation timestamp (in RFC3339 format) | `2018-07-31T12:24:17Z` | 12306 | CurrentReplicas | int32 (formatted integer)| `int32` | ✓ | | Number of current replicas pods that matches controller selector labels | `2` | 12307 | DashboardAnnotations | map of string| `map[string]string` | | | Dashboard annotations | | 12308 | DesiredReplicas | int32 (formatted integer)| `int32` | ✓ | | Number of desired replicas defined by the user in the controller Spec | `2` | 12309 | HealthAnnotations | map of string| `map[string]string` | | | HealthAnnotations | | 12310 | IstioInjectionAnnotation | boolean| `bool` | | | Define if Workload has an explicit Istio policy annotation 12311 Istio supports this as a label as well - this will be defined if the label is set, too. 12312 If both annotation and label are set, if any is false, injection is disabled. 12313 It's mapped as a pointer to show three values nil, true, false | | 12314 | IstioReferences | [][IstioValidationKey](#istio-validation-key)| `[]*IstioValidationKey` | | | Istio References | | 12315 | IstioSidecar | boolean| `bool` | ✓ | | Define if Pods related to this Workload has an IstioSidecar deployed | `true` | 12316 | Labels | map of string| `map[string]string` | | | Workload labels | | 12317 | Name | string| `string` | ✓ | | Name of the workload | `reviews-v1` | 12318 | PodCount | int64 (formatted integer)| `int64` | ✓ | | Number of current workload pods | `1` | 12319 | ResourceVersion | string| `string` | ✓ | | Kubernetes ResourceVersion | `192892127` | 12320 | Runtimes | [][Runtime](#runtime)| `[]*Runtime` | | | Runtimes and associated dashboards | | 12321 | ServiceAccountNames | []string| `[]string` | | | Names of the workload service accounts | | 12322 | Services | [][ServiceOverview](#service-overview)| `[]*ServiceOverview` | | | Services that match workload selector | | 12323 | Type | string| `string` | ✓ | | Type of the workload | `deployment` | 12324 | VersionLabel | boolean| `bool` | ✓ | | Define if Pods related to this Workload has the label Version | `true` | 12325 | additionalDetailSample | [AdditionalItem](#additional-item)| `AdditionalItem` | | | | | 12326 | health | [WorkloadHealth](#workload-health)| `WorkloadHealth` | | | | | 12327 | pods | [Pods](#pods)| `Pods` | | | | | 12328 | validations | [IstioValidations](#istio-validations)| `IstioValidations` | | | | | 12329 12330 12331 12332 ### <span id="workload-entry"></span> WorkloadEntry 12333 12334 12335 > <!-- crd generation tags 12336 +cue-gen:WorkloadEntry:groupName:networking.istio.io 12337 +cue-gen:WorkloadEntry:version:v1beta1 12338 +cue-gen:WorkloadEntry:annotations:helm.sh/resource-policy=keep 12339 +cue-gen:WorkloadEntry:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 12340 +cue-gen:WorkloadEntry:subresource:status 12341 +cue-gen:WorkloadEntry:scope:Namespaced 12342 +cue-gen:WorkloadEntry:resource:categories=istio-io,networking-istio-io,shortNames=we,plural=workloadentries 12343 +cue-gen:WorkloadEntry:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp 12344 representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. 12345 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 12346 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" 12347 +cue-gen:WorkloadEntry:printerColumn:name=Address,type=string,JSONPath=.spec.address,description="Address associated with the network endpoint." 12348 +cue-gen:WorkloadEntry:preserveUnknownFields:false 12349 > 12350 12351 <!-- go code generation tags 12352 +kubetype-gen 12353 +kubetype-gen:groupVersion=networking.istio.io/v1beta1 12354 +genclient 12355 +k8s:deepcopy-gen=true 12356 > 12357 <!-- istio code generation tags 12358 +istio.io/sync-from:networking/v1alpha3/workload_entry.proto 12359 > 12360 12361 12362 12363 12364 12365 12366 **Properties** 12367 12368 | Name | Type | Go type | Required | Default | Description | Example | 12369 |------|------|---------|:--------:| ------- |-------------|---------| 12370 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 12371 Servers should convert recognized schemas to the latest internal value, and 12372 may reject unrecognized values. 12373 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 12374 +optional | | 12375 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 12376 set by external tools to store and retrieve arbitrary metadata. They are not 12377 queryable and should be preserved when modifying objects. 12378 More info: http://kubernetes.io/docs/user-guide/annotations 12379 +optional | | 12380 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 12381 created. It is not guaranteed to be set in happens-before order across separate operations. 12382 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 12383 12384 Populated by the system. 12385 Read-only. 12386 Null for lists. 12387 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 12388 +optional | | 12389 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 12390 it will be removed from the system. Only set when deletionTimestamp is also set. 12391 May only be shortened. 12392 Read-only. 12393 +optional | | 12394 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 12395 field is set by the server when a graceful deletion is requested by the user, and is not 12396 directly settable by a client. The resource is expected to be deleted (no longer visible 12397 from resource lists, and not reachable by name) after the time in this field, once the 12398 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 12399 Once the deletionTimestamp is set, this value may not be unset or be set further into the 12400 future, although it may be shortened or the resource may be deleted prior to this time. 12401 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 12402 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 12403 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 12404 remove the pod from the API. In the presence of network partitions, this object may still 12405 exist after this timestamp, until an administrator or automated process can determine the 12406 resource is fully terminated. 12407 If not set, graceful deletion of the object has not been requested. 12408 12409 Populated by the system when a graceful deletion is requested. 12410 Read-only. 12411 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 12412 +optional | | 12413 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 12414 is an identifier for the responsible component that will remove the entry 12415 from the list. If the deletionTimestamp of the object is non-nil, entries 12416 in this list can only be removed. 12417 Finalizers may be processed and removed in any order. Order is NOT enforced 12418 because it introduces significant risk of stuck finalizers. 12419 finalizers is a shared field, any actor with permission can reorder it. 12420 If the finalizer list is processed in order, then this can lead to a situation 12421 in which the component responsible for the first finalizer in the list is 12422 waiting for a signal (field value, external system, or other) produced by a 12423 component responsible for a finalizer later in the list, resulting in a deadlock. 12424 Without enforced ordering finalizers are free to order amongst themselves and 12425 are not vulnerable to ordering changes in the list. 12426 +optional 12427 +patchStrategy=merge | | 12428 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 12429 name ONLY IF the Name field has not been provided. 12430 If this field is used, the name returned to the client will be different 12431 than the name passed. This value will also be combined with a unique suffix. 12432 The provided value has the same validation rules as the Name field, 12433 and may be truncated by the length of the suffix required to make the value 12434 unique on the server. 12435 12436 If this field is specified and the generated name exists, the server will return a 409. 12437 12438 Applied only if Name is not specified. 12439 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 12440 +optional | | 12441 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 12442 Populated by the system. Read-only. 12443 +optional | | 12444 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 12445 Servers may infer this from the endpoint the client submits requests to. 12446 Cannot be updated. 12447 In CamelCase. 12448 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 12449 +optional | | 12450 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 12451 (scope and select) objects. May match selectors of replication controllers 12452 and services. 12453 More info: http://kubernetes.io/docs/user-guide/labels 12454 +optional | | 12455 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 12456 that are managed by that workflow. This is mostly for internal 12457 housekeeping, and users typically shouldn't need to set or 12458 understand this field. A workflow can be the user's name, a 12459 controller's name, or the name of a specific apply path like 12460 "ci-cd". The set of fields is always in the version that the 12461 workflow used when modifying the object. 12462 12463 +optional | | 12464 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 12465 some resources may allow a client to request the generation of an appropriate name 12466 automatically. Name is primarily intended for creation idempotence and configuration 12467 definition. 12468 Cannot be updated. 12469 More info: http://kubernetes.io/docs/user-guide/identifiers#names 12470 +optional | | 12471 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 12472 equivalent to the "default" namespace, but "default" is the canonical representation. 12473 Not all objects are required to be scoped to a namespace - the value of this field for 12474 those objects will be empty. 12475 12476 Must be a DNS_LABEL. 12477 Cannot be updated. 12478 More info: http://kubernetes.io/docs/user-guide/namespaces 12479 +optional | | 12480 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 12481 been deleted, this object will be garbage collected. If this object is managed by a controller, 12482 then an entry in this list will point to this controller, with the controller field set to true. 12483 There cannot be more than one managing controller. 12484 +optional 12485 +patchMergeKey=uid 12486 +patchStrategy=merge | | 12487 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 12488 be used by clients to determine when objects have changed. May be used for optimistic 12489 concurrency, change detection, and the watch operation on a resource or set of resources. 12490 Clients must treat these values as opaque and passed unmodified back to the server. 12491 They may only be valid for a particular resource or set of resources. 12492 12493 Populated by the system. 12494 Read-only. 12495 Value must be treated as opaque by clients and . 12496 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 12497 +optional | | 12498 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 12499 +optional | | 12500 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 12501 the system and never used; it will be removed completely in 1.25. 12502 12503 The name in the go struct is changed to help clients detect 12504 accidental use. 12505 12506 +optional | | 12507 | spec | [WorkloadEntry](#workload-entry)| `WorkloadEntry` | | | | | 12508 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 12509 | uid | [UID](#uid)| `UID` | | | | | 12510 12511 12512 12513 ### <span id="workload-group"></span> WorkloadGroup 12514 12515 12516 > <!-- crd generation tags 12517 +cue-gen:WorkloadGroup:groupName:networking.istio.io 12518 +cue-gen:WorkloadGroup:version:v1beta1 12519 +cue-gen:WorkloadGroup:labels:app=istio-pilot,chart=istio,heritage=Tiller,release=istio 12520 +cue-gen:WorkloadGroup:subresource:status 12521 +cue-gen:WorkloadGroup:scope:Namespaced 12522 +cue-gen:WorkloadGroup:resource:categories=istio-io,networking-istio-io,shortNames=wg,plural=workloadgroups 12523 +cue-gen:WorkloadGroup:printerColumn:name=Age,type=date,JSONPath=.metadata.creationTimestamp,description="CreationTimestamp is a timestamp 12524 representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. 12525 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 12526 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" 12527 +cue-gen:WorkloadGroup:preserveUnknownFields:false 12528 > 12529 12530 <!-- go code generation tags 12531 +kubetype-gen 12532 +kubetype-gen:groupVersion=networking.istio.io/v1beta1 12533 +genclient 12534 +k8s:deepcopy-gen=true 12535 > 12536 <!-- istio code generation tags 12537 +istio.io/sync-from:networking/v1alpha3/workload_group.proto 12538 > 12539 12540 12541 12542 12543 12544 12545 **Properties** 12546 12547 | Name | Type | Go type | Required | Default | Description | Example | 12548 |------|------|---------|:--------:| ------- |-------------|---------| 12549 | APIVersion | string| `string` | | | APIVersion defines the versioned schema of this representation of an object. 12550 Servers should convert recognized schemas to the latest internal value, and 12551 may reject unrecognized values. 12552 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources 12553 +optional | | 12554 | Annotations | map of string| `map[string]string` | | | Annotations is an unstructured key value map stored with a resource that may be 12555 set by external tools to store and retrieve arbitrary metadata. They are not 12556 queryable and should be preserved when modifying objects. 12557 More info: http://kubernetes.io/docs/user-guide/annotations 12558 +optional | | 12559 | CreationTimestamp | string| `string` | | | CreationTimestamp is a timestamp representing the server time when this object was 12560 created. It is not guaranteed to be set in happens-before order across separate operations. 12561 Clients may not set this value. It is represented in RFC3339 form and is in UTC. 12562 12563 Populated by the system. 12564 Read-only. 12565 Null for lists. 12566 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 12567 +optional | | 12568 | DeletionGracePeriodSeconds | int64 (formatted integer)| `int64` | | | Number of seconds allowed for this object to gracefully terminate before 12569 it will be removed from the system. Only set when deletionTimestamp is also set. 12570 May only be shortened. 12571 Read-only. 12572 +optional | | 12573 | DeletionTimestamp | string| `string` | | | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This 12574 field is set by the server when a graceful deletion is requested by the user, and is not 12575 directly settable by a client. The resource is expected to be deleted (no longer visible 12576 from resource lists, and not reachable by name) after the time in this field, once the 12577 finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. 12578 Once the deletionTimestamp is set, this value may not be unset or be set further into the 12579 future, although it may be shortened or the resource may be deleted prior to this time. 12580 For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react 12581 by sending a graceful termination signal to the containers in the pod. After that 30 seconds, 12582 the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, 12583 remove the pod from the API. In the presence of network partitions, this object may still 12584 exist after this timestamp, until an administrator or automated process can determine the 12585 resource is fully terminated. 12586 If not set, graceful deletion of the object has not been requested. 12587 12588 Populated by the system when a graceful deletion is requested. 12589 Read-only. 12590 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 12591 +optional | | 12592 | Finalizers | []string| `[]string` | | | Must be empty before the object is deleted from the registry. Each entry 12593 is an identifier for the responsible component that will remove the entry 12594 from the list. If the deletionTimestamp of the object is non-nil, entries 12595 in this list can only be removed. 12596 Finalizers may be processed and removed in any order. Order is NOT enforced 12597 because it introduces significant risk of stuck finalizers. 12598 finalizers is a shared field, any actor with permission can reorder it. 12599 If the finalizer list is processed in order, then this can lead to a situation 12600 in which the component responsible for the first finalizer in the list is 12601 waiting for a signal (field value, external system, or other) produced by a 12602 component responsible for a finalizer later in the list, resulting in a deadlock. 12603 Without enforced ordering finalizers are free to order amongst themselves and 12604 are not vulnerable to ordering changes in the list. 12605 +optional 12606 +patchStrategy=merge | | 12607 | GenerateName | string| `string` | | | GenerateName is an optional prefix, used by the server, to generate a unique 12608 name ONLY IF the Name field has not been provided. 12609 If this field is used, the name returned to the client will be different 12610 than the name passed. This value will also be combined with a unique suffix. 12611 The provided value has the same validation rules as the Name field, 12612 and may be truncated by the length of the suffix required to make the value 12613 unique on the server. 12614 12615 If this field is specified and the generated name exists, the server will return a 409. 12616 12617 Applied only if Name is not specified. 12618 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 12619 +optional | | 12620 | Generation | int64 (formatted integer)| `int64` | | | A sequence number representing a specific generation of the desired state. 12621 Populated by the system. Read-only. 12622 +optional | | 12623 | Kind | string| `string` | | | Kind is a string value representing the REST resource this object represents. 12624 Servers may infer this from the endpoint the client submits requests to. 12625 Cannot be updated. 12626 In CamelCase. 12627 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds 12628 +optional | | 12629 | Labels | map of string| `map[string]string` | | | Map of string keys and values that can be used to organize and categorize 12630 (scope and select) objects. May match selectors of replication controllers 12631 and services. 12632 More info: http://kubernetes.io/docs/user-guide/labels 12633 +optional | | 12634 | ManagedFields | [][ManagedFieldsEntry](#managed-fields-entry)| `[]*ManagedFieldsEntry` | | | ManagedFields maps workflow-id and version to the set of fields 12635 that are managed by that workflow. This is mostly for internal 12636 housekeeping, and users typically shouldn't need to set or 12637 understand this field. A workflow can be the user's name, a 12638 controller's name, or the name of a specific apply path like 12639 "ci-cd". The set of fields is always in the version that the 12640 workflow used when modifying the object. 12641 12642 +optional | | 12643 | Name | string| `string` | | | Name must be unique within a namespace. Is required when creating resources, although 12644 some resources may allow a client to request the generation of an appropriate name 12645 automatically. Name is primarily intended for creation idempotence and configuration 12646 definition. 12647 Cannot be updated. 12648 More info: http://kubernetes.io/docs/user-guide/identifiers#names 12649 +optional | | 12650 | Namespace | string| `string` | | | Namespace defines the space within which each name must be unique. An empty namespace is 12651 equivalent to the "default" namespace, but "default" is the canonical representation. 12652 Not all objects are required to be scoped to a namespace - the value of this field for 12653 those objects will be empty. 12654 12655 Must be a DNS_LABEL. 12656 Cannot be updated. 12657 More info: http://kubernetes.io/docs/user-guide/namespaces 12658 +optional | | 12659 | OwnerReferences | [][OwnerReference](#owner-reference)| `[]*OwnerReference` | | | List of objects depended by this object. If ALL objects in the list have 12660 been deleted, this object will be garbage collected. If this object is managed by a controller, 12661 then an entry in this list will point to this controller, with the controller field set to true. 12662 There cannot be more than one managing controller. 12663 +optional 12664 +patchMergeKey=uid 12665 +patchStrategy=merge | | 12666 | ResourceVersion | string| `string` | | | An opaque value that represents the internal version of this object that can 12667 be used by clients to determine when objects have changed. May be used for optimistic 12668 concurrency, change detection, and the watch operation on a resource or set of resources. 12669 Clients must treat these values as opaque and passed unmodified back to the server. 12670 They may only be valid for a particular resource or set of resources. 12671 12672 Populated by the system. 12673 Read-only. 12674 Value must be treated as opaque by clients and . 12675 More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 12676 +optional | | 12677 | SelfLink | string| `string` | | | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. 12678 +optional | | 12679 | ZZZ_DeprecatedClusterName | string| `string` | | | Deprecated: ClusterName is a legacy field that was always cleared by 12680 the system and never used; it will be removed completely in 1.25. 12681 12682 The name in the go struct is changed to help clients detect 12683 accidental use. 12684 12685 +optional | | 12686 | spec | [WorkloadGroup](#workload-group)| `WorkloadGroup` | | | | | 12687 | status | [IstioStatus](#istio-status)| `IstioStatus` | | | | | 12688 | uid | [UID](#uid)| `UID` | | | | | 12689 12690 12691 12692 ### <span id="workload-health"></span> WorkloadHealth 12693 12694 12695 > WorkloadHealth contains aggregated health from various sources, for a given workload 12696 12697 12698 12699 12700 12701 12702 **Properties** 12703 12704 | Name | Type | Go type | Required | Default | Description | Example | 12705 |------|------|---------|:--------:| ------- |-------------|---------| 12706 | requests | [RequestHealth](#request-health)| `RequestHealth` | | | | | 12707 | workloadStatus | [WorkloadStatus](#workload-status)| `WorkloadStatus` | | | | | 12708 12709 12710 12711 ### <span id="workload-item"></span> WorkloadItem 12712 12713 12714 12715 12716 12717 12718 **Properties** 12719 12720 | Name | Type | Go type | Required | Default | Description | Example | 12721 |------|------|---------|:--------:| ------- |-------------|---------| 12722 | IstioSidecar | boolean| `bool` | ✓ | | Define if all Pods related to the Workload has an IstioSidecar deployed | `true` | 12723 | Labels | map of string| `map[string]string` | | | Labels for Workload | | 12724 | ServiceAccountNames | []string| `[]string` | ✓ | | List of service accounts involved in this application | | 12725 | WorkloadName | string| `string` | ✓ | | Name of a workload member of an application | `reviews-v1` | 12726 12727 12728 12729 ### <span id="workload-list"></span> WorkloadList 12730 12731 12732 12733 12734 12735 12736 **Properties** 12737 12738 | Name | Type | Go type | Required | Default | Description | Example | 12739 |------|------|---------|:--------:| ------- |-------------|---------| 12740 | Workloads | [][WorkloadListItem](#workload-list-item)| `[]*WorkloadListItem` | ✓ | | Workloads for a given namespace | | 12741 | namespace | [Namespace](#namespace)| `Namespace` | ✓ | | | | 12742 | validations | [IstioValidations](#istio-validations)| `IstioValidations` | | | | | 12743 12744 12745 12746 ### <span id="workload-list-item"></span> WorkloadListItem 12747 12748 12749 > WorkloadListItem has the necessary information to display the console workload list 12750 12751 12752 12753 12754 12755 12756 **Properties** 12757 12758 | Name | Type | Go type | Required | Default | Description | Example | 12759 |------|------|---------|:--------:| ------- |-------------|---------| 12760 | AppLabel | boolean| `bool` | ✓ | | Define if Pods related to this Workload has the label App | `true` | 12761 | CreatedAt | string| `string` | ✓ | | Creation timestamp (in RFC3339 format) | `2018-07-31T12:24:17Z` | 12762 | DashboardAnnotations | map of string| `map[string]string` | | | Dashboard annotations | | 12763 | HealthAnnotations | map of string| `map[string]string` | | | HealthAnnotations | | 12764 | IstioInjectionAnnotation | boolean| `bool` | | | Define if Workload has an explicit Istio policy annotation 12765 Istio supports this as a label as well - this will be defined if the label is set, too. 12766 If both annotation and label are set, if any is false, injection is disabled. 12767 It's mapped as a pointer to show three values nil, true, false | | 12768 | IstioReferences | [][IstioValidationKey](#istio-validation-key)| `[]*IstioValidationKey` | | | Istio References | | 12769 | IstioSidecar | boolean| `bool` | ✓ | | Define if Pods related to this Workload has an IstioSidecar deployed | `true` | 12770 | Labels | map of string| `map[string]string` | | | Workload labels | | 12771 | Name | string| `string` | ✓ | | Name of the workload | `reviews-v1` | 12772 | PodCount | int64 (formatted integer)| `int64` | ✓ | | Number of current workload pods | `1` | 12773 | ResourceVersion | string| `string` | ✓ | | Kubernetes ResourceVersion | `192892127` | 12774 | ServiceAccountNames | []string| `[]string` | | | Names of the workload service accounts | | 12775 | Type | string| `string` | ✓ | | Type of the workload | `deployment` | 12776 | VersionLabel | boolean| `bool` | ✓ | | Define if Pods related to this Workload has the label Version | `true` | 12777 | additionalDetailSample | [AdditionalItem](#additional-item)| `AdditionalItem` | | | | | 12778 | health | [WorkloadHealth](#workload-health)| `WorkloadHealth` | | | | | 12779 12780 12781 12782 ### <span id="workload-overviews"></span> WorkloadOverviews 12783 12784 12785 12786 12787 [][WorkloadListItem](#workload-list-item) 12788 12789 ### <span id="workload-reference"></span> WorkloadReference 12790 12791 12792 12793 12794 12795 12796 **Properties** 12797 12798 | Name | Type | Go type | Required | Default | Description | Example | 12799 |------|------|---------|:--------:| ------- |-------------|---------| 12800 | Name | string| `string` | | | | | 12801 | Namespace | string| `string` | | | | | 12802 12803 12804 12805 ### <span id="workload-status"></span> WorkloadStatus 12806 12807 12808 > WorkloadStatus gives 12809 number of desired replicas defined in the Spec of a controller 12810 number of current replicas that matches selector of a controller 12811 number of available replicas for a given workload 12812 In healthy scenarios all variables should point same value. 12813 When something wrong happens the different values can indicate an unhealthy situation. 12814 i.e. 12815 desired = 1, current = 10, available = 0 would means that a user scaled down a workload from 10 to 1 12816 but in the operaton 10 pods showed problems, so no pod is available/ready but user will see 10 pods under a workload 12817 12818 12819 12820 12821 12822 12823 **Properties** 12824 12825 | Name | Type | Go type | Required | Default | Description | Example | 12826 |------|------|---------|:--------:| ------- |-------------|---------| 12827 | AvailableReplicas | int32 (formatted integer)| `int32` | | | | | 12828 | CurrentReplicas | int32 (formatted integer)| `int32` | | | | | 12829 | DesiredReplicas | int32 (formatted integer)| `int32` | | | | | 12830 | Name | string| `string` | | | | | 12831 | SyncedProxies | int32 (formatted integer)| `int32` | | | | | 12832 12833