Skip to content

Commit

Permalink
Update document with more flags
Browse files Browse the repository at this point in the history
Update README with caveats
  • Loading branch information
nikhilsbhat committed Mar 27, 2023
1 parent 7babd0b commit 0698812
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 11 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,4 +185,13 @@ Global Flags:
## Documentation
Updated documentation on all available commands and flags can be found [here](https://github.com/nikhilsbhat/helm-drift/blob/master/docs/doc/drift.md).
Updated documentation on all available commands and flags can be found [here](https://github.com/nikhilsbhat/helm-drift/blob/master/docs/doc/drift.md).
## Caveats
Identifying drifts on `CRD`'s would be tricky, plugin might not respond with correct data.
If helm hooks defined in chart, one might find drifts always on helm hooks which is marked with `hook-succeeded` and `hook-failed` when identifying drifts from charts.</br>
Things would work perfectly when identifying drifts from installed release.
Support for adding a `flag` to skip helm `hooks` if required is under development.
2 changes: 1 addition & 1 deletion docs/doc/drift.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ drift [command] [flags]
* [drift run](drift_run.md) - Identifies drifts from a selected chart/release
* [drift version](drift_version.md) - Command to fetch the version of helm-drift installed

###### Auto generated by spf13/cobra on 25-Mar-2023
###### Auto generated by spf13/cobra on 27-Mar-2023
20 changes: 12 additions & 8 deletions docs/doc/drift_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,17 @@ drift run [RELEASE] [CHART] [flags]
### Options

```
--from-release enable the flag to identify drifts from a release instead (disabled by default)
-h, --help help for run
--regex string regex used to split helm template rendered (default "---\\n# Source:\\s.*.")
--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
--temp-path string path on disk where the helm templates would be rendered on to (the same would be used be used by 'kubectl diff') (default "/Users/nikhil.bhat/.helm-drift/templates")
-d, --disable-error-on-drift enabling this would disable exiting with error if drifts were identified (works only when --summary is enabled)
--from-release enable the flag to identify drifts from a release instead (disabled by default)
-h, --help help for run
-j, --json enable the flag to render drifts in json format (disabled by default)
--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-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
--temp-path string path on disk where the helm templates would be rendered on to (the same would be used be used by 'kubectl diff') (default "/Users/nikhil.bhat/.helm-drift/templates")
-y, --yaml enable the flag to render drifts in yaml format (disabled by default)
```

### Options inherited from parent commands
Expand All @@ -45,4 +49,4 @@ drift run [RELEASE] [CHART] [flags]

* [drift](drift.md) - Utility that helps in identifying drifts in infrastructure

###### Auto generated by spf13/cobra on 25-Mar-2023
###### Auto generated by spf13/cobra on 27-Mar-2023
2 changes: 1 addition & 1 deletion docs/doc/drift_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ drift version [flags]

* [drift](drift.md) - Utility that helps in identifying drifts in infrastructure

###### Auto generated by spf13/cobra on 25-Mar-2023
###### Auto generated by spf13/cobra on 27-Mar-2023

0 comments on commit 0698812

Please sign in to comment.