ECoMan is a tool for supporting virtual machine management on VMware ESXi. It provides administrators to view virtual machine lists with web user interface.

• View virtual machine lists over multiple ESXi Nodes
• Create a virtual machine via Web UI
• Set power status via Web UI
• Emphasize several machines which have large hardware resources in Web UI

• Python 3.9 or later
  • Paramiko
  • FastAPI
  • PyMongo
• MongoDB 5.0 or later

ECoMan has several ways for running as below.

• Linux Machine (General)
• Kubernetes

Hosts config file hosts.yml for ESXi Nodes:

hoge:  # ESXi Node Name
  addr: 'hoge.a910.tak-cslab.org'  # ESXi Node Address
  username: 'root'  # ESXi Username
  identity_file_path: "ssh/id_rsa"  # SSH Private Key File
  datastore_path: '/vmfs/volumes/datastore1/'  # VM stored path on ESXi
  installer_iso_path: "/vmfs/volumes/datastore1/os-images/ubuntu2004.iso"  # Installer ISO stored path
  network_port_group: "Management Network"  # VM network port group

Environment Variables:

ECoMan has following system archtiecture.

• crawler fetches VMs info via SSH and regist VMs info to MongoDB. This component works by polling.
• dashboard provides Web UI to Administrators. When Administrator accesses dashboard, it fetches VMs info from MongoDB and returns to Administrator.
• executor receives actions, "Create VM" or "Update VM's power", from dashboard and does the actions via SSH.