F OpenNebula/one#6430: Refactor services section (#2960)

* Add legacy components to main sidebar

Signed-off-by: Victor Hansson <vhansson@opennebula.io>

source/conf.py

@@ -6,8 +6,7 @@
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
-# Note that not all possible configuration values are present in this
-# autogenerated file.
+# Note that not all possible configuration values are present in this autogenerated file.
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.

source/index.rst

@@ -23,6 +23,8 @@ OpenNebula is an open source cloud management platform that combines virtualizat
 +------------------------------------------+------------------------------------------------------------------------------------------+
 | :ref:`Release Notes <rn>`                | New features, improvements and fixes, and the upgrade process in each version            |
 +------------------------------------------+------------------------------------------------------------------------------------------+
+| :ref:`Legacy Components <lc>`            | No longer maintained, legacy & deprecated component documentation                        |
++------------------------------------------+------------------------------------------------------------------------------------------+
 
 .. _entry_point:
 

source/installation_and_configuration/opennebula_services/fireedge.rst

@@ -1,3 +1,4 @@
+.. _fireedge:
 .. _fireedge_setup:
 .. _fireedge_configuration:
 .. _fireedge_conf:
@@ -11,7 +12,7 @@ The OpenNebula FireEdge server provides a **next-generation web-management inter
 Main Features
 --------------------------------------------------------------------------------
 
-- **VMRC and Guacamole Proxy** for Sunstone to remotely access the VMs (incl., VNC, RDP, and SSH)
+- **Guacamole Proxy** for Sunstone to remotely access the VMs (incl., VNC, RDP, and SSH)
 - **OneProvision GUI**: to manage deployments of fully operational Clusters on remote Edge Cloud providers, see :ref:`Provisioning an Edge Cluster <first_edge_cluster>`. Accessible from the following URL:
 
 .. code::
@@ -26,7 +27,6 @@ Main Features
     http://<OPENNEBULA-FRONTEND>:2616
 
 
-.. warning:: FireEdge currently doesn't support :ref:`federated environments <federation>`. It can interact only with a local OpenNebula instance (even if it's federated), but can't interact with remote, federated OpenNebula instances.
 
 .. _fireedge_install_configuration:
 
@@ -100,7 +100,7 @@ The FireEdge server configuration file can be found in ``/etc/one/fireedge-serve
 |                                           |                                | **.** or a **URL**                                 |
 +-------------------------------------------+--------------------------------+----------------------------------------------------+
 
-.. note:: JWT is acronime of JSON Web Token
+.. note:: JWT is a acronym of JSON Web Token
 
 .. _oneprovision_configuration:
 
@@ -155,7 +155,7 @@ The FireEdge server configuration file can be found in ``/etc/one/fireedge-serve
 | ``keep_me_logged_in``                     | ``true``                                  | True to display 'Keep me logged in' option           |
 +-------------------------------------------+-------------------------------------------+------------------------------------------------------+
 
-Once the server is initialized, it creates the file ``/var/lib/one/.one/fireedge_key``, used to encrypt communications with Guacd.
+Once the server is initialized, it creates the file ``/var/lib/one/.one/fireedge_key``, used to encrypt communication with Guacd.
 
 .. _fireedge_in_ha:
 
@@ -177,7 +177,7 @@ Branding FireEdge
 
 You can add your logo to the login, main, favicon and loading screens by updating the ``logo:`` attribute as follows:
 
-- The login screen is defined in the ``/etc/one/fireedge/sunstone/sunstone-views.yaml``.
+- The logo configuration is done in the ``/etc/one/fireedge/sunstone/sunstone-views.yaml`` file.
 - The logo of the main UI screen is defined for each view.
 
 The logo image must be copied to ``/usr/lib/one/fireedge/src/client/assets/images/logos``.
