blyndusk/flamingops

🦩 FlamingOps - Cloud Providers Aggregator: 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.

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.

flamingops's Issues

[US] As a developer, I want to have a Configuration view

Tasks:

• gestion des web services
• secret manager ?

[US] As a repository owner, I want a nice project logo

Tasks:

• Upload a new image
• edit Readme.md

[US] As a developer, I want to be able to store, update, retrieve and delete secrets from AWS Secrets Manager

Tasks:

• Create a flamingops aws account
• Create methods for creation, update and deletion from the main api
• Create methods for retrieval from the workers

See minified doc here

[US] As a developer, I want jwt verification to work

Tasks:

• task 1
• task 2
• task 3

[US] As a developer, I want to fix my JWT

Tasks:

• fix JWT

[US] As a developer, I want to have a Swagger API documentation host on GitHub Pages

[US] As a developer, I want to have Login/Register routes

Tasks:

• login route
• register route

[US] As a developer, I want to have a AccountHandle view

Tasks:

• CRUD login
• CRUD password
• CRUD mail

[US] As a developer, I want to have User routes

[US] As a developer, I want to have technical and functionnal specifications as md files

[US] As a developer, I want to implement Snapshot Testing with Jest in the React app

Tasks:

• Add react-test-renderer dependency
• Implement a first successful snapshot test
• Add snapshot testing to every UI components

[US] As a developer, I want to have a SignUp / Login view

Tasks:

• Login:
  • login
  • password
• Sign up:
  • login
  • password
  • mail

[US] As a developer, I want to test what AWS api can offer

Tasks:

• task 1
• task 2
• task 3

[US] As a developer, I want to have ActiveService routes

[US] As a repository owner, I want to have a clean wiki

[US] As a developer, I want to create my DB Models

Tasks:

• User Model
• DisplayPreferences Model
• AWSCredentials Model
• AWSServiceData Model
• SCWCredentials Model
• SCWServiceData Model

[US] As a developer owner, I want to have an Helm chart for my project

[US] As a repository owner, I want to dockerize my apps + functionnal CI/CD

Tasks:

• web prod + loc dockerfile
• web ci/cd

[US] As a developer, I want to have a Dashboard view

Tasks:

• see data
• see data
• see data AGAIN

[US] As a developer, I want to have a worker queue

Tasks:

• add workflow
• trigger workflow

[US] As a developer, I want to clean the front template we're going to use as well as incorporate it cleanly in the repo

Tasks:

• Cleanup project
• Incorporate it in github

[US] As a developer, I want to fix my middlewares

Tasks:

• reorganize the exchanges between controllers and middlewares.
• Fix some errors

[US] As a repository owner, I want to terraform my project

[US] As a developer, I want passwords to be hashed

Tasks:

• hash password in db
• hash password on login to compare hash in db
• comment getUsers route