Skip to content

Commit

Permalink
docs: update to Hawtio 4.x
Browse files Browse the repository at this point in the history
  • Loading branch information
tadayosi committed Apr 18, 2024
1 parent 1a4a8d2 commit 92c5258
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 23 deletions.
6 changes: 3 additions & 3 deletions modules/ROOT/pages/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ The Camel plugin currently requires that the Camel MBeans are stored using the d

=== Why doesn't the Debug tab appear for my Camel route?

The Debug tab depends on the JMX MBeans provided by the Camel application you run. Camel debugging is enabled by the https://camel.apache.org/components/3.21.x/others/debug.html[Camel Debug] component. Installing the component is the requirement for the Debug tab in Hawtio.
The Debug tab depends on the JMX MBeans provided by the Camel application you run. Camel debugging is enabled by the https://camel.apache.org/components/4.4.x/others/debug.html[Camel Debug] component. Installing the component is the requirement for the Debug tab in Hawtio.

*Camel Quarkus 3.x*
*Camel Quarkus*

Camel Quarkus by default only enables the debug extension in development mode. If you want to enable debugging with a packaged Quarkus application, you need an extra configuration properties as follows:

Expand All @@ -95,7 +95,7 @@ Camel Quarkus by default only enables the debug extension in development mode. I
quarkus.camel.debug.enabled = true
----

See https://camel.apache.org/camel-quarkus/3.6.x/reference/extensions/debug.html#extensions-debug-additional-camel-quarkus-configuration[Camel Quarkus Reference - Debug - Additional Camel Quarkus configuration] for more information.
See https://camel.apache.org/camel-quarkus/3.2.x/reference/extensions/debug.html#extensions-debug-additional-camel-quarkus-configuration[Camel Quarkus Reference - Debug - Additional Camel Quarkus configuration] for more information.

=== Why doesn't the Trace tab appear for my Camel route?

Expand Down
16 changes: 6 additions & 10 deletions modules/ROOT/pages/get-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,20 +71,18 @@ Run Hawtio

== Running a Quarkus app

IMPORTANT: The supported Quarkus versions are 2.x for Hawtio v3. The upcoming Hawtio v4 will support Quarkus 3.x.

You can attach the Hawtio console to your Quarkus application in a single step.

=== Set up

- Add `io.hawt:hawtio-quarkus` and the supporting Camel Quarkus extensions to the dependencies in `pom.xml`:
- Add `io.hawt:hawtio-quarkus` and the supporting Camel Quarkus extensions to the dependencies in `pom.xml` (replace `4.x.y` with the latest Hawtio release version):
+
[source,xml]
----
<dependency>
<groupId>io.hawt</groupId>
<artifactId>hawtio-quarkus</artifactId>
<version>3.x.y</version>
<version>4.x.y</version>
</dependency>
<!-- Mandatory for enabling Camel management via JMX / Hawtio -->
Expand Down Expand Up @@ -117,20 +115,18 @@ https://github.com/hawtio/hawtio/tree/hawtio-3.0.0-RC1/examples/quarkus[Quarkus

== Running a Spring Boot app

IMPORTANT: The supported Spring Boot versions are 2.x for Hawtio v3. The upcoming Hawtio v4 will support Spring Boot 3.x.

You can attach the Hawtio console to your Spring Boot application in two steps.

=== Set up

1. Add `io.hawt:hawtio-springboot` and the supporting Camel Spring Boot starters to the dependencies in `pom.xml`:
1. Add `io.hawt:hawtio-springboot` and the supporting Camel Spring Boot starters to the dependencies in `pom.xml` (replace `4.x.y` with the latest Hawtio release version):
+
[source,xml]
----
<dependency>
<groupId>io.hawt</groupId>
<artifactId>hawtio-springboot</artifactId>
<version>3.x.y</version>
<version>4.x.y</version>
</dependency>
<!-- Mandatory for enabling Camel management via JMX / Hawtio -->
Expand Down Expand Up @@ -198,14 +194,14 @@ Please read xref:configuration.adoc[] to see how to configure the console, or in

You can also embed Hawtio inside your Java application instead of deploying it on a servlet container or application server.

To embed Hawtio to an application, add `io.hawt:hawtio-embedded` to your `pom.xml`:
To embed Hawtio to an application, add `io.hawt:hawtio-embedded` to your `pom.xml` (replace `4.x.y` with the latest Hawtio release version):

[source,xml]
----
<dependency>
<groupId>io.hawt</groupId>
<artifactId>hawtio-embedded</artifactId>
<version>3.x.y</version>
<version>4.x.y</version>
</dependency>
----

Expand Down
12 changes: 6 additions & 6 deletions modules/ROOT/pages/keycloak.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ docker run -d --name keycloak \

Here we use port number `18080` for the Keycloak server to avoid potential conflicts with the ports other applications might use.

