Back to Articles

The following is an example of a completed site_vars file.

---
# Customer Site Specific Variables 

# ServAssure NXT

# Installation Deployment Environment
#
# standard = (Default) Normal on premise deployment model
# demo = Single server installs for demonstration or test
#
# NOTE: Use ONLY "standard" unless otherwise instructed by CommScope Support and/or Deployment
# NOTE: This is being removed in a coming release
#
DEPLOYMENT: standard

# Install JAVA JDK
# ServAssure NXT requires the latest Java JDK.  If you have installed
# the JDK yourself, you can leave the default (no) as is.
# NOTE: You must encapsulate the YES/NO in quotes as seen below
# "YES" - Install Java JDK
# "NO" - Do NOT Install Java JDK (DEFAULT)
#
# NOTE: If you set this to "YES", then ARRIS_SWLIB must be defined,
#       and the JDK software must be present in that path.
#
INSTALL_JAVA: "NO"

# INSTALL DEFAULTS

# Software Location
# Note: Enter path to location of JDK
#
ARRIS_SWLIB: /opt/arris/ansible/ac_files

# ServAssure NXT default tenant name
#
TENANT_NAME: <tenantUsername>
TENANT_PASS: <tenantPassword>

# Note: The following is a NEW Variable.
# Tenant TTL configuration
# If TENANT_TTL is 0 or commented out, a default TTL will be used when creating the TENANT in NXT Engine.
# Only to be set with guidance from CommScope Development.
#
#TENANT_TTL:

# Note:  The following is a NEW variable.
# Multi-Tenant UI Server Configuration
# Allowed tenants - Comma separated list of tenants that
#                   users can login to on the UI.
# Note:  If this variable is commented out(default), then TENANT_NAME will be used.
#
# ALLOWED_TENANTS "<>,<>"

# ServAssure NXT default Application/UI Username and Password
#
NXT_USERNAME: <applicationUsername>
NXT_PASSWORD: <applicationPassword>

# ServAssure NXT heartbeat configuration
# If HEARTBEAT_INTERVAL is 0 or commented out, heartbeat will not be installed
# and will get uninstalled/unconfigured if it is installed. If HEARTBEAT_INTERVAL > 0, heartbeat script
# gets installed and a cron is configured to execute it at specified HEARTBEAT_INTERVAL
# Note that this requires an endpoint for heartbeat message to be sent to. If there
# isn't an end point to send it to, don't  configure it
#
#HEARTBEAT_INTERVAL: 1
#NOTIFICATION_URLS: <Comma delimited list of urls for ac posting heartbeat message to>
#NOTIFICATION_USER: <User name (if required) for url to which heartbeat message is POSTed to>
#NOTIFICATION_PASSWORD: <Password (if required) for url to which heartbeat message is POSTed to>

# HAPROXY_HA_VIP is used to specify the Virtual IP to use when more than one HAPROXY host is defined in inventory. 
# When more than one host is defined, the HA (High Availability) features of HAPROXY are enabled.  The HAPROXY_HA_VIP
# allows ONE IP address to be used to support the HA features.
# To Use:  Uncomment the variable, and put the IP Address you have chosen as your VIP within the quotes.
# Note: The IP Address used here should also be set for the "ctvip", "stvip", and "atvip" variables in the 
#       host inventory
#
#HAPROXY_HA_VIP: ''

# THE FOLLOWING IS NOT YET IMPLEMENTED!  DO NOT USE
# ServAssure NXT normally defaults to using the servers PRIMARY Ethernet Interface for all IP 
# connectivity.
# If your servers use a secondary ETHERNET interface for primary communications (not management)
# then you will need to uncomment the following variable, and define the interface used.
# Examples: "eth0,eth1,en0,en1...etc"
#
#USE_ETH_INTERFACE: ''

# The ENABLE_RABBIT_JMS var is set to true if NXT Engine will be consuming data off of the RabbitMQ message bus.
# Set to false if NXT will be collecting data via HTTP ingest. Set to true if NXT is collecting data from DOCSIS Platform.
#
# ENABLE_RABBIT_JMS: <true/false>

