AutoConfiguration
=================


User guide to utilise auto configuration
----------------------------------------

.. note::
    Please note that the auto configuration script waits for event subscribers
    and configuration managers present in same deployment.
    The script will only able to configure attribute using archivers which are deployed already.

* The auto configuration script is ran only once at time of start of deployment.

* User can utilise 2 ways to enable auto configuration:

1. Using CAR:

    - User can provide file updaloaded in CAR using tmdata.

    - The deployment accepts two keys ``car_sources`` and ``car_file_path`` to utilise the file for configuration.

    - For Example :
        - In values.yaml file please update following:

        - ``car_sources: "car:ska-tmc/ska-tmc-simulators?main"``

        - ``car_file_path: "archiver_configuration/mid_configuration/archiver_configuration_old.yaml"``

2. Using external link:

    - User can provide any downloadable link where yaml is present.

    - For Example:
      - In values.yaml file please update following:

      - ``configuration_file_url: "https://gitlab.com/ska-telescope/ska-eda/ska-tango-archiver/-/raw/master/example_add_attribute.yaml?ref_type=heads&inline=false"``

* User can utilise both old and new format for the auto configuration by updating ``is_auto_config_format_new`` in values.yaml.
  Set it as ``true`` if format is new else set it as ``false``. Default value is ``false``.