starlingx/docs
Code Issues Proposed changes

Merge "Added --reuse-attributes"

Browse Source
This commit is contained in:
Zuul 2023-05-09 13:47:12 +00:00 committed by Gerrit Code Review
commit fc7b8ed77c
3 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/admintasks/kubernetes/admin-application-commands-and-helm-overrides.rst
View File

@ -387,7 +387,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)]$ system application-update [-n | --app-name] <app_name> [-v | --app-version] <version> <tar_file>
~(keystone_admin)]$ system application-update [-n | --app-name] <app_name> [-v | --app-version] <version> [ --reuse-attributes <true/false> ] [ --reuse-user-overrides ` <true/false> ] <tar_file>
where the following are optional arguments:
@ -416,6 +416,16 @@ commands to manage containerized applications provided as part of |prod|.
**<version>**
The version to update the application to.
**reuse-attributes**
If the user disabled some Helm charts (using :command:`system helm-chart-attribute-modify --enabled false`)
and wants to keep them disabled during an app-update then the user
should use ``--reuse-attributes true``.
**reuse-user-overrides**
If the user added some Helm chart overrides
(using :command:`system helm-override-update`) and wants to keep them
over an app-update then the user should use ``--reuse-user-overrides true``.
and the following is a positional argument which must come last:
**<tar_file>**

3
doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-metrics-server.rst
View File

@ -79,7 +79,7 @@ of Metrics API.
.. code-block:: none
~(keystone_admin)]$ system application-update --reuse-user-overrides true /usr/local/share/applications/helm/metrics-server-1.0-18.tgz
~(keystone_admin)]$ system application-update /usr/local/share/applications/helm/metrics-server-1.0-18.tgz
For details on leveraging Metrics Server for horizontal autoscaling or for
@ -93,3 +93,4 @@ For more information see:
`https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#top
<https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#top>`__

15
doc/source/system_configuration/kubernetes/application-commands-and-helm-overrides.rst
View File

@ -97,6 +97,7 @@ commands to manage containerized applications provided as part of |prod|.
**<tar_file>**
is the path to the tar file containing the application to be uploaded.
For example:
.. parsed-literal::
@ -395,7 +396,7 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)]$ system application-update [-n | --app-name] <app_name> [-v | --app-version] <version> <tar_file>
~(keystone_admin)]$ system application-update [-n | --app-name] <app_name> [-v | --app-version] <version> [ --reuse-attributes <true/false> ] [ --reuse-user-overrides ` <true/false> ] <tar_file>
where the following are optional arguments:
@ -422,6 +423,16 @@ commands to manage containerized applications provided as part of |prod|.
**<version>**
The version to update the application to.
**reuse-attributes**
If the user disabled some Helm charts (using :command:`system helm-chart-attribute-modify --enabled false`)
and wants to keep them disabled during an app-update then the user
should use ``--reuse-attributes true``.
**reuse-user-overrides**
If the user added some Helm chart overrides
(using :command:`system helm-override-update`) and wants to keep them
over an app-update then the user should use ``--reuse-user-overrides true``.
and the following is a positional argument which must come last:
**<tar_file>**
@ -485,3 +496,5 @@ commands to manage containerized applications provided as part of |prod|.
~(keystone_admin)]$ system application-delete metrics-server
Application metrics-server deleted.