Configurator
============

User guide for configurator tool
--------------------------------

1. Authentication
* The UI has authenticaiton mechanism enabled, which allows users only in selective group to access
the application. Please refer :doc:`Auth` for group details in which user must be present. Please request
the IT team to get registered in one of the groups.

.. note::
    Please note the authentication requires a persistent namespace which needs to be registered in MS Entra.
    Please reach out to `#team-himalaya <https://app.slack.com/client/T1T3Q6ZR9/C03FAHGEXF1>`_  slack channel to get your namespace registered.

* Once namespace is registered and user is present in the required groups, the member can proceed with login
  by clicking on the button as showed in the snapshot below and please proceed with microsoft login.

.. image:: images/login.png
   :alt: login

2. Configuration of attribute

.. note::
    Please note the cross deployment configuration manager and event subscriber combination is currently not supported.
    It is a limitation in current HDBPP version.
    Please use event subscriber from same the facility as of configuration manager.


.. image:: images/configure_page.png
   :alt: configuration_page

* There are two format which any user can utilise for configuration.
    - `new format <https://developer.skao.int/projects/ska-eda-yaml2archiving/en/latest/yam2archiving.html#example-yaml-configuration>`_.
    - `old format <https://confluence.skatelescope.org/display/UD/Attribute+Configuration+for+archiving#AttributeConfigurationforarchiving-ConfigurationFileFormat>`_.

* User can select format to utilise for archiving and operation to perform add/update/perform and provide a yaml file for the same.

- For example: 

    - Adding attribute using new format.

    .. image:: images/add.png
       :alt: submit

    - Once attributes are successfully configured, it can be viewed in the resultant table below.
    
    .. image:: images/add_result.png
       :alt: table_result

    - Updating an attribute configuration using new format
   
    .. image:: images/update.png
       :alt: update_submit

    - Change result reflected in the table once completed successfully.
   
    .. image:: images/update_result.png
       :alt: update_result

    - Removing an attribute configuration using new format.
    
    .. image:: images/remove.png
       :alt: remove_submit

    - Remove result reflected in the table once completed successfully.
   
    .. image:: images/remove_result.png
       :alt: remove_table_result


* User can download in any desired file format as required. 

.. note::
    Please note if the configuration manager is not related to event subscriber provided, 
    it would not get reflected in the downloaded configuration.
    
- For Example:

    - Downloading configruation data in new format from specific event subscriber and configuration manager.


      .. image:: images/download_specific.png
         :alt: download_specific
    
    - Downloading configuration data in new format from all instances of es and cm present in current deployment.
      Please use "*" in place of instance to get data from all instances.

      .. image:: images/download_all.png
         :alt: download_all

    - Downloading configuration data in new format from es without cm. The cm field is not mandatory.

      .. image:: images/download_withoutcm.png
         :alt: download_withoutcm

    - Downloading configuration data in new format from multiple es and cm.
      Please use "," separated values to specify multiple cm and es.

      .. image:: images/download_multiple.png
         :alt: download_multiple

    - Downloading configuration data in old format from specific es.

      .. image:: images/download_old.png
         :alt: download_old