# Advanced Usage Options
Pluto has a wide variety of options that can be used to customize behavior and output.
# Display Options
In addition to the standard output, Pluto can output in the following modes: Wide, YAML, JSON, CSV or Markdown.
--no-headers option hides headers in the outputs for Text, CSV and Markdown output.
# Wide
The wide output provides more information about when an apiVersion was removed or deprecated.
$ pluto detect-helm -owide
NAME NAMESPACE KIND VERSION REPLACEMENT DEPRECATED DEPRECATED IN REMOVED REMOVED IN
cert-manager/cert-manager-webhook cert-manager MutatingWebhookConfiguration admissionregistration.k8s.io/v1beta1 admissionregistration.k8s.io/v1 true v1.16.0 false v1.19.0
# JSON
$ pluto detect-helm -ojson | jq .
{
"items": [
{
"name": "cert-manager/cert-manager-webhook",
"namespace": "cert-manager",
"api": {
"version": "admissionregistration.k8s.io/v1beta1",
"kind": "MutatingWebhookConfiguration",
"deprecated-in": "v1.16.0",
"removed-in": "v1.19.0",
"replacement-api": "admissionregistration.k8s.io/v1",
"component": "k8s"
},
"deprecated": true,
"removed": false
}
],
"target-versions": {
"cert-manager": "v0.15.1",
"istio": "v1.6.0",
"k8s": "v1.16.0"
}
}
# YAML
items:
- name: cert-manager/cert-manager-webhook
namespace: cert-manager
api:
version: admissionregistration.k8s.io/v1beta1
kind: MutatingWebhookConfiguration
deprecated-in: v1.16.0
removed-in: v1.19.0
replacement-api: admissionregistration.k8s.io/v1
component: k8s
deprecated: true
removed: false
target-versions:
cert-manager: v0.15.1
istio: v1.6.0
k8s: v1.16.0
# Custom columns
$ pluto detect-helm -ocustom --columns NAMESPACE,NAME
NAME NAMESPACE
cert-manager/cert-manager-webhook cert-manager
NOTE: Any columns with spaces will need to be escaped or quoted, such as DEPRECATED\ IN or "DEPRECATED IN"
# Markdown
$ pluto detect-files -o markdown
| NAME | NAMESPACE | KIND | VERSION | REPLACEMENT | DEPRECATED | DEPRECATED IN | REMOVED | REMOVED IN |
|-----------|----------------|------------|--------------------|-------------|------------|---------------|---------|------------|
| utilities | <UNKNOWN> | Deployment | extensions/v1beta1 | apps/v1 | true | v1.9.0 | true | v1.16.0 |
| utilities | json-namespace | Deployment | extensions/v1beta1 | apps/v1 | true | v1.9.0 | true | v1.16.0 |
| utilities | yaml-namespace | Deployment | extensions/v1beta1 | apps/v1 | true | v1.9.0 | true | v1.16.0 |
$ pluto detect-files -o markdown --columns NAMESPACE,NAME,DEPRECATED IN,DEPRECATED,REPLACEMENT,VERSION,KIND,COMPONENT,FILEPATH
| NAME | NAMESPACE | KIND | VERSION | REPLACEMENT | DEPRECATED | DEPRECATED IN | COMPONENT | FILEPATH |
|---------------|-----------------|------------|--------------------|-------------|------------|---------------|-----------|--------------|
| some name one | pluto-namespace | Deployment | extensions/v1beta1 | apps/v1 | true | v1.9.0 | foo | path-to-file |
| some name two | <UNKNOWN> | Deployment | extensions/v1beta1 | apps/v1 | true | v1.9.0 | foo | <UNKNOWN> |
# CSV
$ pluto detect-helm -o csv
NAME,NAMESPACE,KIND,VERSION,REPLACEMENT,DEPRECATED,DEPRECATED IN,REMOVED,REMOVED IN
deploy1,pluto-namespace,Deployment,extensions/v1beta1,apps/v1,true,v1.9.0,true,v1.16.0
deploy1,other-namespace,Deployment,extensions/v1beta1,apps/v1,true,v1.9.0,true,v1.16.0
$ pluto detect-helm -o csv --columns "KIND,NAMESPACE,NAME,VERSION,REPLACEMENT"
KIND,NAMESPACE,NAME,VERSION,REPLACEMENT
Deployment,pluto-namespace,deploy1,extensions/v1beta1,apps/v1
Deployment,other-namespace,deploy1,extensions/v1beta1,apps/v1
# CI Pipelines
Pluto has specific exit codes that is uses to indicate certain results:
- Exit Code 1 - An error. A message will be displayed
- Exit Code 2 - A deprecated apiVersion has been found.
- Exit Code 3 - A removed apiVersion has been found.
- Exit Code 4 - A replacement apiVersion is unavailable in the target version
If you wish to bypass the generation of exit codes 2 and 3, you may do so with two different flags:
--ignore-deprecations Ignore the default behavior to exit 2 if deprecated apiVersions are found.
--ignore-removals Ignore the default behavior to exit 3 if removed apiVersions are found.
--ignore-unavailable-replacements Ignore the default behavior to exit 4 if deprecated but unavailable apiVersions are found.
# Target Versions
Pluto was originally designed with deprecations related to Kubernetes v1.16.0. As more deprecations are introduced, we will try to keep it updated. Community contributions are welcome in this area.
Currently, Pluto defaults to a targetVersion of v1.22.0, however this is configurable (please continue reading)
You can target the version you are concerned with by using the --target-versions or -t flag. You must pass the component=version, and the version must begin with a v (this is a limitation of the semver library we are using to verify).
For example:
$ pluto detect-helm --target-versions k8s=v1.15.0
No output to display
$ echo $?
0
Notice that there is no output, despite the fact that we might have recognized apiVersions present in the cluster that are not yet deprecated or removed in v1.15.0. This particular run exited 0.
# Components
By default Pluto will scan for all components in the versionsList that it can find. If you wish to only see deprecations for a specific component, you can use the --components flag to specify a list.
# Only Show Removed
If you are targeting an upgrade, you may only wish to see apiVersions that have been removed rather than both deprecated and removed. You can pass the --only-show-removed or -r flag for this. It will remove any detections that are deprecated, but not yet removed. This will affect the exit code of the command as well as the json and yaml output.
# Adding Custom Version Checks
If you want to check additional apiVersions and/or types, you can pass an additional file with the --additional-versions or -f flag.
The file should look something like this:
target-versions:
custom: v1.0.0
deprecated-versions:
- version: someother/v1beta1
kind: AnotherCRD
deprecated-in: v1.9.0
removed-in: v1.16.0
replacement-api: apps/v1
component: custom
You can test that it's working by using list-versions:
$ pluto list-versions -f new.yaml
KIND NAME DEPRECATED IN REMOVED IN REPLACEMENT COMPONENT
AnotherCRD someother/v1beta1 v1.9.0 v1.16.0 apps/v1 custom
NOTE: This output is truncated to show only the additional version. Normally this will include the defaults as well
The target-versions field in this custom file will set the default target version for that component. You can still override this with --target-versions custom=vX.X.X when you run Pluto.
Please note that we do not allow overriding anything contained in the default versions.yaml that Pluto uses.
# Kube Context or kubeconfig
When doing helm or apiVersion detection, you may want to use the --kube-context or --kubeconfig flags to specify a particular context, or a specific file path, that you wish to use for your kubeconfig.
# Environment Variables
For easier use, you can specify flags by using environment variables.
# Precedence
When you run a command with a flag, the command line option takes precedence over the environment variable.
# Supported Environment Variables
All environment variables are prefixed with PLUTO and use _ instead of -.
| Flag | ENV variable |
|---|---|
| --ignore-deprecations | PLUTO_IGNORE_DEPRECATIONS |
| --ignore-removals | PLUTO_IGNORE_REMOVALS |
| --target-versions | PLUTO_TARGET_VERSIONS |
| --only-show-removed | PLUTO_ONLY_SHOW_REMOVED |
| --additional-versions | PLUTO_ADDITIONAL_VERSIONS |
| --output | PLUTO_OUTPUT |
| --columns | PLUTO_COLUMNS |
| --components | PLUTO_COMPONENTS |
| --no-headers | PLUTO_NO_HEADERS |
| --no-footer | PLUTO_NO_FOOTER |
← Quickstart FAQ →