Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove copy/pasta of CLI that always gets out of date #691

Merged
merged 2 commits into from
Oct 21, 2024
Merged

docs: remove copy/pasta of CLI that always gets out of date #691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
758417f
docs: remove copy/pasta of CLI that always gets out of date
sudermanjr Oct 21, 2024
47050b5
docs: update slack link
sudermanjr Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<a href="https://github.com/FairwindsOps/reckoner/releases">
<img src="https://img.shields.io/github/v/release/FairwindsOps/reckoner">
</a>
<a href="https://join.slack.com/t/fairwindscommunity/shared_invite/zt-e3c6vj4l-3lIH6dvKqzWII5fSSFDi1g">
<a href="https://join.slack.com/t/fairwindscommunity/shared_invite/zt-2na8gtwb4-DGQ4qgmQbczQyB2NlFlYQQ">
<img src="https://img.shields.io/static/v1?label=Slack&message=Join+our+Community&color=4a154b&logo=slack">
</a>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<a href="https://github.com/FairwindsOps/reckoner/releases">
<img src="https://img.shields.io/github/v/release/FairwindsOps/reckoner">
</a>
<a href="https://join.slack.com/t/fairwindscommunity/shared_invite/zt-e3c6vj4l-3lIH6dvKqzWII5fSSFDi1g">
<a href="https://join.slack.com/t/fairwindscommunity/shared_invite/zt-2na8gtwb4-DGQ4qgmQbczQyB2NlFlYQQ">
<img src="https://img.shields.io/static/v1?label=Slack&message=Join+our+Community&color=4a154b&logo=slack">
</a>
</div>
Expand Down
153 changes: 0 additions & 153 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,156 +315,3 @@ gitops:

> Must be used with `reckoner template --output-dir <some_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 <chart> 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 <chart> 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.
```