Documentation Updates: Inter-application dependencies

Update 5: Updated the note and dependency text to reflect the latest changes.

Update 4: Renamed the section to Platform Applications based on Greg's feedback, and incorporated additional content as outlined in the comments.

Update 3: Addressed Igors comment.

Updates 2: Most of Greg's comments have been addressed, except for the addition of the Dependency column in the table. That item will be covered in a separate review and will be addressed by Elisa.

Updates: The previously added section on application inter-dependencies has been removed, as this information is already documented in the StarlingX wiki. Instead, a brief summary of the feature has been included in the Application Reference section, along with a link to the StarlingX wiki for further details.

Story: 2011351
Task: 52654

Change-Id: I06982f747adf8177f6d033def664a0b052a56878
Signed-off-by: Petsy Mathew <petsy.mathew@windriver.com>

doc/source/_vendor/rl-strings.txt

@@ -389,7 +389,6 @@
 .. |configuring-ntp-servers-and-services-using-the-cli| replace:: :ref:`Configure NTP Servers Using the CLI <configuring-ntp-servers-and-services-using-the-cli>`
 .. |converting-a-duplex-system-to-switch-based-connection| replace:: :ref:`Convert a Duplex System to Switch-Based Connection <converting-a-duplex-system-to-switch-based-connection>`
 .. |remove-ptp-configurations-4885c027dfa5| replace:: :ref:`Remove PTP Configurations <remove-ptp-configurations-4885c027dfa5>`
-.. |system-config-helm-package-manager| replace:: :ref:`Helm Package Manager <system-config-helm-package-manager>`
 .. |changing-the-mtu-of-an-oam-interface-using-the-cli| replace:: :ref:`Change the MTU of an OAM Interface Using the CLI <changing-the-mtu-of-an-oam-interface-using-the-cli>`
 .. |update-the-registry-secrets| replace:: :ref:`Update the Registries' Auth-Secrets <update-the-registry-secrets>`
 .. |configuring-ptp-service-using-the-cli| replace:: :ref:`Configure PTP Service Using the CLI <configuring-ptp-service-using-the-cli>`

doc/source/application-ref/application-reference-8916dfe370cd.rst

@@ -11,13 +11,36 @@
 .. _application-reference-8916dfe370cd:
 
 =====================
-Application Reference
+Platform Applications
 =====================
 
 .. to be reviewed
 
-Below is a list of Applications that are supported in |prod|. Use the links in
+The |prod| platform includes containerized applications that are
-the table to navigate to the applications based on your requirement.
+deployed and managed within its Kubernetes-based infrastructure. |prod|
+applications are categorized into two types:
+
+* **Mandatory applications** - installed automatically to support core system
+  functions.
+
+* **Optional applications** - can be added later to expand or customize the
+  platform.
+    
+The **Application Reference** table below lists the applications supported in
+|prod|. The table also indicates which applications are mandatory and which
+are optional. Use the links in the table to access detailed descriptions,
+along with instructions for uploading, configuring, and applying
+each application.
+
+|prod| provides a set of commands for managing the lifecycle of these
+containerized Platform Applications. For more information, see :ref:`application-management-commands`.
+
+Relationships between applications can also be defined to ensure that dependencies
+are handled in the correct sequence during deployment. For more information on
+managing these dependencies, see the `StarlingX Wiki
+<https://wiki.openstack.org/wiki/StarlingX/Containers/Applications/AppIntegration#metadata.yaml>`_.
+
+
 
 .. only:: partner
 
@@ -27,11 +50,14 @@ the table to navigate to the applications based on your requirement.
 
 .. note::
 
-    Applications are automatically updated on patch application and
+    Platform Applications are automatically updated when a newer version is
-    automatically downgraded on patch removal.
+    delivered through a Patch Release or Major Release upgrade. Downgrades also
+    occur automatically when patches are removed. For uploaded  applications,
+    manual updates require deleting the existing version before uploading a new
+    one.
+
+   
 
-    Applications on uploaded status will have their old version excluded and
-    the new version will be uploaded.
 
 .. list-table::
    :header-rows: 1
