kube-ez - GitLite

KO | EN

gitlite — search

#python #typescript #llm #go #deep-learning #linux #docker #macos #java #windows #awesome #vue #pytorch #openai

kube-ez

(★ 73)

This is a simple k8s-api project. It is built on Golang and utilises the client-go library to interact with Kubernetes Cluster. It is a plug and play solution and can be used to create a k8s-api server.

파일 탐색기

최종 버전 다운로드 (.zip)

- devcontainer.json
- - build-go-binary.yml
  - build-go-modules.yml
  - don't_mess_with_my_docs
  - greetings.yml
  - label.yml
  - main.yml
  - stale.yml
- api.go
- apply.go
- install.go
- crb.yaml
- one-to-rule-them-all.yaml
- pod.yaml
- sa.yaml
.gitignore
API_DOCS.md
CONTRIBUTING.md
Dockerfile
go.mod
go.sum
golang.jpeg
INSTALL.md
LICENSE
README.md
server.go

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/kitarp29/kube-ez

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd kube-ez

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.

It's a pet project to learn *Kubernetes* and *Golang*. I wanted to build this to better understand these two technologies. I also explored *Docker*

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Go

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Go Go 언어 컴파일러 및 도구 모음입니다.

go build ./...

Go 프로그램을 컴파일해 실행 파일을 만듭니다.

go run .

따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.

✅ 빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# **Kube-ez**
[![GitHub contributors](https://img.shields.io/github/contributors/kitarp29/kube-ez)](https://github.com/kitarp29/kube-ez/graphs/contributors) [![GitHub issues](https://img.shields.io/github/issues/HAC-2020/Aimers)](https://github.com/kitarp29/kube-ez/issues/) 
[![Docker](https://img.shields.io/docker/pulls/kitarp29/k8s-api)](https://hub.docker.com/repository/docker/kitarp29/k8s-api)
[![Docker](https://img.shields.io/docker/stars/kitarp29/k8s-api)](https://hub.docker.com/repository/docker/kitarp29/k8s-api)
![Follow](https://img.shields.io/twitter/follow/kitarp29?label=Follow+Kitarp29&style=social)

<img src="golang.jpeg"></img>

#  <u>**Introduction**</u> 👋🏻

It is built on **Golang** and utilizes the **client-go** library to interact with Kubernetes Cluster.
It is a plug-and-play solution and can be used to create a kube-ez server. In three easy steps, you will have a simple API to interact with your cluster.
The aim is to build a simple API server that can be used to interact with any Kubernetes cluster.

In my industrial experience, I have realized that **Kubernetes** is a very powerful tool but, only used by a handful of developers in the organization. The problem is not grasping the concept of the cluster. My last Product Manager was much more versed in AWS than I am. 
I feel the reason is that there is no easier way to interact with it.
This project will provide a bunch of API endpoints to perform various functions on the cluster. For now, I will have the Postman collections and API docs to achieve it, plan is to build a Dashboard on the API later.

**Docker Image: [kitarp29/k8s-api](https://hub.docker.com/repository/docker/kitarp29/k8s-api)**
> Use the Docker image with tag 2.0 or above to run the kube-ez server.
<hr>

# <u>**Getting started**</u> ▶️

To start using the project you need a Kubernetes Cluster and should have the right access to apply changes to the cluster.
There are two ways to run this project.
  1. **Outside the Cluster**
  2. **Inside the Cluster**

Steps to run the project are mentioned in the [INSTALL.md](https://github.com/kitarp29/kube-ez/blob/main/INSTALL.md)

<hr>

#  <u>**Project Features**</u> 🤯
  -  Get details about any resource in the cluster.
  -  It *detects* if you are trying to run the project inside or outside of a cluster.
  -  Create new resources in the cluster.
  -  Delete resources in the cluster.
  -  Run CLI commands using the API.
  -  Manage Helm Charts.
  -  You can add, install, delete and update HELM charts.
  -  Get live events from the cluster.
  -  It is a REST API to interact with the cluster.
  -  It has a health check endpoint as well.
  -  More coming soon... 🚧

<hr>

#  <u>**API Docs**</u> 📖

There are multiple endpoints in the API. You can find all the endpoints in the [API Docs](https://github.com/kitarp29/kube-ez/blob/main/API_DOCS.md)

Moreover you can find the **Postman Collections** [Here](https://www.getpostman.com/collections/b14cdaad336ab81340b5) 📮

<hr>

# <u>**Contributors Guide**</u> 🥰
  
 Thanks for considering contributing to the project. If you have any questions, please feel free to contact me at [Twitter](https://twitter.com/kitarp29).
  The Contributors Guide is available [Here](https://github.com/kitarp29/kube-ez/blob/main/CONTRIBUTING.md) 📖

<hr>

# <u>**License**</u> 🍻

This project is licensed under the **MIT license**. Feel free to use it and if you want to contribute, please feel free to fork the project and make a pull request. Thanks!

<hr>

# <u>**FAQ**</u> 🤔

- **Is this a Unique Product?**
  
      No, this is not a unique product. There are similar implementations made by other developers.
  
  - **Purpose of this project?**

It's a pet project to learn *Kubernetes* and *Golang*. I wanted to build this to better understand these two technologies. I also explored *Docker*

### Thanks for your interest in my API :)
<hr>