Skip to content

Commit

Permalink
Removed usage from readme. It was annoying. Just expand quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Suderman committed Mar 26, 2020
1 parent 7816503 commit df1a0aa
Showing 1 changed file with 8 additions and 60 deletions.
68 changes: 8 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is a very simple utility to help users find deprecated Kubernetes apiVersio

Install the binary from our [releases](https://github.com/FairwindsOps/pluto/releases) page.

### File Detection
### File Detection in a Directory

Run `pluto detect-files -d <DIRECTORY YOU WANT TO SCAN>`

Expand All @@ -25,7 +25,7 @@ Deployment extensions/v1beta1 true pkg/finder/testdata/deployment-ex

This indicates that we have two files in our directory that have deprecated apiVersions. This will need to be fixed prior to a 1.16 upgrade.

### Helm Detection
### Helm Detection (in-cluster)

```
$ pluto detect-helm --helm-version 3
Expand All @@ -35,66 +35,14 @@ StatefulSet apps/v1beta1 true audit-dashboard-prod-rabbitmq-ha

This indicates that the StatefulSet audit-dashboard-prod-rabbitmq-ha was deployed with apps/v1beta1 which is deprecated in 1.16

## Usage
### Helm Chart Checking (local files)

```
A tool to detect Kubernetes apiVersions
Usage:
pluto [flags]
pluto [command]
Available Commands:
detect-files detect-files
detect-helm detect-helm
help Help about any command
version Prints the current version of the tool.
Flags:
--add_dir_header If true, adds the file directory to the header
--alsologtostderr log to standard error as well as files
-h, --help help for pluto
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
--log_dir string If non-empty, write log files in this directory
--log_file string If non-empty, use this log file
--log_file_max_size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
--logtostderr log to standard error instead of files (default true)
--master --kubeconfig (Deprecated: switch to --kubeconfig) The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.
--skip_headers If true, avoid header prefixes in the log messages
--skip_log_headers If true, avoid headers when opening log files
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level number for the log level verbosity
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
Use "pluto [command] --help" for more information about a command.
```
You can run `helm template <chart-dir> | pluto detect --show-non-deprecated -`

## Detect Files Options
This will output something like so:

```
Usage:
pluto detect-files [flags]
Flags:
-d, --directory string The directory to scan. If blank, defaults to current workding dir.
-h, --help help for detect-files
-o, --output string The output format to use. (tabular|json|yaml) (default "tabular")
--show-non-deprecated If enabled, will show files that have non-deprecated apiVersion. Only applies to tabular output.
```

## Detect Helm Options

NOTE: Only helm 3 is currently supported

```
Detect Kubernetes apiVersions in a helm release (in cluster)
Usage:
pluto detect-helm [flags]
Flags:
--helm-version string Helm version in current cluster (2|3) (default "3")
-h, --help help for detect-helm
--show-non-deprecated If enabled, will show files that have non-deprecated apiVersion. Only applies to tabular output.
KIND VERSION DEPRECATED RESOURCE NAME
Deployment apps/v1 false RELEASE-NAME-goldilocks-controller
Deployment apps/v1 false RELEASE-NAME-goldilocks-dashboard
```

0 comments on commit df1a0aa

Please sign in to comment.