Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 4.3 KB

installation.md

File metadata and controls

78 lines (49 loc) · 4.3 KB
Raw

How to install the Buildpack into your Cloud Foundry release

As a Cloud Foundry administrator, you can install the Liberty Buildpack as an admin Buildpack, which can be used by all users in your Cloud Foundry environment. To create the admin Buildpack:

  1. Clone the ibm-websphere-liberty-buildpack repository to a machine with Ruby installed and Internet connectivity.

  2. Customize the buildpack configuration as needed.

    If you are licensed to deploy the buildpack into your environment, you can create a config/licenses.yml file that contains the accepted license numbers prior to packaging:

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

    After adding the license to the buildpack package, individual applications will not be required to accept the license terms via environment variables.

  3. In the top-level directory of the cloned repository, run the Rake package task to create an admin buildpack:

    bundle exec rake package

    This task pulls down the Liberty and IBM JRE binaries that are hosted on public IBM sites and packages the binaries with the Buildpack code in a .zip file in the parent directory. The name of the file consists of the name of the repository directory appended with the shortened identifier of the latest commit. If you are using the default name for the buildpack repository directory, the file name is of the form ibm-websphere-liberty-buildpack-480d2de.zip where 480d2de would be replaced by the latest commit identifier.

    The rake package task can be customized by providing parameters. The accepted parameters are zipfile, hosts, and version in the following order:

    bundle exec rake 'package[zipfile,hosts,version]'

    zipfile is the name of the generated admin buildpack and should include a relative location that is NOT the current directory. For example, "../my-admin-buildpack.zip" can be specified as the zipfile to generate my-admin-buildpack.zip in the parent directory instead of the default ibm-websphere-liberty-buildpack-480d2de.zip. An example of this usage:

    bundle exec rake 'package[../my-admin-buildpack.zip]'

    hosts is a list of sites that the package task should pull binaries from, for inclusion in the admin buildpack. By default, only binaries from the public IBM site will be pulled. As IBM hosted sites do not include third party binaries, a package parameter should be specified to indicate that third party binaries should be included in the admin buildpack for cases where the admin buildpack will be used in offline mode. Using * will include all the binaries (if the download is possible during the packaging) in the admin buildpack. An example of this usage:

    bundle exec rake 'package[,*,]'

    version is the version information that will be displayed when an application is deployed to CloudFoundry using the CF CLI. By default, the displayed version is the latest commit identifier, such as 480d2de. An example of the displayed version information when using the default:

    -----> Liberty Buildpack Version: 480d2de | [email protected]:cloudfoundry/ibm-websphere-liberty-buildpack.git#480d2de

    Specifying the version to be v1.2.3 in the following example:

    bundle exec rake 'package[,,v1.2.3]'

    Results in the output:

    -----> Liberty Buildpack Version: v1.2.3

  4. Install the admin Buildpack using the cf client as follows:

    cf create-buildpack ibm-websphere-liberty-buildpack ibm-websphere-liberty-buildpack-480d2de.zip 1

In this command:

  • ibm-websphere-liberty-buildpack is the name that will be given to the admin buildpack

  • ibm-websphere-liberty-buildpack-480d2de.zip is the path to the .zip file that is created by the Rake task

  • 1 is the priority given to the admin Buildpack. The lower the number, the higher the priority. See the Cloud Foundry documentation for further details.

Result: Users of the Cloud Foundry environment using the Liberty Buildpack do not need to specify the -b option in order to use the buildpack directly from GitHub. They must, however, still provide the license information in the manifest unless a config/licenses.yml file has been provided as described above.