Configuring and Deploying a Telemetry Ingestion Pipeline
When setting up a telemetry ingestion pipeline between an IOS router and Provider Connectivity Assurance, you can choose the type of connectivity you want to use between your router and the Telemetry Collector. This article will explain the available methods (user interface and/or API) for configuring and deploying pipelines using either gNMI Dial-Out and gNMI Dial-In connectivity.
Setting up a telemetry ingestion pipeline
The Telemetry Collector receives and ingests a default set of sensor path telemetry metrics that are being streamed out of the IOS XR and IOS XE devices on a user-defined cadence.
The Telemetry Collector transforms the data to OpenMetrics format and transmits the data to the Sensor Collector, the data collector component for Provider Connectivity Assurance. The Sensor Collector securely transmits the data to Provider Connectivity Assurance.
To set up a data ingestion pipeline, you must deploy the Sensor Collector in a location accessible to both the Telemetry Collector and Provider Connectivity Assurance.
Both the Sensor Collector and Telemetry Collector are deployed as Docker containers but have slightly different installation methods:
Sensor Collector: Downloaded from Provider Connectivity Assurance through the user interface, transferred to the target machine, extracted, and run via a shell script.
Telemetry Collector: Installed using Docker Compose, which automatically pulls the required binaries.
It is recommended to deploy the Sensor Collector before the Telemetry Collector. Deploying them in reverse order may trigger warning messages if the Telemetry Collector cannot locate a Sensor Collector to which it can connect. Therefore, the instructions below deploy the Sensor Collector first, followed bythe Telemetry Collector.*
The out-of-the-box solution uses gNMI DIal-Out connectivity; the sections below explain the difference between Dial IN and Dial Out, how to choose the best approach for your network, and provide configuration and deployment instructions for both options.
What is the Difference Between gNMI Dial-In and gNMI Dial-Out Connectivity?
The main difference between these two modes lies in who initiates the gRPC connection used to stream telemetry data to the Telemetry Collector:
gNMI Dial-Out Mode
In this mode, the router generating the telemetry data is responsible for initiating the gRPC connection to the Telemetry Collector.
The router must also be configured with sensor paths, destination groups, and subscription groups, which define how telemetry data is sent to the collector.
gNMI Dial-In Mode
Here, the Telemetry Collector is responsible for reaching out to the router to establish the gRPC connection.
The collector must also subscribe to specific sensor paths to receive the telemetry data it needs.
Once the connection is established, the behavior is the same for both modes: the router streams its telemetry data to the collector in the same format, regardless of which mode is used.
How Do You Choose Between gNMI Dial-In and gNMI Dial-Out Connectivity?
The choice between the two depends on how you want to handle provisioning:
gNMI Dial-Out Mode:
This requires configuring each router individually. If you have a large number of routers to set up (dozens or even hundreds), this method may be more time-consuming.
gNMI Dial-In Mode:
All provisioning is handled in the Telemetry Collector’s configuration. This can be a more centralized and efficient approach, especially for large-scale deployments.
Ultimately, the decision comes down to user preference and the specific requirements of your network.
How to Establish gNMI Dial-Out Connectivity
If you choose gNMI Dial-Out, there are two ways to configure the pipeline. The method you choose will depend on your comfort level with technical tools and the level of control you need.
Option 1: User Interface (UI) Method (Recommended)
This is the simplest and most user-friendly option. Using the UI, you can quickly build and configure the necessary components for the telemetry ingestion pipeline.
Guide: Follow the steps in the "IOS XE and XR via gNMI Dial-Out - UI Method (Recommended)" guide.
Option 2: API Method
For advanced users familiar with issuing API calls (e.g., using tools like Postman), this alternate method is available.
Guide: Use the instructions in the "IOS XE and XR via gNMI Dial-Out - API Method" guide.
How to Establish gNMI Dial-In Connectivity
If you prefer gNMI Dial-In connectivity, be aware that this configuration is not available through the User Interface. Instead, it must be done using API calls and configuration files.
Guide: IOS XE and XR via gNMI Dial-In - API Method Only
By understanding the differences between these connectivity modes and the configuration methods, you can choose the approach that best suits your network’s needs and your level of expertise.