rawlinp commented on code in PR #6769: URL: https://github.com/apache/trafficcontrol/pull/6769#discussion_r856552979
########## docs/source/admin/traffic_monitor.rst: ########## @@ -48,17 +48,85 @@ These are the recommended hardware specifications for a production deployment of Configuring Traffic Monitor =========================== -Configuration Overview ----------------------- -Traffic Monitor is configured via two JSON configuration files, :file:`traffic_ops.cfg` and :file:`traffic_monitor.cfg`, by default located in the ``conf`` directory in the install location. :file:`traffic_ops.cfg` contains Traffic Ops connection information. Specify the URL, username, and password for the instance of Traffic Ops of which this Traffic Monitor is a member. :file:`traffic_monitor.cfg` contains log file locations, as well as detailed application configuration variables such as processing flush times, initial poll intervals, and the polling protocols. Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling :term:`cache server` s. Once every :term:`cache server` has been polled, :ref:`health-proto` state is available via RESTful JSON endpoints and a web browser UI. +Configuration Files +------------------- +Traffic Monitor is configured via two JSON configuration files, :file:`traffic_ops.cfg` and :file:`traffic_monitor.cfg`, by default located in the ``conf`` directory in the install location. + +traffic_ops.cfg +""""""""""""""" +:file:`traffic_ops.cfg` contains Traffic Ops connection information. Specify the URL, username, and password for the instance of Traffic Ops of which this Traffic Monitor is a member. However, this *also* sets some settings relating to the Traffic Monitor API server. + +:``cdnName``: The name of the CDN to which this Traffic Monitor belongs. Used to fetch configuration and to determine which :term:`cache servers` to monitor. +:``certFile``: The path to an SSL certificate file that corresponds to ``keyFile`` which will be used for Traffic Monitor's HTTPS API server. +:``httpListener``: Sets the address on which Traffic Monitor will listen for HTTP requests. +:``httpsListener``: Sets the address on which Traffic Monitor will listen for HTTPS requests. If not provided, ``null``, or the empty string, Traffic Monitor will only serve HTTP, and ``keyFile`` and ``certFile`` are not used. If this is provided, the ``httpListener`` address will be used only to redirect clients to use HTTPS. +:``insecure``: A boolean that controls whether to validate the HTTPS certificate prevented by the Traffic Ops server. +:``keyFile``: The path to an SSL key file that corresponds to ``certFile`` which will be used for Traffic Monitor's HTTPS API server. +:``password``: The password of the user identified by ``username``. +:``url``: The URL at which Traffic Ops may be reached e.g. ``"https://trafficops.infra.ciab.test"``. +:``username``: The username of the user as whom to authenticate with Traffic Ops. +:``usingDummyTO``: A boolean with no real effect. This value is used internally within the runtime of Traffic Monitor, and should never be set manually in its configuration file. + + .. deprecated:: ATCv7 + The dependency on this field being valid will be removed in the future. It already has no effect. + + +traffic_monitor.cfg +""""""""""""""""""" +:file:`traffic_monitor.cfg` contains log file locations, as well as detailed application configuration variables such as processing flush times, initial poll intervals, and the polling protocols. Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops which will override the options in this file and begins polling :term:`cache server` s. Once every :term:`cache server` has been polled, :ref:`health-proto` state is available via RESTful JSON endpoints and a web browser UI. Review Comment: Oh ok, yeah, if there are corresponding TM profile params, those will override options in the config file, but not the other way around. Ideally, we should notate the corresponding TM profile params which would override the config file options. I'm pretty sure that includes at least these ones: ``` tm.polling.interval health.polling.interval peers.polling.interval heartbeat.polling.interval ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
