diff --git a/README.md b/README.md index 3792dbc..37dfc25 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ * [Classes and Defined Types](#classes-and-defined-types) * [Class: oracle_java](#class-oracle_java) * [Define: oracle_java::installation](#define-oracle_javainstallation) + * [Common parameters](#common-parameters) 5. [Limitations](#limitations) 6. [Contributors](#contributors) 7. [Credits](#credits) @@ -116,10 +117,6 @@ Primary class and entry point of the module. Installs Java in `/usr/java` Java version to install, formatted as '*major_version*'u'*minor_version*' or simply '*major_version*' for the latest available release in the selected Java SE series. Defaults to `8` *Note*: a minor version of '0' (for example `8u0`) matches the initial release of the selected Java SE series. -#####`type` - -What envionment type to install. Valid values are `jre` and `jdk`. Defaults to `jre` - #####`format` What format of installation archive to retrieve. Valid values are `rpm` and `tar.gz`. Default depends on the platform @@ -128,33 +125,11 @@ What format of installation archive to retrieve. Valid values are `rpm` and `tar Absolute root path where the Oracle Java archives are extracted. Requires `format` set to `tar.gz`. Defaults to `/usr/java` -#####`check_checksum` - -Enable checksum validation on downloaded archives. Boolean value. Defaults to `true` - -#####`add_alternative` - -Add Oracle Java to the system alternatives on compatible platforms (Debian/RHEL/SuSE families). Boolean value. Defaults to `false` - #####`add_system_env` Add `JAVA_HOME` environment variable to the `/etc/environment` file. Boolean value. Defaults to `false` -#####`custom_download_url` - -Do not download the Oracle Java archive from Oracle servers, instead use an alternative URL. Must but the full URL to the archive file or RPM package - -#####`custom_checksum` - -Custom MD5 checksum used to verify the archive integrity. Optional. Defaults to the checksum provided by Oracle - -#####`proxy_server` - -URL of a proxy server used for downloading Java archives - -#####`proxy_type` - -Type of the proxy server. Valid values are `none`, `http`, `https` and `ftp`. Optional. Default determined by the scheme used in `proxy_server` +See also [Common parameters](#common-parameters) ####Define: `oracle_java::installation` @@ -166,25 +141,39 @@ Installs an extra version of Oracle Java in `install_path` Namevar. See [oracle_java::version](#version) +See also [Common parameters](#common-parameters) + +####Common parameters + +Parameters common to both `oracle_java` and `oracle_java::installation` + #####`type` -See [oracle_java::type](#type) +What envionment type to install. Valid values are `jre` and `jdk`. Defaults to `jre` #####`check_checksum` -See [oracle_java::check_checksum](#check_checksum) +Enable checksum validation on downloaded archives. Boolean value. Defaults to `true` #####`add_alternative` -See [oracle_java::add_alternative](#add_alternative) +Add Oracle Java to the system alternatives on compatible platforms (Debian/RHEL/SuSE families). Boolean value. Defaults to `false` #####`custom_download_url` -See [oracle_java::custom_download_url](#custom_download_url) +Do not download the Oracle Java archive from Oracle servers, instead use an alternative URL. Must but the full URL to the archive file or RPM package #####`custom_checksum` -See [oracle_java::custom_checksum](#custom_checksum) +Custom MD5 checksum used to verify the archive integrity. Optional. Defaults to the checksum provided by Oracle + +#####`proxy_server` + +URL of a proxy server used for downloading Java archives + +#####`proxy_type` + +Type of the proxy server. Valid values are `none`, `http`, `https` and `ftp`. Optional. Default determined by the scheme used in `proxy_server` ##Limitations