diff --git a/admin_manual/exapps_management/AdvancedDeployOptions.rst b/admin_manual/exapps_management/AdvancedDeployOptions.rst new file mode 100644 index 00000000000..cdd45083aa5 --- /dev/null +++ b/admin_manual/exapps_management/AdvancedDeployOptions.rst @@ -0,0 +1,38 @@ +======================= +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 + +.. image:: ./img/advanced_deploy_options_3.png + +When ExApp installed the list of set environment variables will be displayed. + +.. image:: ./img/advanced_deploy_options_installed_1.png + + +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. + diff --git a/admin_manual/exapps_management/ManagingExApps.rst b/admin_manual/exapps_management/ManagingExApps.rst index 95c5ffb4a15..c2e954c96a2 100644 --- a/admin_manual/exapps_management/ManagingExApps.rst +++ b/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] [--] `` +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]] [--] []`` 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 diff --git a/admin_manual/exapps_management/img/advanced_deploy_options_1.png b/admin_manual/exapps_management/img/advanced_deploy_options_1.png new file mode 100644 index 00000000000..4dc950033ae Binary files /dev/null and b/admin_manual/exapps_management/img/advanced_deploy_options_1.png differ diff --git a/admin_manual/exapps_management/img/advanced_deploy_options_2.png b/admin_manual/exapps_management/img/advanced_deploy_options_2.png new file mode 100644 index 00000000000..07c72264ffd Binary files /dev/null and b/admin_manual/exapps_management/img/advanced_deploy_options_2.png differ diff --git a/admin_manual/exapps_management/img/advanced_deploy_options_3.png b/admin_manual/exapps_management/img/advanced_deploy_options_3.png new file mode 100644 index 00000000000..591248dad19 Binary files /dev/null and b/admin_manual/exapps_management/img/advanced_deploy_options_3.png differ diff --git a/admin_manual/exapps_management/img/advanced_deploy_options_installed_1.png b/admin_manual/exapps_management/img/advanced_deploy_options_installed_1.png new file mode 100644 index 00000000000..fef64f0ecce Binary files /dev/null and b/admin_manual/exapps_management/img/advanced_deploy_options_installed_1.png differ diff --git a/admin_manual/exapps_management/index.rst b/admin_manual/exapps_management/index.rst index 157e328024f..9d0de532bd2 100644 --- a/admin_manual/exapps_management/index.rst +++ b/admin_manual/exapps_management/index.rst @@ -10,3 +10,4 @@ ExApps management ManagingDeployDaemons TestDeploy ManagingExApps + AdvancedDeployOptions