How should containerized services consume Foreman platform settings?

Hello,

The Documentation URL setting exists today.

Is there a supported and documented way for containerized services and external extensions to consume this setting?

If not, is this something that should be standardized?

Regards,

Is this a plugin? Or a completely external service?

Settings can be consumed via the Foreman API: GET /api/settings/:id and PUT /api/settings/:id. API docs are available at <your_foreman_instance_fqdn>/apidoc

I’m primarily thinking about external containerized services running alongside Satellite rather than traditional Foreman plugins.

One example would be Red Hat IOP / Lightspeed services, which operate outside the Foreman application itself.

Since Foreman already exposes administrator-configured settings through the API, I was trying to understand whether consuming such settings is considered the recommended approach for external services as well.

For IoP backend services I’d expect them to use the Foreman API thru the IoP gateway to read the settings. If a service needs to set a setting, then I’d like to have a conversation about that :slight_smile:

(And please note, of course, the foreman_rh_cloud plugin acts as liaison between IoP gateway and Foreman, and can read and write settings directly.)

2 Likes