wlp

Deploy and Manage WebSphere Liberty

Module Stats

7,177 downloads

7,177 latest version

4.5 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Jul 5th 2016

This version is compatible with:

, , ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'ipcrm-wlp', '0.0.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ipcrm-wlp

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ipcrm-wlp --version 0.0.1

Documentation

ipcrm/wlp — version 0.0.1 Jul 5th 2016

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with wlp
- What wlp affects
- Beginning with wlp
Usage - Configuration options and additional functionality
- Classes
- Defines
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

Overview

Module for managing Websphere Liberty

Module Description

This module allows you to install Websphere Liberty, install features or additional archives, configure/manage severs, as well as install applications.

Setup

This module was intended for use with WLP instances that are being installed from standalone archives (zip/jar) - it does NOT make use of IBM installation manager.

What wlp affects

Given no options except install source, wlp will:

Create a wlp user
Install java (using puppetlabs-java module)
Create /opt/ibm
Extract the supplied archive into /opt/ibm/wlp (default install location in params.pp)

No servers are created by default. Any addtional configuration needs to be declared.

Beginning with wlp

To start, we need to declare the base class and provide an installation source

class {'::wlp':
  install_src => 'https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/downloads/wlp/8.5.5.9/wlp-javaee7-8.5.5.9.zip',
}

Next, we can optionally install features. (Feature List)

wlp::feature { 'openidConnectClient-1.0':
  ensure => present,
}

Once we've installed all the bits we want, we can move onto defining servers. We need to provide the contents for the server.xml file (if left blank, you'll just get a default server.xml file). You can setup a new server and give a config like this(just an example, you could use a template here instead of a HEREDOC, that was shown for simplicity).

$config = @("SERVERCONFIG")
<?xml version="1.0" encoding="UTF-8"?>
<server description="new server">

    <featureManager>
        <feature>javaee-7.0</feature>
        <feature>openidConnectClient-1.0</feature>
    </featureManager>


    <basicRegistry id="basic" realm="BasicRealm">
        <!-- <user name="yourUserName" password="" />  -->
    </basicRegistry>

    <application context-root="hello_world" type="war" id="hello_world"
       location="hello_world.war" name="hello_world"/>

    <httpEndpoint id="defaultHttpEndpoint"
                  host="*"
                  httpPort="9080"
                  httpsPort="9443" />

    <applicationManager autoExpand="true"/>
</server>
| SERVERCONFIG

wlp::server{'testserver':
 ensure        => present,
 enable        => true,
 server_config => $config
}

Finally, we can deploy apps from within the DSL if we so choose using the following syntax:

wlp::deploy_app{'hello_world.war':
  type        => 'static',
  server      => 'testserver',
  install_src => '/var/tmp/hello_world.war',
  ensure      => 'present',
}

Here's the combined configuration

$config = @("SERVERCONFIG")
<?xml version="1.0" encoding="UTF-8"?>
<server description="new server">

    <featureManager>
        <feature>javaee-7.0</feature>
        <feature>openidConnectClient-1.0</feature>
    </featureManager>


    <basicRegistry id="basic" realm="BasicRealm">
        <!-- <user name="yourUserName" password="" />  -->
    </basicRegistry>

    <application context-root="hello_world" type="war" id="hello_world"
       location="hello_world.war" name="hello_world"/>

    <httpEndpoint id="defaultHttpEndpoint"
                  host="*"
                  httpPort="9080"
                  httpsPort="9443" />

    <applicationManager autoExpand="true"/>
</server>
| SERVERCONFIG

class {'::wlp':
  install_src => 'https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/downloads/wlp/8.5.5.9/wlp-javaee7-8.5.5.9.zip',
}

wlp::feature { 'openidConnectClient-1.0':
  ensure => present,
}

wlp::server{'testserver':
 ensure        => present,
 enable        => true,
 server_config => $config
}

wlp::deploy_app{'hello_world.war':
  type        => 'static',
  server      => 'testserver',
  install_src => '/var/tmp/hello_world.war',
  ensure      => 'present',
}

Usage

An overview of the classes and defines that make up the wlp module

Classes

`wlp`

This class is soley responsible for the base envionrment setup and installation of the actually software, it does not configure anything

Parameters:

install_src: Required. Provide the path to the installation media. Can be a zip or jar archive.
manage_user: Default True. This parameter will cause the wlp user to be created.
manage_java: Default True. This parameter will cause java to be installed via the puppetlabs-java module.
base_path: Default /opt/ibm. This parameter controls where the software will be installed to.
wlp_user: Default wlp. This parameter controls which user owns and runs the Liberty software.

Defines

`server`

This define allows you to create and manage server instances within your WLP installation.

