Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mateimicu/kdiscover

Discover all K8s clusters on AWS, Google, etc ..
https://github.com/mateimicu/kdiscover

aks cli eks gke golang kubeconfig kubeconfig-manager kubernetes

Last synced: 2 months ago
JSON representation

Discover all K8s clusters on AWS, Google, etc ..

Host: GitHub
URL: https://github.com/mateimicu/kdiscover
Owner: mateimicu
License: mit
Created: 2020-03-22T17:08:49.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-05-07T20:59:39.000Z (8 months ago)
Last Synced: 2024-10-15T23:11:09.039Z (3 months ago)
Topics: aks, cli, eks, gke, golang, kubeconfig, kubeconfig-manager, kubernetes
Language: Go
Homepage:
Size: 1.3 MB
Stars: 9
Watchers: 3
Forks: 2
Open Issues: 16
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# kdiscover
[![CI](https://github.com/mateimicu/kdiscover/actions/workflows/golang-ci.yaml/badge.svg?branch=master)](https://github.com/mateimicu/kdiscover/actions/workflows/golang-ci.yaml)
![CodeQL](https://github.com/mateimicu/kdiscover/workflows/CodeQL/badge.svg)
[![codecov](https://codecov.io/gh/mateimicu/kdiscover/branch/master/graph/badge.svg)](https://codecov.io/gh/mateimicu/kdiscover)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/mateimicu/kdiscover?sort=semver)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/mateimicu/kdiscover)
![GitHub](https://img.shields.io/github/license/mateimicu/kdiscover)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmateimicu%2Fkdiscover.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmateimicu%2Fkdiscover?ref=badge_shield)
[![Go Report Card](https://goreportcard.com/badge/github.com/mateimicu/kdiscover)](https://goreportcard.com/report/github.com/mateimicu/kdiscover)

Kdiscover is a simple utility to list and configure access to all clusters it can find.
The basic usecase revolves in having access to a lot of clusters but you still need to discover and export apposite kubeconfig.

Currently we suport only EKS clusters but there are plans to support othe k8s providers (GKE, AKE, etc ...)

- [kdiscover](#kdiscover)
- [Example](#example)
- [Demo](#demo)
- [Install](#install)
- [Krew (Recommended)](#krew-recommended)
- [MacOs](#macos)
- [Binary](#binary)
- [Go](#go)
- [Future Plans](#future-plans)
- [FAQ](docs/FAQ.md)

## Example

```bash
~ $ kubectl discover aws list
┌────────────────────────────────────────────────────────────────────────────────┐
│ cluster name region status exported locally │
├────────────────────────────────────────────────────────────────────────────────┤
│ 1 production-us us-east-1 ACTIVE No │
│ 2 production-eu eu-west-1 ACTIVE No │
│ 3 dev-eu eu-central-1 ACTIVE No │
│ 4 sandbox-eu eu-central-1 ACTIVE No │
├────────────────────────────────────────────────────────────────────────────────┤
│ number of clusters 4 │
└────────────────────────────────────────────────────────────────────────────────┘
~ $ kubectl discover aws update
Update all EKS Clusters
Found 4 clusters remote
Backup kubeconfig to /Users/tuxy/.kube/config.bak
~ $ kubectl discover aws list
┌────────────────────────────────────────────────────────────────────────────────┐
│ cluster name region status exported locally │
├────────────────────────────────────────────────────────────────────────────────┤
│ 1 production-us us-east-1 ACTIVE Yes │
│ 2 production-eu eu-west-1 ACTIVE Yes │
│ 3 dev-eu eu-central-1 ACTIVE Yes │
│ 4 sandbox-eu eu-central-1 ACTIVE Yes │
├────────────────────────────────────────────────────────────────────────────────┤
│ number of clusters 4 │
└────────────────────────────────────────────────────────────────────────────────┘
```

Columns in the list :

- `cluster name` is the name of the cluster based on the configuration
- `region` region where the cluster is deployed (it is cloud specific)
- `status` this is reported by the cloud, if the cluster is up or in another state (modifying, down, creating ... etc)
- `exported locally` uses an heuristic too see if the local config already has information about this cluster

## Install

## Krew (Recommended)

Using the [Krew](https://krew.sigs.k8s.io/) plugin manager:

```bash
kubectl krew install discover
```
Note that in this context the command will need to invoked using `kubectl discover`.

## macOs

You can also install a binary release on macOS using [brew](https://brew.sh/):

```bash
brew install mateimicu/tap/kdiscover
brew upgrade mateimicu/tap/kdiscover
```
Note that in this context the executable is name `kdiscover`.

## Binary

You can download a specific version from the [release page](https://github.com/mateimicu/kdiscover/releases)

## Go

```bash
GO111MODULE=on go get github.com/mateimicu/kdiscover
```

# Future Plans

Development is tracked in [this board](https://github.com/mateimicu/kdiscover/projects/1) and we also have specific [milestones](https://github.com/mateimicu/kdiscover/milestones?direction=asc&sort=due_date)

## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmateimicu%2Fkdiscover.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmateimicu%2Fkdiscover?ref=badge_large)