2373921485
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>
12 KiB
StarlingX Application Package Manager
Use the system application commands to manage containerized applications provided as part of .
StarlingX application management provides a wrapper around FluxCD and Kubernetes Helm (see 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 StarlingX 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.
StarlingX application package management provides a set of system CLI commands for
managing the lifecycle of an Application, which includes managing
overrides to the helm charts within the application.
| Command | Description |
|---|---|
application-list |
List all applications. |
application-show |
Show application details such as name, status, and progress. |
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. |
helm-override-list |
List system helm charts and the namespaces with helm chart overrides for each helm chart. |
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. |
helm-override-update |
Update helm chart user-overrides for a particular namespace. |
helm-chart-attribute-modify |
Enable or disable the installation of a particular helm chart within an application manifest. |
helm-override-delete |
Delete a helm chart's user-overrides for a particular namespace. |
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. |
application-abort |
Abort the current application operation. |
application-update |
Update the deployed application to a different version |
application-remove |
Uninstall an application. |
application-delete |
Remove the uninstalled application's definition, including manifest and helm charts and helm chart overrides, from the system. |