Fskube

<!-- PROJECT LOGO --> <br /> <p align="center"> <a href="https://github.com/rebataur/fskube"> <img src="/static/images/mini-icon.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">fskube - Python Developer's full-stack Kubernetes enabler</h3> <p align="center"> If you are a Python Python developer then fskube provides you with best user experience in easily running your full-stack Python apps on Kubernetes in AWS with just a few clicks. <br /> <!-- <a href="https://github.com/rebataur/fskube"><strong>Explore the docs »</strong></a> --> <br /> <br /> <a href="https://www.youtube.com/watch?v=Nt5yowdwm5Q">View Demo</a> · <a href="https://github.com/rebataur/fskube/issues">fskube Bug</a> · <a href="https://github.com/rebataur/fskube/issues">Request Feature</a> </p> </p> <!-- TABLE OF CONTENTS -->

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

<!-- ABOUT THE PROJECT -->

About The Project

Built With

• Python
• Bootstrap
• AWS Libraries
• Kubernetes Libraries

<!-- GETTING STARTED -->

Getting Started

Please note the following

• Currently only runs on Windows
• Linux and Mac ports coming soon.

For Convenience Download single executable for Windows

https://github.com/rebataur/fskube/releases/download/v0.1.8/fskube.exe

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Currently tested only on Windows
• Python 3.7+

Installation

1. Clone the fskube

git clone https://github.com/rebataur/fskube.git

2. Create virtualenv

cd fskube
virtualenv venv
venv\scripts\activate

3. Install fskube

pip install -r requirements.txt

4. Run the flask app

>set FLASK_APP=fskube.py
>set FLASK_DEBUG=FALSE 
>set FLASK_RUN_PORT=5678
>flask run

6. Launch http://localhost:5678 in your browser

<!-- USAGE EXAMPLES -->

Usage

KubeConfig file is stored in your YOUR_USER_DIRECTORY/.fskube/YOUR_CLUSTER_ID

Please watch a detailed video of fskube below.

<!-- ROADMAP -->

Roadmap

1. Spot Instances
2. AMD Based Instances
3. Graviton based Instances
4. AutoScaling Group

See the open issues for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE for more information.

<!-- CONTACT -->

Contact

Your Name - @rebataur - hello@rebataur.com

Project Link: https://github.com/rebataur/fskube

<!-- ACKNOWLEDGEMENTS -->

Acknowledgements

We stand on the shoulders of giants! This project would not have been possible without the following projects.

• eksctl
• aws cli
• linkerd
• velero
• ELK Stack
• Metrics-Server
• Kubernetes
• Kubectl

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->