README.md

IBM ends support for this buildpack on August 13, 2024. No further updates from IBM will occur after this date.

IBM WebSphere Application Server Liberty Buildpack

The liberty-buildpack is a Cloud Foundry Buildpack for running applications on IBM's WebSphere Application Server Liberty Profile.

Usage

To deploy applications using the IBM WebSphere Application Server Liberty Buildpack, you are required to accept the IBM Liberty license and IBM JRE license by following the instructions below:

1. Read the current IBM Liberty-License and the current IBM JVM-License.

2. Extract the D/N: <License code> from the Liberty-License and JVM-License.

3. Add the following environment variables and extracted license codes to the manifest.yml file in the directory from which you push your application. For further information on the format of the manifest.yml file refer to the manifest documentation.

     env:
       IBM_JVM_LICENSE: <jvm license code>
       IBM_LIBERTY_LICENSE: <liberty license code>
   

After you have set the license acceptance environment variables, use the following command to deploy the application with the IBM WebSphere Application Server Liberty Buildpack:

cf push <APP-NAME> -p <ARCHIVE> -b https://github.com/cloudfoundry/ibm-websphere-liberty-buildpack.git

• For further details on the options available for deploying your applications see options.
• For further details on tuning the applications JVM see tuning options.
• For further details on pushing a Java Main application see java main push.

Documentation

All Documentation is available in the Docs folder of the buildpack.

• Liberty Buildpack Design Overview
• Containers
  • Liberty Container
    • Service Plug-ins
      • MongoDB
      • MySQL
      • PostgreSQL
  • Java Main (for jars with a main() class)
  • DistZip
• Frameworks
  • AppDynamics Agent
  • CA APM Agent
  • Contrast Security Agent
  • Dynatrace Appmon Agent
  • Dynatrace SaaS/Managed OneAgent
  • DynamicPULSE Agent
  • Java Options
  • JRebel Agent
  • New Relic Agent
  • Spring Auto Reconfiguration
• JVMs
  • IBM SDK
  • OpenJDK
  • OpenJ9
• Server Behavior xml Options
• Forking the buildpack
• Overriding buildpack configuration
• Setting Environment Variables
• Installation (admin buildpack into CF)
• Tuning
• Logging
• Debugging the buildpack
• Troubleshooting
• Security
• Restrictions
• Configuring Liberty with bootstrap.properties
• Applying an iFix to the Liberty runtime
• Utilities
  • Utility: Caches
  • Utility: Repositories
  • Utility: Repository Builder
  • Utility: Test Applications

Running Tests

To run the tests, do the following:

bundle install
bundle exec rake

If you want to use the RubyMine debugger, you may need to install additional gems.

bundle install --gemfile Gemfile.rubymine-debug

Contributing

Pull requests are welcome; see the contributor guidelines for details.