From 83070ce1584b89944005b03128e65f40a449e611 Mon Sep 17 00:00:00 2001 From: Davide Principi Date: Thu, 12 Sep 2024 15:16:30 +0200 Subject: [PATCH 1/5] Fix README.rst block style examples --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 4b7c2ad4..7695c862 100644 --- a/README.rst +++ b/README.rst @@ -97,8 +97,9 @@ Add warnings with :: Other conventions: -* use double backtick to quote labels and links from the web user interface -* use ``guilabel`` markup for buttons +* use double backtick \``, to quote labels and links from the web + user interface, e.g. ````some link```` +* use ``guilabel`` markup for buttons, e.g. ``:guilabel:`some label``` You can find more info about **RST Inline Markup** here: rst-cheatsheet_ From 2ce17536aa1b24f68694153dcffb00a6b0dbde8f Mon Sep 17 00:00:00 2001 From: Davide Principi Date: Thu, 12 Sep 2024 16:58:45 +0200 Subject: [PATCH 2/5] Revised Software Center page - Application Information: Expanded details on what each application card displays and the types of information available for each application. - Levels of Certification: Introduces a new section explaining the different certification levels of applications and the criteria for each level. - Installing Applications: Clarifies the process for installing new applications and instances, including node selection in clusters. - Application Instances: Details actions that can be performed on application instances, such as cloning, moving, or uninstalling. - Software Repositories: Provides a comprehensive overview of software repositories, including default repositories and how to add custom ones. - Core Applications: Adds information on how to review and manage core applications and updates. --- software_center.rst | 160 ++++++++++++++++++++++++++++++-------------- 1 file changed, 110 insertions(+), 50 deletions(-) diff --git a/software_center.rst b/software_center.rst index a189034a..10e0bddd 100644 --- a/software_center.rst +++ b/software_center.rst @@ -1,84 +1,144 @@ .. _software_center-section: =============== -Software center +Software Center =============== -The software center lists applications available from all repositories -[#fileserver]_\ . +The Software Center displays and manages applications available from all +configured repositories [#fileserver]_\ . -To install a new application just click on the :guilabel:`Install` button. -If the cluster has multiple nodes, you will be alse required to select the -target node. +Application information +======================== -To install another instance of an existing application, click on the -``Instances`` link inside the application card. Then click on -:guilabel:`Install new instance`. +Each application is represented by a card displaying its name, level of +certification, and category. Click on the application's name to view +detailed information such as screenshots, author, latest version, +container images, and links to documentation, source code, and bug +tracker. -.. note:: +Some applications may include additional Terms and Conditions; if present, +read them carefully. - Be careful! The user interface does not currently check if an - application supports multiple instances on the same node. -.. |bento| image:: _static/bento.png +.. _certification-levels: -Installed applications are always available from the application drawer, -by clicking on the |bento| menu in the top right corner. +Levels of certification +======================= -You can also perform multiple actions on installed applications by -clicking on the three-dots menu: +Applications are certified at the following levels: -- ``Add to favorites``: the application will be always listed on top of - the application drawer +- **Level 1/5**: The application is hosted by a custom repository and is + not certified. +- **Level 2/5**: The application is hosted by the ``nethforge`` repository + and certified by the NethServer community. +- **Level 3/5**: The application is hosted by the ``default`` or + ``subscription`` repositories and is certified by Nethesis. +- **Level 4/5**: The application is developed and maintained by Nethesis + developers. +- **Level 5/5**: The application is developed and maintained by Nethesis + developers and is covered by Nethesis support. -- ``Edit instance label``: add a name to the instance +Certification levels are determined based on the following factors: -- ``Clone``: clone the application, see :ref:`move_clone-section` +1. **Repository**: To be listed in a public repository, an application + must undergo a review process. Being listed in a public repository + establishes the base certification level of the application. +2. **Origin**: The container image registry hosting the application + identifies the person or organization distributing it. Currently, the + recognized registries are ``ghcr.io/nethserver`` and + ``ghcr.io/nethesis``. +3. **Support**: If the cluster has an active subscription and paid support + is available for the application (whether included in the current + subscription plan or not). See :ref:`subscription-section` for more + information. -- ``Move``: move the application to another node, see - :ref:`move_clone-section` -- ``Uninstall``: remove the application and all related data +Install applications +==================== -.. _software_repositories-section: +To install a new application, simply click the :guilabel:`Install` button +of the application card. If your cluster has multiple nodes, you will also +need to select the target node. -Software repositories -===================== +To install an additional instance of an existing application, click on the +``Instances`` link within the application's card. Then, select +:guilabel:`Install new instance`. Note that in some cases, installation on +certain cluster nodes may be restricted due to application policies or +node resource limitations. -Software repositories contain applications metadata, which is constituted -by the index of applications, along with their descriptions and additional -information on how to obtain them. +Application instances +====================== -The list of configured repositories is accessible by different ways: +Once an application has one or more installed instances, click on the +``Instances`` link within the application's card. You can perform various +actions on each instance by clicking on its three-dots menu: -* In the ``Settings`` page: click the ``Software repositories`` card. +- ``Add to favorites``: The application will always be listed at the top + of the application drawer. +- ``Edit instance label``: Add a custom name to the instance. +- ``Clone``: Clone the application. See :ref:`move_clone-section`. +- ``Move``: Move the application to another node. See + :ref:`move_clone-section`. +- ``Uninstall``: Remove the application and all related data. + +.. |bento| image:: _static/bento.png + :alt: application drawer -* In the ``Software Center`` page: click the ``Software repository`` item - under the three-dots menu on the top right corner of the page. +Installed application instances are also accessible from the application +drawer by clicking on the |bento| menu in the top-right corner of the +screen. -NethServer comes with a default set of software repositories in both -enabled and disabled state. +.. _software_repositories-section: -NethForge is a repository of applications built by the NethServer -community, initially set in a disabled state. +Software repositories +===================== -To add your own repository click on the :guilabel:`Add repository` button. -Then fill all required fields: +An NS8 software repository is an index of applications and a collection of +their metadata. -- ``Name`` a unique name for the repository +You can access the list of configured repositories in several ways: -- ``URL`` public URL of the repository, it must be a valid `NS8 repository - `_ +* In the ``Settings`` page: click the ``Software repositories`` card. +* In the ``Software Center`` page: click the ``Software repositories`` + item in the three-dots menu at the top-right corner. + +NS8 includes a default set of software repositories, some enabled and +others disabled: + +- ``default``: Contains applications developed and maintained mainly by + NethServer developers. It also tracks updates for NS8 core modules and + the core itself. +- ``nethforge``: A repository of applications built and maintained by the + NethServer community. It is initially disabled. +- ``subscription``: Added and enabled when the cluster has an active + subscription. It overrides the contents of the ``default`` repository + with an update schedule managed by Nethesis. See + :ref:`subscription-section` for details. + +To add a custom repository, click on the :guilabel:`Add repository` button +and fill in the required fields: + +- ``Name``: A unique name for the repository. +- ``URL``: The public URL of the repository. It must be a valid `NS8 + repository `_. +- ``Status``: Check this option to enable the repository. + +You can refresh the metadata by clicking on the :guilabel:`Reload +repositories` button. -- ``Status`` check this option to enable the repository +Core applications +================= -- ``Testing`` check this option to access also non-stable releases of - modules from this repository +NS8 consists of the core and several applications. Each core component has +its own version number, and the Software Center will display a warning +when an update is available. + +You can review the components currently installed in the cluster at any +time. To do this, click on the three-dots menu in the top-right corner of +the ``Software Center`` page, then select the ``Core apps`` option. -You can force the metadata refresh by clicking on the :guilabel:`Reload -repositories` button. .. rubric:: Footnotes -.. [#fileserver] Except for :ref:`file-server-section`, that is installed - with :ref:`active_directory-section` +.. [#fileserver] Except for :ref:`file-server-section`, that is provided + by a core module, installed with :ref:`active_directory-section` From 9985c892faa5ff7f2a54f9ad5b830ef2656c8e92 Mon Sep 17 00:00:00 2001 From: Davide Principi Date: Fri, 27 Sep 2024 15:54:50 +0200 Subject: [PATCH 3/5] Add Terms and Conditions section This section is the destination of a link displayed in the cluster-admin UI, in Subscription page. Co-authored-by: Nick <87082120+NethNick@users.noreply.github.com> --- subscription.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/subscription.rst b/subscription.rst index 0d1598e9..73af94df 100644 --- a/subscription.rst +++ b/subscription.rst @@ -51,6 +51,32 @@ button. If the procedure is successful the Subscription page displays the ``System ID``, ``Plan`` type and ``Expiration`` date. +.. _terms-and-conditions: + +Terms and Conditions +==================== + +Please read the Terms and Conditions carefully. By maintaining an active +NethServer 8 subscription, you confirm that you accept the Terms and +Conditions and agree to abide by them. If you do not agree to these Terms +and Conditions, you may not activate or continue your subscription. + +Details of subscription plans can be found on the `NethServer website`_. + +.. _NethServer website: https://www.nethserver.org/subscription + +Personal identification information is stored and processed when necessary +to fulfill a contract to which the data subject is a party, or to take +steps at the request of the data subject prior to entering into a +contract. This information may also be used to share updates and news +related to the subscribed service. + +The data controller is Nethesis S.r.l unipersonale CF/PI/RI IT +02734760412, located at Strada degli Olmi 8 -- 61122 Pesaro (PU) -- Italy. + +Any requests concerning the processing of personal identification +information (PII) may be addressed to privacy@nethesis.it. + .. _scheduled-updates: From ca67ab71087c46150a41df5cc7e71b19ec0b2d3d Mon Sep 17 00:00:00 2001 From: Davide Principi Date: Fri, 27 Sep 2024 17:03:07 +0200 Subject: [PATCH 4/5] Update Scheduled updates section Clarify the difference between the scheduled policy and manual access to the Software Center if a subscription is active on the cluster. --- subscription.rst | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/subscription.rst b/subscription.rst index 73af94df..1f226596 100644 --- a/subscription.rst +++ b/subscription.rst @@ -83,23 +83,31 @@ information (PII) may be addressed to privacy@nethesis.it. Scheduled updates ================= -An overnight scheduled task installs software updates available from -managed software repositories. The task runs daily, from Tuesday through -Friday, within a randomly selected time slot between midnight and 6 AM. -This variability helps distribute the load on the network and servers. -Updates concern: - -- **Operating system**: updates are sourced from Nethesis managed - repositories, specifically from DNF repositories labeled as - ``ns-baseos`` and ``ns-appstream``. These repositories provide delayed - snapshots of Rocky Linux repositories, aiming to prevent the - distribution of updates that may lead to unexpected issues. +A scheduled overnight task automatically installs software updates +available from Nethesis-managed repositories. This task runs daily from +Tuesday through Friday, within a randomly selected time slot between +midnight and 6 AM. The randomization helps distribute the load on network +and server resources. The updates include: + +- **Operating system**: Updates are sourced from the DNF repositories + labeled ``ns-baseos`` and ``ns-appstream``. These repositories provide + delayed snapshots of Rocky Linux repositories to avoid distributing + updates that could cause unexpected issues. - **Core components**: Updates are fetched from the ``subscription`` - repository + repository. + +- **Applications**: Updates are also sourced from the ``subscription`` + repository. + +Managed repositories follow a conservative update policy to ensure +stability and thorough testing of updates, making them suitable for +automated updates. -- **Applications**: Updates are fetched from the ``subscription`` - repository +It is possible to override the managed update policy by manually +installing or updating core components or applications via the Software +Center page. The metadata for applications and core components from the +``subscription`` repository is refreshed hourly in the Software Center. Remove the subscription From 0b1ec781a640db1d35d64b2580f1dba7b57d7593 Mon Sep 17 00:00:00 2001 From: Davide Principi Date: Fri, 27 Sep 2024 18:12:26 +0200 Subject: [PATCH 5/5] fixup! Revised Software Center page --- software_center.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/software_center.rst b/software_center.rst index 10e0bddd..d4553d1f 100644 --- a/software_center.rst +++ b/software_center.rst @@ -1,7 +1,7 @@ .. _software_center-section: =============== -Software Center +Software center =============== The Software Center displays and manages applications available from all