Helm list: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 7: Line 7:


=Overview=
=Overview=
{{Note|<center>Revised for Helm 3</center>}}
The command lists releases that has a "deployed" or "failed" [[Helm_Concepts#Release_State|state]] in the "default" namespace. This behavior can be modified with the flags [[#--uninstalled|--uninstalled]] and [[#--all|--all]]. To list releases from all namespaces see [[#--all-namespaces|--all-namespaces]].
 
<font size=-1>
The command lists releases that are deployed or failed in the "default" namespace. This behavior can be modified with the flags [[#--uninstalled|--uninstalled]] and [[#--all|--all]]. To list releases from all namespaces see [[#--all-namespaces|--all-namespaces]].
 
  helm list|ls
  helm list|ls
</font>


=Options=
=Options=
==<span id=''Show_Deleted_Releases></span>--uninstalled==
==<span id=''Show_Deleted_Releases></span><tt>--uninstalled</tt>==


Shows uninstalled releases for which uninstallation was done with the [[Helm_uninstall#--keep-history|--keep-history]] flag. By default, uninstallation [[Helm_uninstall#Overview|removes historical information]] about the release.
Shows uninstalled releases for which uninstallation was done with the [[Helm_uninstall#--keep-history|--keep-history]] flag. By default, uninstallation [[Helm_uninstall#Overview|removes historical information]] about the release.
 
<font size=-1>
  helm list --uninstalled
  helm list --uninstalled
 
</font>
==--all==
==<tt>--all</tt>==
 
<code>helm list</code> shows by default only releases with status "deployed" or "failed". To list releases in all states, use <code>--all</code>
<code>helm list</code> shows by default only releases with status "deployed" or "failed". To list releases in all states, use <code>--all</code>
 
==<span id='Ordered_by_Date'></span><tt>-d, --date</tt>==
==<span id='Ordered_by_Date'></span>-d, --date==
Show releases sorted by release date.
Show releases sorted by release date.
==Namespace Support==
==Namespace Support==
===<span id='--all-namespaces'></span>-A|--all-namespaces===
===<span id='--all-namespaces'></span><tt>-A|--all-namespaces</tt>===
 
Releases can be installed in arbitrary namespaces and this command list all releases in the kubernetes cluster, irrespective on namespace.
Releases can be installed in arbitrary namespaces and this command list all releases in the kubernetes cluster, irrespective on namespace.
===<span id='--namespace'></span><tt>-n|--namespace</tt>===
==<tt>--o|--output-format</tt>==


===<span id='--namespace'></span>-n|--namespace===
Prints the output in the specified format: table (default), json, yaml.


==--o|--output-format==
==<tt>--f|--filter </tt>==
 
Specifies a filter string, which is a Perl-compatible regular expression applied to the '''release name'''. Any releases whose names match the expression will be included in the results. To list "blue" and only "blue":
Prints the output in the specified format: table (default), json, yaml.
<font size=-1>
helm list -f '^blue$'
</font>

Latest revision as of 00:06, 9 February 2022

External

Internal

Overview

The command lists releases that has a "deployed" or "failed" state in the "default" namespace. This behavior can be modified with the flags --uninstalled and --all. To list releases from all namespaces see --all-namespaces.

helm list|ls

Options

--uninstalled

Shows uninstalled releases for which uninstallation was done with the --keep-history flag. By default, uninstallation removes historical information about the release.

helm list --uninstalled

--all

helm list shows by default only releases with status "deployed" or "failed". To list releases in all states, use --all

-d, --date

Show releases sorted by release date.

Namespace Support

-A|--all-namespaces

Releases can be installed in arbitrary namespaces and this command list all releases in the kubernetes cluster, irrespective on namespace.

-n|--namespace

--o|--output-format

Prints the output in the specified format: table (default), json, yaml.

--f|--filter

Specifies a filter string, which is a Perl-compatible regular expression applied to the release name. Any releases whose names match the expression will be included in the results. To list "blue" and only "blue":

helm list -f '^blue$'