Uploaded image for project: 'Satellite'
  1. Satellite
  2. SAT-38955

Support configurable Apache log formats (e.g., Referer, User-Agent) via Satellite-installer in Satellite 6.15+

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 6.15.z, 6.16.0
    • Installation
    • False
    • sat-rocket
    • None
    • None
    • None
    • None

      Problem Statement:

      In Red Hat Satellite versions up to 6.14, users were able to define custom Apache log formats — including Referer and User-Agent headers — using entries in /etc/foreman-installer/custom-hiera.yaml. The following line worked without error in those versions:
       
       
      combined: '%a %l %u %t \"%r\" %>s %b [C:%X E:%L R:%D] \"%{Referer}i\" \"%{User-Agent}i\"'
       
      Starting in Satellite 6.15 and later versions (6.16+), this configuration triggers a Puppet error during the installer run:

      *****************
      [ERROR ] [configure] Evaluation Error: Error while evaluating a Function Call, Undefined variable 'Referer'; (file: /usr/share/foreman-installer/modules/foreman/manifests/config/apache.pp, 
      *****************
      This prevents Satellite installation or upgrades from completing successfully if the format is not removed. The goal of this RFE is to restore support or provide a supported mechanism (e.g., via a Satellite-installer flag) to define custom Apache log formats including headers like Referer.


      User Experience & Workflow

      Current (unsupported) workflow:

      1. User edits /etc/foreman-installer/custom-hiera.yaml to include a custom log format.
      1. Runs satellite-installer.
      1. Installer fails due to undefined variable error (Referer).

      Proposed workflow (post-RFE):

      1. User defines a custom log format through a documented and supported method, such as a Satellite-installer flag or external configuration file reference.
      1. Runs satellite-installer.
      1. Installer completes successfully.
      1. User verifies Apache is logging with the desired format (including Referer and User-Agent headers) by reviewing /var/log/httpd/foreman_access_ssl.log (or similar).

      End-state:
      Custom Apache log formats — particularly those with Referer and User-Agent headers — are applied successfully and persist across Satellite upgrades.


      Requirements

      • Ability to configure Apache log format via supported Satellite-installer parameters or documented procedure.
      •  Validate the format for syntax correctness to prevent Puppet errors during installer execution.

      Business Impact

      • Customers who rely on extended logging (e.g., for security compliance, debugging, or auditing purposes) are blocked from upgrading to Satellite 6.15+ unless they remove these configurations.

              Unassigned Unassigned
              rhn-support-amiagarw Amit Agarwal
              Amit Agarwal
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: