Skip to content

Commit

Permalink
feat: document the validator rules check --custom-resources flag (#4)
Browse files Browse the repository at this point in the history
## Issue
N/A

## Description
Document the usage of the `--custom-resources` flag which was added
here:
validator-labs/validatorctl#218
  • Loading branch information
ahmad-ibra authored Sep 9, 2024
1 parent e445354 commit dd83708
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/validatorctl/2-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,7 @@ The `check` subcommand accepts the following flags.
| -------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `-f` | `--config-file` | Validator configuration file. | string |
| `-o` | `--config-only` | Update the configuration file only. Do not proceed with checks. Default: false | boolean |
| | `--custom-resources` | Path to a file or directory containing validator custom resource YAML documents. | string |
| `-h` | `--help` | Help with any command. | - |
| `-r` | `--reconfigure` | Reconfigure plugins rules prior to running checks. The `--config-file` flag must be included. Default: false. | boolean |
| `-p` | `--update-passwords` | Update credentials provided in the configuration file. This does not proceed with installation. The `--config-file` flag must be included. Default: false. | boolean |
Expand All @@ -367,13 +368,20 @@ Directly evaluate Validator plugin rules.
validator rules check
```

Directly evaluate preconfigured Validator plugin rules.
Directly evaluate preconfigured Validator plugin rules via validator config.

```shell
validator rules check \
--config-file /Users/demo/.validator/validator-20231109135306/validator.yaml
```

Directly evaluate preconfigured Validator plugin rules via custom resources.

```shell
validator rules check \
--custom-resources /Users/demo/custom-resources
```

### Uninstall

Use the `uninstall` subcommand to uninstall the Validator framework and remove all Validator plugins. To remove
Expand Down

0 comments on commit dd83708

Please sign in to comment.