Candlepin

1 Candlepin Basics

1.1 Overview

1.1.1 Glossary

1.2 Subscriptions and Engineering Products

1.3 Entitlements

1.4 Virtualization Entitlements

1.4.1 Virt Guest Limit Design
1.4.2 Associating Hosts and Guests in Candlepin

1.5 Jobs

1.5.1 Active Entitlement Job
1.5.2 Certificate Cleanup Job
1.5.3 Import Record Cleaner Job
1.5.4 Inactive Consumer Cleanup Job
1.5.5 Job Cleaner Job
1.5.6 Manifest Cleaner Job
1.5.7 Orphan Cleanup Job
1.5.8 Unmapped Guest Entitlement Cleaner Job

2 User Guide

2.1 Basic How To

3 Administration Guide

3.1 Setting Up Candlepin

3.1.1 Candlepin Configuration
3.1.2 Quartz Configuration
3.1.3 Configuring Candlepin to Use MySQL
3.1.4 Configuring A Remote Artemis Server
3.1.5 Allow Remote Connections to embedded Artemis

3.6 Data Transfer
3.7 Migrating to the Artemis Job System

4 Developers

4.1 Architecture

4.1.9.1 OAuth Authentication

4.1.10 Fail Fast Mechanism

4.2 Development

4.2.1 Setting up IntelliJ IDEA
4.2.2 Developer Deployment
4.2.3 Auto Generating candlepin.conf
4.2.4 Coding Conventions
4.2.5 Checkstyle
4.2.6 Logging in Candlepin
4.2.7 Internationalization
4.2.8 Paginating Results
4.2.9 Database Schema Updates
4.2.10 JSON and JAXB
4.2.11 The Certificate Revocation List
4.2.12 Hibernate Gotchas
4.2.13 Ruby Bindings for Candlepin
4.2.14 Caching - JCache and Candlepin Second Level Cache
4.2.15 What to look for in a Code Review

4.3 Implementation details

4.3.1 Revoke Entitlements Implementation
4.3.2 Bind Time Locks
4.3.3 Bind Operation Dependencies

4.4 Debugging

4.5 Testing

4.5.1 Spec test migration
4.5.2 Candlepin Database Validation

4.6 Documentation

4.6.1 Diagramming with PlantUml

4.7 Useful Queries

4.7.1 Clean up database backup

5 Reference

6 Design Documents

6.1 API Version Design
6.2 Compliance Snapshots
6.3 Environments Design
6.4 Federated Certificate Management
6.5 Lazy Certificate Regeneration
6.6 Manifest Consumer Association
6.7 Multi-Owner Users Design
6.8 Multi-Version Product Design
6.9 Owner Hierarchy
6.10 Plugins
6.11 Policy Design
6.12 Service Layer Guidelines
6.13 Supporting Multiple Servlet Containers

Table of Contents

Unable to Start Webapp
RHEL 6 And java-1.5.0-gcj

Unable to Start Webapp

The Tomcat RPM likes to change permissions on install / upgrade, and leave the directories unwritable by the tomcat process itself. This may surface in cpsetup with an error like:

Error running command: wget -qO- http://localhost:8080/candlepin/admin/init

Or when trying to do an import/export:

Caused by: java.io.IOException: No such file or directory
        at java.io.UnixFileSystem.createFileExclusively(Native Method)
        at java.io.File.checkAndCreate(File.java:1716)
        at java.io.File.createTempFile(File.java:1804)
        at org.apache.james.mime4j.storage.TempFileStorageProvider.createStorageOutputStream(TempFileStorageProvider.java:104)

cpsetup now has some code to try and fix this, but essentially you need to check for any dangling symlinks in /usr/share/tomcat6, and make sure the directories are writable by the tomcat process:

$ chmod g+x /var/log/tomcat6
$ chmod g+x /etc/tomcat6/
$ chown tomcat:tomcat -R /var/lib/tomcat6
$ chown tomcat:tomcat -R /var/lib/tomcat6
$ chown tomcat:tomcat -R /var/cache/tomcat6

Sometimes the no such file or directory error will originate from resteasy, which indicates the tomcat temp directory does not exist. This can be corrected with:

$ mkdir /var/cache/tomcat6/temp
$ chown root:tomcat /var/cache/tomcat6/temp
$ chmod g+w /var/cache/tomcat6/temp

RHEL 6 And java-1.5.0-gcj

We may have an issue with RHEL 6 and the Candlepin rpms. If your system is using java-1.5.0-gcj after installing the Candlepin RPMs, switch to java-1.6.0-openjdk instead. We’re probably missing a requires on our rpm.

Last modified on 24 September 2024