htop

Managing htop's configuration

Project URL RSS Feed Report issues

Module Stats

8,912 downloads

349 latest version

5.0 quality score

Version information

released Jun 21st 2024

This version is compatible with:

Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 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

Installation method

Add this module to your Puppetfile:

mod 'deric-htop', '2.0.1'

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 2.0.1

Documentation

deric/htop — version 2.0.1 Jun 21st 2024

puppet-htop

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

Reference

Classes

htop: Htop is an interactive process viewer for Unix
htop::install: Binary package installation

Defined types

htop::config: Htop configuration files

Data types

Htop::Conf: Single user config
Htop::Screen: Screen
Htop::Screens: Screens (tabs) definition
Htop::Users: Configuration for multiple users

Classes

`htop`

Htop is an interactive process viewer for Unix

Examples

htop::users:
  john:
    sort_key: 47

Parameters

The following parameters are available in the htop class:

package_name
ensure
manage_rc
manage_package
replace
defaults
users

`package_name`

Data type: String

package name in distribution, usually htop

`ensure`

Data type: String

puppeet will force this package version, possible values are present, latest or exact version like 2.0.2

`manage_rc`

Data type: Boolean

Whether htoprc config file should be managed by Puppet at all.

`manage_package`

Data type: Boolean

Whether package should be managed by this module

`replace`

Data type: Boolean

Whether to replace a file or symlink that already exists on the local system but whose content doesn't match what the source or content attribute specifies. Default: true

`defaults`

Data type: Htop::Conf

Default configuration for multiple users

`users`

Data type: Htop::Users

Configuration for multiple users

`htop::install`

Binary package installation

Parameters

The following parameters are available in the htop::install class:

ensure

`ensure`

Data type: String

package ensure

Default value: $htop::ensure

Defined types

`htop::config`

Htop configuration files

Parameters

The following parameters are available in the htop::config defined type:

options
replace
defaults
screens

`options`

Data type: Htop::Conf

Hash containing key-value pairs

Default value: {}

`replace`

Data type: Boolean

Whether to replace a file or symlink that already exists on the local system but whose content doesn't match what the source or content attribute specifies. Default: true

Default value: $htop::replace

`defaults`

Data type: Htop::Conf

Will be overwritten by options hash, can be used to provide system-wide defaults

Default value: $htop::defaults

`screens`

Data type: Htop::Screens

Starting from htop 3.x it's possible to define custom screens

Default value: undef

Data types

`Htop::Conf`

Single user config

Alias of Hash[String[1], Variant[String,Integer,Boolean]]

`Htop::Screen`

Screen

Alias of

Struct[{
  name             => String[1],
  header           => String[1],
  Optional[config] => Htop::Conf,
}]

`Htop::Screens`

Screens (tabs) definition

Alias of Optional[Array[Htop::Screen]]

`Htop::Users`

Configuration for multiple users

Alias of

Hash[String[1], Struct[{
    Optional[options]  => Htop::Conf,
    Optional[replace]  => Boolean,
    Optional[defaults] => Htop::Conf,
    Optional[screens] => Htop::Screens,
  }]]

Changelog

All notable changes to this project will be documented in this file.

Release 2.0.01 [2024-06-21]

Avoid using stdlib::merge function
Puppet 8 compatible

Release 2.0.0 [2024-06-21]

BC use stdlib:: prefix for puppet 4.x functions
stdlib >= 9 is required

Release 1.0.2 [2024-01-15]

Bugfixes

Avoid corrective changes on Debian 10

Release 1.0.1 [2024-01-15]

Bugfixes

Fixed typo in htop::defaults

Release 1.0.0 [2023-12-18]

Support htop 3.x screens
BC removed Hash param htop::config, use htop::defaults instead
Enforce hash structure
Defaults moved to specific distribution
Packages installed using ensure_packages()
Add param manage_package
Template converted to epp
Deep merge configs by default

Release 0.4.0

Use hierarical facts
Removed params class
Puppet 8 and stdlib 9 compatibility

Release 0.3.0

Use types

Release 0.2.0

Bugfixes Using Puppet Types, removed deprecated validate_* functions

Known Issues

                              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.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

htop

Version information

This version is compatible with:

Start using this module

Documentation

puppet-htop

Usage

Installation

Requirements

Dependencies

Reference

Table of Contents

Classes

Defined types

Data types

Classes

htop

Examples

Parameters

package_name

ensure

manage_rc

manage_package

replace

defaults

users

htop::install

Parameters

ensure

Defined types

htop::config

Parameters

options

replace

defaults

screens

Data types

Htop::Conf

Htop::Screen

Htop::Screens

Htop::Users

Changelog

Release 2.0.01 [2024-06-21]

Release 2.0.0 [2024-06-21]

Release 1.0.2 [2024-01-15]

Release 1.0.1 [2024-01-15]

Release 1.0.0 [2023-12-18]

Release 0.4.0

Release 0.3.0

Release 0.2.0

Dependencies

`htop`

`package_name`

`ensure`

`manage_rc`

`manage_package`

`replace`

`defaults`

`users`

`htop::install`

`ensure`

`htop::config`

`options`

`replace`

`defaults`

`screens`

`Htop::Conf`

`Htop::Screen`

`Htop::Screens`

`Htop::Users`