# libertydiag

**Repository Path**: mirrors_ibm/libertydiag

## Basic Information

- **Project Name**: libertydiag
- **Description**: Liberty diagnostic web application
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-24
- **Last Updated**: 2025-09-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# libertydiag

`libertydiag` is a [MicroProfile 5](https://openliberty.io/docs/latest/microprofile.html) and [Jakarta EE 9 (Web Profile)](https://openliberty.io/docs/latest/jakarta-ee.html) web application for simulating diagnostic situations.

Running this application in production should be done with care because it may be used to execute various powerful functions.

## Download or Run

Download `libertydiag.war` from <https://github.com/IBM/libertydiag/releases/latest>

This application [requires](https://www.ibm.com/docs/en/was-liberty/base?topic=management-liberty-features) Liberty >= 22.0.0.1 and at least the following features to be installed:

```
  <featureManager>
    <feature>webProfile-9.1</feature>
    <feature>microProfile-5.0</feature>
  <featureManager>
```

The latest release is also built into an image at [quay.io/ibm/libertydiag](https://quay.io/repository/ibm/libertydiag); for example:

```
podman run --rm -p 9080:9080 -p 9443:9443 -it quay.io/ibm/libertydiag
```

Then access at <http://localhost:9080/> or <https://localhost:9443/>

There is also a [Liberty InstantOn](https://developer.ibm.com/blogs/liberty-instanton-serverless-for-java-without-compromise/) image at [quay.io/ibm/libertydiag:instanton](https://quay.io/repository/ibm/libertydiag?tab=tags); for example:

```
podman run --pull=newer --rm --privileged -p 9080:9080 -p 9443:9443 -it quay.io/ibm/libertydiag:instanton
```

## Screenshot

![Screenshot](screenshot.png)

## Development

1. Pre-requisities:
    1. Java >= 8 is required on your `PATH`; for example, [IBM Semeru Runtimes](https://developer.ibm.com/languages/java/semeru-runtimes/downloads/)
    1. Using podman on macOS:
       ```
       podman machine ssh "sudo rpm-ostree install qemu-user-static cpp && sudo systemctl reboot"
       ```
1. Build and run:
    * macOS and Linux:
      ```
      ./mvnw clean liberty:dev
      ```
    * Windows:
      ```
      mvnw clean liberty:dev
      ```
1. Wait for the message, "server is ready to run a smarter planet". For example:
   ```
   CWWKF0011I: The defaultServer server is ready to run a smarter planet. The defaultServer server started in 30.292 seconds.
   ```
1. Open your browser to the HTTP or HTTPS page:
    * <http://localhost:9080/>
    * <https://localhost:9443/>

### Eclipse

To develop in Eclipse:

1. Install the Eclipse flavor: [Eclipse IDE for Enterprise Java and Web Developers](https://www.eclipse.org/downloads/packages/)
1. Start Eclipse and click File } Import... } Maven } Existing Maven Projects

### Notes

1. Example overriding variables:
   ```
   ./mvnw -Dliberty.var.HTTP_PORT=9081 -Dliberty.var.HTTPS_PORT=9444 clean liberty:dev
   ```
1. Build WAR file and Liberty package:
   ```
   ./mvnw clean package
   ```
1. Run Liberty in the console:
   ```
   ./mvnw clean liberty:run
   ```
1. Run a specific version of Liberty:
   ```
   ./mvnw -Dliberty.runtime.version=22.0.0.10 clean liberty:run
   ```
1. If you'd like to run the Liberty package as a jar:
   ```
   java -jar target/libertydiag.jar
   ```
1. Build container:
   ```
   ./mvnw clean deploy
   podman run --rm --platform linux/amd64 -p 9080:9080 -p 9443:9443 -it localhost/libertydiag:latest
   ```
1. Build container with InstantOn:
   ```
   ./mvnw -Dimage.build.instanton=true clean deploy
   podman run --rm --privileged --platform linux/amd64 -p 9080:9080 -p 9443:9443 -it localhost/libertydiag:instanton
   ```
1. Build container with normal logging:
   ```
   ./mvnw -Dimage.builder.arguments="--build-arg WLP_LOGGING_CONSOLE_FORMAT='SIMPLE' --build-arg WLP_LOGGING_CONSOLE_LOGLEVEL='INFO' --build-arg WLP_LOGGING_CONSOLE_SOURCE='message'" deploy
   ```

### Build Issues

1. Running `mvnw clean deploy` errors with `An Ant BuildException has occured: Execute failed: java.io.IOException: Cannot run program "podman"`
   \
   \
   If `podman` is not on your path and you want to use, for example, `docker` instead:
   ```
   ./mvnw -Dimage.builder=docker deploy
   ```
1. Running `mvnw clean deploy` errors with `An Ant BuildException has occured: exec returned:`
   \
   \
   Add `-X` to show full output:
   ```
   ./mvnw -X deploy
   ```

## New Release

1. Update the date in `pom.xml` in the line `<version>0.1.$DATE</version>` and then commit and push
    1. `git commit -a -s -S -m "Description of changes in this release"`
    1. `git push`
1. Confirm that the push built successfully: <https://github.com/IBM/libertydiag/actions>
1. Tag with the same version and push
    1. `git tag 0.1.$DATE`
    1. `git push --tags`

### Push new version to Quay

1. On macOS, install `qemu-user-static` for cross-compilation:
   ```
   podman machine ssh "sudo rpm-ostree install qemu-user-static cpp && sudo systemctl reboot"
   ```
1. Run:
   ```
   ./mvnw -Dimage.build.instanton=true -Dimage.manifest.repository.push=true clean deploy
   ```
1. Confirm new build at <https://quay.io/repository/ibm/libertydiag?tab=tags>