Skip to content

Commit

Permalink
Merge pull request #4 from FairwindsOps/rb/logo
Browse files Browse the repository at this point in the history
Add logo, adjust readme
  • Loading branch information
rbren authored Jul 24, 2020
2 parents 810a0ef + ab4c89f commit 45459f9
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 23 deletions.
68 changes: 46 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,64 @@
# Nova
Find outdated or deprecated Helm charts running in your cluster.
<div align="center">
<img src="/img/logo.png" alt="Nova" />
<br>

# Installation
<b>Find outdated or deprecated Helm charts running in your cluster.</b>

## From GitHub Releases
[![Version][version-image]][version-link] [![CircleCI][circleci-image]][circleci-link] [![Go Report Card][goreport-image]][goreport-link]
</div>

[version-image]: https://img.shields.io/static/v1.svg?label=Version&message=1.0.0&color=239922
[version-link]: https://github.com/FairwindsOps/nova

[goreport-image]: https://goreportcard.com/badge/github.com/FairwindsOps/nova
[goreport-link]: https://goreportcard.com/report/github.com/FairwindsOps/nova

[circleci-image]: https://circleci.com/gh/FairwindsOps/nova.svg?style=svg
[circleci-link]: https://circleci.com/gh/FairwindsOps/nova.svg


Nova scans your cluster for installed Helm charts, then cross-checks them against
all known Helm repositories. If it finds an updated version of the chart you're using,
or notices your current version is deprecated, it will let you know.

## Installation

### From GitHub Releases
Visit the [releases page](https://github.com/FairwindsOps/nova/releases) to find the release
that's right for your environment. For example, on Linux:
```
curl -L "https://github.com/FairwindsOps/nova/releases/download/1.1.0/nova_1.1.0_linux_amd64.tar.gz" > nova.tar.gz
curl -L "https://github.com/FairwindsOps/nova/releases/download/1.0.0/nova_1.0.0_linux_amd64.tar.gz" > nova.tar.gz
tar -xvf nova.tar.gz
sudo mv nova /usr/local/bin/
```

## Homebrew
### Homebrew
```
brew tap fairwindsops/tap
brew install fairwindsops/tap/nova
```

## From source
### From source
```
go get https://github.com/fairwindsops/nova
```

# Usage
## Usage

```
nova find
nova find --helm-version=auto --wide
```

## Options
### Options
* `--helm-version` - which version of Helm to use. Options are `2`, `3`, and `auto` (default is `3`)
* `--wide` - show `Chart Name` and `Namespace`
* `--output-file` - output JSON to a file

# Output
### Output
Below is sample output for Nova

## CLI
```
#### CLI
```bash
Release Name Installed Latest Old Deprecated
cert-manager v0.11.0 v0.15.2 true false
insights-agent 0.21.0 0.21.1 true false
Expand All @@ -47,24 +67,28 @@ metrics-server 2.8.8 2.11.1 true false
nginx-ingress 1.25.0 1.40.3 true false
```

## JSON
```
#### JSON
```json
{
"helm_releases": [
"helm": [
{
"release": "cert-manager",
"chartName": "cert-manager",
"namespace": "cert-manager",
"description": "A Helm chart for cert-manager",
"home": "https://github.com/jetstack/cert-manager",
"icon": "https://raw.githubusercontent.com/jetstack/cert-manager/master/logo/logo.png",
"version": "v0.11.0",
"appVersion": "v0.11.0",
"newest": "v0.15.2",
"newest_appVersion": "v0.15.2",
"outdated": true
"Installed": {
"version": "v0.11.0",
"appVersion": "v0.11.0"
},
"Latest": {
"version": "v0.16.0",
"appVersion": "v0.16.0"
},
"outdated": true,
"deprecated": false
}
]
}
```

Binary file added img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pkg/output/output.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ type ReleaseOutput struct {
ChartName string `json:"chartName"`
Namespace string `json:"namespace,omitempty"`
Description string `json:"description"`
Deprecated bool `json:"deprecated,omitempty"`
Home string `json:"home,omitempty"`
Icon string `json:"icon,omitempty"`
Installed VersionInfo
Latest VersionInfo
IsOld bool `json:"outdated"`
Deprecated bool `json:"deprecated"`
}

// VersionInfo contains both a chart version and an app version
Expand Down

0 comments on commit 45459f9

Please sign in to comment.