1. Foreman Cockpit 1.0 manual

Foreman Cockpit allows you to see a host’s Cockpit in Foreman.

Cockpit is a lightweight service that runs in your hosts, and allows you to perform sysadmin tasks through a web UI.

Integration between Cockpit and Foreman is seamless. Foreman automatically detects which of your hosts are running Cockpit.

gif demoing foreman_cockpit

2. Installation

As of Foreman 1.11+, the foreman-installer is able to automatically install the package and proceed with all necessary steps. To do this, re-run the installer with the following option:

# foreman-installer --enable-foreman-plugin-cockpit

Important note: Executing foreman-installer will re-deploy all foreman-related configuration files. In case changes have been made, proceed with manual installation.

2.1.2 Manual installation

If this is the first plugin you’re installing, please see the plugin repository section to set up the repository first.

To install Foreman Cockpit, run the following:

  • Red Hat based (RHEL, CentOS…)

    # yum install tfm-rubygem-foreman_cockpit
    
  • Fedora

    # yum install rubygem-foreman_cockpit
    
  • Debian based (Debian, Ubuntu…)

    # apt-get install ruby-foreman-cockpit
    

Restarting Foreman might be needed after installing the package.

3. Usage

Using Foreman Cockpit is incredibly easy. It requires no configuration after installing the package, so just click on a host where Cockpit is enabled, and you will see a Cockpit button on the top bar.

top bar with cockpit

Only hosts associated with an operating system of the Fedora, Red Hat, Archlinux, and Ubuntu families are compatible with Foreman Cockpit, because Cockpit can only be installed in these systems for the moment.

Any user in Foreman that has the ‘Host/managed’ ‘console_hosts’ permission in any of its roles, will be able to see it.

If you need help installing or running Cockpit in the host, please visit the Cockpit project installation guide.

You should make sure the Foreman host can contact the host at ‘http://$HOSTFQDN:9090’, which is Cockpit’s service. Please make sure your firewall allows incoming connections from the Foreman host in the target host, and outgoing connections from Foreman to the target host.

4. Help

Please follow our standard procedures and contacts.

4.1 Troubleshooting

If you find a bug, please file it in Redmine.

See the troubleshooting section in the Foreman manual for more info.

4.2 Contributing

Follow the same process as Foreman for contributing. Sources at github.com/theforeman/foreman_cockpit

Foreman 1.21.3 has been released! Follow the quick start to install it.

Foreman 1.20.2 has been released! Follow the quick start to install it.