Skip to content

Latest commit

 

History

History
176 lines (133 loc) · 4.81 KB

CONTRIBUTING.md

File metadata and controls

176 lines (133 loc) · 4.81 KB
Raw

Contributing

Setting up development environment

Fedora

Install required packages:

sudo dnf install git golang make podman

Check required go version in go.mod. If your distro version is too old, see Managing Go installations for info on installing the required version.

Install additional tools:

macOS

Install the require packages:

brew install git go make podman kubectl kind

To build container images or run tests using kind you need to start the podman machine:

podman machine init
podman machine start

Install additional tools:

Get the source

Fork the project in github and clone the source:

git clone https://github.com/{my-github-username}/kubectl-gather.git

Build

make

Installing

Install a symlink to kubectl-gather and kubectl_complete-gather in the PATH so kubectl and oc can find them.

ln -s $PWD/kubectl-gather ~/bin/
ln -s $PWD/kubectl_complete-gather ~/bin/
ln -s $PWD/kubectl_complete-gather ~/bin/oc_complete-gather

Creating test clusters

Create test clusters:

kind create cluster -n c1
kind create cluster -n c2

Note

kind adds "kind-" prefix to the cluster names

Testing local gather

Gather data from the kind clusters:

% kubectl gather --contexts kind-c1,kind-c2 -d gather.local
2024-09-04T02:05:12.146+0300	INFO	gather	Using kubeconfig "/Users/nsoffer/.kube/config"
2024-09-04T02:05:12.148+0300	INFO	gather	Gathering from all namespaces
2024-09-04T02:05:12.148+0300	INFO	gather	Using all addons
2024-09-04T02:05:12.148+0300	INFO	gather	Gathering from cluster "kind-c1"
2024-09-04T02:05:12.148+0300	INFO	gather	Gathering from cluster "kind-c2"
2024-09-04T02:05:12.288+0300	INFO	gather	Gathered 324 resources from cluster "kind-c1" in 0.140 seconds
2024-09-04T02:05:12.288+0300	INFO	gather	Gathered 339 resources from cluster "kind-c2" in 0.140 seconds
2024-09-04T02:05:12.288+0300	INFO	gather	Gathered 663 resources from 2 clusters in 0.140 seconds

Inspecting gathered data:

% tree -L2 gather.local
gather.local
├── gather.log
├── kind-c1
│   ├── cluster
│   └── namespaces
└── kind-c2
    ├── cluster
    └── namespaces

Build and push a container image

Build and push a multi-arch container image to your private quay.io repo:

make container REPO=my-quay-user
make container-push

Important

  • Make your repo public to used it for gathering.

Testing remote gather

Gather data data remotely using your new image:

% kubectl gather --contexts kind-c1,kind-c2 --remote -d gather.remote
2024-09-04T02:45:26.051+0300	INFO	gather	Using kubeconfig "/Users/nsoffer/.kube/config"
2024-09-04T02:45:26.051+0300	INFO	gather	Gathering from all namespaces
2024-09-04T02:45:26.051+0300	INFO	gather	Using all addons
2024-09-04T02:45:26.051+0300	INFO	gather	Gathering on remote cluster "kind-c2"
2024-09-04T02:45:26.052+0300	INFO	gather	Gathering on remote cluster "kind-c1"
2024-09-04T02:45:36.435+0300	INFO	gather	Gathered on remote cluster "kind-c2" in 10.383 seconds
2024-09-04T02:45:36.437+0300	INFO	gather	Gathered on remote cluster "kind-c1" in 10.385 seconds
2024-09-04T02:45:36.437+0300	INFO	gather	Gathered 2 clusters in 10.385 seconds

Inspecting gathered data:

% tree -L3 gather.remote
gather.remote
├── gather.log
├── kind-c1
│   ├── event-filter.html
│   ├── must-gather.log
│   ├── must-gather.logs
│   ├── quay-io-nirsof-gather-sha256-aa5b3469396e5fc9217a4ffb2cc88465c4dedb311aef072bc1556b2a34f1339c
│   │   ├── cluster
│   │   ├── gather.log
│   │   ├── gather.logs
│   │   ├── namespaces
│   │   └── version
│   └── timestamp
└── kind-c2
    ├── event-filter.html
    ├── must-gather.log
    ├── must-gather.logs
    ├── quay-io-nirsof-gather-sha256-aa5b3469396e5fc9217a4ffb2cc88465c4dedb311aef072bc1556b2a34f1339c
    │   ├── cluster
    │   ├── gather.log
    │   ├── gather.logs
    │   ├── namespaces
    │   └── version
    └── timestamp

Sending pull requests

Pull requests can be submitted to https://github.com/nirs/kubectl-gather/pulls.

Tips:

  • Keep pull requests small
  • Each commit should have one logical change
  • Before sending a pull request rebase on upstream main branch.
  • Test your changes with local and remote clusters