You can log in to the Keycloak admin console http://localhost:18080/admin/ with user `admin` / password `admin`. Import https://raw.githubusercontent.com/hawtio/hawtio/3.x/examples/keycloak-integration/hawtio-demo-realm.json[hawtio-demo-realm.json] into Keycloak. To do so, click `Create Realm` button and then import `hawtio-demo-realm.json`. It will create `hawtio-demo` realm.
You can log in to the Keycloak admin console http://localhost:18080/admin/ with user `admin` / password `admin`. Import https://raw.githubusercontent.com/hawtio/hawtio/4.x/examples/keycloak-integration/hawtio-demo-realm.json[hawtio-demo-realm.json] into Keycloak. To do so, click `Create Realm` button and then import `hawtio-demo-realm.json`. It will create `hawtio-demo` realm.

The `hawtio-demo` realm has the `hawtio-client` application installed as a public client, and defines a couple of realm roles such as `admin` and `viewer`. The names of these roles are the same as the default Hawtio roles, which are allowed to log in to Hawtio admin console and to JMX.

Expand Down Expand Up @@ -96,21 +96,21 @@ Build and run the project and it will be integrated with Keycloak.

==== Example

See https://github.com/hawtio/hawtio/tree/3.x/examples/quarkus-keycloak[quarkus-keycloak example] for a working example.
See https://github.com/hawtio/hawtio/tree/4.x/examples/quarkus-keycloak[quarkus-keycloak example] for a working example.

=== Spring Boot

Firstly, apply xref:get-started.adoc#_running_a_spring_boot_app[the required configuration] for attaching Hawtio to a Spring Boot application.

What you need to integrate your Spring Boot application with Keycloak is to add the following dependency to `pom.xml` (replace `3.x.y` with the latest Hawtio release version):
What you need to integrate your Spring Boot application with Keycloak is to add the following dependency to `pom.xml` (replace `4.x.y` with the latest Hawtio release version):

[source,xml]
.pom.xml
----
<dependency>
<groupId>io.hawt</groupId>
<artifactId>hawtio-springboot-keycloak</artifactId>
<version>3.x.y</version>
<version>4.x.y</version>
</dependency>
----

Expand Down Expand Up @@ -148,7 +148,7 @@ Build and run the project and it will be integrated with Keycloak.

==== Example

See https://github.com/hawtio/hawtio/tree/3.x/examples/springboot-keycloak[springboot-keycloak example] for a working example.
See https://github.com/hawtio/hawtio/tree/4.x/examples/springboot-keycloak[springboot-keycloak example] for a working example.

=== Jetty

Expand Down Expand Up @@ -220,7 +220,7 @@ Assume `$JBOSS_HOME` is the root directory of your WildFly/JBoss EAP installatio
Install Keycloak adapter subsystem to your WildFly as described on the https://www.keycloak.org/docs/latest/securing_apps/index.html#_jboss_adapter[Keycloak documentation].
Download and copy `keycloak-hawtio.json` and `keycloak-bearer.json` from https://github.com/hawtio/hawtio/tree/3.x/examples/keycloak-integration[this example] into WildFly. File `keycloak-bearer.json` is currently used for adapters on server (JAAS Login module) side. File `keycloak-hawtio.json` is used on client (Hawtio JS application) side.
Download and copy `keycloak-hawtio.json` and `keycloak-bearer.json` from https://github.com/hawtio/hawtio/tree/4.x/examples/keycloak-integration[this example] into WildFly. File `keycloak-bearer.json` is currently used for adapters on server (JAAS Login module) side. File `keycloak-hawtio.json` is used on client (Hawtio JS application) side.
[source,console]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ You can also extend the Hawtio capabilities by developing a custom plugin.
Typically, plugin development involves TypeScript, React, and PatternFly v4. For now, we have a few examples that demonstrate how you can develop a custom plugin to extend Hawtio.

Sample plugin within the Hawtio project examples::
https://github.com/hawtio/hawtio/tree/3.x/examples/sample-plugin +
https://github.com/hawtio/hawtio/tree/4.x/examples/sample-plugin +
The simplest form of a Hawtio plugin. It packages itself as a JAR, and then can be used by including it as a dependency in a Java project.

Sample plugin for Spring Boot::
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/releasing.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
= Releasing Hawtio

See https://github.com/hawtio/hawtio/blob/3.x/RELEASING.md[RELEASING].
See https://github.com/hawtio/hawtio/blob/4.x/RELEASING.md[RELEASING].
4 changes: 2 additions & 2 deletions modules/ROOT/pages/security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ quarkus.security.users.embedded.roles.hawtio = admin

==== Example

See https://github.com/hawtio/hawtio/tree/3.x/examples/quarkus[quarkus example] for a working example of the properties-based authentication.
See https://github.com/hawtio/hawtio/tree/4.x/examples/quarkus[quarkus example] for a working example of the properties-based authentication.

=== Quarkus with Keycloak

Expand Down Expand Up @@ -158,7 +158,7 @@ public class SecurityConfig {

==== Example

See https://github.com/hawtio/hawtio/tree/3.x/examples/springboot-security[springboot-security example] for a working example.
See https://github.com/hawtio/hawtio/tree/4.x/examples/springboot-security[springboot-security example] for a working example.

==== Connecting to a remote application with Spring Security

Expand Down

0 comments on commit 92c5258

Please sign in to comment.