Skip to content

Commit

Permalink
F OpenNebula/one#6430: Refactor services section
Browse files Browse the repository at this point in the history
Signed-off-by: Victor Hansson <[email protected]>
  • Loading branch information
vichansson committed Jul 4, 2024
1 parent d2bab70 commit 23d62af
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ If FireEdge is installed and running on the same machine and expected to be used
</Location>
</VirtualHost>
In Sunstone configuration (:ref:`/etc/one/sunstone-server.conf <sunstone_conf>`), set the public FireEdge endpoint in option ``:public_fireedge_endpoint``, to the public endpoint that correctly redirects to FireEdge. Sunstone will automatically add the /fireedge suffix to any URL meant to be go to FireEdge, so we can skip that (we can leave it as well, since /fireedge/fireedge will be redirected by FireEdge server to the /fireedge endopoint). E.g.,
In Ruby Sunstone configuration (:ref:`/etc/one/sunstone-server.conf <ruby_sunstone_conf>`), set the public FireEdge endpoint in option ``:public_fireedge_endpoint``, to the public endpoint that correctly redirects to FireEdge. Sunstone will automatically add the /fireedge suffix to any URL meant to be go to FireEdge, so we can skip that (we can leave it as well, since /fireedge/fireedge will be redirected by FireEdge server to the /fireedge endopoint). E.g.,

.. code::
Expand Down Expand Up @@ -275,7 +275,7 @@ If FireEdge is installed and running on the same machine and expected to be used
</Location>
</VirtualHost>
In Sunstone configuration (:ref:`/etc/one/sunstone-server.conf <sunstone_conf>`), set the public FireEdge endpoint in option ``:public_fireedge_endpoint``. E.g.,
In Sunstone configuration (:ref:`/etc/one/sunstone-server.conf <ruby_sunstone_conf>`), set the public FireEdge endpoint in option ``:public_fireedge_endpoint``. E.g.,

