Update document with new flag

nikhilsbhat · Apr 25, 2023 · b236d71 · b236d71
1 parent 612efa9
commit b236d71
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/cmd/commands.go b/cmd/commands.go
@@ -80,7 +80,8 @@ func getAllCommand() *cobra.Command {
 	driftCommand := &cobra.Command{
 		Use:   "all",
 		Short: "Identifies drifts from all releases from the cluster.",
-		Long:  "It lists all configuration drifts that are part of various releases present in the cluster.",
+		Long: `It lists all configuration drifts that are part of various releases present in the cluster. 
+Do note that this is expensive operation since multiple kubectl command would be executed in parallel.`,
 		Example: `  helm drift all --kube-context k3d-sample
   helm drift all --kube-context k3d-sample -n sample`,
 		Args: cobra.NoArgs,

diff --git a/docs/doc/drift_all.md b/docs/doc/drift_all.md
@@ -4,7 +4,8 @@ Identifies drifts from all releases from the cluster.
 
 ### Synopsis
 
-It lists all configuration drifts that are part of various releases present in the cluster.
+It lists all configuration drifts that are part of various releases present in the cluster. 
+Do note that this is expensive operation since multiple kubectl command would be executed in parallel.
 
 ```
 drift all [flags]
@@ -29,6 +30,7 @@ drift all [flags]
       --name string                         name of the kubernetes resource to limit the drift identification
       --regex string                        regex used to split helm template rendered (default "---\\n# Source:\\s.*.")
       --report                              when enabled the summary report would be rendered on to a file (this works only if --yaml or --json is enabled along with summary)
+      --skip strings                        kubernetes resource names to skip the drift identification (ex: --skip Deployments)
       --skip-cleaning                       enable the flag to skip cleaning the manifests rendered on to disk
       --skip-validation                     enable the flag if prerequisite validation needs to be skipped
       --summary                             if enabled, prints a quick summary in table format without printing actual drifts
@@ -52,4 +54,4 @@ drift all [flags]
 
 * [drift](drift.md)	 - A utility that helps in identifying drifts in infrastructure
 
-###### Auto generated by spf13/cobra on 15-Apr-2023
+###### Auto generated by spf13/cobra on 25-Apr-2023
diff --git a/docs/doc/drift_run.md b/docs/doc/drift_run.md
@@ -29,6 +29,7 @@ drift run [RELEASE] [CHART] [flags]
       --name string                         name of the kubernetes resource to limit the drift identification
       --regex string                        regex used to split helm template rendered (default "---\\n# Source:\\s.*.")
       --report                              when enabled the summary report would be rendered on to a file (this works only if --yaml or --json is enabled along with summary)
+      --skip strings                        kubernetes resource names to skip the drift identification (ex: --skip Deployments)
       --skip-cleaning                       enable the flag to skip cleaning the manifests rendered on to disk
       --skip-validation                     enable the flag if prerequisite validation needs to be skipped
       --summary                             if enabled, prints a quick summary in table format without printing actual drifts
@@ -52,4 +53,4 @@ drift run [RELEASE] [CHART] [flags]
 
 * [drift](drift.md)	 - A utility that helps in identifying drifts in infrastructure
 
-###### Auto generated by spf13/cobra on 15-Apr-2023
+###### Auto generated by spf13/cobra on 25-Apr-2023