Skip to main content

ServiceRadar Quickstart

Follow these condensed steps to get ServiceRadar collecting data within an hour. Each phase links to longer-form docs so you can dive deeper when needed.

1. Pick a Deployment Path​

  • Docker Compose – fastest path for local trials. Follow the Docker setup guide to launch core, poller, web UI, and supporting services with pre-baked defaults.
  • Bare Metal – when you want packages on dedicated hosts, start with the Installation Guide and layer on TLS, authentication, and KV configuration.
  • Kubernetes – production-style clusters or cloud POCs. Use the Helm configuration to install charts and align values with your environment.

2. Bootstrap Access​

  1. Generate TLS material with the Self-Signed Certificates guide or import your existing CA chain.
  2. Create initial local users and JWT settings using the Authentication configuration checklist.
  3. Enable API keys for pollers and sync integrations as described in Configuration Basics.

3. Ingest Device Data​

Pick one telemetry channel to validate the pipeline end to end:

Once the first data source is healthy, layer on additional protocols through the Get Data In section.

4. Explore the UI​

  • Sign in to the dashboard at https://<web-host> and bookmark the SRQL explorer.
  • Import starter dashboards from the Web UI configuration guide.
  • Use Service Port Map to verify discovered services and dependencies.

5. Automate Integrations​

When the core deployment is stable, connect inventory and security feeds:

6. Validate Health​

  • Run smoketests in cmd/poller/testdata or your own synthetic checks to confirm alerting.
  • Review the Troubleshooting Guide for quick fixes to common onboarding blockers.
  • Keep the demo namespace tidy with the reset steps in Agents & Demo Operations.