Skip to content

Latest commit

 

History

History
181 lines (139 loc) · 9.7 KB

installLiberty.md

File metadata and controls

181 lines (139 loc) · 9.7 KB
Raw

installLiberty task

The installLiberty task is used to download and install WebSphere Liberty. The task can also upgrade your Liberty runtime from an ILAN to an IPLA license with a license JAR file setup and license configuration.

The task can download the Liberty runtime archive in three ways:

When installing Liberty from a JAR file, the Liberty license code is needed to install the runtime. When you are installing Liberty from the Liberty repository, you can see the versions of Liberty available to install and find the link to their license using the index.yml file. After opening the license, look for the D/N: <license code> line. Otherwise, download the runtime archive and execute java -jar wlp*runtime.jar --viewLicenseInfo command and look for the D/N: <license code> line.

Note: Use the libertyRuntime dependency to install Liberty from The Central Repository. Use the install block to install from the Liberty repository or from a local file. If both configurations are specified, the libertyRuntime dependency takes precedence.

Dependencies

The Liberty Gradle plugin defines two dependency configurations: libertyRuntime and libertyLicense. libertyRuntime defines which WebSphere Liberty runtime to download from The Central Repository. libertyLicense configures a license artifact so that your license JAR archive can be identified and used during the installLiberty task. Make sure to properly setup your license JAR to prevent a missing dependency failure.

You need to include group, name, and version values that describes the artifacts to use. An ext value for a specific archive type can be used but is not required.

Properties

Use the general runtime properies for properties to configure the runtime installation location if you want to override the defaults. By default, the runtime is installed in the ${project.buildDir}/wlp folder.

install block

Use the install to specify the name of the Liberty server to install from the Liberty repository.

Attribute Description Required
licenseCode WebSphere Liberty server license code. See above. Yes, if type is webProfile6 or runtimeUrl specifies a .jar file.
version Exact or wildcard version of the WebSphere Liberty server to install. Available versions are listed in the index.yml file. Only used if runtimeUrl is not set and the Maven repository is not used. By default, the latest stable release is used. No
runtimeUrl URL to the WebSphere Liberty server's .jar or a .zip file on your repository or on the Liberty repository. runtimeUrl can also point to an Open Liberty .zip. If not set, the Liberty repository will be used to find the Liberty runtime archive. No
baseDir The base installation directory. The actual installation directory of WebSphere Liberty server will be ${baseDir}/wlp. The default value is ${project.buildDir}. No
cacheDir The directory used for caching downloaded files such as the license or .jar files. The default value is ${java.io.tmpdir}/wlp-cache. No
username Username needed for basic authentication. No
password Password needed for basic authentication. No
maxDownloadTime Maximum time in seconds the download can take. The default value is 0 (no maximum time). No
type Liberty runtime type to download from the Liberty repository. Currently, the following types are supported: kernel, webProfile6, webProfile7, and javaee7. Only used if runtimeUrl is not set and the Maven repository is not used. The default value is webProfile6. No

Example

dependencies {
    libertyRuntime group: 'com.ibm.websphere.appserver.runtime', name: 'wlp-webProfile7', version: '17.0.0.2'

    libertyLicense 'com.ibm.websphere.appserver.license:wlp-core-license:17.0.0.2'
}

You can define your dependencies with any of the following formats:

libertyRuntime 'com.ibm.websphere.appserver.runtime:wlp-webProfile7:17.0.0.2'

libertyRuntime group: 'com.ibm.websphere.appserver.runtime', name: 'wlp-webProfile7', version: '17.0.0.2'

libertyRuntime(
    [group: 'com.ibm.websphere.appserver.runtime', name: 'wlp-webProfile7', version: '17.0.0.2']
)

Examples

  1. Install Liberty runtime with all Java EE 7 features using Liberty repository.
  apply plugin: 'liberty'

  liberty {
      install {
          type = "javaee7"
      }
  }
  1. Install from a specific location using a zip file.
  apply plugin: 'liberty'

  liberty {
      install {
          runtimeUrl="<url to wlp*.zip>"
      }
  }
  1. Install from a specific location using a jar file. licenseCode is required when installing from a jar file.
  apply plugin: 'liberty'

  liberty {
      install {
          licenseCode = "<license code>"
          runtimeUrl = "<url to runtime.jar>"
      }
  }

Using Maven artifact

Use the dependencies block to specify the name of the repository artifact that contains your custom Liberty server or use one of the provided on The Central Repository.

The Maven Central repository includes the following Liberty runtime artifacts:

name Versions Description
wlp-javaee7 17.0.0.2, 17.0.0.1, 16.0.0.4, 16.0.0.3, 16.0.0.2, 8.5.5.9, 8.5.5.8, 8.5.5.7, 8.5.5.6 Liberty runtime with all Java EE 7 Full Platform features.
wlp-webProfile7 17.0.0.2, 17.0.0.1, 16.0.0.4, 16.0.0.3, 16.0.0.2, 8.5.5.9, 8.5.5.8, 8.5.5.7, 8.5.5.6 Liberty runtime with Java EE 7 Web Profile features.
wlp-kernel 17.0.0.2, 17.0.0.1, 16.0.0.4, 16.0.0.3, 16.0.0.2, 8.5.5.9, 8.5.5.8 Liberty runtime kernel.
wlp-osgi 17.0.0.2, 17.0.0.1, 16.0.0.4, 16.0.0.3, 16.0.0.2, 8.5.5.9, 8.5.5.8 Liberty runtime with features that support OSGi applications.
wlp-microProfile1 17.0.0.2, 17.0.0.1, 16.0.0.4, 16.0.0.3 Liberty with features for a MicroProfile runtime.

The group value for all the artifacts listed above is com.ibm.websphere.appserver.runtime.

Installing your upgrade license

To upgrade the runtime license, the Liberty license JAR file, which is available to download from IBM Fix Central or the Passport Advantage website, must be installed into a local repository or a protected internal repository. After successful installation, add your license artifact to your Liberty block in your build.gradle file to upgrade the license during the installLiberty task.

You can install your Liberty license JAR file in an internal repository such as Artifactory or to a local Maven repository. The following examples show how you can install the JAR file to a local Maven repository:

If you have Maven installed

Got to the location of your license JAR file and enter the following command in the console:

mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=wlp-core-license.jar

If you do not have Maven installed

Add these details to the build.gradle file before executing a gradle publishToMavenLocal command. This has the same effect as maven-install-plugin above.

build.gradle
apply-plugin: 'maven'
apply-plugin: 'maven-publish'

def licenseFile = file('wlp-core-license.jar')
artifacts {
    archives licenseFile
}

publishing {
    publications {
        licenseArtifact(MavenPublication) {
            groupId = 'com.ibm.websphere.appserver.license'
            artifactId = 'wlp-core-license'
            version = '17.0.0.2'

            artifact licenseFile
        }
    }
}

License configuration

The libertyLicense parameter defines the coordinates for the Liberty license JAR file that you added to an internal repository. The installLiberty task will only upgrade the license if this configuration is present.

apply plugin: 'liberty'

repositories {
    mavenLocal()
}

dependencies {
    libertyLicense 'com.ibm.websphere.appserver.license:wlp-core-license:17.0.0.2'
}

Adding a custom repository

Add to your build.gradle this outline with your information. For more details, refer to Gradle's documentation.

repositories {
    maven {
        name 'Your Custom Repository'
        url 'https://your-url-here.me'
        credentials {
            username ''
            password ''
        }
    }
}