Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leejones/kubectl-nearby
List Kubernetes pods that are running on the same node or nodes running in the same zone.
https://github.com/leejones/kubectl-nearby
kubectl kubectl-plugins kubernetes
Last synced: about 1 month ago
JSON representation
List Kubernetes pods that are running on the same node or nodes running in the same zone.
- Host: GitHub
- URL: https://github.com/leejones/kubectl-nearby
- Owner: leejones
- License: mit
- Created: 2021-04-25T19:51:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T12:47:38.000Z (8 months ago)
- Last Synced: 2024-06-20T22:37:22.262Z (7 months ago)
- Topics: kubectl, kubectl-plugins, kubernetes
- Language: Go
- Homepage:
- Size: 140 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# kubectl nearby
A kubectl plugin that lists:
* pods on the same node as a given pod
* nodes in the same zone as a given node
## Installation
1. Download the latest version from the [Releases](https://github.com/leejones/kubectl-nearby/releases) page.
2. Place the `kubectl-nearby` binary in a directory that's included in your `$PATH`. For example: `/usr/local/bin`.
## Usage
### Nearby Pods
To list pods on the same node as a given pod:
```
kubectl nearby pods POD_NAME [OPTIONS]
```
By default, the output only shows pods from the same namespace as the given pod.
Options:
* `--namespace NAMESPACE` - The namespace for the given pod.
* `--all-namespaces` - The output will include pods from all namespaces on the same node as the given pod.
* `--kubeconfig` - The location of the kubeconfig file if it's not in a standard location.
### Nearby Nodes
To list nodes in the same zone as a given node:
```
kubectl nearby nodes NODE_NAME [OPTIONS]
```
kubectl-nearby uses the `topology.kubernetes.io/zone` label value to determine a node's zone.
Options:
* `--kubeconfig` - The location of the kubeconfig file if it's not in a standard location.
## Creating a new release
This is the standard release process for maintainers.
1. Go to the [Releases](https://github.com/leejones/kubectl-nearby/releases) page
1. Note the most recent release version
1. Locally, checkout the `main` branch to the latest revision
1. Run `bin/release VERSION` where version is in the form `vX.Y.Z` and is the next logical semantic version based on the changes
1. Go to the [Tags](https://github.com/leejones/kubectl-nearby/tags) page
1. Find the tag named after the version you just created
1. Click **...** and click **Create release**
1. Release title format: `Release vX.Y.Z`
2. Description: Note relevant changes and link to the PR(s).
3. Attach the `.tar.gz` files from your local `releases/vX.Y.Z` directory.