Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Device lab management section added with three new pages #215

Merged
merged 4 commits into from
May 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ nav:
- modules/organization/nav.adoc
- modules/test-management/nav.adoc
- modules/reporting/nav.adoc
- modules/device-lab-management/nav.adoc
- modules/supported-platforms/nav.adoc
- modules/api-reference/nav.adoc
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/modules/device-lab-management/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.xref:index.adoc[]
* deviceConnect
** xref:deviceConnect/hardware-requirements-for-deviceconnect.adoc[]
** xref:deviceConnect/retrieve-deviceconnect-logs.adoc[]
** xref:deviceConnect/restart-deviceconnect-services.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
= Hardware requirements for deviceConnect
:navtitle: Hardware requirements for deviceConnect

== Hardware requirements for deviceConnect
deviceConnect requires an M1 or M2 Mac mini - the *Mac mini host* - with the following minimum specs:

- macOS Sonoma 15.3
- At least 24GB RAM
- At least 512GB SSD (1TB optimal)

[IMPORTANT]
The Mac mini host must be dedicated to hosting Kobiton and devices. Do not install any additional software not mentioned in install documentation.

A Mac mini workstation can host up to 15 mobile devices. Use one of the following Cambrionix hub models to connect mobile devices to the workstation:

- link:https://www.cambrionix.com/products/powerpad15s-pp15s-industrial-usb-hub[PowerPad15S]
- link:https://www.cambrionix.com/products/supersync15/[SuperSync15]

You need one USB 3.0 cable to connect a hub to the Mac mini. We recommend shielded USB 3.0 cables. For Standard mode, 3ft or 6ft cables are usually sufficient.
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
= Restart deviceConnect services
:navtitle: Restart deviceConnect services

Sometimes, Hybrid and On-prem customers hosting dedicated devices need to restart deviceConnect services on the Mac mini host to apply configuration changes or software updates. This action can be performed from the Kobiton Portal via the Device Management page.

[NOTE]
When you restart deviceConnect services, all devices linked to the Mac mini will become inaccessible and any active test sessions will be terminated. Make sure to restart the correct Mac mini and inform all affected users beforehand.

== Prerequisites
- Gather the internal IP address or hostname of the Mac mini host(s)
- Kobiton administrator with the ADMIN predefined permission

== Steps to restart deviceConnect services
Log in to the Kobiton Portal with an administrator account.

include::profile:partial$open-settings.adoc[]

Select the *Device Management* tab.

The *Device Management* page lists all dedicated mobile devices for the org grouped by Mac mini host. Locate the Mac mini host you want to restart and click the corresponding *Restart services* button.

image:device-lab-management:restart-dc-restart-services-button.PNG[]

In the confirmation modal, choose *Restart Services* again to proceed.

Any active sessions on devices hosted by that Mac mini will be terminated. During the service restart, no actions can be performed on the Mac mini or the connected devices (all the buttons are grayed out). A notification is displayed when the restart completes successfully.

image:device-lab-management:restart-dc-services-restart-successful-popup.PNG[]

After the service restart completes, the devices should automatically come back online.

== Impacts on active test sessions during a restart
When a Mac mini host's services are restarted using the above method, active sessions on devices hosted by that Mac mini experience the following:

- In the Manual or Mixed session, the user receives a _Device disconnected_ error message and the session is terminated with a status of _Terminated_.
+
image:device-lab-management:restart-dc-devices-disconnect-popup.PNG[]

- Automation and revisit sessions are also terminated with a status of _Terminated_.

== Additional notes
- For those with a GEM server, services on the GEM cannot be restarted via the Kobiton Portal. Contact Kobiton support for help to restart the GEM server.
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
= Retrieve deviceConnect logs
:navtitle: Retrieve deviceConnect logs

Logs are a critical tool for troubleshooting and essential when submitting tickets to Kobiton Support.

This document outlines how Hybrid and On-prem customers who host dedicated devices can gather deviceConnect logs from the Mac mini host running Kobiton software.

== Prerequisites

- Gather the internal IP address or hostname of the Mac mini host(s).
- Kobiton administrator with the ADMIN predefined permission.

== Two ways to gather deviceConnect logs
There are currently two methods to gather deviceConnect logs.

=== From Kobiton Portal

Log in to the Kobiton Portal with an administrator account.

include::profile:partial$open-settings.adoc[]

Look for the host using its internal IP address or hostname.

Click Save Logs (3 days), or click the dropdown icon and select Save Logs (7 days).

image:device-lab-management:dc-logs-save-logs-dropdown-portal.PNG[]

Wait for the system to gather the logs. When the logs are ready, click the *Download icon*. The logs are downloaded as a .zip archive.

image:device-lab-management:dc-logs-save-logs-button-portal.PNG[]

If the host does not appear on the Device Management page or the Save Logs button for that host is grayed out, see the next section to gather logs using deviceConnect application directly on the Mac mini host.

=== From deviceConnect on the Mac mini host
If deviceConnect logs are not available from the Kobiton Portal, they can typically be retrieved from the deviceConnect application. Access the Mac mini host using the IP address or hostname, or use any machine that is inside the same network as the Mac mini.

Open Chrome browser. Enter localhost (using the Mac mini itself) or the local IP address of the Mac mini (using other computers) in the address bar.

Log into the deviceConnect portal, then click the *Systems* tab.

Under System logs, choose the duration to gather the logs (the default is 2 days), then click *Save logs*.

image:device-lab-management:dc-logs-save-logs-button-gigafox.PNG[]

The logs are downloaded as a .zip archive.


8 changes: 8 additions & 0 deletions docs/modules/device-lab-management/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
= Device lab management
:navtitle: Device lab management

tungmhoang marked this conversation as resolved.
Show resolved Hide resolved
Learn how to manage and organize mobile devices, as well as set up and configure Kobiton software for your Hybrid or OnPrem device lab.

== In this section

include::../nav.adoc[lines=2..]
2 changes: 1 addition & 1 deletion docs/modules/profile/partials/open-settings.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Open your settings

First, select your profile name and picture. Then select *Settings*.
Select your profile name or picture, then choose **Settings**.

image:profile:choose-settings-context.png[width=1000,alt="Select your profile name and select Settings"]
Loading