@@ -186,6 +186,7 @@ The following example shows how you can change the logo to a generic linux one (
 
 .. code-block:: yaml
 
+    # /etc/one/fireedge/sunstone/sunstone-views.yaml
     ---
     logo: linux.png
 
@@ -202,30 +203,6 @@ The following example shows how you can change the logo to a generic linux one (
 
 |fireedge_sunstone_linux_login_logo| |fireedge_sunstone_linux_drawer_logo|
 
-Configure Sunstone for VMRC and Guacamole
---------------------------------------------------------------------------------
-
-.. note::
-
-    After a configuration change, the Sunstone server must be :ref:`restarted <sunstone_conf_service>` to take effect.
-
-In order for Sunstone (not FireEdge Sunstone, but rather the current Sunstone, with full admin functionality) to allow VMRC and Guacamole VNC/RDP/SSH access, you need to configure Sunstone with the public endpoint of FireEdge so that one service can redirect users to the other. To configure the public FireEdge endpoint in Sunstone, edit ``/etc/one/sunstone-server.conf`` and update the ``:public_fireedge_endpoint`` with the base URL (domain or IP-based) over which end-users can access the service. For example:
-
-.. code::
-
-    :public_fireedge_endpoint: http://one.example.com:2616
-
-.. hint::
-
-    If you aren't planning to use FireEdge, you can disable it in Sunstone by commenting out the following parameters in ``/etc/one/sunstone-server.conf``, e.g.:
-
-    .. code::
-
-        #:private_fireedge_endpoint: http://localhost:2616
-        #:public_fireedge_endpoint: http://localhost:2616
-
-.. warning:: FireEdge currently doesn't support :ref:`X.509 Authentication <x509_auth>`.
-
 .. _fireedge_conf_guacamole:
 
 Configure Guacamole
@@ -296,7 +273,7 @@ A common issue when starting FireEdge is a used port:
 
     Error: listen EADDRINUSE: address already in use 0.0.0.0:2616
 
-If another service is using the port, you can change FireEdge configuration (``/etc/one/fireedge-server.conf``) to use another host/port. Remember to also adjust the FireEdge endpoints in Sunstone configuration (``/etc/one/sunstone-server.conf``) as well.
+If another service is using the port, you can change FireEdge configuration (``/etc/one/fireedge-server.conf``) to use another host/port.
 
 .. |oneprovision_dashboard| image:: /images/oneprovision_dashboard.png
 .. |fireedge_sunstone_dashboard| image:: /images/fireedge_sunstone_dashboard.png

source/installation_and_configuration/opennebula_services/oned.rst

@@ -9,7 +9,7 @@ The OpenNebula Daemon (``oned``) is the **core service of the cloud management p
 Configuration
 =============
 
-The OpenNebula Daemon configuration file can be found in ``/etc/one/oned.conf`` on the Front-end and can be customized with parameters:
+The OpenNebula Daemon configuration file can be found in ``/etc/one/oned.conf`` on the Front-end and can be customized with the following parameters:
 
 .. note::
 
@@ -714,7 +714,7 @@ Generic quota attributes used for :ref:`Compute Quotas <quota_auth>`. You can im
     QUOTA_VM_ATTRIBUTE = "VCPU"
     QUOTA_VM_ATTRIBUTE = "LICENSE"
 
-Note that any generic quota attribute will be added to the ``VM_RESTRICTEC_ATTR`` set (see below).
+Note that any generic quota attribute will be added to the ``VM_RESTRICTED_ATTR`` set (see below).
 
 .. _oned_conf_restricted_attributes_configuration:
 

source/installation_and_configuration/opennebula_services/oneflow.rst

@@ -78,9 +78,9 @@ In the default configuration, the OneFlow server will only listen to requests co
 Configure Sunstone
 ------------------
 
-Sunstone GUI enables end-users to access the OneFlow from the UI and it directly connects to OneFlow on their behalf. Sunstone has configured the OneFlow endpoint it connects to in ``/etc/one/sunstone-server.conf`` in parameter ``:oneflow_server``. When OneFlow is running on a different host than Sunstone, the endpoint in Sunstone must be configured appropriately.
+Sunstone GUI enables end-users to access the OneFlow from the UI and it directly connects to OneFlow on their behalf. Sunstone has configured the OneFlow endpoint it connects to in ``/etc/one/fireedge-server.conf`` in parameter ``:oneflow_server``. When OneFlow is running on a different host than Sunstone, the endpoint in Sunstone must be configured appropriately.
 
-Sunstone tabs for OneFlow (*Services* and *Service Templates*) are enabled in Sunstone by default. To customize visibility for different types of users, follow the :ref:`Sunstone Views <suns_views>` documentation.
+Sunstone tabs for OneFlow (*Services* and *Service Templates*) are enabled in Sunstone by default. To customize visibility for different types of users, follow the :ref:`Sunstone Views <fireedge_suns_views>` documentation.
 
 Configure CLI
 -------------

source/installation_and_configuration/opennebula_services/scheduler.rst

@@ -27,7 +27,7 @@ The Scheduling algorithm easily allows us to implement several placement heurist
 
 The policy used to place a VM can be configured in two places:
 
-* Globally, for all the VMs in the configuration file ``/etc/one/sched.conf`` of Scheduler.
+* Globally, for all the VMs in the configuration file ``/etc/one/sched.conf`` of the scheduler.
 * For each VM, as defined by the general ``SCHED_RANK`` and ``SCHED_DS_RANK`` and NIC-specific ``SCHED_RANK`` in the VM template.
 
 .. _schg_configuration:
@@ -149,7 +149,7 @@ To start, restart or stop the server, execute one of:
 
 .. note::
 
-   Service is automatically started (unless masked) upon the start of OpenNebula Daemon.
+   The service is automatically started (unless masked) upon the start of the OpenNebula Daemon.
 
 Server **logs** are located in ``/var/log/one`` in following file:
 

source/installation_and_configuration/opennebula_services/troubleshooting.rst

@@ -7,7 +7,7 @@ Troubleshooting
 Logging
 =======
 
-Every OpenNebula server generates logs with a configurable verbosity (level of detail) and through different means (file, syslog, or standard error output) to allow cloud administrators to troubleshoot the potential problems. Logs are stored in ``/var/log/one/`` on a Front-end Host with a particular component. Some valuable error messages can be also seen by the end-users in :ref:`CLI <cli>` tools or the :ref:`Sunstone GUI <sunstone>`.
+Every OpenNebula server generates logs with a configurable verbosity (level of detail) and through different means (file, syslog, or standard error output) to allow cloud administrators to troubleshoot the potential problems. Logs are stored in ``/var/log/one/`` on a Front-end Host with a particular component. Some valuable error messages can be also seen by the end-users in :ref:`CLI <cli>` tools or the :ref:`Sunstone GUI <fireedge>`.
 
 Configure Logging System
 ------------------------
@@ -17,7 +17,6 @@ Follow the guides of each component to find the logs' location and configuration
 - OpenNebula Daemon: :ref:`logs <oned_conf_service>`, :ref:`configuration <oned_conf>` (parameter ``LOG/DEBUG_LEVEL``)
 - Scheduler: :ref:`logs <sched_conf_service>`, :ref:`configuration <sched_conf>` (parameter ``LOG/DEBUG_LEVEL``)
 - Monitoring: :ref:`logs <mon_conf_service>`, :ref:`configuration <mon_conf>` (parameter ``LOG/DEBUG_LEVEL``)
-- Sunstone: :ref:`logs <sunstone_conf_service>`, :ref:`configuration <sunstone_conf>` (parameter ``:debug_level``)
 - FireEdge: :ref:`logs <fireedge_conf_service>`, :ref:`configuration <fireedge_conf>` (parameter ``log``)
 - OneFlow: :ref:`logs <oneflow_conf_service>`, :ref:`configuration <oneflow_conf>` (parameter ``:debug_level``)
 - OneGate: :ref:`logs <onegate_conf_service>`, :ref:`configuration <onegate_conf>` (parameter ``:debug_level``)

source/legacy_components/index.rst

@@ -1,3 +1,4 @@
+.. _lc:
 .. _legacy_components:
 
 ================================================================================