# NXT_INSIGHT_ENABLED: <true/false> for configuring NXT Insight host and SSL information in the NXT Engine properties. Default=false.

# Following vars are properties for NXT Simulator (nxt-sim)
# NXT_SIM_INGEST: <"enrichment_kafka","enrichment_nxt","http">. One of the three strings is allowed, to Kafka, to NXT via enrichment, to NXT over http.
# Defaults exist for 2million device simulation. Only need to define COUNT/PERCENTAGE vars for override.
# SIMULATED_MODEM_COUNT: <integer>. REQUIRED for Simulator install. Deployment will have instructions on how to configure this value based on multiple simulators.
# NXT_SIM_US_CHAN_COUNT: <integer>. Default is 24. 
# NXT_SIM_DS_CHAN_COUNT: <integer>. Default is 8.
# NXT_SIM_OFDM_PERCENTAGE: <0-100>.

# Property override vars (note that indentation must be exactly 2 spaces before each property key, and no "=" signs, must be ": "
# NXT_APP_PROPERTIES:
# NXT_ENG_PROPERTIES:
# NXT_SIM_PROPERTIES:
#
# Example:
# NXT_ENG_PROPERTIES:
#   test.property.string: "nxt-engine-test"
#   test.property.integer: 52

##Optional Node API
## NODE_API_TIER_PORT: 9000

## Optional Dashboard
#DASHBOARD_LOAD_BALANCER_DOMAIN_NAME <domain name> 
#set only when ENABLE_NGINX_AS_LOAD_BALANCER is false. If variable is not defined, the first 
#Dashboard host(node) is used as a load balancer.
#DASHBOARD_LOAD_BALANCER_PORT: <port> 
#default is 8888
#DASHBOARD_API_PORT: <apiPort>
#default is 8089

#!CSO#########################################################
## SPECIAL - CUSTOMER SPECIFIC OVERRIDES !!!! ################
#
# NOTE:	Variables in this section are NOT validated against required site_vars defaults.
#	Use caution when adding variables here, and reference the appropriate documentation
#	describing allowed values.
#
### APPSERVER OVERRIDES
# To define your own keystore with custom site SSL certificates, uncomment
# the following variables and enter the appropriate information.
# If left commented out, we create a default keystore with self-signed certificates.
#
# NXT_UI_KEYSTORE_FILE: <pathToFile>
# NXT_UI_KEYSTORE_PASS: <keystorePassword>
# NXT_UI_KEYSTORE_TYPE: <allowedValues: JKS, PKCS11, PKCS12>

### NXT-ENGINE OVERRIDES
# Similar to defining the keystores above for the Appserver, you can define 
# custom site SSL certificates for the NXT Engine Administration UI.
# If left commented out, we create a default keystore with self-signed certificates.
#
# NXT_ENG_SECURE_UI: <true/false, default is false, and if false, below NXT_ENG_KEYSTORE vars are not needed>
# NXT_ENG_KEYSTORE_FILE: <pathToFile>
# NXT_ENG_KEYSTORE_PASS: <keystorePassword>

### SOLR/ZOOKEEPER OVERRIDES

### CASSANDRA OVERRIDES
# Cassandra Data Directory
# Note: /var/lib/cassandra is a default if this is commented out or not defined here.
# If you have configured a different mount point for the cassandra data directory, enter
# it here in place of the default path.
# Note: Change "<pathTo....>" field only.
#
#CASSANDRA_DATA_DIR: <pathToDataDir>
#CASSANDRA_COMMITLOG_DIRECTORY: cassandra_commitlog_directory: <pathToCommitDir>
#CASSANDRA_SAVED_CACHES_DIRECTORY: cassandra_saved_caches_directory: <pathToSavedCachesDir>

# MULTI-INTERFACE SUPPORT
# For configuring alternative interfaces for intracluster communication, see the host_inventory example configuration.