Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpupuli/puppet-stackify
https://github.com/voxpupuli/puppet-stackify
hacktoberfest puppet windows-puppet-module
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/voxpupuli/puppet-stackify
- Owner: voxpupuli
- License: apache-2.0
- Created: 2017-09-18T10:46:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T19:05:49.000Z (4 months ago)
- Last Synced: 2024-10-29T14:22:43.576Z (2 months ago)
- Topics: hacktoberfest, puppet, windows-puppet-module
- Language: Ruby
- Homepage: https://forge.puppet.com/puppet/stackify
- Size: 157 KB
- Stars: 0
- Watchers: 39
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# stackify
[](https://github.com/voxpupuli/puppet-stackify/blob/master/LICENSE)
[](https://travis-ci.org/voxpupuli/puppet-stackify)
[](https://forge.puppetlabs.com/puppet/stackify)
[](https://forge.puppetlabs.com/puppet/stackify)
[](https://forge.puppetlabs.com/puppet/stackify)
#### Table of Contents
1. [Description](#description)
1. [Setup - The basics of getting started with stackify](#setup)
* [Setup requirements](#setup-requirements)
* [Beginning with stackify](#beginning-with-stackify)
1. [Usage - Configuration options and additional functionality](#usage)
* [Install stackify only](#install_stackify_only)
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)
## Description
The stackify module installs and manages the stackify agent and service on Windows systems.
Stackify is an APM tools that uses an agent on nodes that need to be monitored.
## Setup
### Setup Requirements
The stackify module requires the following:
* Puppet Agent 4.7.1 or later.
* Access to the internet.
* Stackify account setup and a license/activation key in hand.
* Windows Server 2012/2012R2/2016.
### Beginning with stackify
To get started with the stackify module simply include the following in your manifest:
```puppet
class { 'stackify':
package_ensure => 'present',
package_install_options_environment => 'development',
package_install_options_activationkey => 'XXXXXXXXXXXXXXXXXXXXXXXXXX',
}
```
This example downloads and installs the latest version of the stackify agent and ensures the stackify services are running and in the desired state. After running this you should see your node pop up in the stackify servers list from the web ui.
A more advanced configuration including all attributes available:
```puppet
class { 'stackify':
package_ensure => 'present',
package_install_options_environment => 'development',
package_install_options_activationkey => 'XXXXXXXXXXXXXXXXXXXXXXXXXX',
file_download_directory => 'C:\\Temp',
service_manage => true,
service_ensure => true,
service_enable => true,
}
```
The above is just an example of the flexibility you have with this module. You will generally never need to specify every or even so many parameters as shown.
## Usage
### Install Stackify only
Sometimes you might want to install the stackify agent but not manage the service.
```puppet
class { 'stackify':
package_ensure => 'present',
package_install_options_environment => 'development',
package_install_options_activationkey => 'XXXXXXXXXXXXXXXXXXXXXXXXXX',
service_manage => false,
}
```
## Reference
### Classes
Parameters are optional unless otherwise noted.
#### `stackify`
Installs, configures, and manages the stackify agent.
#### `package_ensure`
Specifies whether the stackify package resource should be present. Valid options: 'present' and 'absent'.
Default: 'present'.
#### `package_install_options_environment`
*Required.*
Sets the stackify environment for this node.
#### `package_install_options_activationkey`
*Required.*
Your stackify license/activation key so the node can be associated with your stackify account.
#### `file_download_directory`
Specifies which directory to store the downloaded stackify agent installer in.
Default: 'C:\Temp'.
#### `service_manage`
Specifies whether or not to manage the desired state of the stackify windows services.
Default: true.
#### `service_ensure`
Whether or not the stackify services should be running or stopped. Valid options: true, false
Default: true.
#### `service_enable`
Whether or not the stackify services should be enabled at boot or disabled. Valid options: true, false
Default: true.
## Limitations
This module is only available for Windows 2012 or 2012 R2 and works with Puppet 4.0 and later.
## Development
## Contributing
1. Fork it ( https://github.com/voxpupuli/puppet-stackify/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request