Real-Time Working Group

Attributes

Business Goal

To ship one real-time feature to self-managed customers.

Exit Criteria - Phase 1

(✅ Done, ✏️ In-progress)

One Working Real-Time Feature, Usable by Single Instance/Small Cluster, Self-Hosting Customers => 100%

• Supports starting Action Cable in embedded mode ✅
• Omnibus includes ability to start embedded Action Cable with config/cable.yml ✅
• GDK supports configuration of Action Cable ✅
• Workhorse Proxies Action Cable requests ✅
• Backend work is complete to upgrade websocket connections and push signal when assignees are updated on an issue ✅
• Frontend work is complete to respond to WebSockets with an update to the sidebar ✅
• Action Cable settings are exported to Prometheus ✅
• Track ActionCable settings in Usage Ping ✅
• Documentation enabled to advise customers on using the feature in small deployments ✅
• Feature usable conditionally when Action Cable is enabled ✅

Exit Criteria - Phase 2

(✅ Done, ✏️ In-progress)

One Working Real-Time Feature, Usable on larger deployments => 100%

• Omnibus includes ability to start standalone Action Cable Puma Server with config/cable.yml ✅
• GDK allows configuration of standalone Action Cable and starts Puma server ✅
• Workhorse Proxies Action Cable requests ✅
• Establish reference architectures for supporting WebSocket connections at scale ✅
• Helm charts allow configuration of embedded Action Cable in webservice service ✅
• QA work complete to test initial feature ✅
• Feature flag defaulted to on, with suitable fallback ✅

Working, Real-Time Feature Available on .com => 100%

• Containerization of Real-Time Feature including Action Cable and Puma ✅
• Update of Helm charts allowing use of multiple Redis instances ✅
• WebSocket requests supported in Kubernetes ✅
• Deployment to a non-production environment for manual, full-stack testing ✅
• Action Cable requests served by Kubernetes pods on Staging ✅
• Action Cable requests served by Kubernetes pods on Canary ✅
• Readiness-review complete to ensure observabilty & contain risk ✅
• Action Cable requests served by Kubernetes pods on Production ✅
• Default to embedded Action Cable enabled ✅

Design Document

Technical decisions and rationale are captured in this design document.

Roles and Responsibilities

Meetings

Meetings are recorded and publicly available on YouTube in the Real-Time Working Group playlist.

View page source - Edit this page - please contribute.