From 3819ba9d630e283752ce46937ad7d0ae7fb909d4 Mon Sep 17 00:00:00 2001 From: Robert Brennan Date: Mon, 6 Jul 2020 19:54:24 +0000 Subject: [PATCH 1/5] add paperwork --- CHANGELOG.md | 2 + CODEOWNERs | 1 + CODE_OF_CONDUCT.md | 74 +++++++++++++++++ CONTRIBUTING.md | 59 +++++++++++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 35 ++++++++ 6 files changed, 372 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CODEOWNERs create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6a5d062 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +# x.x.x +* Migrated existing functionality from private repository diff --git a/CODEOWNERs b/CODEOWNERs new file mode 100644 index 0000000..99961b0 --- /dev/null +++ b/CODEOWNERs @@ -0,0 +1 @@ +* @kimschles @makoscafee @rbren diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..32a47d5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4191993 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Contributing + +Issues, whether bugs, tasks, or feature requests are essential for keeping our projects great. +We believe it should be as easy as possible to contribute changes that get things working in your environment. +There are a few guidelines that we need contributors to follow so that we can keep on top of things. + +## Code of Conduct + +This project adheres to a [code of conduct](CODE_OF_CONDUCT.md). Please review this document before contributing to this project. + +## Sign the CLA +Before you can contribute, you will need to sign the [Contributor License Agreement](https://cla-assistant.io/fairwindsops/nova). + +## Creating a New Issue + +If you've encountered an issue that is not already reported, please create a [new issue](https://github.com/FairwindsOps/polaris/issues), choose `Bug Report`, `Feature Request` or `Misc.` and follow the instructions in the template. + +## Getting Started + +We label issues with the ["good first issue" tag](https://github.com/FairwindsOps/nova/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, +please start a conversation on that issue, and we can help answer any questions as they come up. + +## Setting Up Your Development Environment +### Prerequisites +* A properly configured Golang environment with Go 1.11 or higher +* A Kubernetes cluster defined in `~/.kube/config` (or in a file specified by the `KUBECONFIG` env variable) + +### Installation +* Install the project with `go get github.com/fairwindsops/nova` +* Change into the polaris directory which is installed at `$GOPATH/src/github.com/fairwindsops/nova` +* See the results with `go run main.go find` + +## Running Tests + +The following commands are all required to pass as part of testing: + +``` +go list ./... | grep -v vendor | xargs golint -set_exit_status +go list ./... | grep -v vendor | xargs go vet +go test ./... +``` + +## Creating a Pull Request + +Each new pull request should: + +- Reference any related issues +- Add tests that show the issues have been solved +- Pass existing tests and linting +- Contain a clear indication of if they're ready for review or a work in progress +- Be up to date and/or rebased on the master branch + +## Creating a new release +Tagging a commit will build and push a new Docker image, add a binary to the +[releases page](https://github.com/FairwindsOps/nova/releases), and publish a new Homebrew binary. + +Be sure to add any notes to CHANGELOG.md + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6c9c097 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 FairwindsOps Inc + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 73be060..b1cc199 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,38 @@ Nova finds Helm charts in your Kubernetes cluster, and checks the upstream repos ``` nova find --output-file=releases.json ``` + +# Output +Below is sample output for Nova + +## CLI +``` +ReleaseName ChartName Namespace Version NewestVersion IsOld Deprecated +cert-manager cert-manager cert-manager v0.11.0 v0.15.2 True +insights-agent insights-agent insights-agent 0.21.0 0.21.0 +grafana grafana insights-tools-graf… 2.1.3 3.0.1 True +metrics-server metrics-server metrics-server 2.8.8 2.11.1 True +nginx-ingress nginx-ingress nginx-ingress 1.25.0 1.40.2 True +``` + +## JSON +``` +{ + "helm_releases": [ + { + "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 + } + ] +} +``` + From 706e6cca24d2fd515d42db975489ca41a8033566 Mon Sep 17 00:00:00 2001 From: Robert Brennan Date: Mon, 6 Jul 2020 19:57:28 +0000 Subject: [PATCH 2/5] fix polaris refs --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4191993..77d5f16 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ Before you can contribute, you will need to sign the [Contributor License Agreem ## Creating a New Issue -If you've encountered an issue that is not already reported, please create a [new issue](https://github.com/FairwindsOps/polaris/issues), choose `Bug Report`, `Feature Request` or `Misc.` and follow the instructions in the template. +If you've encountered an issue that is not already reported, please create a [new issue](https://github.com/FairwindsOps/nova/issues), choose `Bug Report`, `Feature Request` or `Misc.` and follow the instructions in the template. ## Getting Started @@ -28,7 +28,7 @@ please start a conversation on that issue, and we can help answer any questions ### Installation * Install the project with `go get github.com/fairwindsops/nova` -* Change into the polaris directory which is installed at `$GOPATH/src/github.com/fairwindsops/nova` +* Change into the Nova directory which is installed at `$GOPATH/src/github.com/fairwindsops/nova` * See the results with `go run main.go find` ## Running Tests From 8d96e3dbe7fe647e128a002cac7ce9eef0cf0472 Mon Sep 17 00:00:00 2001 From: Robert Brennan Date: Mon, 6 Jul 2020 20:26:37 +0000 Subject: [PATCH 3/5] add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 57 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++ .github/ISSUE_TEMPLATE/other.md | 10 ++++ 3 files changed, 87 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..316edf2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,57 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +--- +name: Bug report +about: Let us know about an unexpected error, a crash, or an incorrect behavior. + +--- +### Installation Process + + +### Nova Version + + +``` +... +``` + +### Expected Behavior + + +### Actual Behavior + + +### Steps to Reproduce + + +### Additional Context + + +### References + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md new file mode 100644 index 0000000..58e0dc6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.md @@ -0,0 +1,10 @@ +--- +name: Other +about: For misc. tasks like research or continued conversation +title: '' +labels: '' +assignees: '' + +--- + + From c74a632d8d9acbd9ca2a3531096e37aae0f46ec8 Mon Sep 17 00:00:00 2001 From: Robert Brennan Date: Mon, 6 Jul 2020 20:36:18 +0000 Subject: [PATCH 4/5] add installation instructions --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index b1cc199..046ef9c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,28 @@ Nova finds Helm charts in your Kubernetes cluster, and checks the upstream repository for any new releases. +# 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 +tar -xvf nova.tar.gz +sudo mv nova /usr/local/bin/ +``` + +## Homebrew +``` +brew tap fairwindsops/tap +brew install fairwindsops/tap/nova +``` + +## From source +``` +go get https://github.com/fairwindsops/nova +``` + # Usage ``` From cba590fc54cbb08ae6111e608fcc923db2b02273 Mon Sep 17 00:00:00 2001 From: Robert Brennan Date: Fri, 10 Jul 2020 13:15:12 +0000 Subject: [PATCH 5/5] add documentation --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 046ef9c..528d832 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Nova - -Nova finds Helm charts in your Kubernetes cluster, and checks the upstream repository for any new releases. +Find outdated or deprecated Helm charts running in your cluster. # Installation @@ -27,9 +26,13 @@ go get https://github.com/fairwindsops/nova # Usage ``` -nova find --output-file=releases.json +nova find ``` +## Options +* `--helm-version` - which version of Helm to use. Options are `2`, `3`, and `auto` (default is `3`) +* `--output-file` - output JSON to a file + # Output Below is sample output for Nova @@ -38,7 +41,7 @@ Below is sample output for Nova ReleaseName ChartName Namespace Version NewestVersion IsOld Deprecated cert-manager cert-manager cert-manager v0.11.0 v0.15.2 True insights-agent insights-agent insights-agent 0.21.0 0.21.0 -grafana grafana insights-tools-graf… 2.1.3 3.0.1 True +grafana grafana grafana-dashboard 2.1.3 3.0.1 True metrics-server metrics-server metrics-server 2.8.8 2.11.1 True nginx-ingress nginx-ingress nginx-ingress 1.25.0 1.40.2 True ```