From 2373921485a57c9f1c4218ce8ccaeafd0946c054 Mon Sep 17 00:00:00 2001 From: Petsy Mathew Date: Mon, 11 Aug 2025 15:00:02 +0000 Subject: [PATCH] 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 --- doc/source/_vendor/rl-strings.txt | 1 - ...pplication-commands-and-helm-overrides.rst | 0 .../application-reference-8916dfe370cd.rst | 41 +++++++++++++---- ...orm-application-reference-88eec414685e.rst | 26 +++++++++-- ...-starlingx-application-package-manager.rst | 0 .../index-sysconf-kub-78f0e1e9ca5a.rst | 10 ---- .../system-config-helm-package-manager.rst | 46 ------------------- .../system-configuration-overview.rst | 3 +- 8 files changed, 56 insertions(+), 71 deletions(-) rename doc/source/{system_configuration/kubernetes => application-ref}/application-commands-and-helm-overrides.rst (100%) rename doc/source/{system_configuration/kubernetes => application-ref}/system-configuration-starlingx-application-package-manager.rst (100%) delete mode 100644 doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst diff --git a/doc/source/_vendor/rl-strings.txt b/doc/source/_vendor/rl-strings.txt index e247189e4..4a8a888ae 100644 --- a/doc/source/_vendor/rl-strings.txt +++ b/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 ` .. |converting-a-duplex-system-to-switch-based-connection| replace:: :ref:`Convert a Duplex System to Switch-Based Connection ` .. |remove-ptp-configurations-4885c027dfa5| replace:: :ref:`Remove PTP Configurations ` -.. |system-config-helm-package-manager| replace:: :ref:`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 ` .. |update-the-registry-secrets| replace:: :ref:`Update the Registries' Auth-Secrets ` .. |configuring-ptp-service-using-the-cli| replace:: :ref:`Configure PTP Service Using the CLI ` diff --git a/doc/source/system_configuration/kubernetes/application-commands-and-helm-overrides.rst b/doc/source/application-ref/application-commands-and-helm-overrides.rst similarity index 100% rename from doc/source/system_configuration/kubernetes/application-commands-and-helm-overrides.rst rename to doc/source/application-ref/application-commands-and-helm-overrides.rst diff --git a/doc/source/application-ref/application-reference-8916dfe370cd.rst b/doc/source/application-ref/application-reference-8916dfe370cd.rst index 00057f3b1..62c875322 100644 --- a/doc/source/application-ref/application-reference-8916dfe370cd.rst +++ b/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 table to navigate to the applications based on your requirement. +The |prod| platform includes containerized applications that are +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 +`_. + + .. 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 - automatically downgraded on patch removal. + Platform Applications are automatically updated when a newer version is + 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 - diff --git a/doc/source/application-ref/index-platform-application-reference-88eec414685e.rst b/doc/source/application-ref/index-platform-application-reference-88eec414685e.rst index 0b55dc3bd..8fb59440d 100644 --- a/doc/source/application-ref/index-platform-application-reference-88eec414685e.rst +++ b/doc/source/application-ref/index-platform-application-reference-88eec414685e.rst @@ -4,14 +4,32 @@ .. _index-platform-application-reference-88eec414685e: ============================== -Platform Application Reference +|prod| Applications ============================== - -.. Uncomment topic-a etc. below and replace with the names of your topics, - excluding the .rst extension +Use this section to view the list of supported Platform Applications. .. 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 + + + + + + diff --git a/doc/source/system_configuration/kubernetes/system-configuration-starlingx-application-package-manager.rst b/doc/source/application-ref/system-configuration-starlingx-application-package-manager.rst similarity index 100% rename from doc/source/system_configuration/kubernetes/system-configuration-starlingx-application-package-manager.rst rename to doc/source/application-ref/system-configuration-starlingx-application-package-manager.rst diff --git a/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst b/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst index 3b0ba2a08..bbc64a370 100644 --- a/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst +++ b/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 diff --git a/doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst b/doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst deleted file mode 100644 index 540c76c05..000000000 --- a/doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst +++ /dev/null @@ -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/ `__. - -For more information on how to configure and use Helm both locally and remotely, see :ref:`Configure Local CLI Access `, -and :ref:`Configure Remote CLI Access `. \ No newline at end of file diff --git a/doc/source/system_configuration/openstack/system-configuration-overview.rst b/doc/source/system_configuration/openstack/system-configuration-overview.rst index 62dd5df05..8b74c4d77 100644 --- a/doc/source/system_configuration/openstack/system-configuration-overview.rst +++ b/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 -`, for a description of the application +See |prod| System Configuration: :ref:`kubernetes-user-tutorials-helm-package-manager` lifecycle commands for managing a system application. System Applications are a set of one or more interdependent Application Helm