Skip to content
Katello integrates open source systems management tools into a single solution for controlling the lifecycle of your machines.
Ruby JavaScript HTML CSS
Failed to load latest commit information.
.tx fix paths in .tx/config after git reorganization Apr 29, 2013
app fixes #15512 - load host_and_hostgroup_edit.js on new host page (#6148) Jun 28, 2016
bin Fixes #15035 - Adding rails script to katello (#6045) May 13, 2016
ca adding redhat-uep.pem to katello ca Oct 5, 2011
config Fixes #15410 - Update route for activation_key... (#6124) Jun 28, 2016
db Fixes #15460 - Viewer Role have content-view rights on upgrade (#6137) Jun 24, 2016
engines/bastion_katello Fixes #11871 - subscription rows match colors when grouped (#6152) Jun 28, 2016
lib Fixes #14938 - Renamed Setting::Katello (#6019) Jun 15, 2016
locale Merge pull request #5760 from bkearney/bkearney/10241 Feb 9, 2016
spec Refs #14950 - Enabling MutableConstant rubocop (#6043) Jun 6, 2016
test Fixes #15410 - Update route for activation_key... (#6124) Jun 28, 2016
vendor Fixes #4062: remove jScrollPane and references. Jun 24, 2016
.gitignore Fixes #13396 - Update the zanata mapping files Jan 26, 2016
.rspec initial commit Jun 15, 2011
.rubocop.yml Fixes #15483 - Turn on AssignmentInCondition cop (#6140) Jun 23, 2016
.rubocop_todo.yml Refs #14950 - Enabling MutableConstant rubocop (#6043) Jun 6, 2016
.simplecov Setup simplecov in katello Mar 5, 2013
.yardopts Add documentation of db schema Jun 4, 2013 Refs #7242: Add 1.5-2.0 Changelog. Sep 12, 2014 Fixes #15034 - Remove old scripts from katello (#6044) May 13, 2016
CONTRIBUTORS adding myself to contrib Jul 1, 2015
Gemfile Engine: Removing old gem files Dec 6, 2013
LICENSE.txt set Markdown as default markup Jan 16, 2013 updates to README file Oct 14, 2015
katello.gemspec Fixes #15144 - update dependencies on foreman-tasks (#6088) Jun 1, 2016

Katello Dependency Status

Full documentation is at


Katello is a systems life cycle management plugin to Foreman. Katello allows you to manage thousands of machines with one click. Katello can pull content from remote repositories into isolated environments, and make subscriptions management a breeze.

Currently, it is able to handle Fedora and Red Hat Enterprise Linux based systems.


The most common way to set up Katello for development is to use katello-deploy. This will set up a Vagrant instance with the Katello codebase checked out. You can also run setup.rb directly with katello-deploy if you prefer to not use Vagrant.

There is also katello-devel-installer if you would like to use that.

If you have questions or issues with any of the above methods, feel free to ask for assistance on #theforeman-dev IRC channel or via the foreman-dev mailing list.

Test Run

At this point, the development environment should be completely setup and the Katello engine functionality available. To verify this, go to your Foreman checkout:

  1. Start the development server

    cd $GITDIR/foreman
    rails s
  2. Access Foreman in your browser (e.g. https://<hostname>/). Note that while Rails will listen on port 3000, the dev installer will set up a reverse proxy so HTTPS on port 443 will work.

  3. Login to Foreman (default: admin and changeme)
  4. If you go to https://<hostname>/about and view the "Plugins" tab, you should see a "Katello" plugin listed.

Reset Development Environment

In order to reset the development environment, all backend data and the database needs to be reset. To reiterate, the following will destroy all data in Pulp, Candlepin and your Foreman/Katello database. From the Foreman checkout run:

rake katello:reset

Found a bug?

That's rather unfortunate. But don't worry! We can help. Just file a bug in our project tracker.


See the developer documentation.

Contact & Resources


Documentation is generated with YARD and hosted at This documentation is intended for developers, user documentation can be found on wiki. Developer documentation contains:

  • code documentation
  • high level guides to architectures and implementation details
  • how-tos

Note: older developer guides can be found on our wiki, they are being migrated.

How to

Current documentation

  • {file:doc/}
  • {file:doc/}


  • {file:doc/how_to/ Enabling Praise} - raise/exception investigation


  • {file:doc/how_to/ How to package new gem}


  • {file:doc/katellodb.html DB schema documentation}
  • Original Rails generated README {file:doc/RailsReadme}, we may do certain things differently

    • we use doc directory for storing markdown guides instead of a generated documentation


  • {Katello::Configuration}
  • {Notifications}
Something went wrong with that request. Please try again.