@@ -572,4 +598,3 @@ the table to navigate to the applications based on your requirement.
           .. include:: /_includes/application-reference-8916dfe370cd.rest
             :start-after: deployment-manager-image2-begin
             :end-before: deployment-manager-image2-end
-

doc/source/application-ref/index-platform-application-reference-88eec414685e.rst

@@ -4,14 +4,32 @@
 .. _index-platform-application-reference-88eec414685e:
 
 ==============================
-Platform Application Reference
+|prod| Applications
 ==============================
-
+Use this section to view the list of supported Platform Applications.
-.. Uncomment topic-a etc. below and replace with the names of your topics,
-   excluding the .rst extension
 
 .. toctree::
    :maxdepth: 2
 
    application-reference-8916dfe370cd
 
+.. _application-management-commands:
+
+*******************************
+Application Management Commands
+*******************************
+Use these commands to manage the lifecycle of Platform Applications.
+These commands allow you to upload, configure, apply (or install), update, or
+remove Platform Applications as needed.
+
+.. toctree::
+   :maxdepth: 2
+
+   system-configuration-starlingx-application-package-manager
+   application-commands-and-helm-overrides
+
+
+
+
+
+

doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst

@@ -119,16 +119,6 @@ Switch Intel Driver Versions
 
    intel-driver-version-c6e3fa384ff7
 
-----------------------
-Application Management
-----------------------
-
-.. toctree::
-   :maxdepth: 2
-
-   system-config-helm-package-manager
-   system-configuration-starlingx-application-package-manager
-   application-commands-and-helm-overrides
 
 ----------------------------------------
 Direct vs Switch-Based AIO Configuration

doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst

@@ -1,46 +0,0 @@
-
-.. emk1568230814240
-.. _system-config-helm-package-manager:
-
-====================
-Helm Package Manager
-====================
-
-|prod-long| supports Helm v3 package manager for Kubernetes that can be used to
-securely manage the lifecycle of applications within the Kubernetes cluster.
-
-.. rubric:: |context|
-
-Helm packages are defined by Helm charts with container information sufficient
-for managing a Kubernetes application. You can configure, install, and upgrade
-your Kubernetes applications using Helm charts. Helm charts are defined with a
-default set of values that describe the behavior of the service installed
-within the Kubernetes cluster.
-
-A Helm v3 client is installed on controllers for local use by admins to manage
-end-users' Kubernetes applications. |prod| recommends to install a Helm v3
-client on a remote workstation, so that non-admin (and admin) end-users can
-manage their Kubernetes applications remotely.
-
-Upon system installation, local Helm repositories (containing |prod-long|
-packages) are created and added to the Helm repo list.
-
-Use the following command to list these local Helm repositories:
-
-.. code-block:: none
-
-    ~(keystone_admin)]$ helm repo list
-    NAME            URL
-    starlingx       `http://127.0.0.1:8080/helm_charts/starlingx`
-    stx-platform    `http://127.0.0.1:8080/helm_charts/stx-platform`
-
-Where the `stx-platform` repo holds Helm charts of StarlingX Applications (see
-next section) of the |prod| platform itself, while the `starlingx` repo holds
-Helm charts of optional StarlingX applications, such as Openstack. The admin
-user can add charts to these local repos and regenerate the index to use these
-charts, and add new remote repositories to the list of known repos.
-
-For more information on Helm v3, see the documentation at `https://helm.sh/docs/ <https://helm.sh/docs/>`__.
-
-For more information on how to configure and use Helm both locally and remotely, see :ref:`Configure Local CLI Access <configure-local-cli-access>`,
-and :ref:`Configure Remote CLI Access <configure-remote-cli-access>`.

doc/source/system_configuration/openstack/system-configuration-overview.rst

@@ -9,8 +9,7 @@ Overview of Configuring StarlingX OpenStack
 
 |prod-os| is installed and managed as a system application.
 
-See |prod| System Configuration: :ref:`Application Management
+See |prod| System Configuration: :ref:`kubernetes-user-tutorials-helm-package-manager`
-<system-config-helm-package-manager>`, for a description of the application
 lifecycle commands for managing a system application.
 
 System Applications are a set of one or more interdependent Application Helm