Puppet Module to manage Java
Ruby Puppet
Latest commit 901bfe9 Dec 6, 2017 @pmcmaw pmcmaw Merge pull request #279 from tphoney/FM-6634
FM-6634 rubocop fixes

README.markdown

java

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with the java module
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

Installs the correct Java package on various platforms.

Module Description

The java module can automatically install Java jdk or jre on a wide variety of systems. Java is a base component for many software platforms, but Java system packages don't always follow packaging conventions. The java module simplifies the Java installation process.

Setup

Beginning with the java module

To install the correct Java package on your system, include the java class: include java.

Usage

The java module installs the correct jdk or jre package on a wide variety of systems. By default, the module installs the jdk package, but you can set different installation parameters as needed. For example, to install jre instead of jdk, you would set the distribution parameter:

class { 'java':
  distribution => 'jre',
}

To install the latest patch version of Java 8 on CentOS

class { 'java' :
  package => 'java-1.8.0-openjdk-devel',
}

The defined type java::oracle installs one or more versions of Oracle Java SE. java::oracle depends on puppet/archive. By using java::oracle you agree to Oracle's licensing terms for Java SE.

java::oracle { 'jdk6' :
  ensure  => 'present',
  version => '6',
  java_se => 'jdk',
}

java::oracle { 'jdk8' :
  ensure  => 'present',
  version => '8',
  java_se => 'jdk',
}

To install a specific release of a Java version, e.g. 8u101-b13, provide both parameters version_major and version_minor as follows:

java::oracle { 'jdk8' :
  ensure  => 'present',
  version_major => '8u101',
  version_minor => 'b13',
  java_se => 'jdk',
}

Reference

Classes

Public classes

  • java: Installs and manages the Java package.

Private classes

  • java::config: Configures the Java alternatives.

  • java::params: Builds a hash of jdk/jre packages for all compatible operating systems.

Parameters

The following parameters are available in java:

distribution

Specifies the Java distribution to install. Valid options: 'jdk', 'jre', or, where the platform supports alternative packages, 'sun-jdk', 'sun-jre', 'oracle-jdk', 'oracle-jre'. Default: 'jdk'.

java_alternative

Specifies the name of the Java alternative to use. If you set this parameter, you must also set the java_alternative_path. Valid options: Run command update-java-alternatives -l for a list of available choices. Default: OS and distribution dependent defaults on *deb systems, undef on others.

java_alternative_path

Required when java_alternative is specified. Defines the path to the java command. Valid option: String. Default: OS and distribution dependent defaults on *deb systems, undef on others.

package

Specifies the name of the Java package. This is configurable in case you want to install a non-standard Java package. If not set, the module installs the appropriate package for the distribution parameter and target platform. If you set package, the distribution parameter does nothing. Valid option: String. Default: undef.

version

Sets the version of Java to install, if you want to ensure a particular version. Valid options: 'present', 'installed', 'latest', or a string matching /^[.+_0-9a-zA-Z:-]+$/. Default: 'present'.

Public defined types

  • java::oracle: Installs specified version of Oracle Java SE. You may install multiple versions of Oracle Jave SE on the same node using this defined type.

Parameters

The following parameters are available in java::oracle:

version

Version of Java Standard Edition (SE) to install. 6, 7 or 8.

version_major

Major version of the Java Standard Edition (SE) to install. Must be used together with version_minor. For example, '8u101'.

version_minor

Minor version (or build version) of the Java Standard Edition (SE) to install. Must be used together with version_major. For example, 'b13'.

java_se

Type of Java SE to install, jdk or jre.

ensure

Install or remove the package.

oracle_url

Official Oracle URL to download the binaries from.

proxy_server

Specify a proxy server, with port number if needed. ie: https://example.com:8080. (passed to archive)

proxy_type

Proxy server type (none|http|https|ftp). (passed to archive)

url

Pass an entire URL to download the installer from rather than building the complete URL from other parameters. This will allow the module to be used even if the URLs are changed by Oracle. If this parameter is used, matching version_major and version_minor parameters must also be passed to the class.

url_hash

Directory hash used by the download.oracle.com site. This value is a 32 character string which is part of the file URL returned by the JDK download site.

Facts

The java module includes a few facts to describe the version of Java installed on the system:

  • java_major_version: The major version of Java.
  • java_patch_level: The patch level of Java.
  • java_version: The full Java version string.
  • java_default_home: The absolute path to the java system home directory (only available on Linux). For instance, the java executable's path would be ${::java_default_home}/jre/bin/java. This is slightly different from the "standard" JAVA_HOME environment variable.
  • java_libjvm_path: The absolute path to the directory containing the shared library libjvm.so (only available on Linux). Useful for setting LD_LIBRARY_PATH or configuring the dynamic linker.

Note: The facts return nil if Java is not installed on the system.

Limitations

This module cannot guarantee installation of Java versions that are not available on platform repositories.

This module only manages a singular installation of Java, meaning it is not possible to manage e.g. OpenJDK 7, Oracle Java 7 and Oracle Java 8 in parallel on the same system.

Oracle Java packages are not included in Debian 7 and Ubuntu 12.04/14.04 repositories. To install Java on those systems, you'll need to package Oracle JDK/JRE, and then the module can install the package. For more information on how to package Oracle JDK/JRE, see the Debian wiki.

This module is officially supported for the following Java versions and platforms:

OpenJDK is supported on:

  • Red Hat Enterprise Linux (RHEL) 5, 6, 7
  • CentOS 5, 6, 7
  • Oracle Linux 6, 7
  • Scientific Linux 5, 6
  • Debian 6, 7
  • Ubuntu 10.04, 12.04, 14.04
  • Solaris 11
  • SLES 11 SP1, SP2, SP3, SP4; SLES 12, SP1, SP2
  • OpenBSD 5.6, 5.7

Sun Java is supported on:

  • Debian 6

Oracle Java is supported on:

  • CentOS 6
  • CentOS 7
  • Red Hat Enterprise Linux (RHEL) 7

Known issues

Where Oracle change the format of the URLs to different installer packages, the curl to fetch the package may fail with a HTTP/404 error. In this case, passing a full known good URL using the url parameter will allow the module to still be able to install specific versions of the JRE/JDK. Note the version_major and version_minor parameters must be passed and must match the version downloaded using the known URL in the url parameter.

OpenBSD

OpenBSD packages install Java JRE/JDK in a unique directory structure, not linking the binaries to a standard directory. Because of that, the path to this location is hardcoded in the java_version fact. Whenever you upgrade Java to a newer version, you have to update the path in this fact.

FreeBSD

By default on FreeBSD, Puppet versions prior to 4.0 throw an error saying pkgng is not the default provider. To fix this, install the zleslie/pkgng module and set it as the default package provider:

Package {
  provider => 'pkgng',
}

On Puppet 4.0 and later, pkgng is included within Puppet and is the default package provider.

Development

Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. To contribute to Puppet projects, see our module contribution guide.

Contributors

The list of contributors can be found at https://github.com/puppetlabs/puppetlabs-java/graphs/contributors.