Add Installing External Applications Server

docs/deploying_clearml/enterprise_deploy/app_install_ex_server.md

@@ -0,0 +1,87 @@
+---
+title: Installing External Applications Server
+---
+
+ClearML supports applications, which are extensions that allow additional capabilities, such as cloud auto-scaling, 
+Hyperparameter Optimizations, etc. For more information, see [ClearML Applications](../../webapp/applications/apps_overview.md).
+
+Applications run inside Docker containers, which can either reside on the ClearML Server side, or on an external server. 
+The `clearml-apps-agent` polls an internal applications queue, and spawns additional Docker containers for application 
+instances that are launched using the ClearML web UI. 
+
+This document provides a short guide on how to configure an external applications server.
+
+## Requirements
+
+* A server, as described in [Server Requirements](#server-requirements)
+* `docker-compose.yml` file provided by ClearML
+* `constants.env` - Environment file with required credentials 
+* Credentials to access ClearML’s enterprise Dockerhub registry
+
+### Server Requirements
+
+* Operating system: Linux-based
+* CPU: Since applications do not produce a high CPU load, we recommend 2-4 virtual CPUs, assuming around 10 concurrent 
+  applications are required
+* Memory: Around 1 GiB of RAM is required per each concurrent application instance
+* Storage: About 100 GB of storage is recommended for the system volume, with an additional 100 GB of storage for 
+  application caching. In AWS, `m6a.xlarge` can be used for running up to 10 applications in parallel.
+
+## Installation
+
+:::note
+Installing an external server requires removing the applications’ agent from the ClearML Enterprise Server. This 
+is done by ClearML in hosted environments, or by removing the `apps-agent` service from the `docker-compose` override 
+file in VPC and on-premises installations. For K8s environments, please consult the ClearML team.
+:::
+
+1. Install Docker. See [Docker documentation](https://docs.docker.com/engine/install/ubuntu/) 
+1. Copy the `docker-compose.yml` and `constants.env` files to `/opt/allegro`. The
+   `constants.env` file should contain following definitions:
+    
+   * `APISERVER_URL_FOR_EXTERNAL_WORKERS` - URL of the ClearML API server
+   * `WEBSERVER_URL_FOR_EXTERNAL_WORKERS` - URL of the ClearML WebApp
+   * `FILESERVER_URL_FOR_EXTERNAL_WORKERS` - URL of the ClearML files server
+   * `APPS_AGENT_USER_KEY` - Provided by ClearML
+   * `APPS_AGENT_USER_SECRET` - Provided by ClearML
+   * `APPS_AGENT_GIT_USER` - Provided by ClearML (required up to ClearML Server 1.8)
+   * `APPS_AGENT_GIT_PASSWORD` - Provided by ClearML (required up to ClearML Server 1.8)
+   * `APPS_WORKER_DOCKER_IMAGE` - Provided by ClearML (required up to ClearML Server 1.8)
+   * `APPS_DAEMON_DOCKER_IMAGE` - Provided by ClearML
+   
+1. Log in to the Docker registry:
+    
+   ```
+   sudo docker login -username allegroaienterprise
+   ```
+
+1. Pull the container:
+
+   ```
+   docker compose -env-file constants.env pull
+   ```
+
+1. Start the service:
+
+   ```
+   docker compose -env-file constants.env up -d
+   ```
+
+
+## Clearing Stopped Containers
+Containers of running applications that are stopped are not automatically deleted. Therefore, it is recommended to 
+periodically delete stopped containers. This can be done by adding the following to the cron file:
+
+```
+0 0 * * * root docker container prune --force --filter "until=96h" --filter "label=allegro-type=application"
+```
+
+## Monitoring
+We recommend monitoring the following:
+* Available memory
+* CPU usage
+* Remaining Storage
+
+For more information contact ClearML's support team.
+
+

sidebars.js

@@ -701,7 +701,8 @@ module.exports = {
         },
         {
             'Enterprise Applications': [
-                'deploying_clearml/enterprise_deploy/apps_install'
+                'deploying_clearml/enterprise_deploy/app_install_ubuntu_on_prem',
+                'deploying_clearml/enterprise_deploy/app_install_ex_server',
             ]
         },
     ]