Nginx Failed to Start with Error "unknown "sensor_mod_idx" variable"

[#1]

Version

CB Response 6.1

Issue

Nginx failed to startup with error "nginx: [emerg] unknown "sensor_mod_idx" variable".

Symptoms

/var/log/cb/nginx/startup.log:

nginx: [emerg] unknown "sensor_mod_idx" variable

Cause

The root cause of the upgrade failure was determined to be an issue with the home directory of the cb service account being changed to a custom location (which worked in 5.1). In 6.1, server code is dependent upon the default location to fetch run-time configuration items for NGINX. This is being tracked as a documentation bug which explains these requirements: CBDOX-113.

Solution

If using a multihome configuration (signed cert), follow this guide to migrate to the latest 5.2/6.1 cb.multihome format:

Migrating to a 5.2/6.1 Multihome Configuration File

If using a standard configuration with a self signed cert, update /etc/cb/nginx/conf.d/cb.conf file to latest 5.2/6.1 version (attached):

###############################################################################

#

# /etc/cb/nginx/conf.d/cb.conf:

#     Carbon Black HTTP Server Nginx configuration file

#

###############################################################################

#

# This file contains several properties whose values are determined dynamically

# at runtime when cb-nginx service is started based on current settings in

# /etc/cb/cb.conf.  These properties are imported via an 'include' directive

# which references a runtime properties file which has the following naming

# convention: "/var/cb/nginx/props/nginx.runtime.<property name>.prop"

#

# If nginx configuration must be modified in order to add additional 'location'

# blocks (or other configuration within 'server' block), it is strongly

# recommended that instead of directly modifying this file, you add such

# changes to /etc/cb/nginx/conf.d/cb.server.custom file. Doing so will ensure

# that any changes, that are made to this configuration file by future version

# of cb-enterprise package, will get applied automatically without generating

# .rpmnew files which would require manual consolidation of differences

#

###############################################################################

server

{

    # IMPORTANT: If listener configuration is updated here, make sure to

    # also upate corresponding Nginx#### parameters in /etc/cb/cb.conf file

    listen [::]:443 ssl ipv6only=off;

    include /etc/cb/nginx/conf.d/includes/cb.server.body;

    include /etc/cb/nginx/conf.d/includes/cb.server.api;

    include /etc/cb/nginx/conf.d/includes/cb.server.sensor;

    # Include content of custom server configuration file

    include /etc/cb/nginx/conf.d/includes/cb.server.custom;

}