Deployment
==========

Aiviro can be run locally at your computer or it can be deployed to a server with its orchestration system.

Local deployment
----------------
For running it locally, just run your main python script of the scenario you want to start.


Server deployment
-----------------

.. note::
    Aiviro orchestration is deployed to a server with the help of docker & docker-compose.
    Therefore, you need to have `docker <https://docs.docker.com/engine/install/>`_ & `docker compose <https://docs.docker.com/compose/install/linux/>`_ installed on your server.

1. Connect to your server via ssh.
2. Go to the directory where you want to deploy Aiviro. We recommend creating a new directory for it.

.. code-block:: bash

    mkdir -p projects/aiviro  # create a new directory
    cd projects/aiviro  # go to the directory

3. Create and activate a python virtual environment.

.. code-block:: bash

    python3 -m venv venv  # create a virtual environment
    source venv/bin/activate  # activate the virtual environment

4. Install Aiviro with Prefect extra dependencies.

.. code-block:: bash

    pip install -i https://pypi.aiviro.com aiviro[prefect]

5. Deploy Aiviro orchestration server. It contains server, database and web interface.

.. code-block:: bash

    # deploying server with the default settings
    aiviro-cli deploy server start --detach

    # for information about custom deployment of the server, use --help option
    aiviro-cli deploy server start --help

6. Deploy Aiviro agent.

.. code-block:: bash

    # deploying agent with the default settings
    aiviro-cli deploy agent start --agent-name <your-agent-name> --git-url <repo-url-with-access-token> --label rdp --max-flows 1 --detach

    # for information about custom deployment of the agent, use --help option
    aiviro-cli deploy agent start --help

7. Add aiviro configuration file and set API credentials.

.. code-block:: bash

    aiviro-cli config login --client-id <your-client-id> --api-key <your-api-key> --output prefect-data/<agent-name>/volume/

8. Open the web interface in your browser, default url is http://localhost:8080. Select the ``Flow`` tab, ``Hello World`` flow and run it, in order to validate your installation.

.. figure:: ../images/orchestration_flow_tab.png
    :width: 100%

    Web interface with selected ``Flow`` tab

.. figure:: ../images/orchestration_flow_run.png
    :width: 100%

    Detailed view of the ``Hello World`` flow

9. To stop agent and server, use the following commands. You must be in the same directory where you deployed them.

.. code-block:: bash

    # stop agent
    aiviro-cli deploy agent stop --agent-name <your-agent-name>

    # stop server
    aiviro-cli deploy server stop

Successful deployment will look like this, you can check all running docker containers by running ``docker ps`` command.

.. figure:: ../images/docker_containers.png
    :width: 100%

    Running docker containers


Register Flow
^^^^^^^^^^^^^
The deployed agent contains your git repository and therefore also your flows.
However, you need to register them in the deployed environment, so that you can run them from the web interface.
Follow these steps to register your flow:

.. code-block:: bash

    # connect to the linux server
    ssh <your-username>@<your-server-ip>
    # enter the agent container
    docker exec -it <agent-container-name> /bin/bash
    # navigate to git repository directory
    cd git-repo/
    # register your flow
    python flows/<your-flow-script>.py

Successful registration of the flow will look similar to this:

.. figure:: ../images/flow_registration.png
    :width: 100%

    Successful flow registration