Ansible Role: ctop

Role to download and install ctop the top-like interface for container metrics. View CPU, RAM and network I/O for your Docker containers at a glance from your terminal.

Requirements

• Ansible >= 2.4

• Linux Distribution

  • Debian Family

    • Debian

      • Jessie (8)
      • Stretch (9)

    • Ubuntu

      • Trusty (14.04)
      • Xenial (16.04)
      • Bionic (18.04)

  • RedHat Family

    • CentOS

      • 7

    • Fedora

      • 28

  • SUSE Family

    • OpenSUSE

      • 42.2

  • Note: other versions are likely to work but have not been tested.

• Docker (already installed)

Role Variables

The following variables will change the behavior of this role (default values are shown below):

# ctop version number
ctop_version: '0.7.1'

# SHA256 sum for the ctop redistributable
ctop_redis_sha256sum: '38cfd92618ba2d92e0e1262c0c43d7690074b4b8dc77844b654f8e565166b577'

# Directory to store files downloaded for ctop
ctop_download_dir: "{{ x_ansible_download_dir | default(ansible_env.HOME + '/.ansible/tmp/downloads') }}"

Example Playbook

- hosts: servers
  roles:
    - role: gantsign.ctop

Tab Completion for Zsh

Using Ansible

We recommend using the gantsign.antigen role to enable tab completion for ctop (this must be configured for each user).

- hosts: servers
  roles:
    - role: gantsign.ctop

    - role: gantsign.antigen
      users:
        - username: example
          antigen_bundles:
            - name: ctop
              url: gantsign/zsh-plugins
              location: ctop

Using Antigen

If you prefer to use Antigen directly add the following to your Antigen configuration:

antigen bundle gantsign/zsh-plugins ctop

More Roles From GantSign

You can find more roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule to aid in the development and testing; the role is unit tested using Testinfra and pytest.

To develop or test you'll need to have installed the following:

• Linux (e.g. Ubuntu)
• Docker
• Python (including python-pip)
• Ansible
• Molecule

To test this role run the following command from the project root:

molecule test

License

MIT

Author Information

John Freeman

GantSign Ltd. Company No. 06109112 (registered in England)