.. code::
Expand Down Expand Up @@ -368,7 +368,7 @@ By default, the Sunstone server is configured to run on the :ref:`Single Front-e

- Install only the Sunstone server package on the machine that will be running the server.

- Ensure the ``:one_xmlprc:`` option in :ref:`/etc/one/sunstone-server.conf <sunstone_conf>` points to the endpoint where OpenNebula Daemon is running (e.g., ``http://opennebula-oned:2633/RPC2``). You can also leave it undefined and export the ``ONE_XMLRPC`` environment variable.
- Ensure the ``:one_xmlprc:`` option in :ref:`/etc/one/sunstone-server.conf <ruby_sunstone_conf>` points to the endpoint where OpenNebula Daemon is running (e.g., ``http://opennebula-oned:2633/RPC2``). You can also leave it undefined and export the ``ONE_XMLRPC`` environment variable.

- *(Optional)* On host running OpenNebula Daemon, enable ZeroMQ to listen to non-localhost address. In :ref:`/etc/one/oned.conf <oned_conf>` in ``HM_MAD/ARGUMENTS`` replace ``-b 127.0.0.1`` with your IP address accessible by Sunstone from a different machine (e.g., ``-b 192.168.0.1``). Update the endpoints accordingly in ``/etc/one/onehem-server.conf`` in parameters ``:subscriber_endpoint`` and ``:replier_endpoint``. **IMPORTANT**: This endpoint is not secure and should be available only through private IPs (unreachable from outside). Set the IP carefully, **never set wildcard address** ``0.0.0.0``! Sensitive information from the OpenNebula might leak!!!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
FireEdge Configuration
================================================================================

The OpenNebula FireEdge server provides a **next-generation web-management interface** for remote OpenNebula Cluster provisioning (OneProvision GUI) as well as additional functionality to Sunstone. It's a dedicated daemon installed by default as part of the :ref:`Single Front-end Installation <frontend_installation>`, but can be deployed independently on a different machine. The server is distributed as an operating system package ``opennebula-fireedge`` with the system service ``opennebula-fireedge``.
The OpenNebula FireEdge server provides a **next-generation web-management interface** for remote OpenNebula Cluster provisioning (OneProvision GUI) as well as additional functionality to Ruby Sunstone. It's a dedicated daemon installed by default as part of the :ref:`Single Front-end Installation <frontend_installation>`, but can be deployed independently on a different machine. The server is distributed as an operating system package ``opennebula-fireedge`` with the system service ``opennebula-fireedge``.

Main Features
--------------------------------------------------------------------------------
Expand All @@ -26,7 +26,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:

Expand Down Expand Up @@ -100,7 +99,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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ OpenNebula Services
OpenNebula Configuration <oned>
Scheduler Configuration <scheduler>
Monitoring Configuration <monitoring>
Sunstone Configuration <sunstone>
FireEdge Configuration <fireedge>
Sunstone Configuration <sunstone>
OneFlow Configuration <oneflow>
OneGate Configuration <onegate>
Database Maintenance <database>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Read the sections for services you are interested in
- :ref:`Scheduler <sched_conf>`
- :ref:`Monitoring <mon_conf>`
- :ref:`Sunstone <sunstone_conf>`
- :ref:`FireEdge <fireedge_conf>`
- :ref:`Ruby Sunstone <ruby_sunstone_conf>`
- :ref:`OneFlow <oneflow_conf>`
- :ref:`OneGate <onegate_conf>`

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. _sunstone:
.. _ruby_sunstone:
.. _sunstone_setup:
.. _sunstone_conf:
.. _ruby_sunstone_conf:
.. _sunstone_sunstone_server_conf:

======================
Sunstone Configuration
======================
===========================
Ruby Sunstone Configuration
===========================

The OpenNebula Sunstone server provides a **web-based management interface**. It's a dedicated daemon installed by default as part of the :ref:`Single Front-end Installation <frontend_installation>`, but can be deployed independently on a different machine. The server is distributed as an operating system package ``opennebula-sunstone`` with the system services ``opennebula-sunstone`` for Sunstone and ``opennebula-novnc`` for noVNC Proxy.
The OpenNebula Ruby Sunstone server provides a **web-based management interface**. It's a dedicated daemon installed by default as part of the :ref:`Single Front-end Installation <frontend_installation>`, but can be deployed independently on a different machine. The server is distributed as an operating system package ``opennebula-sunstone`` with the system services ``opennebula-sunstone`` for Sunstone and ``opennebula-novnc`` for noVNC Proxy.

Configuration
=============
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ 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``)
- Sunstone: :ref:`logs <fireedge_conf_service>`, :ref:`configuration <sunstone_conf>` (parameter ``log``)
- Ruby Sunstone: :ref:`logs <sunstone_conf_service>`, :ref:`configuration <ruby_sunstone_conf>` (parameter ``:debug_level``)
- 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``)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The Groups will share the physical resources, but without being aware of it. If
Managing VDCs in Sunstone
================================================================================

All the described functionality is available graphically using :ref:`Sunstone <fireedge_conf>`:
All the described functionality is available graphically using :ref:`Sunstone <sunstone_conf>`:

|sunstone_vdcs|

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1035,7 +1035,7 @@ Sunstone provides several different methods to access your VM console and deskto

.. important::

:ref:`FireEdge <fireedge_conf>` server must be running to get Guacamole connections working. For VMRC, Sunstone and FireEdge must be running on the **same server**.
:ref:`FireEdge <sunstone_conf>` server must be running to get Guacamole connections working. For VMRC, Sunstone and FireEdge must be running on the **same server**.

.. _requirements_remote_access_sunstone:

Expand Down
2 changes: 1 addition & 1 deletion source/marketplace/appliances/marketapps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Please take a look at the CLI reference to see how to use these actions. These o

Using Sunstone to Manage Marketplace Appliances
================================================================================
You can also import and export Marketplace Appliances using :ref:`Sunstone <sunstone>`. Select the Storage > MarketApps tab, and there, you will be able see the available Appliances in a user friendly way.
You can also import and export Marketplace Appliances using :ref:`Ruby Sunstone <ruby_sunstone>`. Select the Storage > MarketApps tab, and there, you will be able see the available Appliances in a user friendly way.

.. image:: /images/show_marketplaceapp.png
:width: 90%
Expand Down

0 comments on commit 23d62af

Please sign in to comment.