(FM-7921) - Implement Puppet Strings
This commit is contained in:
@@ -95,94 +95,7 @@ java::oracle { 'jdk8' :
|
||||
|
||||
## 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.
|
||||
For information on the classes and types, see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-java/blob/master/REFERENCE.md). For information on the facts, see below.
|
||||
|
||||
### Facts
|
||||
|
||||
|
||||
Reference in New Issue
Block a user