Giter VIP home page Giter VIP logo

kubestro's Introduction

kubestro

A kubernetes automated dashboard to deploy your Minecraft servers.

Description

When deploying a Minecraft server, we often use the same tools : hosting providers, bare bones linux server, docker container, Pterodactyl instance, etc. What i'm looking for, is something similar to what we know with Pterodactyl : a good and simple to use web dashboard to deploy servers but, this time, inside a Kubernetes cluster.

This mainly answer a personal desire to take the advantage of my own Kubernetes cluster to deploy any kind of Minecraft servers.

Getting Started

How does it work?

The project is divived in 4 sub-projects: api, operator, download and webui.

  • Operator handles all the deployment logic on the Kubernetes side. This means that, when we will deploy a custom resource (i.e. MinecraftServer), the operator will translate it into Kubernetes primitives kinds (StatefulSet, Pods, Service, etc.).
  • Download is a small tool used to download required files and ensure the hash match with the one expected. It is useful to download Minecraft required files like the server.jar, mods/plugins or even extra resources.
  • api is the actual HTTP API of the kubestro dashboard. The API will handle all the interaction and then process the deployment of custom resources on the cluster.
  • webui is the dashboard itself. It will be served through the same container as the API, and will be presented to the user to interact with the cluster.

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please also adhere to this project's CODE OF CONDUCT

License

This project is under MIT license. It can be found here or on https://opensource.org/license/mit.

Acknowledgements

kubestro's People

Contributors

bricklou avatar

Watchers

 avatar  avatar

kubestro's Issues

Configure project structure

Configure:

  • git hooks (formating, commitlint)
  • taskfiles
  • releases configurations
  • global linter and formatters

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.