CLI development ideas

[LorenzoTettamanti]

Hi everyone @PranavVerma-droid @lorebrada - first of all, I want to personally thank Pranav for the interest shown in our project.

I opened this discussion to share ideas and thoughs regarding the CLI development. I have temporarily assigned issue #77 to Pranav. If you need a quick link to filter the existing CLI issues, here's a shortcut CLI open issues.

We can use this discussion to keep the project organized and clean 🚀 make sure to read the contributing guidelines before star working

Organization Note :
I have assigned the triage role to Pranav to give him the power to clone the repository, manage the issues, and Pull Requests

[PranavVerma-droid]

Hi team!
Here is a list of commands that I created for the new cortex cli:

cortex install [--profile minimal|standard|full]  
cortex status [--output text|json|yaml] [--namespace <namespace name>]
cortex uninstall [--keep-data]  
cortex service list [--namespace <namespace name>]  
cortex service describe <service-name> [--namespace <namespace name>]  
cortex logs [--service <name>] [--component control-plane|data-plane] [--namespace <namespace name>]  
cortex config [get|set] <key> [<value>]  
cortex version  
cortex update [--component cli|core|all]  
cortex dashboard  
cortex debug <service-name> [--namespace <ns>]  

I'll initially start work on some of the easier ones and submit a PR.

[LorenzoTettamanti]

@PranavVerma-droid Perfect... waiting for the changes 🚀. I've already created some structure in the "feature/cli" branch, i guess you can use that as a starting point!

Also with the triage role you can directly clone the repository and push commits and PR...make sure to create a dedicated branch for your features to keep the project clean!

[LorenzoTettamanti]

HI @PranavVerma-droid, as I said to you privately, I have merged the PR #101. Just one annotation for the next commits: Can you also tag the issue in the commit? You can use this style:

[#issue number]: commit-message

In this way, it will be easy to track changes directly from the issue page for everyone accessing the repository.

Note: I'm investigating the auto-assign workflow to fix the problem with the PR checks.

[PranavVerma-droid]

Okay sure, I'll be sure to use the format you specified. Thanks!

[LorenzoTettamanti]

@PranavVerma-droid I have updated the auto-assign workflow, adding exceptions to skip the auto-assign workflow while the PR came from a forked repository (apparently this was the trouble). I'm also testing a workflow to auto-assign issues when the "cortexflow cli" label is placed

[LorenzoTettamanti]

Hi everyone, @lorebrada @PranavVerma-droid. I'm merging all the changes into the PreReleaseMain branch, and after that, I'll sync the changes in the main branch

[LorenzoTettamanti]

@PranavVerma-droid merged and synched all the branches with the main branch

[LorenzoTettamanti]

Hi @PranavVerma-droid,I'm checking the project tab. Could you let me know which tasks you still need to complete?
In case some tasks are already done, i'll proceed to close the related issues

[PranavVerma-droid]

I guess I'll do #94 next maybe

[LorenzoTettamanti]

Ok, i'll close the issue #94 and #77 after that. Maybe just give me a couple of days to see if we can improve some parts of the code 💯

[lorebrada]

Hi everybody! Thanks for your incredible job. @LorenzoTettamanti @PranavVerma-droid

[LorenzoTettamanti]

Hi everyone @PranavVerma-droid @lorebrada, I have an idea in my mind regarding the CLI that I want to discuss previously here.

Right now, the CLI has an environment (ENV) parameter that could be used to let CortexFlow expand its usage possibilities in other container orchestrators such as Docker Swarm, Apache Mesos,Nomad,Azure AKS, and so on..

On the other hand, having to refer to the env parameter every time can get a bit annoying; for example, to install and uninstall the components the commands are:

cfcli <ENV> install
cfcli <ENV> uninstall

The same pattern occurs for all the other commands and subcommands, for example cfcli <ENV> status

I propose to create a file that will be created during the installation process to store all the command line metadata, for example, the environment metadata. The metadata doesn't need to be overcomplicated; it will just store the essential data in a simple JSON format in the /etc directory. This will lead to simpler commands because the parameter will be deduced from the metadata file instead of including it in each command.

What do you think about this feature? Do you think that this will be helpful for future users?

[PranavVerma-droid]

Hi @LorenzoTettamanti @lorebrada,

Honestly, Really Great Ideas!
I would recommend using .yaml instead of .json because JSON is suited better for raw data, and YAML is for configuration purposes, and I feel like it would suit better here, but again, entirely up to you, let me know.
More here: https://www.geeksforgeeks.org/html/what-is-the-difference-between-yaml-and-json/

I have one more recommendation. If you see the the command list (Here: https://github.com/orgs/CortexFlow/discussions/98#discussioncomment-13463993), I have a command in there called cortex config [get|set] <key> [<value>]. We can store the ENV parameter, and also the namespace name in the same config. As you can see in the commands list, most of the commands also require the --namespace flag, and if the users have got a custom namespace name, this can get repetitive. So, I suggest storing the env & the namespace name in the config.

Additionally, this can be expanded to add more keys in the future. Not just <ENV> and --namespace <ns>, but more.

[PranavVerma-droid]

@lorebrada I really like the implementation that you showed. This seems to be the perfect solution!

[LorenzoTettamanti]

Hi @PranavVerma-droid @lorebrada

The idea of storing the metadata using a .yaml file instead of a JSON file is great. I'll open a dedicated issue tomorrow morning so we can start building this new feature.

At the moment i'm a little bit busy with a great core update so i can't start working on this feature tomorrow

Pranav, can i assign this feature to you? I think I still need a couple of days to complete the core update so if you can start the logic i can finish the feature as soon as i complete my work

[PranavVerma-droid]

Hi @LorenzoTettamanti
Sure! Assign it and i'll start working on it!

[LorenzoTettamanti]

@PranavVerma-droid opened the issue. You can tag all the related commits with the #112 code

[LorenzoTettamanti]

Hi @PranavVerma-droid. How's it going? I know you're busy, but I was wondering if you could do a couple of tests when you're free.

I've introduced the "metadata config file " update and a couple of minor changes that includes graphics changes and I've fixed the command "cfcli service list" to show the cluster's services instead of the cluster's pods (using the word "service" for list pods was a bit incorrect to me especially because in kubernetes services and pods are two different objects). Right now, the crate is published in crates.io with the name "cortexflow-cli".

Can you test the install and uninstall commands and notify me here, or open an issue if you encounter any bugs or strange outputs?

[PranavVerma-droid]

Hi! Sorry for the late reply.
Sure, I'll do the tests and tell you what I find!