.. title:: Deployment Zones

Deployment Zones
========================

Deployment Zones are created to enable logical grouping of Kasm services. In large or distributed deployments, it may
be desirable to route users to Kasm services that are closer geographically to improve the user experience. In other
use cases, Deployment Zones might be defined for special network segments representing different tenants or security
enclaves. Administrators can use a their desired routing, DNS or load balancing techniques to route users to a desired
Zone.

.. image:: /images/zones/deployment_zones_diagram.png
    :width: 100%


Capabilities
-------------

Utilizing multiple deployment zones allows administrators to:

* Prefer end-user :term:`Kasms <Kasm>` are provisioned in the Deployment Zone the user is connected to.

  * When a user connects to the Kasm UI, the server will attempt to provision the Kasm on  Agents in the same Zone, only falling back to other Agent's in other Zone's if all Agents in the current zone are full or unavailable.

* Restrict certain :term:`Images <Image>` to only provision on Agent's within a given Deployment Zone.
  See `Add/Edit Kasm Images <../custom_images.html#add-edit-kasm-images>`_

  * This option is most useful if the Deployment Zones represent special network enclaves that only certain Images and perhaps certain Users should be allowed to access.


Configuring Deployment Zones
----------------------------

Defining Zone Configurations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Deployment Zones can be defined in the UI by and administrator.

.. image:: /images/zones/deployment_zones_list.png
    :width: 100%


:term:`Agents <Agent>` are assigned the Zone of whichever manager they are currently checked in to.

Once defined, the Kasm services need to be configured to be members of the given Zone.
The Deployment Zone setting for API Servers (kasm_api, kasm_manager) is set their configuration file. The default
zone is **default**

.. code-block:: bash

  grep zone_name /opt/kasm/current/conf/app/api.app.config.yaml
        zone_name: east


Assigning Zone Configurations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Ensure all Kasm services are stopped

.. code-block:: Bash

  sudo /opt/kasm/bin/stop

* Edit the **zone_name** property in api.app.config.yaml

.. code-block:: Bash

  vi /opt/kasm/current/conf/app/api.app.config.yaml

* Restart the Kasm Services

.. code-block:: Bash

  sudo /opt/kasm/bin/start