Skip to content

Commit

Permalink
Add some documentation about the /q/info endpoint
Browse files Browse the repository at this point in the history
Co-authored-by: Rostislav Svoboda <rsvoboda@redhat.com>
  • Loading branch information
geoand and rsvoboda committed Apr 4, 2023
1 parent a6aa204 commit f9e24d2
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
22 changes: 22 additions & 0 deletions docs/src/main/asciidoc/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,28 @@ By default, when a Quarkus application starts (in regular or dev mode), it will
by setting the `-Dquarkus.banner.enabled=false` Java System Property, or by setting the `QUARKUS_BANNER_ENABLED` environment variable to `false`.
Furthermore, users can supply a custom banner by placing the banner file in `src/main/resources` and configuring `quarkus.banner.path=name-of-file` in `application.properties`.

== Non Application endpoints

Various Quarkus extensions contribute non-application endpoints that provide different kinds of information about the application.
Examples of such extensions are the xref:smallrye-health.adoc[health], xref:micrometer.adoc[metrics], xref:openapi-swaggerui.adoc[OpenAPI] and info extensions.

These non application endpoints are normally accessible under the `/q` prefix like so:

* `/q/health`
* `/q/metrics`
* `/q/openapi`
* `/q/info`

but users can also choose to expose one that might present a security risk under a different TCP port using a dedicated xref:management-interface-reference.adoc[management interface].

=== Info endpoint

If the application contains the `quarkus-info` extension, then Quarkus will by default expose the `/q/info` endpoint which provides information about the build, java version, version control, and operating system. The level of detail of the exposed information is configurable.

==== Configuration Reference

include::{generated-dir}/config/quarkus-info.adoc[opts=optional, leveloffset=+2]

== What's next?

This guide covered the creation of an application using Quarkus.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/management-interface-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ quarkus.management.enabled=true
By default, management endpoints will be exposed on: `http://0.0.0.0:9000/q`.
For example, `http://0.0.0.0:9000/q/health/ready` for the readiness probe.

SmallRye Health Checks, SmallRye Metrics, and Micrometer endpoints will be declared as management endpoints when the management interface is enabled.
SmallRye Health Checks, SmallRye Metrics, Micrometer and Info endpoints will be declared as management endpoints when the management interface is enabled.

== Configure the host, port and scheme

Expand Down Expand Up @@ -241,4 +241,4 @@ quarkus.management.auth.permission.metrics.paths=/q/metrics/*
quarkus.management.auth.permission.metrics.policy=authenticated
----

More details about Basic authentication in Quarkus can be found in the xref:security-basic-authentication-howto.adoc[Basic authentication guide].
More details about Basic authentication in Quarkus can be found in the xref:security-basic-authentication-howto.adoc[Basic authentication guide].

0 comments on commit f9e24d2

Please sign in to comment.