.. _fleets-overview:

########################
Overview Page
########################

*In this chapter we are going to show you what is available on the Overview page in the Fleets section. We will cover fleet info, fleet status, dashboards, managing compositions and managing devices in a fleet.*


.. figure:: ../images/fl-fleet-overview.png
    :alt: Overview page
    :align: center
    :width: 800px

    Overview Page

Fleet info
=============

Fleet info contains general information about your fleet, such as its name, unique ID, and description. In this section you can change the fleet's description whenever you want. Simply start typing a new description and a pop-up will appear at the bottom of the page. Once you have finished, press the **Save** button to save the new description.

Fleet status
==============

This section shows the fleet's current status. There are several statuses that can appear there:

- **Ok** - all devices successfully received the latest release
- **Degraded** - some/all devices are still running an old release
- **Failed** - some/all devices failed to run a new release
- **In Progress** - a new release is being deployed to some/all devices
- **Planned** - a new release is planned to be deployed to some/all devices
- **Planned when online** - a new release will be deployed to some/all devices when they come online
- **Unknown** - there is no information about any recent release on some/all devices

Dashboards
============

There are **two dashboards**: **Compositions and Devices**. They show you all statuses and how many items (devices or compositions) are under each status. This helps you understand the current deployment state of the latest release, for example how many devices in the fleet still need to be updated or how many updates failed.

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

You can see the status of your compositions and add new ones right from the Overview page.

.. image:: ../images/fl-overview-compositions.png
    :alt: Compositions section
    :align: center
    :width: 800px

- **By clicking** the **\"+\"** button at the top right corner of the section, you can **add a new composition**
- Under **Status**, you can see the current status of the composition's latest release
- **By clicking** a specific **composition's ID**, you can **access the composition page**, where you can manage it

Devices
==============

You can also manage fleet devices right from the Overview page:

.. image:: ../images/fl-overview-devices.png
    :alt: Devices section
    :align: center
    :width: 800px

Here you can:

- See the **Status** of the latest release on each device
- See the **Connection status** of each device
- **Click the ID** of a specific device in order **to manage that device**
- Click the **Edit** button at the top right corner in order **to attach new devices** to the fleet **or detach them**

If you want to attach devices to your fleet or detach them from it, click the **Edit** button at the top right corner of the section. The following pop-up will appear:

.. image:: ../images/fl-editing-devices.png
    :alt: Editing devices
    :align: center
    :width: 800px

Here you can make any changes you want to the fleet's devices. When you have finished, click the **Save** button. Be careful: if you select devices and close the pop-up without saving, the fleet's device list will not change, and you will not get any notification that your devices were not added.

.. important:: Attaching a new device will immediately deploy all releases to the attached device. Detaching a device will immediately remove all fleet compositions from that device.