Initial public release

Author: bespokebob

CHANGELOG.md

@@ -0,0 +1,16 @@
+## Initial Public Release 0.2.0
+### Summary
+
+The first version released on GitHub and Puppet Forge
+
+
+## Private Beta Release 0.1.0
+### Summary
+
+The initial private beta test given to customers.
+
+#### Features
+
+- Agent can be installed on Windows and Linux
+- Agent Tag file is created
+- Agent and EG services can be managed

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# How to Contribute
+
+## Short version
+
+Essentially, do the normal GitHub thing - fork and pull request. We track issues in this repository.
+
+This project is [Apache 2.0 licensed](LICENSE). By contributing to this project,
+you agree to the terms of the license, and you agree that you have the right to
+submit your contribution under the terms of the license.
+
+## Slightly longer version
+
+* Submit an issue in this repository for any bug or feature request.
+* Fork this repository.
+* Create a topic branch in your fork named after the issue.
+  * Optionally with a short description like `issue-42-answer-everything`
+* Commit your changes to the branch, referencing the issue in your commit message.
+  * Your commit message should have a summary line, followed by an empty line, followed by a description of the commit.
+  * Create or update any tests and documentation as needed.
+* Submit a pull request to this repository.
+
+## Testing
+
+Because the modules require a copy of the agent install files to function,
+you must supply a local path to the files for Beaker to copy them to the
+node under test. Use the `TE_AGENT_install_root` environment variable for this.
+
+Testing this module at Tripwire is done with our own internal Vagrant cluster
+and box files. Those nodesets are not in this repository, as they will not run
+for anyone else. There is a default nodeset defined using a public puppetlabs
+box, but we do not use it for testing.

Gemfile

@@ -0,0 +1,23 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+puppetversion = ENV.key?('PUPPET_VERSION') ? ENV['PUPPET_VERSION'] : ['>= 3.3']
+gem 'metadata-json-lint'
+gem 'puppet', puppetversion
+gem 'puppetlabs_spec_helper', '>= 1.0.0'
+gem 'puppet-lint', '>= 1.0.0'
+gem 'puppet-strings'
+gem 'facter', '>= 1.7.0'
+gem 'rspec-puppet'
+
+# rspec must be v2 for ruby 1.8.7
+if RUBY_VERSION >= '1.8.7' && RUBY_VERSION < '1.9'
+  gem 'rspec', '~> 2.0'
+  gem 'rake', '~> 10.0'
+else
+  # rubocop requires ruby >= 1.9
+  gem 'rubocop'
+end
+
+group :acceptance do
+  gem 'beaker-rspec'
+end

LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

NOTICE

@@ -0,0 +1,3 @@
+Puppet Module - tripwire-te_agent
+
+Copyright 2017 Tripwire, Inc.

README.md

@@ -1,2 +1,115 @@
-# puppet-te_agent
-Puppet module for installing the Tripwire Enterprise Agent
+# te_agent
+
+#### Table of Contents
+
+1. [Module Description - What the module does and why it is useful](#module-description)
+1. [Setup - The basics of getting started with te_agent](#setup)
+    * [Setup requirements](#setup-requirements)
+    * [Beginning with te_agent](#beginning-with-te_agent)
+1. [Usage - Configuration options and additional functionality](#usage)
+1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+1. [Limitations - OS compatibility, etc.](#limitations)
+1. [Development - Guide for contributing to the module](#development)
+
+## Module Description
+
+The te_agent module installs, configures, and manages the services of the
+Tripwire Enterprise Agent.
+
+## Setup
+
+### Setup Requirements
+
+The Tripwire Enterprise Agent needs a Tripwire Enterprise Console server
+to connect to. The server hostname and services passphrase are needed
+to configure the Agent.
+
+The Agent install files must be staged somewhere on the target system. This can
+be a network drive, or you can use a separate `file` resource to manually copy
+the package files to the target system.
+
+The MSI provider for Windows is a little more forgiving and may work with URLs
+or network drive paths.
+
+### Beginning with te_agent
+
+At minimum, you must specify the hostname and services passphrase for the
+Tripwire Enterprise Console and the source path to the agent installer.
+
+```puppet
+class { 'te_agent':
+  package_source         => '/mnt/share/tripwire/te_agent.bin',
+  te_server_host         => 'teconsole.example.com',
+  te_services_passphrase => 'correct horse battery staple',
+}
+```
+
+## Usage
+
+All parameters for the te_agent module are contained within the main `te_agent` class, so for any function of the module, set the options you want. See the common usages below for examples.
+
+Examples omit common parameters for brevity.
+
+### Staging the installer
+
+```puppet
+file {'/tmp/te_agent.bin':
+  ensure => file,
+  mode   => '0700',
+  source => 'http://files.example.com/te_agent/linux/x86_64/te_agent.bin'
+}
+class { 'te_agent':
+  package_source => '/tmp/te_agent.bin'
+}
+```
+
+### Setting Custom Tags
+
+```puppet
+class { 'te_agent':
+  ...
+  tags => {
+    'tagset_1' => 'tag1',
+    'tagset_2' => ['tag2a', 'tag2b'],
+  },
+}
+```
+
+### Setting custom agent.properties
+
+```puppet
+class { 'te_agent':
+  ...
+  agent_properties => {
+    'tw.launcher.debug'  => 'true',
+    'tw.rmi.socketDebug' => 'true',
+  },
+}
+```
+
+## Reference
+
+The full reference documentation can be generated with Puppet Strings:
+
+```
+$ bundle exec rake strings:generate
+```
+
+HTML documentation will be created under the ./doc/ directory.
+
+## Limitations
+
+The te_agent module was tested with Puppet 4.10, though it should work on 4.9
+or later (or Puppet Enterprise 2017.1 or later).
+
+The following Operating Systems have been tested with this module:
+
+* Red Hat 5, 6, 7
+* CentOS 5, 6, 7
+* Windows 7, 8.1, 10, Server 2008 R2, Server 2012 R2, Server 2016
+
+Other versions may work if they are supported by both Puppet and the Tripwire Enterprise Agent.
+
+## Development
+
+See the [contribution guidelines](CONTRIBUTING.md) for more information.