Skip to content

Commit

Permalink
Rename face
Browse files Browse the repository at this point in the history
  • Loading branch information
tkishel committed Dec 5, 2018
1 parent 242bf78 commit 38dfcbe
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

> The fault, dear Brutus, is not in our stars, but in our defaults, that we are under-allocated.
This module provides a Puppet subcommand that outputs settings for Puppet Enterprise services based upon available hardware resources.
This module provides a Puppet subcommand that outputs optimized settings for Puppet Enterprise services based upon available hardware resources.

## Setup

Expand All @@ -26,7 +26,7 @@ git clone https://github.com/tkishel/pe_tune.git /etc/puppetlabs/code/modules/pe

## Usage

1. Run the `puppet pe_tune tune` command as root on the Primary Master.
1. Run the `puppet pe tune` command as root on the Primary Master.
1. Verify the optimized settings.
1. Add the optimized settings to Hiera.
1. Remove any duplicate settings from the Console.
Expand All @@ -36,7 +36,7 @@ git clone https://github.com/tkishel/pe_tune.git /etc/puppetlabs/code/modules/pe

##### `--common`

Extract common settings from per-node settings.
Extract common settings from node-specific settings.

A common setting is one with a value that is not unique to a specific node.

Expand Down Expand Up @@ -84,7 +84,7 @@ Amount of RAM to reserve for the OS.

## Reference

This module reads the configuration files on the Primary Master, queries PuppetDB for node group membership to identify PE Infrastructure nodes, queries PuppetDB for processor and memory facts for each PE Infrastructure node, and outputs optimized settings in YAML format use in Hiera.
This module queries PuppetDB for node group membership to identify PE Infrastructure nodes, queries PuppetDB for processor and memory facts for each PE Infrastructure node, and outputs optimized settings in YAML format use in Hiera.

### Output

Expand All @@ -93,7 +93,7 @@ By default, optimized settings are output to STDOUT.
For example:

```shell
[root@master ~] puppet pe_tune tune
[root@pe-master ~] puppet pe tune
# Puppet Infrastructure Summary: Found a Monolithic Infrastructure

# Found 8 CPU(s) / 16384 MB RAM for Primary Master pe-master.puppetdebug.vlan
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
require 'puppet/application/face_base'

# This subcommand is implemented as a face.
# The definition of the application can be found in lib/puppet/face/pe_tune.rb.
# The definition of the application can be found in lib/puppet/face/pe.rb.

class Puppet::Application::Pe_tune < Puppet::Application::FaceBase
class Puppet::Application::Pe < Puppet::Application::FaceBase
end
2 changes: 1 addition & 1 deletion lib/puppet/face/pe_tune.rb → lib/puppet/face/pe.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
require_relative '../../puppet_x/puppetlabs/tune/inventory'
require_relative '../../puppet_x/puppetlabs/tune/query'

Puppet::Face.define(:pe_tune, '1.0.0') do
Puppet::Face.define(:pe, '1.0.0') do
summary _('Inspect infrastructure and output settings')
description <<-'DESC'
Collects information about your Puppet Enterprise installation.
Expand Down
2 changes: 1 addition & 1 deletion tasks/init.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"description": "Run 'puppet tune pe' on the primary master",
"description": "Run 'puppet pe tune' on the primary master",
"input_method": "stdin",
"supports_noop": false,
"parameters": {
Expand Down
2 changes: 1 addition & 1 deletion tasks/init.rb
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ def return_command_results(_params, command_results)
params = read_parameters

command = 'puppet'
options = ['pe_tune', 'tune',
options = ['pe', 'tune',
params['common'],
params['hiera'],
params['memory_per_jruby'],
Expand Down

0 comments on commit 38dfcbe

Please sign in to comment.