Skip to content

Latest commit

 

History

History
145 lines (99 loc) · 7.31 KB

CONTRIBUTING.md

File metadata and controls

145 lines (99 loc) · 7.31 KB
Raw

Contributing to Troubleshoot

Thank you for your interest in Troubleshoot, we welcome your participation. Please familiarize yourself with our Code of Conduct prior to contributing. There are a number of ways to participate in Troubleshoot as outlined below:

Community

For discussions about developing Troubleshoot, there's an #app-troubleshoot channel in Kubernetes Slack, plus IRC using Libera (#troubleshoot).

There are community meetings on a regular basis, with a shared calendar and public notes

Issues

  • Request a New Feature Create an issue to add functionality that addresses a problem or adds an enhancement.
  • Report a Bug Report a problem or unexpected behaviour with Troubleshoot.

Design Principles

When implementing a new feature please review the design principles to help guide the approach.

Development Environment

To get started we recommend:

  1. Go (v1.20 or later)
  2. A Kubernetes cluster (we recommend https://k3d.io/. This requires Docker v20.10.5 or later)
  3. Fork and clone repo
  4. Run make clean build to generate binaries
  5. Run make run-support-bundle to generate a support bundle with the sample-troubleshoot.yaml in the root of the repo

Note: recent versions of Go support easy cross-compilation. For example, to cross-compile a Linux binary from MacOS: GOOS=linux GOARCH=amd64 make clean build

  1. Install [golangci-lint] linter and run make lint to execute additional code linters.

Build automatically on save with watch

  1. Install npm
  2. Run make watch to build binaries automatically on saving. Note: you may still have to run make schemas if you've added API changes, like a new collector or analyzer type.

Syncing to a test cluster with watchrsync

  1. Install npm
  2. Export REMOTES=<user>@<ip> so that watchrsync knows where to sync.
  3. Maybe run export GOOS=linux and export GOARCH=amd64 so that you build Linux binaries.
  4. run make watchrsync to build and sync binaries automatically on saving.
ssh-add --apple-use-keychain ~/.ssh/google_compute_engine
export [email protected]
export GOOS=linux
export GOARCH=amd64
make watchrsync
# bin/watchrsync.js
# make support-bundle
# go build -tags "netgo containers_image_ostree_stub exclude_graphdriver_devicemapper exclude_graphdriver_btrfs containers_image_openpgp" -installsuffix netgo -ldflags " -s -w -X github.com/replicatedhq/troubleshoot/pkg/version.version=`git describe --tags --dirty` -X github.com/replicatedhq/troubleshoot/pkg/version.gitSHA=`git rev-parse HEAD` -X github.com/replicatedhq/troubleshoot/pkg/version.buildTime=`date -u +"%Y-%m-%dT%H:%M:%SZ"` " -o bin/support-bundle github.com/replicatedhq/troubleshoot/cmd/troubleshoot
# rsync bin/support-bundle [email protected]:
# date
# Tue May 16 14:14:13 EDT 2023
# synced

Testing

To run the tests locally run the following:

make test
make test RUN=TestClusterResources_Merge

Additionally, e2e tests can be run with:

make support-bundle preflight e2e-test

A running Kubernetes cluster as well as jq are required to run e2e tests.

Profiling

You are able to collect CPU & memory runtime properties and store the data for analysis in a file. To do so, pass in the file paths using --cpuprofile and --memprofile flags in the CLI. Once you have your data collected, you can analyse it using pprof visualization tool. Here is how

Run support bundle and with CPU & memory profile flags

./bin/support-bundle examples/support-bundle/sample-supportbundle.yaml --cpuprofile=cpu.prof --memprofile=mem.prof

Visualize using pprof

go tool pprof -http=":8000" cpu.prof

go tool pprof -http=":8001" mem.prof

Additional flags for memory profiling

  • inuse_space: Amount of memory allocated and not released yet (default).
  • inuse_objects: Amount of objects allocated and not released yet.
  • alloc_space: Total amount of memory allocated (regardless of released).
  • alloc_objects: Total amount of objects allocated (regardless of released).

More on profiling please visit https://go.dev/doc/diagnostics#profiling

Contribution workflow

This is a rough outline of how to prepare a contribution:

  • Create a fork of this repo.

  • Create a topic branch from where you want to base your work (branched from main is a safe choice).

  • Make commits of logical units.

  • When your changes are ready to merge, squash your history to 1 commit.

    • For example, if you want to squash your last 3 commits and write a new commit message:

      git reset --soft HEAD~3 &&
git commit

    • If you want to keep the previous commit messages and concatenate them all into a new commit, you can do something like this instead:

      git reset --soft HEAD~3 &&
git commit --edit -m"$(git log --format=%B --reverse HEAD..HEAD@{1})"

  • Push your changes to a topic branch in your fork of the repository.

  • Submit a pull request to the original repository. It will be reviewed in a timely manner.

Pull Requests

A pull request should address a single issue, feature or bug. For example, lets say you've written code that fixes two issues. That's great! However, you should submit two small pull requests, one for each issue as opposed to combining them into a single larger pull request. In general the size of the pull request should be kept small in order to make it easy for a reviewer to understand, and to minimize risks from integrating many changes at the same time. For example, if you are working on a large feature you should break it into several smaller PRs by implementing the feature as changes to several packages and submitting a separate pull request for each one. Squash commit history when preparing your PR so it merges as 1 commit.

Code submitted in pull requests must be properly documented, formatted and tested in order to be approved and merged. The following guidelines describe the things a reviewer will look for when they evaluate your pull request. Here's a tip. If your reviewer doesn't understand what the code is doing, they won't approve the pull request. Strive to make code clear and well documented. If possible, request a reviewer that has some context on the PR.

Commit messages

Commit messages should follow the general guidelines:

  • Breaking changes should be highlighted in the heading of the commit message.
  • Commits should be clear about their purpose (and a single commit per thing that changed)
  • Messages should be descriptive:
    • First line, 50 chars or less, as a heading/title that people can find
    • Then a paragraph explaining things
  • Consider a footer with links to which bugs they fix etc, bearing in mind that Github does some of this magic already