oracle_inventory
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, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.3.0 < 8.0.0
- , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'zerodecimal-oracle_inventory', '0.6.7'Learn more about managing modules with a PuppetfileDocumentation
oracle_inventory
Table of Contents
- Description
- Setup - The basics of getting started with oracle_inventory
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module provides an Oracle inventory parser that produces a set of facts showing what Oracle products are installed on your system. For non-Windows servers, it also includes a class to manage the contents of the inventory pointer file.
The inventory parser begins with the central inventory XML file, then inspects all installed (not removed) homes referenced therein. If there is a product installed in a home that matches a known component ID (see Reference section below), a fact is created with that home location, version, and install date/time. In the case of CRS and Database homes, PSU (patch set update) versions and install date/times are included.
These facts can be useful in configuring servers with Oracle products installed. For example, when the Puppet agent runs after a database home is installed, a fact called "oracle_db_home" is created and can then be used to set the oracle user's environment.
The facts can also be useful for inventory reports. For example, to see the latest patch set update (PSU) applied to all the databases in an environment.
Puppet version 4.3 is required because this module makes use of features such as strong data typing.
Setup
Install the oracle_inventory module to add the facts and classes to your environment.
What oracle_inventory affects
Agent nodes will need to be able to install the xml-simple Ruby gem using the puppet_gem provider. The ensure_packages function is used for this, to give users the freedom to manage this package resource in another module.
If you wish to avoid the xml-simple requirement, there is a REXML version of the fact script under examples. Feel free to pull it out and put it under some other module. It produces the same output but takes a little bit longer to run.
Setup Requirements
puppetlabs/stdlib >= 4.13.1 < 7.0.0 is required.
Beginning with oracle_inventory
The module can simply be installed with a Puppetfile entry and the facts will be available (as long as the xml-simple gem is installed). To manage the inventory pointer file, include the oracle_inventory class in some profile manifest. To accept the default parameters:
include ::oracle_inventory
Usage
To manage the Oracle inventory pointer file with non-default parameters, declare the class in this format:
class { '::oracle_inventory':
file_owner => 'oracle',
file_group => 'oinstall',
inventory_dir => '/home/oracle/oraInventory',
}
To install the xml-simple gem and use the facts, but not manage the Oracle inventory pointer file, declare the class as such:
class { '::oracle_inventory':
manage_pointer => false,
}
Reference
Facts
oracle_inventory_pointer
Description: Central inventory pointer file location
Datatype: String
oracle_inventory
Description: Central inventory file location
Datatype: String
oracle_crs_home
Description: CRS home information, including ASM ORACLE_SID from oratab
Datatype: Hash
oracle_rac_nodes
Description: List of RAC cluster nodes
Datatype: Array
oracle_scan_name
Description: Single Client Access Name for RAC clusters
Datatype: String
oracle_db_home
Description: Database home information, including ORACLE_SID(s) from oratab
Datatype: Hash
oracle_oms_home
Description: OMS (Enterprise Manager) home information
Datatype: Hash
oracle_em_agent_home
Description: Enterprise Manager Agent home information
Datatype: Hash
oracle_ebs_home
Description: EBS application (Fusion Middleware) home information
Datatype: Hash
oracle_endeca_home
Description: Endeca home information
Datatype: Hash
oracle_wls_home
Description: WebLogic home information
Datatype: Hash
oracle_client_home
Description: Database Client home information
Datatype: Hash
Limitations
Supported Operating Systems
- RedHat
- CentOS
- Oracle Linux
- Scientific Linux
- Windows
Supported Oracle versions
The included facts are known to work on the following Oracle software versions. They have not been tested against any others.
- CRS: 11g, 12cR1, 12cR2, 18c, 19c
- Database: 11g, 12cR1, 12cR2, 18c, 19c
- Database Client: 11g, 12c, 19c
- Enterprise Manager (OMS and Agent): 12c, 13c
- E-Business Suite: 12.2 (when there is a single pointer file and central inventory)
- WebLogic: 11g, 12c
Development
Contributions are always welcome - please submit a pull request or issue on GitHub.
Contributors
The list of contributors can be found at: https://github.com/zerodecimal/zerodecimal-oracle_inventory/graphs/contributors.
Reference
Table of Contents
Classes
oracle_inventory: Provides facts from central inventory interrogation.oracle_inventory::inventory_pointer: Manages the Oracle central inventory location pointer.
Classes
oracle_inventory
oracle_inventory
This module manages the Oracle central inventory pointer, and provides facts from the inventory.
Examples
include oracle_inventory
Parameters
The following parameters are available in the oracle_inventory class:
manage_pointer
Data type: Boolean
Whether or not to manage the inventory pointer file
Default value: true
ensure
Data type: Enum['present', 'absent']
Should the pointer file exist
Default value: 'present'
file_owner
Data type: String
Pointer file owner
Default value: 'root'
file_group
Data type: String
Pointer file group
Default value: 'root'
file_mode
Data type: Stdlib::Filemode
Pointer file permissions
Default value: '0644'
pointer_file
Data type: Optional[Stdlib::UnixPath]
Full path to the pointer file
Default value: $::facts[oracle_inventory_pointer]
inventory_dir
Data type: Stdlib::UnixPath
Directory for the inventory_loc entry in the pointer file
Default value: '/u01/app/oraInventory'
inst_group
Data type: String
Value for the inst_group entry in the pointer file
Default value: 'oinstall'
oracle_inventory::inventory_pointer
oracle_inventory::inventory_pointer
This class manages the Oracle central inventory location pointer.
Examples
include oracle_inventory::inventory_pointer
Parameters
The following parameters are available in the oracle_inventory::inventory_pointer class:
ensure
Data type: Any
Default value: $::oracle_inventory::ensure
file_owner
Data type: Any
Default value: $::oracle_inventory::file_owner
file_group
Data type: Any
Default value: $::oracle_inventory::file_group
file_mode
Data type: Any
Default value: $::oracle_inventory::file_mode
pointer_file
Data type: Any
Default value: $::oracle_inventory::pointer_file
inventory_dir
Data type: Any
Default value: $::oracle_inventory::inventory_dir
inst_group
Data type: Any
Default value: $::oracle_inventory::inst_group
Changelog
All notable changes to this project will be documented in this file.
Release 0.6.7
- Ignore ASM Proxy instances in oratab
Release 0.6.6
- Added a default value for oracle_base
Release 0.6.5
- Added oracle_base to oracle_crs_home and oracle_db_home
Release 0.6.4
- Updated documentation
BREAKING CHANGE:
- Updated OS compatibility list
Release 0.6.3
- Bugfix: Prevent oracle_rac_nodes from being defined if empty
Release 0.6.2
- Added owner to oracle_crs_home
- Changed the source file for oracle_rac_nodes
Release 0.6.1
- Added OPatch version to oracle_crs_home and oracle_db_home
Release 0.6.0
BREAKING CHANGE:
- This module now requires stdlib >= 8.0.0 due to changes in ensure_packages function parameters
Release 0.5.6
- Additional pattern match for WebLogic home
Release 0.5.5
- Updated to PDK v1.18.1
Release 0.5.4
- Updated module dependency
Release 0.5.3
- Updated to PDK v1.15.0
Release 0.5.2
- Added support for 32 bit program files on 64 bit Windows
Release 0.5.1
- Added check for Endeca home (oracle_endeca_home fact)
Release 0.5.0
- Added protection from missing XML tags
- Updated to PDK v1.5.0
- Updated module documentation
Release 0.4.9
- Updated the PDK template to version 1.4.1
Release 0.4.8
- Added documentation for oracle_scan_name fact
- Minor update to example script
Release 0.4.7
- Feature: Added oracle_scan_name fact
Release 0.4.6
- Documentation formatting changes
Release 0.4.5
- Travis CI configuration changes
Release 0.4.4
- Formatting, documentation, and unit test updates
Release 0.4.3
- Bugfix: Fixed Windows bug with nil oratab_file variable
Release 0.4.2
- Bugfix: Fixed Windows bug with oracle_inventory_pointer fact
Release 0.4.1
- Bugfix: Updated oratab location for Unix servers
Release 0.4.0
- Feature: Added ASM SID to oracle_crs_home fact
- No longer allowing facts to be created with empty string or array values
Release 0.3.0
- Feature: Added oracle_inventory_pointer fact
- Added license and documentation
Release 0.2.0
- Bugfix: Changed component lookup from EXT_NAME in first component listed, to standard component ID in NAME (first encounterd match)
- Bugfix: Added function to sort installed PSU list by inst_time, instead of just grabbing the last one in the list
- Feature: Added ensure_packages function to manage xml-simple dependency
- Feature: Standardized fact names to begin with "oracle_" in all cases
- Feature: Added oracle_inventory fact
- Feature: Added several class parameters
Release 0.1.0
- Initial commit
Dependencies
- puppetlabs/stdlib (>= 8.0.0 < 9.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 2018 Eric Miller
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.