Flamingops

Cloud Instances Aggregator

Project Status

This repo is a HETIC school project and its purpose is purely educational.

Feel free to fork the project, but be aware that development might slow down or stop completely at any time, and that we are currently not looking for maintainers or owner.

Table of Contents

• Flamingops
• Project Status
• Table of Contents
• Overview
• Project Demo
• Getting Started
  • Requirements
  • Installation
• Documentation
• Built With
  • Ops
  • Back-end
  • Front-end
• Team Members
• Acknowledgments
• License

Overview

Flamingops is a Cloud-based application granting devops an interface to manage all their Cloud instances in a cross-cloud-provider way, hence making it easier to handle your web services consumption.

Current support includes:

• AWS instances
• ScaleWay instances

Project Demo

No demo available at the moment.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment section for notes on how to deploy the project on a live system.

Requirements

• Docker
• Docker Compose
• Golang
• Node
• Make

Installation

First, do this:

make init

Now with your browser of choice get to 127.0.0.1:3000 to access UI.

And get to 127.0.0.1:3333 to access API.

Documentation

See the Flamingops Developer Documentation for information on classes and utility functions.

Built With

Ops

• Kubernetes - Open-source system for automating deployment, scaling, and management of containerized applications
• Terraform - Open-source infrastructure as code software tool
• Docker - PaaS product to deliver software in packages
• GitHub Actions - Automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub
• Go-yave - A Golang project-managed repository template
• Amazon Web Services (AWS) - On-demand cloud computing platforms

Back-end

• Golang - Open source programming language
• AWS SDK for Go - Official AWS SDK for the Go programming language
• sw sdk - Unofficial ScaleWay SDK for the Go programming language
• Jwt-go - Golang implementation of JSON Web Tokens
• gin-gonic - HTTP web framework written in Go

Front-end

• Create React App - Officially supported way to create single-page React applications

Team Members

• Alexandre Delaloy - blyndusk - DevOps (SRE) / Repository manager
• Lucas Lehot - lucaslehot - Lead Dev Back
• Cyrille Banovsky - Ban0vsky - Lead Dev Front
• Florian Brunet - FlorianB98 - Fullstack (Back-oriented)
• Armand Benichou - ArmandBeni - Dev Front
• Quentin Maillard - Tichyus - Fullstack (Back-oriented)
• Corentin Boulanouar - Shawnuke - Dev Front / Documenter

Acknowledgments

Any resemblance of the Flamingops logo to an already existing logo (living or dead) would be purely coincidental (that's a lie).

License

This project is licensed under the terms of the MIT license.