README.md

Katello

Full documentation is at http://katello.github.io/katello

About

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.

Development

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)

Start the background jobs processor

You also will need the delayed_jobs engine to be running to process Katello's async tasks. To start it do:

```bash
cd $GITDIR/foreman

rake jobs:work
```

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 on our Bugzilla or in our project tracker.

Contributing

See getting involved.

Contact & Resources

• Katello.org
• Wiki
• Foreman User Mailing List
• Foreman Developer mailing list
• IRC Freenode: #theforeman-dev
• Twitter

Documentation

Documentation is generated with YARD and hosted at http://katello.github.io/katello/. 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

• to see YARD documentation start Katello server and find the link on "About" page or go directly to http://path.to.katello/url_prefix/yard/docs/katello/frames

  • if it fails run bundle exec yard doc --no-cache first, which will rebuild whole documentation

• see {file:doc/YARDDocumentation.md}

Current documentation

• {file:doc/YARDDocumentation.md}
• {file:doc/Graphs.md}

Debugging

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

Packaging

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

Other

• {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

Source

• {Katello::Configuration}
• {Notifications}