/CFD

Container tooling For Developers

Primary LanguageMakefileGNU Affero General Public License v3.0AGPL-3.0

CFD

Logo

Say Thanks! Made With Go Made With Docker Made With VSCode

Container tooling For Developers


Welcome to Fazendaaa's CFD. This is version 0.0.0!

-----------------------------------------------------

➤ Idea

Currently, in the company that I work for we have a CLI (Command Line Interface) made in Python called estat. As this tool have grown so much and making it available as FOSS (Free and Open-Source Software) was always the idea but the project still in development and not having a properly defined scope, I decided to break its main features in other projects:

  • Succubus: universal project manager based on cloud-native
  • Jinn: universal cloud-native project setup tool
  • Baba Yaga: universal cloud-native manager built to expand Jinn and Succubus capabilities
  • Wendigo: universal project translator from cloud-native projects to other infra technologies
  • Shōjō: LaTex package manager
  • Hellhound: VSCode extension to integrate CFD
  • Crocotta: SOC assisted guider
  • Changeling: Recipes for Succubus and Baba Yaga
  • Rakshasa: CI/CD translator
  • Oni: A CLI tool to unify CFD projects

The tools currently works in Python, R, Node.js and Julia projects. So far, so good. But the turning point is the following: I DON'T HAVE ANY OF THOSE LANGUAGES INSTALLED IN MY MACHINE

The basic flow for now is something like this:

flow

All the company projects have a Dockerfile in it; so the CLI does the following:

  1. Build the current Dockerfile as a helper container
  2. Bind the current project to the helper container, installs the mentioned packages in it
  3. Adds the packages to the project package description file and truncates its version

You may find the concept it similar as npm which this tool is heavily based on.

The main advantage of this approach is to help avoid errors during development, especially because in any project you might find yourself using:

  1. A different language version
  2. Different Operational Systems (OSes)
  3. Forgetting to list all packages used in the project
  4. Also forgetting to list OS-based dependencies
  5. And also forgetting to list environment variables
  6. etc.

The idea is for the development process to be frictionless; as all the developers can switch branches and projects and start to work on them without having to worry to install any dependency or figuring out what the other developer did to that project to work.

Besides this, for that matter, this will work as well for other projects based in:

  • Python
  • Julia
  • npm/yarn -- Node.js, Vue, React, etc.
  • etc.

As the main idea is to work as a abstraction layer to handle projects the language, its version, and OS related packages should not matter only the what is described in the Dockerfile.

And as npm allows us to run the project and test it so estat does it as well. Each project that contains a docker-compose.yml file is executed when running a simple estat run, avoiding that developers no familiarized with docker-compose forget to add the --build flag to it and, besides that, the tool also goes trough the process of checking each listed image in it for updates as also checking the base image for updates before running it -- sometimes developers forget to check them for updates that might fix their problems.

-----------------------------------------------------

➤ What is CFD?

Container tooling for Developers (CFD) acts just as a "ground zero" so you can grasp the whole idea behind the environment in which estat flourished upon and then share some possibilities of how those same environments can be linked to your needs right now.

This project will only uses those tools listed here and then acts like platform to publicize it.

-----------------------------------------------------

➤ Author

Only me because the aforementioned project was implemented by yours only. By knowing each line of that code wrote doing the port would be more easily done this way.

-----------------------------------------------------

➤ Contributing

Check more about this in CONTRIBUTING.md. Here we have a list of some of our contributors:

-----------------------------------------------------

➤ Contributors

Fazendaaa You?
Fazendaaa You?

-----------------------------------------------------

➤ TODO

-----------------------------------------------------

➤ References

-----------------------------------------------------

➤ License

Licensed under AGPL-3.0.