From e3307b13485aacf9444dadf13c1c7a54010b7d9b Mon Sep 17 00:00:00 2001 From: Pedro Ielpi Date: Mon, 29 Jul 2024 12:32:06 +0200 Subject: [PATCH 1/2] Modify RN What's New & other docs: Prometheus & Restic Now in CE Signed-off-by: Pedro Ielpi --- source/intro_release_notes/release_notes/whats_new.rst | 7 ++++++- source/management_and_operations/backups/index.rst | 2 +- source/management_and_operations/backups/overview.rst | 2 +- source/management_and_operations/backups/restic.rst | 6 +++--- .../management_and_operations/capacity_planning/quotas.rst | 2 +- source/management_and_operations/monitor_alert/index.rst | 2 +- source/management_and_operations/monitor_alert/install.rst | 2 +- .../management_and_operations/monitor_alert/overview.rst | 4 +--- 8 files changed, 15 insertions(+), 12 deletions(-) diff --git a/source/intro_release_notes/release_notes/whats_new.rst b/source/intro_release_notes/release_notes/whats_new.rst index bed4328aa8..9d154545c3 100644 --- a/source/intro_release_notes/release_notes/whats_new.rst +++ b/source/intro_release_notes/release_notes/whats_new.rst @@ -6,7 +6,7 @@ What’s New in |version| .. Attention: Substitutions doesn't work for emphasized text -**OpenNebula 6.10 “Bubble”** is the sixth stable release of the OpenNebula 6 series. This new release features the first complete implementation of the Sunstone UI functionality on the FireEdge server, as well as improvements in backups, support for new versions of operating systems for the Front-end node, and streamlining by removing obsolete or little-used components, or providing them as legacy components. +**OpenNebula 6.10 “Bubble”** is the sixth stable release of the OpenNebula 6 series. This new release features the first complete implementation of the Sunstone UI functionality on the FireEdge server, as well as improvements in backups, support for new versions of operating systems for the Front-end node, new features included in the Community Edition, and streamlining by removing obsolete or little-used components, or providing them as legacy components. The first major highlight in this release is the new Sunstone UI. The full power of OpenNebula’s web UI is now provided by the FireEdge server, which delivers the complete set of features previously offered by legacy Ruby-based Sunstone. The new Sunstone UI brings a clean, fast, highly-customizable and easy-to-use UI. @@ -52,6 +52,11 @@ The components in the table below are now included in the distribution as legacy For the full documentation please refer to the :ref:`Legacy Components ` section. +Beginning on version 6.10, users of the :ref:`Community Edition ` will be able to access two features previously only available in the Enterprise Edition: + + * **Backups** using `Restic `__, an open-source backup program designed for speed and security. The Community Edition now includes the possibility of using Restic as a backend for backup operations. + * **System monitoring** using `Prometheus `__, a set of open-source monitoring and alerting tools. The Community edition now includes the possibility of using Prometheus as a backend for monitoring infrastructure. + OpenNebula 6.10 is named after the `Bubble Nebula `__ (NGC 7635) in the constellation Cassiopeia. It is a young, glowing emission nebula energized by a hot, massive central star. Partly located in a group of stars between 7000 and 8000 light-years away from Earth, the Bubble Nebula is in expansion, with a central “bubble” measuring between six and ten light-years and an estimated temperature of more than 37,000 degrees Celsius (67,000 Fahrenheit). It was discovered by the celebrated astronomer William Herschel in 1787. .. important:: This is the first beta version for 6.10, intended for testers and developers to try the new features. All new functionality is present in this release, and only bug fixes will be implemented between this release and the final 6.10 version. Please check the `known issues `__ before submitting an issue through GitHub. Also note that being a development version, there is no migration path from the previous stable version (6.8.x) nor migration path to the final stable version (6.10.0). A list of open issues may be found at the `GitHub development portal `__. diff --git a/source/management_and_operations/backups/index.rst b/source/management_and_operations/backups/index.rst index 9dfbb9b8f5..2c9ce202df 100644 --- a/source/management_and_operations/backups/index.rst +++ b/source/management_and_operations/backups/index.rst @@ -8,7 +8,7 @@ Virtual Machine Backups :maxdepth: 2 Overview - Backup Datastore: Restic (EE) + Backup Datastore: Restic Backup Datastore: Rsync VM Backup Operations Backup Jobs diff --git a/source/management_and_operations/backups/overview.rst b/source/management_and_operations/backups/overview.rst index 781b4b709d..d986440206 100644 --- a/source/management_and_operations/backups/overview.rst +++ b/source/management_and_operations/backups/overview.rst @@ -6,7 +6,7 @@ Overview This chapter contains documentation on how to create and manage Virtual Machines Backups. Backups are managed through the datastore and image abstractions. In this way, all the concepts that apply to these objects also apply to backups like access control or quotas. Backup datastores can be defined using two backends (datastore drivers): - - restic (**Only EE**) based on the `restic backup tool `_ + - restic, based on the `restic backup tool `_ - rsync, that uses the `rsync utility `_ to transfer backup files. diff --git a/source/management_and_operations/backups/restic.rst b/source/management_and_operations/backups/restic.rst index d620cdf197..e281f0ada3 100644 --- a/source/management_and_operations/backups/restic.rst +++ b/source/management_and_operations/backups/restic.rst @@ -1,12 +1,12 @@ .. _vm_backups_restic: ================================================================================ -Backup Datastore: Restic (EE) +Backup Datastore: Restic ================================================================================ -`Restic is an open source (BSD 2-Clause License) backup tool `_ designed to be fast, secure and efficient. The current implementation of the driver uses the SFTP storage type. Restic offers interesting features to store backups, like deduplication (only transferring image blobs not already present in the repository) or compression (enabled by default). +`Restic `__ is an open source (BSD 2-Clause License) backup tool designed for speed, security and efficiency. The current implementation of the driver uses the SFTP storage type. Restic offers interesting features to store backups, like deduplication (only transferring image blobs not already present in the repository) or compression (enabled by default). -If you are using the enterprise edition (EE) of OpenNebula, the right version of restic has been already downloaded and installed in your system as a dependency. In this guide we will use the following terminology (introduce by restic): +In both the Enterprise and Community editions of OpenNebula, the correct version of restic is included as a dependency. In this guide we will use the following terminology (introduced by restic): - *Repository*: This is the storage volume where the disk images backups will be stored. Restic creates an specific interval structure to store the backups efficiently. The restic driver access to the repository through the sftp. protocol. OpenNebula will create a separate restic repository for each VM or backup job. diff --git a/source/management_and_operations/capacity_planning/quotas.rst b/source/management_and_operations/capacity_planning/quotas.rst index e70a87310a..dbf35e73e1 100644 --- a/source/management_and_operations/capacity_planning/quotas.rst +++ b/source/management_and_operations/capacity_planning/quotas.rst @@ -96,7 +96,7 @@ Subsequently, a quota can be enforced for a user, e.g. ``GOLD_QOS = 5``, signify Each generic quota is also automatically prefixed with ``RUNNING_``. For instance, ``RUNNING_GOLD_QOS`` would specify the number of VMs in an ``ACTIVE`` state with the GOLD_QOS attribute. This allows the establishment of quotas specifically tailored for running VMs. -Additionally, it's important to note that each generic quota defined via ``QUOTA_VM_ATTRIBUTE`` is automatically included in the ``VM_RESTICTED_ATTR`` set. This inclusion prevents regular users from circumventing the quota system by altering the attributes related to these generic quotas. +Additionally, it's important to note that each generic quota defined via ``QUOTA_VM_ATTRIBUTE`` is automatically included in the ``VM_RESTRICTED_ATTR`` set. This inclusion prevents regular users from circumventing the quota system by altering the attributes related to these generic quotas. Network Quotas -------------------------------------------------------------------------------- diff --git a/source/management_and_operations/monitor_alert/index.rst b/source/management_and_operations/monitor_alert/index.rst index b72ed36089..52199fee31 100644 --- a/source/management_and_operations/monitor_alert/index.rst +++ b/source/management_and_operations/monitor_alert/index.rst @@ -1,5 +1,5 @@ ============================ -Monitoring and Alerting (EE) +Monitoring and Alerting ============================ .. toctree:: diff --git a/source/management_and_operations/monitor_alert/install.rst b/source/management_and_operations/monitor_alert/install.rst index 92cab493a8..9e38fc397b 100644 --- a/source/management_and_operations/monitor_alert/install.rst +++ b/source/management_and_operations/monitor_alert/install.rst @@ -4,7 +4,7 @@ Installation and Configuration ================================================================================ -This page describes how to install the OpenNebula Prometheus integration packages available in the :ref:`Enterprise Edition software repositories `. +This page describes how to install the OpenNebula Prometheus integration packages available in the :ref:`OpenNebula software repositories `. Step 1. OpenNebula Repositories [Front-end, Hosts] ================================================================================ diff --git a/source/management_and_operations/monitor_alert/overview.rst b/source/management_and_operations/monitor_alert/overview.rst index 3741b8e542..8027135fea 100644 --- a/source/management_and_operations/monitor_alert/overview.rst +++ b/source/management_and_operations/monitor_alert/overview.rst @@ -1,7 +1,7 @@ .. _monitor_alert_overview: ================================================================================ -Monitoring and Alerting (EE) +Monitoring and Alerting ================================================================================ This chapter contains documentation on how to configure OpenNebula to work with `Prometheus monitoring and alerting toolkit `_. The integration consists of four components: @@ -11,8 +11,6 @@ This chapter contains documentation on how to configure OpenNebula to work with - Alert rules sample files based on the provided metrics - `Grafana `_ dashboards to visualize VM, Host and OpenNebula information in a convenient way. -.. important:: This feature is only available for OpenNebula Enterprise Edition. - How Should I Read This Chapter ================================================================================ From 09052af61990f905e104f5ab58daa9543f771933 Mon Sep 17 00:00:00 2001 From: Pedro Ielpi Date: Mon, 29 Jul 2024 12:40:54 +0200 Subject: [PATCH 2/2] M #-: Mention that Prometheus & Restic Now in CE Signed-off-by: Pedro Ielpi --- source/intro_release_notes/release_notes/whats_new.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/intro_release_notes/release_notes/whats_new.rst b/source/intro_release_notes/release_notes/whats_new.rst index 9d154545c3..44324c5daa 100644 --- a/source/intro_release_notes/release_notes/whats_new.rst +++ b/source/intro_release_notes/release_notes/whats_new.rst @@ -52,7 +52,7 @@ The components in the table below are now included in the distribution as legacy For the full documentation please refer to the :ref:`Legacy Components ` section. -Beginning on version 6.10, users of the :ref:`Community Edition ` will be able to access two features previously only available in the Enterprise Edition: +Beginning on version 6.10, users of the :ref:`Community Edition ` can access two features previously only available in the Enterprise Edition: * **Backups** using `Restic `__, an open-source backup program designed for speed and security. The Community Edition now includes the possibility of using Restic as a backend for backup operations. * **System monitoring** using `Prometheus `__, a set of open-source monitoring and alerting tools. The Community edition now includes the possibility of using Prometheus as a backend for monitoring infrastructure.