Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Katello integrates open source systems management tools into a single solution for controlling the lifecycle of your machines.
Ruby JavaScript HTML CSS Other
Branch: master

Merge pull request #5362 from johnpmitsch/distributions

fixes #7890 Move Distributions from Elasticsearch to the Database
latest commit 6af70c27c0
@jlsherrill jlsherrill authored
Failed to load latest commit information.
.tx fix paths in .tx/config after git reorganization
app Merge pull request #5362 from johnpmitsch/distributions
ca adding redhat-uep.pem to katello ca
config Fixes #11239: Move dashboard to Foreman plugin API.
db fixes #7890 Move Distributions from Elasticsearch to the Database
engines/bastion_katello Merge pull request #5362 from johnpmitsch/distributions
lib Merge pull request #5362 from johnpmitsch/distributions
locale Fixes #5659 - String Extract
script Fixes #10809: Remove unused doc/ directory.
spec Fixes #11239: Move dashboard to Foreman plugin API.
test Merge pull request #5362 from johnpmitsch/distributions
vendor Refs #10970: apply backwards compatible rails 4 changes.
.gitignore Fix apipie static generation on RPM build time
.rspec initial commit
.rubocop.yml Refs #9099 - Update rubocop to 0.28
.rubocop_todo.yml fixes #6781 - provide a way to restart capsule services
.simplecov Setup simplecov in katello
.yardopts Add documentation of db schema Refs #7242: Add 1.5-2.0 Changelog. Fixes #6272/BZ1118479 - move Bastion guide to
CONTRIBUTORS adding myself to contrib
Gemfile Engine: Removing old gem files
LICENSE.txt set Markdown as default markup Fixes #6297 - delayed jobs is dead, long live foreman-tasks
katello.gemspec fixes #11102 - upgrading to newer deface version

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 recommended way to set up Katello for development to use the katello-devel-installer directly or via katello-deploy.

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. http://<hostname>:3000/)

  3. Login to Foreman (default: admin and changeme)
  4. Create an initial Foreman organization
  5. Navigate to the Katello engine (e.g. http://<hostname>:3000/katello)

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 getting involved.

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.