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

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 Candlepin to Use Oracle

3.6 Data Transfer

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.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.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 Compliance Snapshots
6.2 Environments Design
6.3 Jython Rules
6.4 Lazy Certificate Regeneration
6.5 Manifest Consumer Association
6.6 Thumbslug Multi-CDN Design
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 Supporting Multiple Servlet Containers
6.13 API Version Design
6.14 Federated Certificate Management
6.15 Multi Org Sharing

Swagger API

Candlepin exposes Swagger file as a documentation of the service. When using deployed candlepin the swagger file can be accessed at:

https://HOST:8443/candlepin/swagger.json

An interactive user interface that allows running Candlepin methods can be accessed at:

https://HOST:8443/candlepin/docs/

If you do not want to serve Swagger, you can turn it off with the following configuration property:

candlepin.swagger.enabled=false

We also host the Swagger file and the UI statically on this site:

Version	Swagger file	Interactive documentation
2.0.13	swagger.json	Swagger UI
2.0.21	swagger.json	Swagger UI
2.0.25	swagger.json	Swagger UI
2.0.40	swagger.json	Swagger UI
2.1.3	swagger.json	Swagger UI
2.2.0	swagger.json	Swagger UI

Last modified on 7 September 2017