Insights Operator Remote Configuration Data

Insights Operator is an OpenShift cluster operator which enables Insights Advisor and other remote health monitoring services for OpenShift. This repository manages data for Insights Operator features that consume dynamic (remote) configuration: Conditional Gathering and Rapid Recommendations.

The Insights Operator downloads the remote configuration from Insights Operator Gathering Conditions Service, a service running on the Red Hat Hybrid Cloud Console. The service provides two API versions:

• v1 is used by Insights Operators in OCP 4.9-4.16. This API version provides only remote configuration for the Conditional Gathering feature.
• v2 is used by Insights Operators in OCP 4.17 and newer. This API version provides remote configuration for both Conditional Gathering and Rapid Recommendations features.

The Insights Operator Gathering Conditions Service uses data that is generated from data in this repository.

Repository Structure

Remote configuration data is stored in a modular way that is convenient for managing the data (see the contributing documentation for details).

• conditional_gathering_rules/*.json [TODO: schema link]
  • A library of conditional gathering rules.
• container_log_requests/*/*.json [TODO: schema link]
  • A library of container log requests, organized by their source.
• templates_v1/rules.json [TODO: schema link]
  • A template for the remote configuration served by the v1 API of the Insights Operator Gathering Conditions Service.
• templates_v2/cluster_version_mapping.json [schema]
  • A mapping between cluster version ranges and remote configurations used by the Insights Operator Gathering Conditions Service for the v2 API.
• templates_v2/remote_configurations/*.json [TODO: schema link]
  • Templates for remote configurations served by the v2 API of the Insights Operator Gathering Conditions Service.

Build

The build.sh script expands templates in templates_v1 and templates_v2 into files expected by the Insights Operator Gathering Conditions Service.

git clone -o upstream https://github.com/RedHatInsights/insights-operator-gathering-conditions
cd insights-operator-gathering-conditions
# the build.sh script needs version tags
git fetch -p origin
/bin/bash build.sh

Generated Files

The Insights Operator Gathering Conditions Service requires the following files to operate:

• build/v1/rules.json [TODO: schema link]
  • The remote configuration returned by the v1 API.
• build/v2/*.json [TODO: schema link]
  • Remote configurations returned by the v2 API.
• build/cluster_mapping.json [schema]
  • A file mapping cluster version ranges to specific v2 remote configurations.