Deploying the Telemetry Collector in Licensing Mode

Lab requirements

Deploying the Telemetry Collector in Licensing Mode will start the collector in a standalone mode that does not require or use a Sensor Collector or Provider Connectivity Assurance platform connection. When operating in Licensing Mode, the Telemetry Collector never reports any data to Provider Connectivity Assurance. All that is required is the Telemetry Collector and the router.

Instructions

Easy Mode

To make it simple to set up a Licensing Tool Mode deployment of the Telemetry Collector, the following script has been created:

#!/bin/sh
echo "Setting up working directory for Telemetry Collector discovery mode instance..."

if [ "$#" -eq 0 ]
then
  DOCKER_VER="r24.09"
else
  DOCKER_VER=${1}
fi

echo "  Creating docker compose file using tag '$DOCKER_VER' for the collector image..."
cat >./docker-compose.yml <<EOL
version: "3.8"
services:
  telemetry-agent:
    container_name: "telemetry-discovery-collector"
    image: "gcr.io/sky-agents/agent-telemetry-amd64:$DOCKER_VER"
    hostname: "telemetry-discovery-collector"
    networks:
      - agent-net
    environment:
      AGENT_MANAGEMENT_PROXY_CONNECT: "false"
      AGENT_MANAGEMENT_CONFIG_FROM_SECRET: "true"
      AGENT_DATA_BROKER_CONNECT: "false"
      AGENT_DATA_BROKER_DEMO_MODE: "true"
      TELEMETRY_LICENSING_MODE: "true"
      TELEMETRY_LICENSING_MODE_REPORT_PERIOD: "5m"
    volumes:
      - ./secrets/secrets.yaml:/run/secrets/secrets.yaml
      - ./config:/etc/telegraf/telegraf.d
    ports:
      - "57000:57000"
networks:
  agent-net:
    driver: bridge
EOL

echo "  Setting up config directory..."
mkdir ./config

echo "  Creating default secrets file..."
mkdir ./secrets
cat >./secrets/secrets.yaml <<EOL
agentConfig:
  identification:
    agentId: 4738cdf6-a2a8-4b0c-aa67-2e0240e2eb19
    authenticationToken: eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhY2NlZGlhbi5jb20iLCJzdWIiOiJhZG1pbkBkYXRhaHViLmNvbSIsImV4cCI6MTcxOTI2MTUyNCwiYXVkIjoiIiwidG9rZW5JRCI6NDIsInRlbmFudElEIjoiYjA1MjAwYzctMzlhYy00YzI1LWJjMjQtOTVkOWRjZmZmYmM4In0.ZoKI--K1CBgYiEukBwK9QOeVOvbAz8L_-5EaxGa53_o
EOL

echo " "
echo "Telemetry Collector can be started by running the following command:"
echo "  docker compose up -d"
echo " "

To set up your collector:

1. Create a working directory for your collector.
2. Copy the above script to that directory and run it.

NOTE: The current version of the script defaults to using tag r24.05 for the TelemetryCollector image, however, you may override this by providing your own tag as a parameter when running the script.

This will set up the files and directories needed to set up and run the collector.

To start your collector

Head over to the Starting the Telemetry Collector and Collecting Object Counts article.

Manual Mode (if preferred/needed)

The provided script just automates creating a couple of files and directories that are needed for running the collector in Licensing Tool Mode. If you want or need to do this yourself without relying on the script, you can follow these steps:

1. Create a working directory for your collector.
2. In the working directory, create a docker-compose.yml file with the following contents:

version: "3.8"
services:
  telemetry-agent:
    container_name: "telemetry-licensing-collector"
    image: "gcr.io/sky-agents/agent-telemetry-amd64:r24.09"
    hostname: "telemetry-licensing-collector"
    networks:
      - agent-net
    environment:
      AGENT_MANAGEMENT_PROXY_CONNECT: "false"
      AGENT_MANAGEMENT_CONFIG_FROM_SECRET: "true"
      AGENT_DATA_BROKER_CONNECT: "false"
      AGENT_DATA_BROKER_DEMO_MODE: "true"
      TELEMETRY_LICENSING_MODE: "true"
      TELEMETRY_LICENSING_MODE_REPORT_PERIOD: "5m"
    volumes:
      - ./secrets/secrets.yaml:/run/secrets/secrets.yaml
      - ./config:/etc/telegraf/telegraf.d
    ports:
      - "57000:57000"
networks:
  agent-net:
    driver: bridge

This docker-compose file will start the collector in a standalone mode that does not require an Analytics connection.

3. In the working directory, create a directory named secrets and add a file named secrets.yaml to that location with the following content:

agentConfig:
  identification:
    agentId: 4738cdf6-a2a8-4b0c-aa67-2e0240e2eb19
    authenticationToken: eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhY2NlZGlhbi5jb20iLCJzdWIiOiJhZG1pbkBkYXRhaHViLmNvbSIsImV4cCI6MTcxOTI2MTUyNCwiYXVkIjoiIiwidG9rZW5JRCI6NDIsInRlbmFudElEIjoiYjA1MjAwYzctMzlhYy00YzI1LWJjMjQtOTVkOWRjZmZmYmM4In0.ZoKI--K1CBgYiEukBwK9QOeVOvbAz8L_-5EaxGa53_o

4. In the working directory, create an empty directory named config.

At this point, you should be good to go.

To start your collector

Head over to the Starting The Collector And Collecting Some Object Counts section below.