kubecost / kubectl-cost

CLI for determining the cost of Kubernetes workloads
Apache License 2.0
913 stars 60 forks source link

Add long explanation, with install instructions #103

Closed michaelmdresser closed 2 years ago

michaelmdresser commented 2 years ago

What does this PR change?

It was sometimes unclear that Kubecost has to be installed in the target cluster for kubectl-cost to function. This commit adds two things to kubectl cost help:

Does this PR rely on any other PRs?

N/A

How does this PR impact users? (This is the kind of thing that goes in release notes!)

Improved help information (with Kubecost install instructions) when running kubectl cost help

Links to Issues or ZD tickets this PR addresses or fixes

How was this PR tested?

Locally by running kubectl cost help and checking the output!

Have you made an update to documentation?

N/A

gitguardian[bot] commented 2 years ago

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
| GitGuardian id | Secret | Commit | Filename | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [3359586](https://dashboard.gitguardian.com/incidents/3359586?occurrence=35673363) | Generic High Entropy Secret | a183c1c42ff6fe6bf09258951129edc69f002441 | pkg/cmd/cost.go | [View secret](https://github.com/kubecost/kubectl-cost/commit/a183c1c42ff6fe6bf09258951129edc69f002441#diff-d20a80ae6635f0743cf4e8b5441852835bb1333179c374b6a590af9df015233cR125) |
🛠 Guidelines to remediate hardcoded secrets
1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secret safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate this secret](https://docs.gitguardian.com/secrets-detection/detectors/generics/generic_high_entropy_secret#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/internal-repositories-monitoring/integrations/git_hooks/pre_commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!