.. meta::
   :description: Guide to managing the ThinLinc cluster through the web
                 administration interface. Contains subclusters and
                 agent settings.

.. _tlwebadm_cluster:

Cluster module
~~~~~~~~~~~~~~

The cluster module contains information about the ThinLinc cluster, and
allows managing of subclusters and agents.

-  :guilabel:`Subclusters` allows viewing, adding, modifying or deleting
   subclusters.

-  :guilabel:`Agents` allows adjusting agent settings for the cluster.

.. _tlwebadm_cluster_subclusters:

Subclusters
^^^^^^^^^^^

On this page, the configured subclusters of the ThinLinc master can be
found. Subclusters are groups of agents that can be associated with
users or groups. Adding, modifying or deleting existing subclusters is
possible. A restart of the **vsmserver** service is required after
changes to subcluster configuration in order for the changes to take
effect. A toast will be shown after saving, facilitating a service
restart.

The page will present a list of currently configured subclusters. This
should be something like the example in
:numref:`tlwebadm_subcluster_list`. To edit a subcluster, click on its
name in the list.

.. _tlwebadm_subcluster_list:

.. figure:: images/tlwebadm-subcluster-list.svg

   Subclusters

:numref:`tlwebadm_subcluster_list` shows a system with a total of two
subclusters. The subcluster called :guilabel:`default` is configured
with two agent servers and :guilabel:`US_cluster` is configured with one
agent.

To add a new subcluster to the list, press the :guilabel:`Add new
subcluster` button. This will bring up an empty subcluster edit pop-up.
See figure :numref:`tlwebadm_subcluster_new` for an example.

.. _tlwebadm_subcluster_new:

.. figure:: images/tlwebadm-subcluster-new.svg

   New subcluster pop-up

There are five editable fields in this view: :guilabel:`Subcluster`,
:guilabel:`Agents`, :guilabel:`Users`, :guilabel:`Groups` and
:guilabel:`Limit sessions`. The first field controls the name of the
subcluster. The rest are described in
:ref:`configuration_subcluster_params`. To save changes, press the
:guilabel:`Save` button.

.. _tlwebadm_cluster_agents:

Agents
^^^^^^

On this page, it is possible to configure the weight of agents, and the
draining of sessions on agents. The weights allow adjusting the distribution of
users across agents in the cluster. Enabling draining for an agent prevents new
sessions from being created on that agent.

A restart of the **vsmserver** service is required after changes to weight or
draining configuration in order for the changes to take effect. A toast will be
shown after saving, facilitating a service restart.

The page will present two lists as shown in
:numref:`tlwebadm_subcluster_agents`. The first consists of currently
configured agents along with its weight. The details on how the weight works is
described in :ref:`configuration_agents_params`. The second list consists of
configured agents along with toggles for enabling draining of each agent. See
:ref:`stop_new_sessions_on_agent` for details on draining agents.

.. _tlwebadm_subcluster_agents:

.. figure:: images/tlwebadm-subcluster-agents.svg

   Agent configuration
