Skip to content

ref-ccsp.adoc

Latest commit

 

History

History
76 lines (59 loc) · 3.57 KB

ref-ccsp.adoc

File metadata and controls

76 lines (59 loc) · 3.57 KB
Raw

CCSP

CCSP is the original report format. It does not include many of the customization of CCSPv2, and it is intended to be used only for the CCSP partner program.

Optional collectors for gather command

You can use the following optional collectors for the gather command:

  • main_jobhostsummary

    • If present by default, this incrementally collects the main_jobhostsummary table from the {ControllerName} database, containing information about jobs runs and managed nodes automated.

  • main_host

    • This collects daily snapshots of the main_host table from the {ControllerName} database and has managed nodes/hosts present across {ControllerName} inventories,

  • main_jobevent

    • This incrementally collects the main_jobevent table from the {ControllerName} database and contains information about which modules, roles, and ansible collections are being used.

  • main_indirectmanagednodeaudit

    • This incrementally collects the main_indirectmanagednodeaudit table from the {ControllerName} database and contains information about indirectly managed nodes,

# Example with all optional collectors
export METRICS_UTILITY_OPTIONAL_COLLECTORS="main_host,main_jobevent,main_indirectmanagednodeaudit"

Optional sheets for build_report command

You may use the following optional sheets for the build_report command:

  • ccsp_summary

    • This is a landing page specifically for partners under the CCSP program. It shows managed node usage by each {ControllerName} organization.

    • This report takes additional parameters to customize the summary page. For more information, see the following example:

export METRICS_UTILITY_PRICE_PER_NODE=11.55 # in USD
export METRICS_UTILITY_REPORT_SKU=MCT3752MO
export METRICS_UTILITY_REPORT_SKU_DESCRIPTION="EX: Red Hat Ansible Automation Platform, Full Support (1 Managed Node, Dedicated, Monthly)"
export METRICS_UTILITY_REPORT_H1_HEADING="CCSP Reporting <Company>: ANSIBLE Consumption"
export METRICS_UTILITY_REPORT_COMPANY_NAME="Company Name"
export METRICS_UTILITY_REPORT_EMAIL="email@email.com"
export METRICS_UTILITY_REPORT_RHN_LOGIN="test_login"
export METRICS_UTILITY_REPORT_COMPANY_BUSINESS_LEADER="BUSINESS LEADER"
export METRICS_UTILITY_REPORT_COMPANY_PROCUREMENT_LEADER="PROCUREMENT LEADER"

  • managed_nodes

    • This is a deduplicated list of managed nodes automated by {ControllerName}.

  • indirectly_managed_nodes

    • This is a deduplicated list of indirect managed nodes automated by {ControllerName}.

  • inventory_scope

    • This is a deduplicated list of managed nodes present across all inventories of {ControllerName}.

  • usage_by_collections

    • This is a list of Ansible collections used in {ControllerName} job runs.

  • usage_by_roles

    • This is a list of roles used in {ControllerName} job runs. *usage_by_modules

    • This is a list of modules used in {ControllerName}job runs.

# Example with all optional sheets
export METRICS_UTILITY_OPTIONAL_CCSP_REPORT_SHEETS='ccsp_summary,managed_nodes,indirectly_managed_nodes,inventory_scope,usage_by_collections,usage_by_roles,usage_by_modules'

Selecting a date range for your CCSP report

The default behavior of this report is to build a report for the previous month. The following examples describe how to override this default behavior to select a specific date range for your report:

# Builds report for a previous month
metrics-utility build_report

# Build report for a specific month
metrics-utility build_report --month=2025-03

# Build report for a specific month overriding an existing report
metrics-utility build_report --month=2025-03 --force