.. _base-functionality:

############################################
Device Management and Performance Monitoring
############################################

.. _om-devices:

Devices
=======

The **Devices** page lists all devices of the tenant. From here you can open each
device to see its details, monitor it or connect to it. On the **Devices** page you can:

* see all devices of the tenant, with their connection status and operating system,
* search for a device,
* add a new device with **Add device**,
* manage your SSH keys with **SSH keys**.

.. figure:: images/devices-view.png
   :alt: Devices page
   :width: 100%
   :align: center

   Devices page

Click a device to open its details. The device view has six tabs:

* :ref:`Info <om-device-info>`,
* :ref:`Performance <om-device-performance>`,
* :ref:`Networking <om-device-networking>`,
* :ref:`Terminal <om-device-terminal>`,
* :ref:`Variables <om-device-variables>`,
* :ref:`Compositions <om-device-compositions>`.

.. _om-device-info:

Info
====

The **Info** tab shows a quick summary of the key device information:

* **Device info**: name, ID, hostname, last time online and first registration,
* **Basic Info**: CPU, CPU architecture, number of cores and RAM,
* **On/Off states**: when the device was online over time,
* **Operating System**: host OS and kernel version.

.. figure:: images/device-info.png
   :alt: Info tab of a device
   :width: 100%
   :align: center

   Info tab

.. _om-device-performance:

Performance
===========

The **Performance** tab gives a deeper view of the device metrics. It shows charts of:

* CPU usage,
* memory usage,
* incoming network traffic,
* outgoing network traffic.

.. tip:: Use the list above the charts to show the last 1 hour, 6 hours, 24 hours or 7 days of performance.

.. figure:: images/device-performance.png
   :alt: Performance tab of a device
   :width: 100%
   :align: center

   Performance tab

.. _om-device-networking:

Networking
==========

The **Networking** tab shows the status of all network interfaces of the device, for
example their IP addresses, hardware address, default route and DNS.

.. figure:: images/device-networking.png
   :alt: Networking tab of a device
   :width: 100%
   :align: center

   Networking tab

.. _om-device-terminal:

Terminal
========

The **Terminal** tab gives you quick SSH access to the device. You can:

* click **Start session** to open a terminal in the browser,
* click **Connect from your terminal** to connect from the terminal on your computer.

You can open several sessions with the same device at once.

Orchestra keeps the terminal fast thanks to WebTransport technology. Whenever possible,
your browser connects to the device directly. If a direct connection isn't possible,
Orchestra sets up a proxy for you.

.. figure:: images/device-terminal.png
   :alt: Terminal tab of a device
   :width: 100%
   :align: center

   Terminal tab

.. _om-connect-from-terminal:

Connect from your terminal
--------------------------

1. Click **Connect from your terminal**.
2. Select your operating system: **macOS**, **Linux** or **Windows**.
3. Copy the command and run it in your terminal. It creates an ed25519 key if you
   don't have one, and copies the public key to your clipboard.
4. Paste the public key, or click **or pick the .pub file**.
5. Optional: enter a key name and click **Store the key** to use it next time.
6. Click **Issue certificate**.

.. note:: Your private key never leaves your computer. Only the public key is stored.

.. tip:: If you don't have a key, click **Generate a key pair for me instead**.

.. figure:: images/connect-from-terminal.png
   :alt: Connect from your terminal window
   :width: 70%
   :align: center

   Connect from your terminal

.. _om-device-variables:

Variables
=========

The **Variables** tab shows the variables that customize the behavior of applications
and compositions deployed to the device. Variables are key-value pairs, so you can adapt
deployments to different environments without changing the compositions. For each
variable you can see its key, current value and overridden value.

.. figure:: images/device-variables.png
   :alt: Variables tab of a device
   :width: 100%
   :align: center

   Variables tab

Click a variable to see its details. The label in the corner shows where the variable
comes from, for example **FLEET**. An inherited variable can't be edited here. Edit it
where it originates from.

.. figure:: images/variable-details.png
   :alt: Variable details window
   :width: 70%
   :align: center

   Variable details

.. _om-device-compositions:

Compositions
============

The **Compositions** tab lists all containerized applications (compositions) deployed
to the device.

The summary shows how many compositions are planned, in progress, completed,
degraded, failed or unknown.

.. figure:: images/device-compositions-summary.png
   :alt: Compositions summary of a device
   :width: 70%
   :align: center

   Compositions summary

The list below shows each composition with its name, ID, current released version,
fleet name, fleet ID and status.

.. figure:: images/device-compositions-list.png
   :alt: List of compositions deployed to a device
   :width: 100%
   :align: center

   Compositions list