ibm_installation_manager
Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
- , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-ibm_installation_manager', '3.0.1'
Learn more about managing modules with a PuppetfileDocumentation
ibm_installation_manager
Table of Contents
- Module Description
- Setup - The basics of getting started with ibm_installation_manager
- Usage - Configuration options and additional functionality
- Reference - Classes and Parameters
- Limitations - OS compatibility, etc.
- Dependencies
- Development and Contributing
- Authors
Module Description
This module installs the IBM Installation Manager. Optionally, it can deploy the installation from a source such as HTTP or a local file path.
This module can also manage the installation of software from IBM packages (for example, WebSphere, IHS).
Usage
Installing Installation Manager
To install Installation Manager from an HTTP repository source archive:
class { 'ibm_installation_manager':
deploy_source => true,
source => 'http://internal.lan/packages/IM.zip',
}
If you've already extracted the archive, install Installation Manager from the existing path:
class { 'ibm_installation_manager':
source_dir => '/path/to/installation/IM'
}
To install Installation Manager to a custom location, specify the target location:
class { 'ibm_installation_manager':
source => 'http://internal.lan/packages/IM.zip',
target => '/opt/myorg/IBM',
}
To install the Installation Manager as a non-root user, specify that user's name and its home directory, and set the installation_mode to 'nonadministrator'
class { 'ibm_installation_manager':
deploy_source => true,
source => 'http://internal.lan/packages/IM.zip',
user => 'iim_user',
user_home => '/home/iim_user',
installation_mode => 'nonadministrator',
}
Installing software packages
To install software with IBM Installation Manager, use the ibm_pkg
type. This type includes the imcl
provider, which uses the Installation Manager's imcl
command-line tool to handle installation.
This provider installs the specified version or greater is installed. This is partly due to the nature of how IBM software is deployed (by a downloaded/extracted archive).
To install a package from an extracted source:
ibm_pkg { 'com.ibm.websphere.NDTRIAL.v85':
ensure => 'present',
package => 'com.ibm.websphere.NDTRIAL.v85',
version => '8.5.5000.20130514_1044',
target => '/opt/IBM/WebSphere85',
repository => '/vagrant/ibm/websphere/repository.config',
}
The above code installs a WebSphere 8.5 package from an extracted source at /vagrant/ibm/websphere/
to /opt/IBM/WebSphere85
You can also provide the package source and other parameters in a custom response file:
ibm_pkg { 'com.ibm.websphere.NDTRIAL.v85':
ensure => 'present',
response => '/mnt/resources/was_response_file.xml',
}
Reference
See REFERENCE.md
Limitations
This module has only been tested with IBM Installation Manager 1.8.7.
For an extensive list of supported operating systems, see metadata.json
Known Issues
The installer exits 0 even if it failed.
ERROR: java.lang.IllegalStateException: No metadata found for installed package com.ibm.cic.agent 1.6.2000.20130301_2248.
Dependencies
- puppetlabs/stdlib
- If you want the module to extract the Zip file for you, puppet/archive.
Development and Contributing
Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our module contribution guide.
Contributors
This module was contributed to by Josh Beard and other contributors.
Reference
Table of Contents
Classes
Resource types
ibm_pkg
: Custom type for installing an IBM package.
Classes
ibm_installation_manager
The ibm_installation_manager class.
Parameters
The following parameters are available in the ibm_installation_manager
class:
deploy_source
source
source_dir
target
manage_user
user
user_home
manage_group
group
options
timeout
installation_mode
install_unzip_package
deploy_source
Data type: Any
Default value: false
source
Data type: Any
Default value: undef
source_dir
Data type: Any
Default value: undef
target
Data type: Any
Default value: undef
manage_user
Data type: Any
Default value: false
user
Data type: Any
Default value: 'root'
user_home
Data type: Any
Default value: undef
manage_group
Data type: Any
Default value: false
group
Data type: Any
Default value: 'root'
options
Data type: Any
Default value: undef
timeout
Data type: Any
Default value: '900'
installation_mode
Data type: Any
Default value: 'administrator'
install_unzip_package
Data type: Any
Default value: true
Resource types
ibm_pkg
Custom type for installing an IBM package.
Properties
The following properties are available in the ibm_pkg
type.
ensure
Valid values: present
, absent
The basic property that the resource should be in.
Default value: present
Parameters
The following parameters are available in the ibm_pkg
type.
imcl_path
jdk_package_name
jdk_package_version
manage_ownership
name
options
package
package_group
package_owner
provider
repository
response
target
user
version
imcl_path
The full path to the imcl executable. This is optional. The provider will attempt to locate imcl by parsing //InstallationManager/installed.xml. If, for some reason, it cannot be discovered or if you need to provide a specific path, you may do so with this parameter.
jdk_package_name
If a JDK must be installed separately (as in the case of Websphere Application Server 9), specify the package_name here (everything before the underscore in the IBM package name).
jdk_package_version
If a JDK must be installed separately (as in the case of Websphere Application Server 9), specify the version here. Like 'version', this parameter refers to the number after the underscore in the IBM package name.
manage_ownership
Valid values: true
, false
, yes
, no
Whether or not to manage the ownership of installed packages. Allows for packages to not be installed as root.
Default value: true
name
namevar
An arbitrary name to identify the resource.
options
Any custom options to pass to the 'imcl' tool for installing the package.
package
The IBM package name. Example: com.ibm.websphere.IBMJAVA.v71 This is the first part of the traditional IBM full package name, before the first underscore.
package_group
The group that should own this package installation. Only used if manage_ownership is true.
Default value: root
package_owner
The user that should own this package installation. Only used if manage_ownership is true.
Default value: root
provider
The specific backend to use for this ibm_pkg
resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
repository
The full path to the 'repository.config' file for installing this package.
response
Full path to an optional response file to use. The user is responsible for ensuring this file is present.
target
The full path to install the specified package to. Corresponds to the 'imcl' option '-installationDirectory'.
user
The user to run the 'imcl' command as.
Default value: root
version
The version of the package. Example: 7.1.2000.20141116_0823 This is the second part of the traditional IBM full package name, after the first underscore.
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v3.0.1 (2021-04-12)
Fixed
- (maint) Frozenstring fix #181 (sheenaajay)
v3.0.0 (2021-03-03)
Changed
- pdksync - (MAINT) Remove RHEL 5 family support #176 (sanfrancrisko)
- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #172 (carabasdaniel)
Added
- pdksync - (feat) Add support for Puppet 7 #166 (daianamezdrea)
v2.2.1 (2020-11-16)
Fixed
- (IAC-990) - Removal of inappropriate terminology #160 (david22swan)
v2.2.0 (2020-06-26)
Added
- Make installation of unzip optional #141 (haloflightleader)
v2.1.0 (2019-12-09)
Added
- (FM-8675) - Addition of Support for CentOS8 #136 (david22swan)
- (FM-8027) Add RedHat 8 support #124 (eimlav)
Fixed
- Timestamp retrieval function now Puppet native #134 (bryanjbelanger)
v2.0.0 (2019-05-14)
Changed
- pdksync - (MODULES-8444) - Raise lower Puppet bound #117 (david22swan)
1.0.0 (2019-02-11)
Changed
- (FM-7710) - Remove Scientific 5 testing/support for IBM Installation Manager #105 (david22swan)
Fixed
0.6.0 (2018-09-27)
Added
- pdksync - (MODULES-6805) metadata.json shows support for puppet 6 #95 (tphoney)
- pdksync - (MODULES-7658) use beaker4 in puppet-module-gems #92 (tphoney)
- (FM-7260) - Addition of support for ubuntu 18.04 #85 (david22swan)
Fixed
- (MODULES-7640) - Update README Limitations section #87 (eimlav)
- (maint) - Removal of support for deprecated OS debian 6 and 7 #86 (david22swan)
- Add Ubuntu 16 to metadata support as it's tested #84 (HelenCampbell)
- MODULES-7308 Services must be stopped when uninstl #83 (mafriedel)
- MODULES-7301 MODULES-7302 #82 (mafriedel)
0.5.0
Summary
This is a small feature release that adds support for IBM Installation Manager 1.8.7 and some new parameters for ibm_pkg
Added
- support for IIM 1.8.7 (MODULES-4738)
jdk_package_name
andjdk_package_version
paramters in the ibm_pkg type
Fixed
- issue for users with non-standard home directories (MODULES-7204)
Supported Release 0.4.0
Summary
This is a small feature release that makes several small fixes while at the same time updating the module to comply with the set rubocop rules and PDK convert.
Added
- The module has been updated to comply with the set Rubocop Rules.
- The module has been updated to work with PDK Convert.
- Migrated from stickler to artifactory.
Fixed
- Error message for 'stopprocs' method fixed.
- Reverted to working version of 'stopprocs' method.
Supported Release 0.3.0
Summary
This is a feature release that allows the user to install as non-root.
Added
- ability to install the IIM as a non-root user (FM-6596)
- change to user's home directory when executing imcl commands
Removed
- Support for Ubuntu 10.04 and 12.04 but compatibility remains intact.
Supported Release 0.2.5
Summary
This small bugfix release that fixes install command options, and module sync changes.
Fixed
- When user is root, use 'installc' as the installation command
Maintenance
- Many modulesync changes
- Update parallel_tests
- Mocha version update
- Add locales directory structure
Supported Release 0.2.4
Summary
This small bugfix release that fixes a failure to append install options
Fixed
- Fixes a failure to append install options to imcl command
Supported Release 0.2.3
Summary
This small bugfix release that fixes a failure to read the install_file
Fixed
- Fixes a failure to read the install file.
Supported Release 0.2.2
Summary
This small bugfix release that fixes an idempotency problem when installing fixpacks
Fixed
- Fixes idempotency problem when installing fixpacks
Supported Release 0.2.1
Summary
This small bugfix release that fixes a potential duplicate resource problem.
Fixed
- Fixes a possible duplicate resource problem
Supported Release 0.2.0
Summary
This release includes feature to manage ibm packages via puppet resource
as well as some bugfixes.
Added
- Adds ability to list
ibm_pkg
resources viapuppet resource
.
Fixed
- Fixes/improves paramater validation in
ibm_pkg
type. - Complete refactor of
ibm_pkg
provider. - Adds more testing.
- Cleanup of README.
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs-stdlib (>= 4.6.0 < 8.0.0)
- puppet-archive (>= 0.4.0 < 5.0.0)
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.