================================
Execute the Local Repo Playbook
================================

The local repository playbook (``local_repo.yml``) downloads and saves the software packages/images to the **Pulp container**, which all cluster nodes can access.

Configurations made by the playbook
=======================================

    * With ``repo_config`` set to ``always`` in ``/opt/omnia/input/project_default/software_config.json``, all images and artifacts will be downloaded to the Pulp container present on the NFS share.

    * If  ``repo_config`` is set to ``always``, the OIM serves as the default Pulp registry.

Playbook Execution
=====================

To create local repositories on the Pulp container, execute the ``local_repo.yml`` playbook using the following command: ::

    ssh omnia_core
    cd /omnia/local_repo
    ansible-playbook local_repo.yml

Metadata Report
===================

After a successful execution of the ``local_repo.yml`` playbook, a metadata file called ``localrepo_metadata.yml`` is created under the ``/opt/omnia/offline_repo/.data/`` directory. 
This file captures the ``repo_config`` (``always``, ``partial``) details provided during the playbook execution. 
If the ``local_repo.yml`` playbook is re-run, it compares the current repository policy with the previously captured metadata. Based on this, there can be two scenarios:

    * If a change in policy is detected, you will be prompted to confirm whether to proceed with the updated configuration or not.

        * If you agree, the playbook continues with the updated policy and after successful execution, it updates the metadata file with the new repository policy.
        * If you decline, the playbook execution is aborted and the metadata file remains unchanged.

    * If there is no change in policy, the playbook execution proceeds without prompting. The metadata file remains unchanged.
         
Check Status of the Packages
===============================

After ``local_repo.yml`` has been executed, a status report is displayed containing the status for each downloaded package along with the complete playbook execution time. Here's an example of what that might look like:

.. image:: ../../../images/local_repo_status.png

**SUCCESS**: The package has been successfully downloaded to the Pulp container.

**FAILED**: The package couldn't be downloaded successfully.

.. note::

    * The ``local_repo.yml`` playbook execution fails if any software package has a ``FAILED`` status. In such a scenario, the user needs to re-run the ``local_repo.yml`` playbook.

    * If any software package fails to download during the execution of this playbook, other scripts/playbooks that rely on the package may also fail.

    * To download additional software packages after the playbook has been executed, simply update the ``/opt/omnia/input/project_default/software_config.json`` with the new software information and re-run the ``local_repo.yml`` playbook.

Log Files
===========

The ``local_repo.yml`` playbook generates and provides two types of log files as part of its execution:

1. ``standard.log``: This log file is present in the ``/opt/omnia/log/local_repo`` directory, and contains the overall status of the ``local_repo.yml`` playbook execution.

2. **Package based logs**: Each package download initiated by the ``local_repo.yml`` playbook comes with its own log file. These log files can be accessed from ``/opt/omnia/log/local_repo``.

.. note:: To view the log files in ``.csv`` format, navigate to ``/opt/omnia/log/local_repo/<arch_type>/<sw_name>/status.csv``.

Here's an example of how the log files are organized in the ``/opt/omnia/log/local_repo`` directory:

.. image:: ../../../images/local_repo_log_updated.png

Updating Local Repositories after Modifying JSON Files
==========================================================

After the execution of the ``local_repo.yml`` playbook is complete, any modifications made to a ``<software_name>.json`` file (for example, ``service_k8s.json``, ``slurm_custom.json``, ``additional_software.json``) will **not** be reflected in the local repositories automatically.
To apply the changes, you must **re-run the** ``local_repo.yml`` **playbook**.

Command Format
--------------

::

   ansible-playbook local_repo.yml 

Local Repository Resync
======================

The Local Repository Resync feature updates the local RPM repositories by synchronizing them with their respective remote sources. During resynchronization, new and updated RPM packages are downloaded, repository metadata is refreshed, and only incremental changes are fetched while preserving the existing local cache. This operation can be performed whenever remote repositories are updated, repository configurations are modified, or to ensure the local repositories remain current. Ensure that the initial local repository setup is complete, network connectivity to the remote repositories is available, and sufficient disk space is present before running the resync.

Command Format
--------------

Resync all RPM repositories:

.. code-block:: bash

    ansible-playbook local_repo.yml -e "resync_repos=all"

Resync specific RPM repository:

.. code-block:: bash

    ansible-playbook local_repo.yml -e "resync_repos=x86_64_epel"

.. note::
   * Use ``all`` to resync all configured RPM repositories
   * Specify exact RPM repository name for targeted resync
   * Existing RPM packages remain available during sync
   * Logs created in ``/opt/omnia/log/local_repo/``