Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ModResorts Demo Application

## Overview
ModResorts (as per the `main` branch) is a IBM WebSphere Application Server web application. It is a simple application that can be used to demonstrate modernization of a IBM WebSphere Application Server to Liberty, as well as Java version upgrade scenarios.
ModResorts (as per the `main` branch) is a IBM WebSphere Application Server web application. It is a simple application that can be used to demonstrate application modernization from IBM WebSphere Application Server traditional to Liberty, which is a modern cloud-ready enterprise Java runtime, as well as Java SE version upgrade scenarios.
The Java source code is dependent on APIs that only exist on the IBM WebSphere Application Server and as such, this version of the application will only function correctly when deployed to IBM WebSphere Application Server. In order to successfully deploy to Liberty, code changes need to be made to the application. See [Liberty Versions of ModResorts](#liberty-versions-of-modresorts) below.


Expand Down Expand Up @@ -38,9 +38,9 @@ Two Liberty versions of the application are maintained on the following branches
- `liberty-java8`
This branch shows what the application looks like after it has been modernized to Liberty. Comparing this branch to main, you will notice the following changes:
- Code changes in some source files (to remove use of WAS APIs)
- Addition of the Liberty config file: `src/main/liberty/config/server.xml`. This file is produced by IBM Transformation Advisor and is available in the [migration bundle](#migration-bundle)
- Addition of the Liberty config file: `src/main/liberty/config/server.xml`. This file is produced by IBM Application Modernization Accelerator and is available in the [migration plan](#migration-plan)
- A `Containerfile` has also been added to the project root to allow you to build an image and run the application in a container.
- The Liberty tools [plugin](https://github.com/OpenLiberty/ci.maven) has been added to the `pom.xml` for convenience of running the application in Liberty.
- [Liberty Maven Plugin](https://github.com/OpenLiberty/ci.maven) has been configured in the `pom.xml` for convenience of developing the application with Liberty.

- `liberty-java21`
This branch shows what the application looks like after it has been modernized to Liberty **AND** upgraded to Java 21. Comparing this branch to main, you will notice all the changes described for the `liberty-java8` branch in addition to:
Expand All @@ -51,27 +51,27 @@ Two Liberty versions of the application are maintained on the following branches
There are no special instructions for deploying the application to IBM WebSphere Application Server. There is no configuration required on the application server in order for the application to deploy and function.

It can be deployed using the UI console or using `wsadmin`.
Please refer to the [documentation](https://www.ibm.com/docs/en/was-nd/9.0.5?topic=applications-how-do-i-deploy) for more details on deploying the application to WebSphere Application Server.
See the [documentation](https://www.ibm.com/docs/en/was-nd/9.0.5?topic=applications-how-do-i-deploy) for more details on deploying the application to WebSphere Application Server.



## Deploying the Application to Liberty
To deploy the application on Liberty you can do one of the following:
- Install the Liberty tools IDE plugin (VSCode and Eclipse available)
- Add the Liberty tools plugin to the build configuration. Note, for convenience, the Liberty tools plugin is already added to the `pom.xml` in the `liberty-` branches. Liberty can be launched in dev mode with the following command:
- Install the Liberty Tools IDE plugin (available for VS Code, Eclipse IDE and IntelliJ IDEA)
- Add Liberty Maven or Gradle Plugin configuration to your build file. Note, for convenience, configuration for Liberty Maven Plugin is already added to the `pom.xml` in the `liberty-` branches. Liberty can be launched in dev mode with the following command:
```
mvn liberty:dev
```
- Run the Liberty tools directly from the command line:
- Start Liberty in dev mode directly from command line:
```
mvn io.openliberty.tools:liberty-maven-plugin:3.10.2:dev
```
- Build and drop the WAR file into Liberty installation.

For more on Liberty Dev Tools please refer to [Develop with Liberty Tools](https://openliberty.io/docs/latest/develop-liberty-tools.html)
For more on Liberty Tools, see [Develop with Liberty Tools](https://openliberty.io/docs/latest/develop-liberty-tools.html)

## Building and Running the Application a Liberty Container
A Containerfile exists in the `liberty-` branches. The Containerfile is produced by IBM Transformation Advisor and is available in the [migration bundle](#migration-bundle). It can be used to build an image and run the application in a container. You can build the image as follows:
A Containerfile exists in the `liberty-` branches. The Containerfile is produced by IBM Application Modernization Accelerator and is available in the [migration plan](#migration-plan). It can be used to build an image and run the application in a container. You can build the image as follows:

```
docker build -t modresorts:latest -f Containerfile .
Expand All @@ -83,5 +83,5 @@ You can run the container as follows:
docker run --rm -d -p 9080:9080 modresorts:latest
```

## Migration Bundle
The `migration_bundle` directory contains a migration bundle for ModResorts created by [IBM Transformation Advisor](https://www.ibm.com/products/cloud-pak-for-applications/transformation-advisor). It contains an analysis of the application and artifacts that accelerate modernization to Liberty and cloud migration.
## Migration Plan
The `migration_plan` directory contains a migration plan for ModResorts created by [IBM Application Modernization Accelerator](https://www.ibm.com/products/jsphere/tools) (AMA). It is used by IBM AMA Dev Tools (available for VS Code, Eclipse IDE, and IntelliJ IDEA) or IBM Bob to accelerate modernization of legacy enterprise Java applications to run on Liberty. [Try](https://www.ibm.com/account/reg/us-en/signup?formid=urx-53705) AMA.
1 change: 0 additions & 1 deletion migration-bundle/About.md

This file was deleted.

1 change: 1 addition & 0 deletions migration-plan/About.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This directory contains a migration plan created by [IBM Transformation Advisor](https://www.ibm.com/products/cloud-pak-for-applications/transformation-advisor). It contains an analysis of the application and artifacts that accellerate modernization to Liberty and cloud migration.