From 8d66a9051e7963c99b47fbefccaa0385cd9cffa5 Mon Sep 17 00:00:00 2001 From: Edward Ly Date: Tue, 12 Nov 2024 12:00:10 -0800 Subject: [PATCH] fix(admin): remove duplicate AppAPI deploy daemon setup instructions Signed-off-by: Edward Ly --- .../AppAPIAndExternalApps.rst | 9 +++- ...oyDaemon.rst => ManagingDeployDaemons.rst} | 46 ++----------------- admin_manual/exapps_management/index.rst | 2 +- 3 files changed, 12 insertions(+), 45 deletions(-) rename admin_manual/exapps_management/{CreationOfDeployDaemon.rst => ManagingDeployDaemons.rst} (61%) diff --git a/admin_manual/exapps_management/AppAPIAndExternalApps.rst b/admin_manual/exapps_management/AppAPIAndExternalApps.rst index 845bf6dba..4745e3cd0 100644 --- a/admin_manual/exapps_management/AppAPIAndExternalApps.rst +++ b/admin_manual/exapps_management/AppAPIAndExternalApps.rst @@ -20,7 +20,7 @@ If AppAPI is not installed, you can still install it by simply navigating to the Setup deploy daemon ------------------- -A Deploy Daemon is a way for Nextcloud to install and communicate with and control ExApps. +A Deploy Daemon is a way for Nextcloud to install, communicate with, and control ExApps. .. note:: If you are using Nextcloud AIO with the "Docker Socket Proxy" container enabled, a Deploy Daemon will be automatically created and configured to work out-of-the-box. @@ -32,7 +32,7 @@ A Deploy Daemon is a way for Nextcloud to install and communicate with and contr 4. Fill in the required fields: - ``Name``: unique name of the Deploy daemon - ``Display name``: the name that will be displayed in the UI - - ``Deployment method``: by default you will need to choose ``docker_install``, ``manual_install`` is for development or custom use case of manual ExApp installation + - ``Deployment method``: by default, you will need to choose ``docker_install`` (``manual_install`` is for development or custom use case of manual ExApp installation) - ``Daemon Host``: hostname/IP address + port of the Deploy daemon - ``Nextcloud URL``: autofilled with current domain, you might need to change the protocol to http/https depending on your setup - ``Set as default daemon``: check if you want set new Deploy daemon as default @@ -45,6 +45,11 @@ A Deploy Daemon is a way for Nextcloud to install and communicate with and contr 5. Click "Check connection" to verify that the configuration is correct. 6. Click "Register" to save the Deploy Daemon configuration. +.. note:: + For remote DSP setup, it should expose the ports on the host. + +.. image:: ./img/app_api_3.png + Deployment configuration examples can be found :ref:`here `. Installing ExApps diff --git a/admin_manual/exapps_management/CreationOfDeployDaemon.rst b/admin_manual/exapps_management/ManagingDeployDaemons.rst similarity index 61% rename from admin_manual/exapps_management/CreationOfDeployDaemon.rst rename to admin_manual/exapps_management/ManagingDeployDaemons.rst index 04f3d9c1b..af145ce36 100644 --- a/admin_manual/exapps_management/CreationOfDeployDaemon.rst +++ b/admin_manual/exapps_management/ManagingDeployDaemons.rst @@ -1,50 +1,12 @@ - .. _create-deploy-daemon: + .. _managing-deploy-daemons: -Creation of Deploy Daemon -========================= - -The Deploy Daemon (DaemonConfig) is used to orchestrate the deployment of ExApps. - -.. note:: - - Currently only ``docker-install`` and ``manual-install`` deployment methods are supported. - -The recommended daemon configuration is using `AppAPI Docker Socket Proxy `_. - -.. image:: ./img/app_api_3.png - - -You can choose one of the basic configuration templates and adjust to your needs. - -.. note:: We highly recommend to use UI to create Deploy Daemons. - -Register Deploy daemon form -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. ``Name``: unique name of the Deploy daemon -2. ``Display name``: the name that will be displayed in the UI -3. ``Deployment method``: by default you will need to choose ``docker_install``, ``manual_install`` is for development or custom use case of manual ExApp installation -4. ``Daemon Host``: hostname/IP address + port of the Deploy daemon -5. ``Nextcloud URL``: autofilled with current domain, you might need to change the protocol to http/https depending on your setup -6. ``Set as default daemon``: check if you want set new Deploy daemon as default -7. ``Enable https``: check if your Deploy daemon (Docker Socket Proxy) is configured with TLS -8. Deploy Config: - 9. ``Network``: Docker network name, depends on your networking setup, enforces to "host" if "Enable https" is checked - 10. ``HaProxy password``: password for Docker Socket Proxy, if it is configured with TLS - 11. ``Compute Device``: CPU, CUDA or ROCm, depending on your hardware config on Deploy daemon host machine - 12. ``Add additional option`` (see :ref:`additional_options_list`): setup additional KEY + VALUE deploy config options - -.. note:: - - For remote DSP setup, it should expose the ports on the host. - - -.. _create-deploy-daemon-cli: +Managing Deploy Daemons +======================= OCC CLI ^^^^^^^ -There are a few commands to manage Deploy Daemons: +There are a few OCC CLI commands to manage Deploy Daemons: 1. Register ``occ app_api:daemon:register`` 2. Unregister ``occ app_api:daemon:unregister`` diff --git a/admin_manual/exapps_management/index.rst b/admin_manual/exapps_management/index.rst index eaf2e8fd4..157e32802 100644 --- a/admin_manual/exapps_management/index.rst +++ b/admin_manual/exapps_management/index.rst @@ -7,6 +7,6 @@ ExApps management AppAPIAndExternalApps DeployConfigurations - CreationOfDeployDaemon + ManagingDeployDaemons TestDeploy ManagingExApps