Audience

How do collectors enroll and operate inside the customer network?

Implementation owners and source-system operators.

Collector Deployment

Run collectors near customer systems.

The collector runs inside a customer network and makes outbound HTTPS calls to the SaaS control plane. It keeps local source credentials and retry state in the customer environment while polling VeridataOps for work leases.

Prerequisites

Docker Engine with the Docker Compose plugin.
Outbound HTTPS access to the SaaS application endpoint, normally https://app.veridataops.com.
Optional outbound WSS access; auto transport tries WSS and falls back to HTTPS polling.
A tenant ID and a one-time connector initial exchange key from Settings - Collectors.
Network reachability from the collector host to the source systems it will query.

Collector compose file

services:
  veridataops-collector:
    image: docker.io/garnser/veridataops-public:collector-vRELEASE
    restart: unless-stopped
    environment:
      NETBOX_INGESTER_CONNECTOR_SERVER_URL: ${NETBOX_INGESTER_CONNECTOR_SERVER_URL}
      NETBOX_INGESTER_CONNECTOR_TENANT_ID: ${NETBOX_INGESTER_CONNECTOR_TENANT_ID}
      NETBOX_INGESTER_CONNECTOR_ID: ${NETBOX_INGESTER_CONNECTOR_ID}
      NETBOX_INGESTER_CONNECTOR_TOKEN: ${NETBOX_INGESTER_CONNECTOR_TOKEN}
      NETBOX_INGESTER_CONNECTOR_TRANSPORT: ${NETBOX_INGESTER_CONNECTOR_TRANSPORT:-auto}
      NETBOX_INGESTER_CONNECTOR_COMPLETION_STATE: /data/connector-completions.json
      NETBOX_INGESTER_CONNECTOR_DESTINATION_STATE: /data/connector-destinations.json
      NETBOX_INGESTER_CONFIG: /data/netbox_ingester.db
    volumes:
      - collector-data:/data

volumes:
  collector-data:

Enroll and start

docker compose run --rm veridataops-collector \
  netbox-ingester-connector \
  --server-url https://app.veridataops.com \
  --tenant-id customer-tenant-id \
  enroll \
  --name customer-collector-1 \
  --initial-exchange-key 'nbicx_REPLACE_ME' \
  > connector.json

Keep the collector /data volume persistent. It stores runtime config, completion retry state, destination retry state, transport state, and hub state.

Next Step

Move from documentation to a scoped review.

Use the implementation reviewer path when you want to turn this page into a concrete source, deployment, or assurance discussion.

Talk to an Implementation Reviewer

Run collectors near customer systems without moving source credentials into the SaaS plane.