Tarana

This guide integrates Layer 9 with Tarana’s three APIs:

• REST API: Get and edit device configurations
• Streaming metrics: gNMIc streaming for device health metrics
• Webhook: Device events and alarms

Prerequisites

• Base nodes: Software version 1.600.003.00 or higher
• Administrator access to Tarana Cloud Suite (TCS)
• Tarana base nodes network allows outbound HTTPS traffic to Layer 9 (IP ranges available upon request)

Step 1: REST API access

1. Open a support ticket and request an API key for the “Northbound REST API”
2. Share the key with Layer 9 team

Step 2: Configure metrics streaming

1. Coordinate with Layer 9 Team to obtain the following:

   • Metrics endpoint (<name>.metrics.tarana.layer9.com)
   • Metrics access key
   • Webhook endpoint (<name>.webhook.tarana.layer9.com)

2. Access Tarana TCS

   • Log into Tarana Cloud Suite with administrator credentials
   • Navigate to Admin > Network Configuration

3. Configure Telemetry Streaming - At the Global (Operator) level:

   • Select your Operator name to display global settings
   • Click Edit at the bottom of the settings pane
   • In “Metrics Collector End Point Configuration” section:
     • Destination Address: Your metrics endpoint
     • Port: 443
     • Secure Mode: Select “Use Secure Mode”
     • Access Key: Your organization-specific metrics access key
     • Streaming Interval: 1 minute
     • Toggle Streaming to “Enabled”
   • Click Done to commit changes

Step 3: Configure a webhook destination

• Navigate to Admin > Webhooks
• Select Add New Webhook
• Enter:
  • Webhook Name: Layer 9
  • Webhook URL: Your webhook endpoint
• Select Done and share the generated secret with the Layer 9 team

Step 4: Send alarms to the webhook

1. Navigate to Admin > Alerts Configuration
2. Select Add New Alert
3. Create an alert for each type
   • Configure each alert to send to the Layer 9 webhook you created
   • Configure each alert to cover “All Regions”
   • Note: For “Critical Alarms”, select the lowest severity level

Official Tarana Documentation

• Streaming

• Webhooks