From a36d8b6be6cb9ba86670d89325e7adf124bbf226 Mon Sep 17 00:00:00 2001 From: Andy Suderman Date: Mon, 21 Oct 2024 14:25:14 -0600 Subject: [PATCH] docs: remove copy/pasta of CLI that always gets out of date (#691) * docs: remove copy/pasta of CLI that always gets out of date * docs: update slack link --- README.md | 2 +- docs/README.md | 2 +- docs/usage.md | 153 ------------------------------------------------- 3 files changed, 2 insertions(+), 155 deletions(-) diff --git a/README.md b/README.md index 2693d8c0..a4468125 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ - + diff --git a/docs/README.md b/docs/README.md index f1ffb1df..f2e33ddd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ - + diff --git a/docs/usage.md b/docs/usage.md index e5d59c0c..de3b1501 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -315,156 +315,3 @@ gitops: > Must be used with `reckoner template --output-dir ` to produce any files. -## CLI Usage - -```text -$ reckoner --help -Usage: reckoner [OPTIONS] COMMAND [ARGS]... - -Options: - --version Show the version and exit. - --log-level TEXT Log Level. [INFO | DEBUG | WARN | ERROR]. (default=INFO) - --help Show this message and exit. - -Commands: - plot Install charts with given arguments as listed in yaml file argument - template Output the template of the chart or charts as they would be installed or - upgraded - get-manifests Output the manifests of the chart or charts as they are installed - diff Output diff of the templates that would be installed and the manifests as they are installed - update Checks to see if anything will be changed, if so, update the release, if not, does nothing - version Takes no arguments, outputs version info - import Outputs a chart block that can be used to import the specified release -``` - -You can add `--help` to any `Command` and get output like the one below: - -```text -$ reckoner plot --help -Usage: reckoner plot [OPTIONS] COURSE_FILE - - Install charts with given arguments as listed in yaml file argument - -Options: - --dry-run Pass --dry-run to helm so no action is - taken. Implies --debug and skips hooks. - - --debug DEPRECATED - use --log-level=DEBUG as a - parameter to `reckoner` instead. May be used - with or without `--dry-run`. Or, pass - `--debug` to --helm-args - - -a, --run-all Run all charts in the course. Mutually - exclusive with 'only'. - - -o, --only, --heading Only run a specific chart by name Mutually - exclusive with 'run_all'. - - --helm-args TEXT Passes the following arg on to helm, can be - used more than once. WARNING: Setting this - will completely override any helm_args in - the course. Also cannot be used for - configuring how helm connects to tiller. - - --continue-on-error Attempt to install all charts in the course, - even if any charts or hooks fail to run. - - --create-namespace / --no-create-namespace - Will create the specified nameaspace if it - does not already exist. Replaces - functionality lost in Helm3 - - --log-level TEXT Log Level. [INFO | DEBUG | WARN | ERROR]. - (default=INFO) - - --help Show this message and exit. -``` - -Or - -``` -$ reckoner update --help -Usage: reckoner update [OPTIONS] COURSE_FILE - - Checks to see if anything will be changed, if so, update the release, - if not, does nothing - -Options: - --dry-run Pass --dry-run to helm so no action is - taken. Implies --debug and skips hooks. - - --debug DEPRECATED - use --log-level=DEBUG as a - parameter to `reckoner` instead. May be used - with or without `--dry-run`. Or, pass - `--debug` to --helm-args - - -a, --run-all Run all charts in the course. Mutually - exclusive with 'only'. - - -o, --only, --heading Only run a specific chart by name Mutually - exclusive with 'run_all'. - - --helm-args TEXT Passes the following arg on to helm, can be - used more than once. WARNING: Setting this - will completely override any helm_args in - the course. Also cannot be used for - configuring how helm connects to tiller. - - --continue-on-error Attempt to install all charts in the course, - even if any charts or hooks fail to run. - - --create-namespace / --no-create-namespace - Will create the specified nameaspace if it - does not already exist. Replaces - functionality lost in Helm3 - - --log-level TEXT Log Level. [INFO | DEBUG | WARN | ERROR]. - (default=INFO) - - --help Show this message and exit. -``` - -Or - -```text -$ reckoner template --help -Templates a helm chart for a release or several releases. Automatically sets --create-namespaces=false --dry-run=true - -Usage: - reckoner template [flags] - -Flags: - -h, --help help for template - --output-dir string path to the base output directory (eg, ~/myproject/manifests) - -Global Flags: - --create-namespaces If true, allow reckoner to create namespaces. (default true) - --dry-run Implies helm --dry-run --debug and skips any hooks - --helm-args strings Additional arguments to pass to helm commands. Can - be passed multiple times. used more than once. - WARNING: Setting this will completely override - any helm_args in the course. - --no-color If true, don't colorize output. - -o, --only strings Only install this list of releases. Can be passed - multiple times. - -a, --run-all Install every release in the course file - -v, --v Level number for the log level verbosity -``` - -Or - -```text -$ reckoner import --help -Usage: reckoner import [OPTIONS] - - Outputs a chart block that can be used to import the specified release - -Options: - --log-level TEXT Log Level. [INFO | DEBUG | WARN | ERROR]. - (default=INFO) - - --release_name TEXT The release name to import [required] - --namespace TEXT The namespace of the release [required] - --repository TEXT The repository of the chart [required] - --help Show this message and exit. -```