f125a8b892
This change addresses a long-standing issue in rST documentation imported from XML.
That import process added backslash escapes in front of various characters. The three
most common being '(', ')', and '_'.
These instances are removed.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id43a9337ffcd505ccbdf072d7b29afdb5d2c997e
69 lines
12 KiB
ReStructuredText
69 lines
12 KiB
ReStructuredText
|
|
.. skm1582115510876
|
|
.. _kubernetes-admin-tutorials-starlingx-application-package-manager:
|
|
|
|
=====================================
|
|
StarlingX Application Package Manager
|
|
=====================================
|
|
|
|
Use the |prod| system application commands to manage containerized application
|
|
deployment from the command-line.
|
|
|
|
|prod| application management provides a wrapper around FluxCD and Kubernetes
|
|
Helm (see `https://github.com/helm/helm <https://github.com/helm/helm>`__)
|
|
for managing containerized applications. FluxCD is a tool for managing multiple
|
|
Helm charts with dependencies by centralizing all configurations in a single
|
|
FluxCD YAML definition and providing life-cycle hooks for all Helm releases.
|
|
|
|
A |prod| application package is a compressed tarball containing a metadata.yaml
|
|
file, a manifest.yaml FluxCD manifest file, and a charts directory containing
|
|
Helm charts and a checksum.md5 file. The metadata.yaml file contains the
|
|
application name, version, and optional Helm repository and disabled charts
|
|
information.
|
|
|
|
|prod| application package management provides a set of :command:`system`
|
|
CLI commands for managing the lifecycle of an application, which includes
|
|
managing overrides to the Helm charts within the application.
|
|
|
|
.. _kubernetes-admin-tutorials-tarlingx-application-package-manager-d463e61:
|
|
|
|
.. table:: Table 1. Application Package Manager Commands
|
|
:widths: auto
|
|
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Command | Description |
|
|
+========================================+=============================================================================================================================================================================================================================================================+
|
|
| :command:`application-list` | List all applications. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`application-show` | Show application details such as name, status, and progress. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`application-upload` | Upload a new application package. |
|
|
| | |
|
|
| | This command loads the application's FluxCD manifest and Helm charts into an internal database and automatically applies system overrides for well-known Helm charts, allowing the Helm chart to be applied optimally to the current cluster configuration. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`helm-override-list` | List system Helm charts and the namespaces with Helm chart overrides for each Helm chart. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`helm-override-show` | Show a Helm chart's overrides for a particular namespace. |
|
|
| | |
|
|
| | This command displays system overrides, user overrides and the combined system and user overrides. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`helm-override-update` | Update Helm chart user overrides for a particular namespace. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`helm-chart-attribute-modify` | Enable or disable the installation of a particular Helm chart within an application manifest. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`helm-override-delete` | Delete a Helm chart's user overrides for a particular namespace. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`application-apply` | Apply or reapply the application manifest and Helm charts. |
|
|
| | |
|
|
| | This command will install or update the existing installation of the application based on its FluxCD manifest, Helm charts and Helm charts' combined system and user overrides. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`application-abort` | Abort the current application operation. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`application-update` | Update the deployed application to a different version. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`application-remove` | Uninstall an application. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :command:`application-delete` | Remove the uninstalled application's definition, including manifest and Helm charts and Helm chart overrides, from the system. |
|
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|