Rainbow Pilot, your Rainbow deployment advisor

Agent tools Edit article Translate article Show labels

Rainbow Pilot is a tool designed to evaluate the capability of an enterprise site to support Rainbow users engaging in collaboration, conferencing, or telephony in Hybrid or Hub modes.

The tool recognizes the importance of conducting on-site testing to examine your network configuration and ensure compliance with Rainbow requirements, with a particular focus on WAN connectivity to Rainbow datacenter worldwide.

The tool is accessible as a web application at https://pilot.openrainbow.com/?lang=en. From this platform, you can also download the Pilot Agent, a lightweight Windows executable intended to handle tests not possible through the web application alone.

Available Features

This initial version of Rainbow Pilot is available for free use by Business Partners and customers, anytime and from any location, featuring the following:

Network Requirements: Provides concise information about Rainbow network requirements, supplementing the official documentation available on the Rainbow Help Center.

Connectivity Tests: Enables the execution of connectivity tests between your site network and Rainbow datacenters, covering all network paths and protocols involved in using Rainbow's desktop or mobile clients, as well as local WebRTC gateways:

• Rainbow domains resolution & reachability
• Through the embedded Rainbow web SDK, a real client connection test to the local datacenter, identical to Rainbow web, desktop, WLAN mobile or WebRTC Gateway clients
• Unitary WebRTC call with audio + video with bandwidth, audio quality check
• Reachability of TURN relays and conferencing servers worldwide using their respective protocols on UDP, TCP and TLS
• Reachability of Rainbow Hub servers for SIP phones

Note: It is recommended to use Google Chrome browser. WebRTC tests will not work with Firefox.

Best practices

Network Testing Across Subnets for Rainbow Hybrid Topology

In a Rainbow Hybrid deployment, the PBX, WebRTC Gateway, and Rainbow clients may reside on different networks, VLANs, or subnets. Because each of these components must independently reach various Rainbow cloud services (e.g., signaling, media, TURN, and conferencing servers), it is essential to:

Run Rainbow Pilot tests from each relevant subnet to validate that all components have proper connectivity and performance to the required cloud endpoints.

This ensures that:

• The PBX can connect to the Rainbow datacenter.
• The WebRTC Gateway can connect to the Rainbow datacenter and relay SIP calls to remote Rainbow clients or TURN servers.
• Rainbow Clients can connect to the Rainbow datacenter and conduct media sessions with remote clients or Rainbow conference servers.

Failing to test each network segment may result in undetected issues that impact call quality, registration, or service availability.

Network Testing Across Subnets for Rainbow Hub Topology

In a Rainbow Hub deployment, Rainbow clients and SIP devices (such as SIP phones) may reside on different networks, VLANs, or subnets. These components must interconnect and reach the Rainbow Hub Cloud PBX instance assigned to the company’s region, using specific protocols and services.

Run Rainbow Pilot tests from each relevant subnet to validate that all components have proper connectivity and performance to the required cloud endpoints.

This ensures that:

• SIP phones can register and communicate with the Hub Cloud PBX using SIP or SIP-TLS.
• Media streams (SRTP/UDP) are reliably transmitted across the network.
• Devices can retrieve configuration and firmware updates via HTTPS from Rainbow’s provisioning service.
• Time synchronization via NTP is available and stable.
• DHCP-based provisioning works correctly when applicable.
• Rainbow Clients can establish signaling and media sessions without degradation.

Testing each network segment helps identify issues that could affect registration, media quality, or service availability; especially in segmented or multi-VLAN environments.

Which Logs to Collect in Rainbow Pilot and Why

Rainbow Pilot generates several types of logs during connectivity tests and WebRTC diagnostics. Understanding which logs to collect — and what each one is useful for — helps streamline troubleshooting and ensures you get the right insights without unnecessary technical clutter.

Overview of Available Logs

What Each Log Is Useful For

1. Client connection Logs

• Captures the same level of detail as the full Rainbow client logs.
• Includes WebRTC call test data such as ICE negotiation, media setup, and signaling.
• Use when: You need to understand why a WebRTC call test failed or want parity with full client diagnostics.

2. Agent Logs

• Generated by the agent conducting connectivity tests.
• Contains verbose, developer-oriented traces.
• Use when: You're debugging the Pilot itself or need to trace the internal logic of test execution.

3. About Box Logs

• A simplified, easy-to-access summary of connectivity test results.
• More readable and accessible than agent logs.
• Use when: You want a quick snapshot of test outcomes without diving into technical details.

4. Exported Reports (PDF/Excel)

• Designed for sharing and archiving.
• Summarizes test results in a structured format.
• Use when: You need to present findings to stakeholders or keep a record of test outcomes.

Recommended Collection Strategy

• Start with the About Box log for quick diagnostics.
• Add Client connection logs if WebRTC issues are suspected.
• Use Agent logs only if deeper debugging is needed.
• Export a PDF or Excel report for documentation or sharing ( it is recommended to take the Excel report).

Tips: Best practice and recommendation is to collect ALL logs + the Excel Report and attach all files to the support ticket.

Next Steps

The next major steps involve addressing additional considerations when planning a Rainbow deployment:

Capacity Planning: the ability to estimate Rainbow-related WAN traffic for a projected number of users in peak hours, accounting for collaboration, conferencing, and telephony usages.

Traffic Tests: leveraging the results of capacity planning, the ability to generate the corresponding traffic flows between a company's site and Rainbow datacenters. Such tests will cover the intended usage patterns for a specified user population, with assumptions regarding usage levels and behavior during peak hours, and provide quality metrics in return.

Questions and Feedback

In the interim, we will continue to iterate on tuning and enhancing the tool, accounting for your feedback, which is highly encouraged and can be shared in our  Community area.

Should you face an issue using the tool, please use the standard Rainbow support process.