istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[kiali] The API is no longer published. Add warning message about the API. (#8580)

This commit is contained in:
John Mazzitelli 2020-11-25 11:15:37 -05:00 committed by GitHub
parent 6dacfe64a0
commit 34d959dcc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/en/docs/tasks/observability/kiali/index.md
View File

@ -254,9 +254,13 @@ when it detects incorrect configurations.
## About the Kiali Developer API ## About the Kiali Developer API
{{< warning >}}
The Kiali Developer API is not designed or documented for public consumption, but it may be useful to some users.
Please note the Kiali Developer API can change from version to version - there is no guarantee of backward compatibility.
{{< /warning >}}
To generate JSON files representing the graphs and other metrics, health, and To generate JSON files representing the graphs and other metrics, health, and
configuration information, you can access the configuration information, you can access the Kiali Developer API.
[Kiali Developer API](https://www.kiali.io/api).
For example, point your browser to `$KIALI_URL/api/namespaces/graph?namespaces=bookinfo&graphType=app` For example, point your browser to `$KIALI_URL/api/namespaces/graph?namespaces=bookinfo&graphType=app`
to get the JSON representation of your graph using the `app` graph type. to get the JSON representation of your graph using the `app` graph type.
@ -267,8 +271,6 @@ Kiali, use the metadata labels `app` and `version` on your application
components. As a template, the Bookinfo sample application follows this components. As a template, the Bookinfo sample application follows this
convention. convention.
Please note the Kiali Developer API can change from version to version with no guarantee of backward compatibility.
## Additional Features ## Additional Features
Kiali has more features than reviewed in this task, such as an [integration with Jaeger tracing](https://kiali.io/documentation/latest/features/#_detail_traces). Kiali has more features than reviewed in this task, such as an [integration with Jaeger tracing](https://kiali.io/documentation/latest/features/#_detail_traces).