Skip to content

Add scaler_orb_ec2_config entry point for ORB EC2 setup#723

Open
magniloquency wants to merge 9 commits intofinos:mainfrom
magniloquency:feat/orb-ec2-config-script
Open

Add scaler_orb_ec2_config entry point for ORB EC2 setup#723
magniloquency wants to merge 9 commits intofinos:mainfrom
magniloquency:feat/orb-ec2-config-script

Conversation

@magniloquency
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new scaler_orb_ec2_config CLI command (src/scaler/entry_points/orb_ec2_config.py) that generates a ready-to-use config.toml for the ORB AWS EC2 worker manager
  • Uses ec2-metadata to auto-detect the instance's public and private IPs, replacing the manual <EC2_PUBLIC_IP> / <EC2_PRIVATE_IP> substitution step from the quickstart docs
  • Prints a post-generation message with the scaler config.toml launch command and an exact Client(address=...) snippet for connecting from a local machine
  • Registered as a package entry point in pyproject.toml

Related Issue

N/A

Adds a new CLI command that auto-detects the EC2 instance's public and
private IPs via ec2-metadata and generates a ready-to-use config.toml
for the ORB AWS EC2 worker manager, replacing the manual templating step
in the quickstart docs.
…ckstart

Step 4 now leads with the new scaler_orb_ec2_config command, which
auto-detects public and private IPs and generates config.toml. The
manual template tab (with <EC2_PUBLIC_IP>/<EC2_PRIVATE_IP> placeholders)
is removed; the command-line alternative is preserved.
@magniloquency magniloquency marked this pull request as ready for review April 16, 2026 01:32
@magniloquency
Copy link
Copy Markdown
Contributor Author

TODO: We also want to run the gui in the ec2 instance. The gui has two addresses, the monitor address that it uses to connect to the scheduler for data, and the gui address that the user connects their web browser to view the webpage

Extends the generated config.toml with a [gui] section so that the
web GUI is automatically started alongside the scheduler and worker
manager when running `scaler config.toml` on an EC2 instance.

The monitor address connects locally to the scheduler's monitor port
(scheduler_port + 2), and the GUI listens on all interfaces so users
can reach it via the instance's public IP. A --gui-port flag (default
50001) is added to allow customisation.
Add port 50001 to the security group ingress rules, update the
scaler_orb_ec2_config example output to show the GUI URL, add the
scaler_gui command to the manual (command line) tab, and add a
Step 6 explaining how to open the web GUI in a browser.
Add a Web GUI service box inside the Scheduler EC2 Instance, a Browser
component on the Local Machine side, and a TCP 50001 arrow connecting
them. Also expand the diagram height to accommodate the new elements.
Adds a manual config.toml template tab alongside the existing
scaler_orb_ec2_config and command line tabs, so users can create
the config file directly without running the generation script.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant