feat(app_api): Advanced Deploy Options (#12517)

Signed-off-by: Andrey Borysenko <andrey18106x@gmail.com>

Author: andrey18106

admin_manual/exapps_management/AdvancedDeployOptions.rst

@@ -0,0 +1,35 @@
+=======================
+Advanced Deploy Options
+=======================
+
+AppAPI allows optionally to configure environment variables and mounts for the ExApp container.
+
+It is available via "Deploy options" modal next to "Deploy and Enable" button in the sidebar of the ExApp page on the Apps management page:
+
+.. image:: ./img/advanced_deploy_options_1.png
+
+Or via CLI (:ref:`advanced_deploy_options_cli`).
+
+
+Environment Variables
+---------------------
+
+Environment variables enable more precise configuration of the ExApp.
+ExApp developers can define the list of supported environment variables with descriptions,
+only these variables will be available for configuration.
+
+By default there are only mounts available for configuration.
+
+.. image:: ./img/advanced_deploy_options_2.png
+
+When ExApp installed the list of set environment variables will be displayed.
+
+
+Mounts
+------
+
+Mounts can be used to provide additional data to the ExApp container from the host.
+For example, it will be useful for some apps to provide a folder with SSL certs of your cloud,
+so the app can handle HTTPS correctly without any additional re-installation of the ExApp.
+
+.. image:: ./img/advanced_deploy_options_3.png

admin_manual/exapps_management/ManagingExApps.rst

@@ -16,7 +16,7 @@ There are several commands to work with ExApps:
 Register
 --------
 
-Command: ``app_api:app:register [--info-xml INFO-XML] [--json-info JSON-INFO] [--] <appid> <daemon-config-name>``
+Command: ``app_api:app:register [--force-scopes] [--info-xml INFO-XML] [--json-info JSON-INFO] [--wait-finish] [--silent] [--test-deploy-mode] [--env [ENV]] [--mount [MOUNT]] [--] <appid> [<daemon-config-name>]``
 
 The register command is the first ExApp installation step.
 
@@ -31,6 +31,17 @@ Options
 
     * ``--json-info JSON-INFO`` *[optional]* - ExApp deploy JSON info (json string)
     * ``--info-xml INFO-XML`` *[optional]* - path to info.xml file (url or local absolute path)
+    * ``--wait-finish`` *[optional]* - wait until initialization finished
+    * ``--silent`` *[optional]* - do not print to console
+    * ``--test-deploy-mode`` *[optional]* - test deploy mode with additional status checks and slightly different logic
+
+ .. _advanced_deploy_options_cli:
+
+Advanced Deploy Options
+***********************
+
+    * ``--env`` *[optional]* - environment (ENV_NAME=ENV_VALUE), passed to ExApp container as environment variables (multiple values allowed)
+    * ``--mount`` *[optional]* - mount options (SRC_PATH=DST_PATH), passed to ExApp container as volume mounts (multiple values allowed)
 
 
 Unregister

admin_manual/exapps_management/img/advanced_deploy_options_1.png

@@ -10,3 +10,4 @@ ExApps management
    ManagingDeployDaemons
    TestDeploy
    ManagingExApps
+   AdvancedDeployOptions