Forge Home

htop

Managing htop's configuration

8,286 downloads

169 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Jan 15th 2024
This version is compatible with:
  • Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 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.0.0 < 9.0.0
  • , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'deric-htop', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add deric-htop
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install deric-htop --version 1.0.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

deric/htop — version 1.0.2 Jan 15th 2024

puppet-htop

Puppet
Forge Tests Puppet Forge
Downloads

Manages htop package and its configuration with Hiera support (optional).

Usage

Basic definition will install htop package and create /root/.config/htop/htoprc file:

include htop

Since htop 3, you can configure screens:

htop::users:
  john:
    options:
      config_reader_min_version: 3
    screens:
      - name: 'Main'
        header: 'PID USER PRIORITY NICE M_VIRT M_RESIDENT M_SHARE STATE PERCENT_CPU PERCENT_MEM TIME Command'
        config:
          sort_key: PERCENT_MEM

note, the config should include config_reader_min_version=3.

In most cases you probably want to override just some configuration

htop::users:
  root:
    options:
      sort_key: 47 # memory
      highlight_base_name: 1

But you can also change global settings (applies to multiple accounts) e.g. via Hiera:

htop::defaults:
  sort_key: 47 # sort by memory
  highlight_base_name: 1

you can configure different options for each account:

htop::users:
  foo:
    options:
      hide_kernel_threads: 0
  bar:
    options:
      tree_view: 1

user options will be merged into global defauls (defined in htop::config::defaults).

or directly via puppet code:

class{'htop':
  defaults => {
    sort_key => 46,
  }
}

All Puppet variables are documented in REFERENCE.md.

Installation

Preferably using libarian or r10k:

mod 'deric-htop'

Requirements

  • Puppet >= 7
  • Ruby 2.7 and newer

Dependencies

  • puppetlabs-stdlib - >= 2.5.0