Parameters:

ensure: Default present. Whether the server should be created or removed.
enable: Default true. Defines if the server should be running or not.
user: The user to run the server as. Defaults to the wlp_user setting from the base wlp class.
base_path: The path WLP is installed. Defaults to the base_path setting in wlp class.
server_config: The configuration for your server. This can be supplied via normal Puppet mechanisms (like templates). If you DO NOT supply this you will get a default server.xml.
server_env: This value configures the server.env file. This can be supplied via normal Puppet mechanisms (like templates). If you DO NOT supply this you will get a default server.env file.

Example

wlp::server{'testserver':
 ensure    => present,
 enable    => true,
 server_config => $config
}

`feature`

This define allows you to install features into your base WLP installation.

Parameters:

ensure: Default present. Whether or not to add or remove the feature.
user: The user to use when applying the new archive(process owner). By default it will inherit this to however the base wlp class is configured.
base_path: The path to install to. By default this is inherited from the base wlp class.

Example

wlp::feature { 'openidConnectClient-1.0':
  ensure => present,
}

`apply_jar`

This define allows you to apply additional jar files to your WLP installation.

Parameters:

creates: Required. The path to check for to validate if this archive has been previously installed. For example /opt/ibm/wlp/extras
install_src: Defaults to $title. The path to the installation media.
user: The user to use when applying the new archive(process owner). By default it will inherit this to however the base wlp class is configured.
base_path: The path to install to. By default this is inherited from the base wlp class, however depending on the archive it may need to be updated.
java_cmd: Default java. The java command to use when installing this archive.

Example

wlp::apply_jar{'https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/downloads/wlp/8.5.5.9/wlp-extended-8.5.5.9.jar':
  creates => 'lib/features/wss4j-1.0.mf',
  notify => Wlp_server_control['testserver'],
}

`deploy_app`

This define allows you to deploy an application, both dropin and static, to a WLP instance.

Parameters:

server: Required. The server to install the application into.
install_src: Required. Where to get the application archive (file/http/https)
type: Required. The type of application this is, dropin or static. Remember that when your deploying a static app you need to update your server config.
ensure: Default present. The state of the application (present/absent)
user: The user to use when deploying the application. By default it will inherit this from the base wlp class.
base_path: The path to install to. By default this is inherited from the base wlp class.

Examples

wlp::deploy_app{'hello_world.war':
  type        => 'static',
  server      => 'testserver',
  install_src => '/var/tmp/hello_world.war',
  ensure      => 'present',
}

Limitations

Although WLP can run accross many platforms, this module currently only supports Linux variants.(Tested. Really anything that is Unix based should work but not tested).

Development

Fork, Add tests, Update, Update CHANGELOG, Update CONTRIBUTORS, PR, repeat.

Types in this module release

wlp_feature

Puppet type for installing IBM Websphere Liberty features

Parameters
accept_license	Setting to accept license agreement, must be true
base_path	Installation path for WLP
download_deps	Whether or not to download dependencies. Valid are true/false
ensure
install_from	Where to install from. If left blank default online repo is used
install_type	Type of install to use. Valid values are usr or extention
name	Feature name to install
provider
verbose	Enable verbose output
wlp_user	user that WLP is installed/running as

Providers
ruby

wlp_server

Puppet type for configuring IBM Websphere Liberty servers

Parameters
base_path	Installation path for WLP
ensure
include	A comma-delimited list of values. The valid values vary depending on the action.
name	Server name to configure
provider
template	Optional. Specify the template to use for setting up the new server
verbose	Enable verbose output
wlp_user	user that WLP is installed/running as

Providers
ruby

wlp_server_control

Puppet type for controlling state of a Websphere Liberty Profile (ie running/stopped)

Parameters
base_path	Installation path for WLP
name	Server name to configure
provider
wlp_user	user that WLP is installed/running as

Properties
ensure	Set the state of server, running or stopped

Providers
ruby

                              Apache License
                        Version 2.0, January 2004
                     http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

   To apply the Apache License to your work, attach the following
   boilerplate notice, with the fields enclosed by brackets "[]"
   replaced with your own identifying information. (Don't include
   the brackets!)  The text should be enclosed in the appropriate
   comment syntax for the file format. We also recommend that a
   file or class name and description of purpose be included on the
   same "printed page" as the copyright notice for easier
   identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

wlp

Contributions Requested

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

Table of Contents

Overview

Module Description

Setup

What wlp affects

Beginning with wlp

Usage

Classes

`wlp`

Defines

`server`

`feature`

`apply_jar`

`deploy_app`

Limitations

Development

Types in this module release

wlp_feature

wlp_server

wlp_server_control

Dependencies