Hawtio

https://hawt.io/docs
Admin
Hawtio is a web-based management console for monitoring and managing Java applications, with support...
Tokens:51,873
Snippets:415
Trust Score:8.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example login.config for myrealm with LdapLoginModule

Source: https://hawt.io/docs/security.html

Example login.config file for the 'myrealm' realm using LdapLoginModule. This file is selected using the -Djava.security.auth.login.config property.

```text
myrealm {
    com.sun.security.auth.module.LdapLoginModule REQUIRED
    userProvider="ldap://localhost:389"
    authIdentity="uid={USERNAME},ou=users,dc=example,dc=com"
    useSSL=false
    debug=true;
};
```

--------------------------------

### Quarkus application.properties example

Source: https://hawt.io/docs/configuration.html

Example of configuring a Hawtio property in Quarkus application.properties with the quarkus.hawtio. prefix.

```properties
quarkus.hawtio.disableProxy = false
```

--------------------------------

### Install dependencies with yarn install

Source: https://hawt.io/docs/online/develop.html

Run this command to install project dependencies. Requires Node.js v18 or higher and Yarn v3+ (classic 1.x doesn't work).

```shell
$ yarn install

```

--------------------------------

### Example hawtconfig.json configuration

Source: https://hawt.io/docs/configuration.html

Example hawtconfig.json file showing the top-level configuration options: branding, login, about, and disabledRoutes. This file is the entrypoint for configuring the frontend console, including branding, styles, login page, about modal, and plugin behaviors.

```json
{
  "branding": {
    "appName": "Hawtio Management Console",
    "showAppName": false,
    "appLogoUrl": "hawtio-logo.svg",
    "appLogoDarkModeUrl": "hawtio-logo-darkmode.svg",
    "css": "",
    "favicon": "favicon.ico"
  },
  "login": {
    "description": "Login page for Hawtio Management Console.",
    "links": [
      { "url": "#terms", "text": "Terms of Use" },
      { "url": "#help", "text": "Help" },
      { "url": "#privacy", "text": "Privacy Policy" }
    ]
  },
  "about": {
    "title": "Hawtio Management Console",
    "description": "A Hawtio reimplementation based on TypeScript + React.",
    "imgSrc": "hawtio-logo.svg",
    "imgDarkModeSrc": "hawtio-logo-darkmode.svg",
    "productInfo": [
      { "name": "ABC", "value": "1.2.3" },
      { "name": "XYZ", "value": "7.8.9" }
    ],
    "copyright": "© Hawtio project",
    "issueReporting": {
      "url": "https://github.com/hawtio/hawtio/issues/new",
      "label": "Report issue"
    }
  },
  "disabledRoutes": [
    "/disabled"
  ]
}
```

--------------------------------

### Directory structure for static plugin registration

Source: https://hawt.io/docs/developers/applications.html

Directory structure for the static plugin registration example. Shows the layout of the source files used in the tutorial.

```text
 src/
 ├── bootstrap.tsx
 ├── examples/
 │   ├── example1/
 │   │   ├── Example1.tsx
 │   │   └── index.ts
 │   └── index.ts
 ├── index.css
 └── index.ts

```

--------------------------------

### Minimal Hawtio React setup: index.ts and bootstrap.tsx

Source: https://hawt.io/docs/developers/architecture.html

Minimal setup for a Hawtio React application. The index.ts file imports the required CSS and dynamically imports bootstrap.tsx. The bootstrap.tsx file creates the React root, calls hawtio.bootstrap() to initialize Hawtio services, and renders the <Hawtio /> component only after the promise resolves, ensuring components are rendered after full initialization.

```javascript
import '@hawtio/react/dist/index.css'
import '@patternfly/react-core/dist/styles/base.css'

import('./bootstrap')

```

```javascript
import React from 'react'
import ReactDOM from 'react-dom/client'

import { Hawtio } from '@hawtio/react/ui'
import { hawtio } from '@hawtio/react'

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement)

hawtio.bootstrap().then(() => {
    root.render(
      <React.StrictMode>
        <Hawtio />
      </React.StrictMode>,
    )
})

```

--------------------------------

### examples/index.ts aggregation function

Source: https://hawt.io/docs/developers/applications.html

Aggregates selected example plugins by calling their registration functions.

```javascript
import { registerExample1 } from './example1'

export const registerExamples = () => {
  registerExample1()
}

```

--------------------------------

### Install Hawtio CLI with JBang

Source: https://hawt.io/docs/get-started.html

Installs the latest Hawtio command using JBang. Requires JBang to be installed first.

```bash
$ jbang app install hawtio@hawtio/hawtio
```

--------------------------------

### Example React component for a Hawtio plugin

Source: https://hawt.io/docs/developers/applications.html

Defines a React Function Component named Example that can be used as the component for a Hawtio plugin. It uses PatternFly components for layout and text.

```javascript
import { PageSection, PageSectionVariants, Text, TextContent } from '@patternfly/react-core'
import React from 'react'

export const Example: React.FunctionComponent = () => (
  <PageSection variant={PageSectionVariants.light}>
    <TextContent>
      <Text component='h1'>Example React component</Text>
      <Text component='p'>This is an example plugin.</Text>
    </TextContent>
  </PageSection>
)
```

--------------------------------

### Jetty JAAS login.properties example

Source: https://hawt.io/docs/security.html

Example login.properties file for Jetty JAAS. Defines two users: scott with password tiger and role user, and admin with obfuscated password admin and roles admin and user.

```properties
scott=tiger,user
admin=CRYPT:adpexzg3FUZAk,admin,user
```

--------------------------------

### Run Keycloak container with podman

Source: https://hawt.io/docs/oidc.html

Starts a Keycloak container for local development. Requires podman and exposes the admin console on port 18080. The admin credentials are set to admin/admin.

```bash
podman run -d --name keycloak \
  -p 18080:8080 \
  -e KEYCLOAK_ADMIN=admin \
  -e KEYCLOAK_ADMIN_PASSWORD=admin \
  quay.io/keycloak/keycloak:latest start-dev
```

--------------------------------

### Run hawtio-online in namespace mode

Source: https://hawt.io/docs/online/develop.html

Starts the console in namespace mode using the current OpenShift server URL and project. Access the console at http://localhost:2772/.

```shell
$ yarn start --master=`oc whoami --show-server` --mode=namespace --namespace=`oc project -q`

```

--------------------------------

### Define users for properties-based authentication (application.properties)

Source: https://hawt.io/docs/security.html

Define users in application.properties to enable authentication. Example defines user 'hawtio' with password 's3cr3t!' and role 'admin'.

```properties
quarkus.security.users.embedded.enabled = true
quarkus.security.users.embedded.plain-text = true
quarkus.security.users.embedded.users.hawtio = s3cr3t!
quarkus.security.users.embedded.roles.hawtio = admin
```

--------------------------------

### Run hawtio-online in cluster mode

Source: https://hawt.io/docs/online/develop.html

Starts the console in cluster mode using the current OpenShift server URL. Access the console at http://localhost:2772/.

```shell
$ yarn start --master=`oc whoami --show-server` --mode=cluster

```

--------------------------------

### Render HawtioInitialization component with verbose mode

Source: https://hawt.io/docs/developers/applications.html

Render the HawtioInitialization component before bootstrapping Hawtio to display initialization progress. In verbose mode it shows initialization items with states: started, finished, skipped, and error.

```javascript
import React from 'react'
import ReactDOM from 'react-dom/client'

import { configManager, HawtioInitialization } from '@hawtio/react/init'

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement)
root.render(<HawtioInitialization verbose={true} />)
```

--------------------------------

### Generate serving certificate with Yarn

Source: https://hawt.io/docs/online/kubernetes.html

Alternative to the script for generating a serving certificate when Yarn is installed. Same parameters and behavior as the script version.

```bash
$ yarn gen:serving [-k tls.key] [-c tls.crt] [SECRET_NAME] [CN]

```

--------------------------------

### Example1.tsx React component

Source: https://hawt.io/docs/developers/applications.html

React component for the example plugin, using PatternFly components.

```javascript
import { PageSection, PageSectionVariants, Text, TextContent } from '@patternfly/react-core'
import React from 'react'

export const Example1: React.FunctionComponent = () => (
  <PageSection variant={PageSectionVariants.light}>
    <TextContent>
      <Text component='h1'>Example 1</Text>
      <Text component='p'>This is an example plugin registered using <code>hawtio.addPlugin()</code>.</Text>
    </TextContent>
  </PageSection>
)

```

--------------------------------

### Run Keycloak server with Docker

Source: https://hawt.io/docs/keycloak.html

Starts a Keycloak server in development mode using Docker. The container is named 'keycloak' and maps host port 18080 to container port 8080 to avoid conflicts. Admin credentials are set to admin/admin.

```bash
docker run -d --name keycloak \
  -p 18080:8080 \
  -e KEYCLOAK_ADMIN=admin \
  -e KEYCLOAK_ADMIN_PASSWORD=admin \
  quay.io/keycloak/keycloak start-dev
```

--------------------------------

### Static import from @hawtio/react/init

Source: https://hawt.io/docs/developers/architecture.html

Shows how to statically import from @hawtio/react/init to render the initialization UI and configure the Hawtio application before dynamically importing the full package. Includes creating the React root, rendering HawtioInitialization, adding product info, and setting a plugin URL.

```typescript
import ReactDOM from 'react-dom/client'

import { configManager, hawtio, HawtioInitialization, TaskState } from '@hawtio/react/init'

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement)

root.render(<HawtioInitialization verbose />)

configManager.addProductInfo('Test App', '1.0.0')
hawtio.addUrl('plugin')
...
```

--------------------------------

### Hawtio CLI usage help

Source: https://hawt.io/docs/get-started.html

Displays the full usage and options for the Hawtio CLI command, including context path, plugins directory, key store, port, and more.

```bash
Usage: hawtio [-hjoV] [-c=<contextPath>] [-d=<plugins>] [-e=<extraClassPath>]
              [-H=<host>] [-k=<keyStore>] [-l=<warLocation>] [-p=<port>]
              [-s=<keyStorePass>] [-w=<war>] [-n=<String=Optional>]...
Run Hawtio
  -c, --context-path=<contextPath>
                      Context path.
  -d, --plugins-dir=<plugins>
                      Directory to search for .war files to install as 3rd
                        party plugins.
  -e, --extra-class-path=<extraClassPath>
                      Extra class path.
  -h, --help          Print usage help and exit.
  -H, --host=<host>   Hostname to listen to.
  -j, --join          Join server thread.
  -k, --key-store=<keyStore>
                      JKS keyStore with the keys for https.
  -l, --war-location=<warLocation>
                      Directory to search for .war files.
  -n, --connection=<String=Optional>
                      List of settings for automated connections.
  -o, --open-url      Open the web console automatic in the web browser.
  -p, --port=<port>   Port number.
  -s, --key-store-pass=<keyStorePass>
                      Password for the JKS keyStore with the keys for https.
  -V, --version       Print Hawtio version
  -w, --war=<war>     War file or directory of the hawtio web application.
```

--------------------------------

### Example access token claims for hawtio-server

Source: https://hawt.io/docs/oidc.html

Example JWT payload showing the aud claim as the UUID of hawtio-server, appid as UUID of hawtio-client, and groups, roles, and scp claims.

```json
{
  "aud": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "iss": "https://sts.windows.net/.../",
  "iat": 1709626257,
  "nbf": 1709626257,
  "exp": 1709630939,
...
  "appid": "55555555-6666-7777-8888-999999999999",
...
  "groups": [
    ...
  ],
...
  "name": "hawtio-viewer",
...
  "roles": [
    "Hawtio.User"
  ],
  "scp": "Jolokia.Access",
```

--------------------------------

### ACL regexp match example

Source: https://hawt.io/docs/online/rbac.html

Example ACL entry for a regexp match on the operation invocation, using the operation signature and invocation arguments. The value 'admin' allows the admin role to perform the operation.

```text
/update\(java\.lang\.String,java\.lang\.String\)\[[1-4]?[0-9],.*\]/: admin
```

--------------------------------

### Generate proxying certificate with script

Source: https://hawt.io/docs/online/openshift.html

Run this script to generate and set up a client certificate for Hawtio Online on OpenShift.

```bash
$ ./scripts/generate-proxying.sh
```

--------------------------------

### ACL operation name match example

Source: https://hawt.io/docs/online/rbac.html

Example ACL entry for an exact match on the operation invocation, using the operation name. The value 'admin, viewer' allows both admin and viewer roles to perform the operation.

```text
dumpStatsAsXml: admin, viewer
```

--------------------------------

### ACL exact match with arguments example

Source: https://hawt.io/docs/online/rbac.html

Example ACL entry for an exact match on the operation invocation, using the operation signature and invocation arguments. The empty role list means no roles can perform this operation.

```text
uninstall(java.lang.String)[0]: [] # no roles can perform this operation
```

--------------------------------

### Launch Hawtio CLI

Source: https://hawt.io/docs/get-started.html

Launches a Hawtio instance with the default settings. The console automatically opens at http://localhost:8080/hawtio/.

```bash
$ hawtio
```

--------------------------------

### Add Jetty modules for Hawtio JAAS

Source: https://hawt.io/docs/security.html

Adds the jaas and hawtio-jetty-security modules to Jetty using start.jar. Shows the expected output when the modules are initialized and the library is copied.

```shell
$ cd $JETTY_BASE
$ java -jar $JETTY_HOME/start.jar --add-module=jaas,hawtio-jetty-security
INFO  : jaas            initialized in ${jetty.base}/start.d/jaas.ini
INFO  : hawtio-jetty-security initialized in ${jetty.base}/start.d/hawtio-jetty-security.ini
INFO  : copy ~/.m2/repository/io/hawt/hawtio-jetty-security/4.6.1/hawtio-jetty-security-<version>.jar to ${jetty.base}/lib/hawtio-jetty-security-<version>.jar
INFO  : Base directory was modified
```

--------------------------------

### Example JWT access token from Keycloak

Source: https://hawt.io/docs/oidc.html

Example JWT access token generated by Keycloak for the 'admin' user in the hawtio-demo realm. Shows the structure of the token, including realm_access.roles and preferred_username, which are used for role and user path configuration.

```json
{
  "exp": 1709552728,
  "iat": 1709552428,
  "jti": "0f33971f-c4f7-4a5c-a240-c18ba3f97aa1",
  "iss": "http://localhost:18080/realms/hawtio-demo",
  "aud": "account",
  "sub": "84d156fa-e4cc-4785-91c1-4e0bda4b8ed9",
  "typ": "Bearer",
  "azp": "hawtio-client",
  "session_state": "181a30ac-fce1-4f4f-aaee-110304ccb0e6",
  "acr": "1",
  "allowed-origins": [
    "http://0.0.0.0:8181",
    "http://localhost:8080",
    "http://localhost:8181",
    "http://0.0.0.0:10001",
    "http://0.0.0.0:8080",
    "http://localhost:10001",
    "http://localhost:10000",
    "http://0.0.0.0:10000"
  ],
  "realm_access": {
    "roles": [
      "viewer",
      "manager",
      "admin",
      "user"
    ]
  },
  "resource_access": {
    "account": {
      "roles": [
        "manage-account",
        "manage-account-links",
        "view-profile"
      ]
    }
  },
  "scope": "openid profile email",
  "sid": "181a30ac-fce1-4f4f-aaee-110304ccb0e6",
  "email_verified": false,
  "name": "Admin Hawtio",
  "preferred_username": "admin",
  "given_name": "Admin",
  "family_name": "Hawtio",
  "email": "admin@hawt.io"
}
```

--------------------------------

### ACL exact match without arguments example

Source: https://hawt.io/docs/online/rbac.html

Example ACL entry for an exact match on the operation invocation, using the operation signature without the invocation arguments. The value 'admin' allows the admin role to perform the operation.

```text
delete(java.lang.String): admin
```

--------------------------------

### Generate serving certificate with script

Source: https://hawt.io/docs/online/kubernetes.html

Run this script to generate and set up a serving certificate for Hawtio Online on Kubernetes. You can provide an existing TLS key and certificate with -k and -c, otherwise a self-signed tls.key and tls.crt are generated. Optional SECRET_NAME and CN customize the secret name and Common Name; defaults are hawtio-online-tls-serving and hawtio-online.hawtio.svc.

```bash
$ ./scripts/generate-serving.sh [-k tls.key] [-c tls.crt] [SECRET_NAME] [CN]

```

--------------------------------

### Register initialization task with configManager.initItem

Source: https://hawt.io/docs/developers/applications.html

Register initialization tasks by calling initItem with a task name, state, and group. Supported groups are 'config', 'plugins', and 'finish' (used internally only).

```javascript
import { configManager } from '@hawtio/react/init'

configManager.initItem('Loading UI', TaskState.started, 'config')
... // later
configManager.initItem('Loading UI', TaskState.finished, 'config')
```

--------------------------------

### Fetch plugin configuration with curl and jq

Source: https://hawt.io/docs/developers/applications.html

Shows the JSON response from the plugin URL. Each object in the array corresponds to a remote Module Federation module, combining an entry from the consumer host's remote and a single entry from the provider host's exposes.

```bash
$ curl -s http://localhost:8080/hawtio/plugin | jq .
[
  {
    "url": "http://localhost:8080/hawtio",
    "scope": "appRemote",
    "module": "./remote3",
    "remoteEntryFileName": "remoteExternalEntry.js",
    "pluginEntry": "registerRemote"
  },
  {
    "url": "http://localhost:8080/hawtio",
    "scope": "appRemote",
    "module": "./remote3-deferred",
    "remoteEntryFileName": "remoteExternalEntry.js",
    "pluginEntry": "registerRemoteDeferred"
  }
]
```

--------------------------------

### Change Hawtio CLI port

Source: https://hawt.io/docs/get-started.html

Starts Hawtio with a custom port number using the --port option.

```bash
$ hawtio --port 8090
```

--------------------------------

### Deploy namespace mode with Yarn

Source: https://hawt.io/docs/online/openshift.html

Deploy Hawtio Online in namespace mode using Yarn.

```bash
$ yarn deploy:openshift:namespace
```

--------------------------------

### Add Spring Security starter dependency to pom.xml

Source: https://hawt.io/docs/security.html

Add this dependency to pom.xml to use Spring Security with Hawtio.

```xml
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-security</artifactId>
</dependency>
```

--------------------------------

### Hide plugins with disabledRoutes in hawtconfig.json

Source: https://hawt.io/docs/configuration.html

Example of the `disabledRoutes` configuration in `hawtconfig.json`. It hides plugins from the console by specifying an array of plugin path strings.

```json
  "disabledRoutes": [
    "/disabled"
  ]
```

--------------------------------

### Deploy namespace mode without Yarn

Source: https://hawt.io/docs/online/openshift.html

Deploy Hawtio Online in namespace mode using oc apply.

```bash
$ oc apply -k deploy/openshift/namespace/
```

--------------------------------

### Create hawtio-viewer Role with minimum permissions

Source: https://hawt.io/docs/online/rbac.html

Creates a Kubernetes Role named hawtio-viewer with the minimum permissions required for connecting and viewing existing pods. After creation, a user can be bound to it with a role-binding.

```bash
$ cat <<EOF | kubectl create -f -
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: hawtio-viewer
rules:
- apiGroups:
  - ""
  resources:
  - pods
  verbs:
  - get
  - list
  - watch
- apiGroups:
  - ""
  resources:
  - pods/proxy
  verbs:
  - get
  - list
  - watch
  - create
- apiGroups:
  - authorization.k8s.io
  resources:
  - localsubjectaccessreviews
  verbs:
  - create
EOF
```

--------------------------------

### Run Quarkus app in development mode

Source: https://hawt.io/docs/get-started.html

Run the Quarkus application with Hawtio in development mode. After starting, open http://localhost:8080/hawtio to see the Hawtio console.

```bash
mvn compile quarkus:dev
```

--------------------------------

### bootstrap.tsx application entry point

Source: https://hawt.io/docs/developers/applications.html

Bootstrap file that registers Hawtio plugins and custom plugins, then bootstraps Hawtio and renders the React application.

```javascript
import { configManager, hawtio, Hawtio, registerPlugins } from '@hawtio/react'
import React from 'react'
import ReactDOM from 'react-dom/client'
import { registerExamples } from './examples'

configManager.addProductInfo('Test App', '1.0.0')

// Register Hawtio plugins
registerPlugins()

// Register custom plugins
registerExamples()

// Bootstrap Hawtio
hawtio.bootstrap()

// Launch React application
const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement)
root.render(
  <React.StrictMode>
    <Hawtio />
  </React.StrictMode>
)

```

--------------------------------

### Add custom product info with configManager.addProductInfo

Source: https://hawt.io/docs/developers/applications.html

Call this before bootstrapping Hawtio to customize the product information shown in the About dialog. Without a hawtconfig.json file, Hawtio uses default UI information.

```javascript
configManager.addProductInfo("Custom Application", "1.0.0")
```

--------------------------------

### Check no role permission with oc auth can-i

Source: https://hawt.io/docs/online/rbac.html

Checks whether a user has the get verb on a pod. The output 'no' indicates the user is not bound to any role.

```bash
$ oc auth can-i get pods/<pod> --as <user>
no
```

--------------------------------

### Jetty XML deployment for Hawtio WAR

Source: https://hawt.io/docs/get-started.html

Deploy Hawtio WAR using a Jetty XML file placed in $JETTY_BASE/webapps. The XML sets the context path to /hawtio and points to the WAR file location. Note that Jetty may not load resources if the real path uses symbolic links, which can be an issue with Maven's war plugin.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "https://jetty.org/configure_10_0.dtd">
<Configure class="org.eclipse.jetty.ee10.webapp.WebAppContext">
  <Set name="contextPath">/hawtio</Set>
  <Set name="war">/data/tmp/hawtio-war-4.2.0.war</Set>
</Configure>
```

--------------------------------

### Get bearer token for hawtio-user

Source: https://hawt.io/docs/online/create-user.html

Generates a bearer token for the hawtio-user ServiceAccount in the hawtio namespace. The token can be pasted into the Token form to log in to the Hawtio console.

```bash
$ kubectl -n hawtio create token hawtio-user

```

--------------------------------

### Create OAuth client for namespace mode

Source: https://hawt.io/docs/online/develop.html

Creates a service account for namespace mode to allow local development authentication. See Service Accounts as OAuth Clients documentation for more information.

```shell
$ oc create -f serviceaccount.yml

```
Tokens:
Raw