mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
69 lines
2.4 KiB
Plaintext
69 lines
2.4 KiB
Plaintext
// Module included in the following assemblies:
|
|
|
|
// *scalability_and_performance/cluster-compare/using-the-cluster-compare-plugin.adoc
|
|
|
|
:_mod-docs-content-type: REFERENCE
|
|
|
|
[id="cluster-compare-reference-args_{context}"]
|
|
= Reference cluster-compare plugin options
|
|
|
|
The following content describes the options for the `cluster-compare` plugin.
|
|
|
|
.Cluster-compare plugin options
|
|
[options="header"]
|
|
[cols="2a,3a"]
|
|
|====
|
|
| Option | Description
|
|
| `-A`, `--all-resources`
|
|
| When used with a live cluster, attempts to match all resources in the cluster that match a type in the reference configuration. When used with local files, attempts to match all resources in the local files that match a type in the reference configuration.
|
|
|
|
| `--concurrency`
|
|
| Specify an integer value for the number of templates to process in parallel when comparing with resources from the live version. A larger number increases speed but also memory, I/O, and CPU usage during that period. The default value is `4`.
|
|
|
|
| `-c`, `--diff-config`
|
|
| Specify the path to the user configuration file.
|
|
|
|
| `-f`, `--filename`
|
|
| Specify a filename, directory, or URL for the configuration custom resources that you want to use for a comparison with a reference configuration.
|
|
|
|
| `--generate-override-for`
|
|
| Specify the path for templates that requires a patch.
|
|
|
|
| `--show-template-functions`
|
|
| Displays the available template functions.
|
|
|
|
[NOTE]
|
|
====
|
|
You must use a file path for the target template that is relative to the `metadata.yaml` file. For example, if the file path for the `metadata.yaml` file is `./compare/metadata.yaml`, a relative file path for the template might be `optional/my-template.yaml`.
|
|
====
|
|
|
|
| `-h`, `--help`
|
|
| Display help information.
|
|
|
|
| `-k`, `--kustomize`
|
|
| Specify a path to process the `kustomization` directory. This flag cannot be used together with `-f` or `-R`.
|
|
|
|
| `-o`, `--output`
|
|
| Specify the output format. Options include `json`, `yaml`, `junit`, or `generate-patches`.
|
|
|
|
| `--override-reason`
|
|
| Specify a reason for generating the override.
|
|
|
|
| `-p`, `--overrides`
|
|
| Specify a path to a patch override file for the reference configuration.
|
|
|
|
| `-R`, `--recursive`
|
|
| Processes the directory specified in `-f`, `--filename` recursively.
|
|
|
|
| `-r`, `--reference`
|
|
| Specify the path to the reference configuration `metadata.yaml` file.
|
|
|
|
| `--show-managed-fields`
|
|
| Specify `true` to include managed fields in the comparison.
|
|
|
|
| `-v`, `--verbose`
|
|
| Increases the verbosity of the plugin output.
|
|
|
|
|====
|
|
|