Skip to content
@kli8nt

Kli8nt

End-of-second-year Project @ INSAT
readme.md

Our end-of-second-year project at INSAT codenamed Kli8nt, is a revolutionary platform that streamlines the process of deploying applications and databases on Kubernetes clusters. Our user-friendly interface allows users to authenticate to GitHub, select a repository, specify the stack, run and build commands, and deploy with ease.

Our backend server, written in Go, leverages the GitHub deployment API to clone repositories, use templates for stacks, add environment variables, and build and push images to our private container registry. We've also developed a custom Kubernetes operator that manages custom resource definitions (CRDs), automating application and database deployment and exposing them using Kubernetes services, with ingress rules behind the Nginx ingress operator.

To ensure seamless communication between the backend and Kubernetes, we use Redis as our messaging system. Additionally, we've integrated Cloudflare API to generate user subdomains on kli8nt.xyz when deployment is complete. We monitor the infrastructure with Prometheus and Grafana.

We use Google Cloud's Kubernetes Engine, Compute Engine for backend, and App Engine for the React TypeScript frontend. Our production deployment environment generates a webhook for future pushes (to trigger our backend) and displays the deployment URL upon success.

Plan:

Roadmap:

  • We will need to make a custom K8s controller/operator based on Client-go
  • Integrate Redis into the backend for communications with Kubernetes Cluster.
  • Implement logging, alerting, and monitoring using Prometheus.
  • Allocate sub-domains using Cloudflare API and configure Nginx ingress controllers for load balancing and routing web traffic to MSAs.
  • Establish a CLI utility as well as a frontend interface for communications with end-user.

More specifics will be added as we go through the project!

This is the start of the TODO as usual, but we're currently in the research phase!

  • Placeholder - not yet done

  • Placeholder - done!

  • Accessing end-user repos including private and the auth token in order to clone private repos git clone https://oauth2:ghp_...Gnm61dm4rh@github.com/gituser/testrepo.git

  • Showing the production environment on the end user github repo just like github pages and vercel

  • Making a front end interface to interact with the github-oauth2 backend

Follow up if you are interested! We'll be happy about it! Thanks!

Popular repositories

  1. .github .github Public

    TODO and info

    1

  2. backend backend Public

    Backend for Kli8nt, interacts with GitHub API through OAuth2.0, GitHub Deployment API, Git Hooks, Git Checks, and Kubernetes on GKE through REDIS. Builds container images using Crane. And keeps use…

    Go 1

  3. github-watcher github-watcher Public

    Watches for changes in repos saved in Postgres.

    1

  4. mq-example mq-example Public

    Go 1

  5. log-stream log-stream Public

    This repo contains an example of how we can stream a logs of a specific pod in Kubernetes through WebSocket

    Go 1

  6. dfile dfile Public

    Go 1

Repositories

Showing 10 of 13 repositories
  • go-log-streamer-controller Public
    Go 0 0 0 0 Updated Jun 1, 2023
  • backend Public

    Backend for Kli8nt, interacts with GitHub API through OAuth2.0, GitHub Deployment API, Git Hooks, Git Checks, and Kubernetes on GKE through REDIS. Builds container images using Crane. And keeps user data tight in Postgres as well!

    Go 1 0 0 0 Updated May 31, 2023
  • dfile Public
    Go 1 0 0 0 Updated May 31, 2023
  • front Public
    TypeScript 1 0 0 0 Updated May 31, 2023
  • pre-Build Public

    The pre-build phase. This program will clone the repository, generate a Dockerfile depending on the stack and the programming language and prepare the environment for Kaniko

    Go 0 0 0 0 Updated May 31, 2023
  • kube-build-controller Public

    This is the Kubernetes Build Controller, The responsible component for Containerizing the applications and launch the Build and push image process to private registry

    Go 0 0 0 0 Updated May 29, 2023
  • terraform Public
    HCL 1 0 0 0 Updated May 29, 2023
  • log-stream Public

    This repo contains an example of how we can stream a logs of a specific pod in Kubernetes through WebSocket

    Go 1 0 0 0 Updated May 28, 2023
  • kafka-example Public
    Go 1 0 0 0 Updated May 27, 2023
  • mq-example Public
    Go 1 0 0 0 Updated May 20, 2023
View all repositories

Top languages

Loading…

Most used topics

Loading…