Skip to content

chore: OSS readiness cleanup#32

Merged
blue4209211 merged 2 commits into
masterfrom
chore/oss-readiness-cleanup
May 19, 2026
Merged

chore: OSS readiness cleanup#32
blue4209211 merged 2 commits into
masterfrom
chore/oss-readiness-cleanup

Conversation

@mayankpande88
Copy link
Copy Markdown
Contributor

Summary

Acts on the readiness-review findings (everything except the Go module rename, which is deliberately deferred, and the /opt/bitnami container path, which is a runtime change worth its own PR).

  • README install: replace go install github.com/bitnami-labs/kubewatch@latest with git clone + make build (the install command otherwise pulls from upstream, since the module path still points at bitnami-labs).
  • Delete docs/CONTRIBUTION.md — stale upstream guide that still links to bitnami-labs/kubewatch/issues; canonical doc lives at CONTRIBUTING.md.
  • Delete kubewatch-in-cluster.yaml — byte-for-byte duplicate of kubewatch.yaml, not referenced by README.
  • .gitignore: add .DS_Store, *.test, *.out, coverage.*.
  • Align Go version to 1.26.3 across go.mod, README.md, CONTRIBUTING.md (Dockerfile is already on 1.26.3 for the stdlib CVE patches).
  • Move pull_request_template.md.github/pull_request_template.md (GitHub's canonical location).
  • Broaden kubewatch-service-account.yaml RBAC: previously only pods + replicationcontrollers, but the tool watches ~18 resource kinds. Now covers core, apps, batch, networking.k8s.io, rbac, and argoproj.io.
  • Remove stray double-quote in pkg/handlers/slackwebhook/slackwebhook.go header comment.

Module rename (bitnami-labsnudgebee) and /opt/bitnami container path are explicitly not in this PR.

Tests performed

  • go build ./...
  • go test ./... (all packages pass)
  • Verified deleted files have no remaining inbound references

- README install: replace `go install bitnami-labs/...` with `git clone + make build`
  (the module path still points at the upstream repo; the rename is deferred)
- Delete docs/CONTRIBUTION.md (stale upstream guide, superseded by root CONTRIBUTING.md)
- Delete kubewatch-in-cluster.yaml (byte-for-byte duplicate of kubewatch.yaml)
- .gitignore: add .DS_Store, *.test, *.out, coverage.*
- Align Go version to 1.26.3 across go.mod, README, CONTRIBUTING (matches Dockerfile)
- Move pull_request_template.md to .github/pull_request_template.md (GitHub canonical path)
- Broaden kubewatch-service-account.yaml RBAC to cover all watchable resource kinds
  (apps, batch, networking, rbac, argoproj — previously only pods + rcs)
- Remove stray double-quote in slackwebhook.go header comment
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the project to Go 1.26.3 across the configuration and documentation, refines the .gitignore file, and updates the README to favor building from source. It also significantly expands the RBAC permissions in kubewatch-service-account.yaml to monitor a wider range of Kubernetes resources and API groups. Review feedback identifies a high-security risk regarding the broad access granted to secrets and suggests adding sudo to the installation instructions to prevent permission errors.

Comment thread kubewatch-service-account.yaml Outdated
Comment thread README.md Outdated
- kubewatch-service-account.yaml: drop `secrets` from the default ClusterRole.
  Cluster-wide read on secrets is a high privilege and should be opt-in for
  users who actually enable the `secret` watch flag. Added an explanatory
  comment block at the top of the file.
- README.md: prepend `sudo` to the `install -m 0755 ... /usr/local/bin`
  command (typically requires root).
@blue4209211 blue4209211 merged commit c5c317e into master May 19, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants