TFROBOT + TFCMD #27

New Issue

sashaastiadi · 2024-03-20T13:07:42Z

sashaastiadi commented

2024-03-20 13:07:42 +00:00

TFROBOT + TFCMD

The idea is we create 2 easy to use cmd line tools which are easy for people to integrate in any app and it has all features required to easily get started with our grid, without having to use an SDK.

2 main use cases are CI/CD and mass deployments for e.g. tests deploy 100 nodes to do xyz, ...

we also want to make sure we support the usecases we now need for our partners e.g. earthwallet & holochain

context

Ahmeds team made a super nice tool to do large scale deployments on the grid lets call this tfrobot
lets extend this with minimal features see below and push this for certain of our workloads

TFRobot features

easy deployer VM: see https://github.com/threefoldtech/home/issues/1504
add on's for CI/CD usecase (see #2)
deploy easily any of the apps/vm's below with good json as return so its easy to integrate in other app

requirements

easy to use
can deploy hundreds of VM's, good to see progress
good feedback with json output (even errors)
return mycelium ip addr if used
return pub ip addr if used
can also delete lots of vm's at once
each VM has unique ID (which can be used to delete)
check other cmdline tool (TFCMD) for TFGrid: can this one check CPU usage
- integrated TFCMD in manual (issue: info_grid)
- rename tf-grid-cli -> tfcmd (issues: info_grid, tfgrid-sdk-go)
- also support --json output so its easy to integrate in other solution
- need to make sure better selection criteria can be used e.g. region, min node size
make sure TFROBOT is also in manual (issue: info_grid)

Remarks

Mycelium in ZOS
the TFCMD is on this link
probably best these new apps/vm's are also in new dashboard (issue: tf-images)

# TFROBOT + TFCMD The idea is we create 2 easy to use cmd line tools which are easy for people to integrate in any app and it has all features required to easily get started with our grid, without having to use an SDK. 2 main use cases are CI/CD and mass deployments for e.g. tests deploy 100 nodes to do xyz, ... we also want to make sure we support the usecases we now need for our partners e.g. earthwallet & holochain ## context - Ahmeds team made a super nice tool to do large scale deployments on the grid lets call this tfrobot - lets extend this with minimal features see below and push this for certain of our workloads ## TFRobot features - easy deployer VM: see https://github.com/threefoldtech/home/issues/1504 - add on's for CI/CD usecase (see #2) - deploy easily any of the apps/vm's below with good json as return so its easy to integrate in other app ## requirements - [x] easy to use - [x] can deploy hundreds of VM's, good to see progress - [ ] good feedback with json output (even errors) - [ ] return mycelium ip addr if used - [ ] return pub ip addr if used - [x] can also delete lots of vm's at once - [ ] each VM has unique ID (which can be used to delete) - [ ] check other cmdline tool (TFCMD) for TFGrid: can this one check CPU usage - [x] integrated TFCMD in manual (issue: [info_grid](https://github.com/threefoldtech/info_grid/issues/371)) - [x] rename tf-grid-cli -> tfcmd (issues: [info_grid](https://github.com/threefoldtech/info_grid/issues/370), [tfgrid-sdk-go](https://github.com/threefoldtech/tfgrid-sdk-go/issues/635)) - [x] also support --json output so its easy to integrate in other solution - [ ] need to make sure better selection criteria can be used e.g. region, min node size - [x] make sure TFROBOT is also in manual (issue: [info_grid](https://github.com/threefoldtech/info_grid/issues/372)) ## Remarks - Mycelium in ZOS - the TFCMD is on this [link](https://manual.grid.tf/tfgridcmd/grid3_cli_readme.html) - probably best these new apps/vm's are also in new dashboard (issue: [tf-images](https://github.com/threefoldtech/tf-images/issues/195))

sashaastiadi commented

2024-03-20 13:07:43 +00:00

Links to Issues

tf-grid-cli to tfcmd
- info_grid: https://github.com/threefoldtech/info_grid/issues/370 CLOSED
- tfgrid-sdk-go: https://github.com/threefoldtech/tfgrid-sdk-go/issues/635 CLOSED
  - done
tfcmd, info_grid: https://github.com/threefoldtech/info_grid/issues/371 CLOSED
- done
tfrobot, info_grid: https://github.com/threefoldtech/info_grid/issues/372 CLOSED
- done
tfcmd integration, info_grid: https://github.com/threefoldtech/info_grid/issues/373 CLOSED
- done
tf-images apps: https://github.com/threefoldtech/tf-images/issues/195 ONGOING
- in progress
rename mass-deployer to tfrobot: https://github.com/threefoldtech/tfgrid-sdk-go/issues/604#issuecomment-1894987388 VERIFICATION
- in verification

@despiegk I added the issues' links directly in your main post to track the progress, if it's ok with you!

# Links to Issues - tf-grid-cli to tfcmd - info_grid: https://github.com/threefoldtech/info_grid/issues/370 CLOSED - tfgrid-sdk-go: https://github.com/threefoldtech/tfgrid-sdk-go/issues/635 CLOSED - done - tfcmd, info_grid: https://github.com/threefoldtech/info_grid/issues/371 CLOSED - done - tfrobot, info_grid: https://github.com/threefoldtech/info_grid/issues/372 CLOSED - done - tfcmd integration, info_grid: https://github.com/threefoldtech/info_grid/issues/373 CLOSED - done - tf-images apps: https://github.com/threefoldtech/tf-images/issues/195 ONGOING - in progress - rename mass-deployer to tfrobot: https://github.com/threefoldtech/tfgrid-sdk-go/issues/604#issuecomment-1894987388 VERIFICATION - in verification @despiegk I added the issues' links directly in your main post to track the progress, if it's ok with you!

sashaastiadi commented

2024-03-20 13:07:43 +00:00

@despiegk @thabeta

The whole project is going great. TFCMD is on the manual, and TFROBOT works well.

One thing I realize is that when you deploy with TFROBOT, you end up using TFCMD to get contracts and delete them.

Proposition: Can we merge TFROBOT and TFCMD into the same tool? We can have all methods from TFROBOT transferred to TFCMD.

There might be reasons why we separate the them, but users will most likely end up using both in parallel for their deployments.

@despiegk @thabeta The whole project is going great. TFCMD is on the manual, and TFROBOT works well. One thing I realize is that when you deploy with TFROBOT, you end up using TFCMD to get contracts and delete them. ### Proposition: Can we merge TFROBOT and TFCMD into the same tool? We can have all methods from TFROBOT transferred to TFCMD. There might be reasons why we separate the them, but users will most likely end up using both in parallel for their deployments.

sashaastiadi commented

2024-03-20 13:07:43 +00:00

Progress/Situation

TFROBOT and TFCMD added to manual. (we can add more docs as more features are added)
Dev team are working on remaining details to tfrobot, led by @thabeta (once released, will be added in manual)
images are being worked on by @PeterNashaat on tf-images
as for CI/CD, @scott made some great progress in possible implementation

# Progress/Situation - [TFROBOT](https://manual.grid.tf/tfrobot/tfrobot.html) and [TFCMD](https://manual.grid.tf/tfcmd/tfcmd.html) added to manual. (we can add more docs as more features are added) - Dev team are working on remaining details to tfrobot, led by @thabeta (once released, will be added in manual) - images are being worked on by @PeterNashaat on tf-images - as for CI/CD, @scott made some great progress in possible implementation

despiegk added this to the (deleted) project 2024-03-21 07:26:53 +00:00

despiegk commented

2024-03-21 07:29:54 +00:00