From 9cd2dc3dca5233f576a9414c03bd38e6e74765f9 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 6 Oct 2026 08:11:30 +0000 Subject: [PATCH] docs(KOB-52679): update docs and release note --- docs/modules/device-lab-management/nav.adoc | 1 + .../pages/virtualusb-routing.adoc | 63 +++++++++++++++++++ .../release-notes/partials/KOB-52679.adoc | 16 +++++ 3 files changed, 80 insertions(+) create mode 100644 docs/modules/device-lab-management/pages/virtualusb-routing.adoc create mode 100644 docs/modules/release-notes/partials/KOB-52679.adoc diff --git a/docs/modules/device-lab-management/nav.adoc b/docs/modules/device-lab-management/nav.adoc index 9710e481d..cae5e25c8 100644 --- a/docs/modules/device-lab-management/nav.adoc +++ b/docs/modules/device-lab-management/nav.adoc @@ -21,3 +21,4 @@ * xref:device-lab-management:device-management-page.adoc[] ** xref:device-lab-management:search-host-machines.adoc[] ** xref:device-lab-management:tidy-up-devices.adoc[] +** xref:device-lab-management:virtualusb-routing.adoc[] diff --git a/docs/modules/device-lab-management/pages/virtualusb-routing.adoc b/docs/modules/device-lab-management/pages/virtualusb-routing.adoc new file mode 100644 index 000000000..562f98135 --- /dev/null +++ b/docs/modules/device-lab-management/pages/virtualusb-routing.adoc @@ -0,0 +1,63 @@ += Kobiton-managed routing for virtualUSB +:navtitle: Kobiton-managed virtualUSB routing + +// Generated by Robot Ranch (Ledger) from KOB-52679. Draft for docs-team review. +// Source: KOB-52679 + +== Overview + +Kobiton-managed routing makes virtualUSB traffic for a host machine reachable without manual IP address management. Kobiton sets up routing when virtualUSB is enabled on the host machine and removes it when virtualUSB is turned off. + +== Availability + +* Available to organizations subscribed to virtualUSB. +* Organization admins configure routing on the *virtualUSB* tab of the host machine *Settings* dialog in *Device Management*. +* *Managed by Kobiton* appears as a routing option only when Kobiton-managed routing is available for the organization. + +// REVIEWER NOTE: Confirm deployment availability (Cloud, Hybrid, Standalone). The 4.27.0S +// release notes exclude the virtualUSB tab as not yet available on Standalone. +// +// REVIEWER NOTE: The Jira ticket does not say what an admin does when *Managed by Kobiton* +// is not offered. Confirm whether to direct admins to Kobiton Support. + +== How routing works + +Each host machine with virtualUSB enabled uses one of two routing options: + +*Managed by Kobiton*:: +Kobiton provisions and removes routing for the host machine automatically. + +Self-managed:: +The organization manages routing and the connection address. Saving a self-managed host machine does not change Kobiton routing. + +// REVIEWER NOTE: Confirm the exact UI label for the self-managed routing option. + +Kobiton provisions routing when virtualUSB is enabled on a host machine that uses *Managed by Kobiton* routing. + +Kobiton removes routing when either of the following happens: + +* virtualUSB is turned off on the host machine. +* The host machine changes from *Managed by Kobiton* to self-managed routing. + +// REVIEWER NOTE: The Jira release summary states that active virtualUSB sessions on the host +// machine end before routing is removed. The Jira development notes list graceful session +// termination as deferred, and the test notes do not cover it. Confirm before documenting. + +== Provisioning status + +After the settings are saved, routing provisioning is in progress until routing is ready. When provisioning completes, virtualUSB is enabled on the host machine. + +If provisioning fails: + +* virtualUSB is turned off on the host machine, and the host machine shows a failed provisioning status. +* Enable virtualUSB on the host machine again to retry. + +If Kobiton cannot start provisioning when the settings are saved, the save returns an error and the previous settings are restored for every host machine in the save. + +// REVIEWER NOTE: Confirm the UI labels shown for the in-progress, complete, and failed +// states, and the error message shown when a save fails. + +== Related guides + +* xref:device-lab-management:device-management-page.adoc[] +* xref:debugging:set-up-virtualusb.adoc[] diff --git a/docs/modules/release-notes/partials/KOB-52679.adoc b/docs/modules/release-notes/partials/KOB-52679.adoc new file mode 100644 index 000000000..feeb6196c --- /dev/null +++ b/docs/modules/release-notes/partials/KOB-52679.adoc @@ -0,0 +1,16 @@ +// Generated by Robot Ranch (Town Crier). Draft for docs-team review. +// Source: KOB-52679 + +== Device Management + +- Host machines that use *Managed by Kobiton* routing for virtualUSB now have network routing set up automatically when virtualUSB is enabled. Routing is removed when virtualUSB is turned off or the host machine changes to self-managed routing. No IP address management is required. +- If routing setup fails, virtualUSB turns off on the host machine and the machine shows a failed status. Enable virtualUSB again to retry. +- *Managed by Kobiton* appears as a routing option only when Kobiton-managed routing is available for the organization. +- Host machines that use self-managed routing are not affected. + +// REVIEWER NOTE: The Cloud September 18, 2026 release notes already announce the virtualUSB +// tab and the routing choice under KOB-52659 (cites KOB-52679). Merge this entry into that +// section or publish it as a follow-up, so the routing choice is not announced twice. +// +// REVIEWER NOTE: Confirm the deployment types this applies to and the UI labels for the +// self-managed option and the failed status.