.. _trackme_admin_vtenants_manage:

Manage Virtual Tenants
######################

Access tenants management menu
==============================

**To manage the life cycle of a Virtual Tenant, click on the tenant menu from the Virtual Tenants user interface:**

.. image:: img_v2/manage_vtenants/access_admin.png
   :alt: access_admin.png
   :align: center
   :width: 1200px
   :class: with-border

Knowledge Objects Explorer
--------------------------

**This screen allows you to easily get the full list of Knowledge Objects and their types for that specific tenant:**

.. image:: img_v2/manage_vtenants/kos_explorer.png
   :alt: kos_explorer.png
   :align: center
   :width: 1200px
   :class: with-border

Manage components (add/delete components to/from a tenant)
----------------------------------------------------------

**This screen allows to add or delete a component to an existing Virtual Tenant:**

.. image:: img_v2/manage_vtenants/modify_components.png
   :alt: modify_components.png
   :align: center
   :width: 1200px
   :class: with-border

.. attention:: **Deleting a component**

   - When deleting a component from a Virtual Tenant, all TrackMe related knowledge objects are permanently deleted.
   - Related KVstores content are as well permanently purged, this operation cannot be undone unless the tenant is restored from a backup.

Updating RBAC and ownership
---------------------------

**The screen allows you to modify the current RBAC policies and the Splunk ownership for this tenant:**

.. image:: img_v2/manage_vtenants/rbac.png
   :alt: rbac.png
   :align: center
   :width: 1200px
   :class: with-border

**When updating the policies or ownership:**

- All Knowledge Objects will be updated accordingly
- If the owner is changed, all Knowledge Objects will automatically be reassigned to the target Splunk user
- Future TrackMe objects will be created and assigned to the owner user defined for the Virtual Tenant

**This can as well be performed via the REST endpoint and the following SPL command:**

::

    | trackme url=/services/trackme/v2/vtenants/admin/update_tenant_rbac mode=post body="{ 'tenant_id': 'flx-demo', 'tenant_roles_admin': 'trackme_amer_admin', 'tenant_roles_user': 'trackme_amer_user', 'tenant_owner': 'svc_trackme'}"

.. image:: img_v2/manage_vtenants/rbac_rest.png
   :alt: rbac_rest.png
   :align: center
   :width: 1200px
   :class: with-border      

Enabling / Disabling a tenant
-----------------------------

**You can enable / disable a tenant at any time, when disabling a tenant:**

- All Knowledge Objects are disabled in Splunk
- None of the executions related to that tenant will be performed as long as the tenant is disabled
- No data is removed, but all entities are inactive and not maintained anymore
- A disabled tenant can be re-enabled by an admin at any time

.. image:: img_v2/manage_vtenants/disable_tenant.png
   :alt: disable_tenant.png
   :align: center
   :width: 1200px
   :class: with-border     

.. image:: img_v2/manage_vtenants/disable_tenant2.png
   :alt: disable_tenant2.png
   :align: center
   :width: 1200px
   :class: with-border    

You can disable a tenant using the REST endpoint with the following SPL command:

::

    | trackme url=/services/trackme/v2/vtenants/admin/disable_tenant mode=post body="{ 'tenant_id': 'flx-demo'}"

.. image:: img_v2/manage_vtenants/disable_tenant3.png
   :alt: disable_tenant3.png
   :align: center
   :width: 1200px
   :class: with-border    

You can enable a tenant using the REST endpoint with the following SPL command:

::

    | trackme url=/services/trackme/v2/vtenants/admin/enable_tenant mode=post body="{ 'tenant_id': 'flx-demo'}"

.. image:: img_v2/manage_vtenants/disable_tenant4.png
   :alt: disable_tenant4.png
   :align: center
   :width: 1200px
   :class: with-border    

Deleting a tenant
-----------------

**When deleting a tenant:**

- All of its related objects are permanently deleted
- This operation cannot be undone, KVstore collection are flushed and could only be restored from backups, objects such as Hybrid trackers would need to be re-created
- Once a tenant has been deleted, there are no traces of the tenant left apart from the previously generated events and metrics which are left untouched

.. image:: img_v2/manage_vtenants/delete_tenant.png
   :alt: delete_tenant.png
   :align: center
   :width: 1200px
   :class: with-border   

**You can delete a tenant using the REST endpoint with the following SPL command:**

::

    | trackme url=/services/trackme/v2/vtenants/admin/del_tenant mode=delete body="{ 'tenant_id': 'flx-demo'}"

.. image:: img_v2/manage_vtenants/delete_tenant2.png
   :alt: delete_tenant2.png
   :align: center
   :width: 1200px
   :class: with-border

SLA compliance
==============

In TrackMe, the SLA compliance purpose is to track the level of quality from the lens of the percentage of time spent in green state for a given entity.

This Key Performance Indicator (KPI) is a concept that you can then rely on to report the level of quality of the Splunk data availability according to your context.

**To access the SLA dashboard from a Virtual Tenant, click on the "Open SLA overview" link from the tenant menu:**

.. image:: img_v2/manage_vtenants/sla_overview.png
   :alt: sla_overview.png
   :align: center
   :width: 1200px
   :class: with-border