Compute
VMs for agents and apps, and machines for one task.
A VM is a server your Sunport manages, for an agent or your own apps. An environment is a machine for one task, yours or an agent's.
- Use it when
- An agent or an app needs a server, or a task needs a machine for a while
- You get
- VMs your Sunport manages, with domains and access you control
- Cost
- A VM's monthly price, or Included on OpenOrange capacity; environments by use
- Setup time
- A few minutes for a new VM
- Needs
- See machines to look; Manage machines and Start jobs to change; Request environments for an environment
Machines
Compute opens on Machines, every server your Sunport uses:
- Sunport: the server your Sunport runs on. You can't change it here.
- Agent VM: the VM an agent runs on. New agent creates it; deleting the agent deletes it.
- Service VM: a VM for your own apps and tools. New VM creates it with Debian 13 and nothing else.
- Edge gateway: a paid server in front of your Sunport's web and model calls.
External marks a server OpenOrange doesn't manage. It can't be powered, resized or removed from here.
Providers and sizes
A VM runs on a provider you choose when you create it:
- OpenOrange capacity uses servers OpenOrange already runs. Its sizes show Included.
- Any other provider, such as Hetzner, rents a new server at its monthly price.
- On OpenOrange capacity, No public IP keeps a VM private. It can't take domains then.
- Clem manages this VM lets Clem and administrators work on it as root. Off, only an owner SSH key signs in.
Resizing depends on the provider:
- On OpenOrange capacity, more CPUs and memory arrive while the VM runs. Less memory needs a short restart.
- On Hetzner, the VM is off for one to three minutes.
- On other providers, VMs aren't resized. Move the work to a new VM.
Disks grow and never shrink. A volume is an extra disk on OpenOrange capacity, for data that grows.
What it costs
Machines shows each VM's hours this month, with its price at list price.
- A powered-off VM is still charged at the same rate. Only deleting it stops the charges.
- A volume costs a price per GB each month, attached or not.
- An edge gateway costs its size's monthly price until you remove it.
- Your server budget caps what servers may cost a month. A new server past it is refused.
- VMs on OpenOrange capacity have no list price yet, so they don't count toward the budget.
- Team limits cap how many VMs and published names you have at once.
Who can do what
Each action takes a permission:
- See machines (
hosts.read) shows machines, VM plans and domains. - Manage machines (
hosts.manage) with Start jobs (jobs.create) plans, powers, resizes and deletes VMs, and changes domains. - Only administrators create a planned VM, open a VM's page, and see what machines cost.
- An agent's owner works as root on that agent's VM, with
oo vm shell --agent.
Access for agents
Administrators run commands on any VM without asking. Agents need a grant:
- Read only: status and logs.
- Root: any command as root.
An agent asks, and an administrator approves on the VM's Access tab. A requested grant expires. Any grant can be revoked any time. An agent works on its own VM as its own user without a grant. Root there needs one. Clem needs one, unless its VM was made with Clem managing it.
Domains
Domains & routes gives an app on a VM a public HTTPS address. It connects one of three ways:
- Through Sunport: one port of the VM, at a name under your Sunport's domain. It can ask for the OpenOrange sign-in.
- Through edge gateway: any name you own. You add its DNS records, and the app keeps its own login.
- Direct to VM: a name under your Sunport's domain, pointing at the VM. The app serves its own certificate and login.
Routes to servers forwards a name on your own edge gateway to any server by its address.
Machines people share
A service VM or an agent's VM can become a machine that people work on together. Everyone on it works as one Linux account, so they can read and change what is on it. Machines explains who works on one, and what agents may run there.
Environments
An environment is a Linux or macOS machine from Namespace, for one task: yours, or an agent's.
- It starts from a profile: a machine shape, how long it may run, and what happens to its data.
- On OpenOrange machines, it is paid from your team balance. It reserves funds upfront, then settles to actual use.
- On your own Namespace workspace, Namespace bills it.
- On-demand stops after 15 minutes idle or at its deadline. Without kept data, it is deleted.
- Keep running until deadline keeps it running while idle.
- Administrators can set Spending caps per member or agent. Caps never grant permission.
Limits
- On a free trial, a new VM on OpenOrange capacity has at most 4 vCPU, 8 GB RAM and 60 GB disk.
- Some sizes are set up by support only.
- Deleting a VM deletes its data. No backup is taken.
- Volumes aren't in backups or pre-update snapshots.
- VMs on OpenOrange capacity can't send mail over SMTP ports 25, 465 and 587. Use a mail provider's HTTPS API.
- Edge and direct routes have no OpenOrange sign-in.
- An environment's runs, files and terminal work only while it runs. They never start it.
- On macOS environments, typed characters don't arrive yet. Clicks and Command shortcuts do.
- Snapshots, restores, clones and pools work only on your own Namespace workspace.
How-to guides
- Create a service VM
- Approve a VM plan
- Resize a VM
- Add a disk to a VM
- Power a VM off or on
- Rename a VM
- Check a VM's usage
- Delete a service VM
- Set the monthly server budget
- Ask for higher team limits
- Turn on backups
- Restore a VM backup
- Open a VM terminal
- Transfer files to a VM
- Reach a VM over SSH
- Give an agent VM access
- Make a VM a machine
- Publish an app
- Publish on your own domain
- Control access to an app
- Remove a domain
- Add an edge gateway
- Forward a domain
- Route traffic through a gateway
- Create an environment
- Run commands in an environment
- Transfer files to an environment
- Open an environment terminal
- Preview an app
- Control a macOS environment
- Stop, extend or delete an environment
- Restore an environment
- Set environment spending caps
- Add an environment profile
How-to guides
Create a service VM
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs. In the dashboard, only an administrator creates the VM.
- Open Compute and choose New VM.
- Fill in Name and Purpose.
- Choose a Provider, a Location / capacity node and a Capacity.
- Keep Clem manages this VM on, so Clem and administrators can work on it.
- To publish an app on your own domain later, turn on Public HTTP / HTTPS.
- Choose Review plan, then check the price and who gets access.
- Choose Create VM.
Check it worked: Recent operations shows the creation as Completed, and the VM is under Machines.
VMs and environments explains providers, sizes and prices.
Approve a VM plan
Before you start: in the dashboard, you need to be an administrator. With oo, Manage machines (hosts.manage) and Start jobs (jobs.create) are enough, except to create a VM a connected agent asked for; an administrator can give you Manage machines and Start jobs.
- Open Compute. Waiting plans show at the top.
- Choose Review plan to see who asked, the price and who gets access.
- Choose Create VM.
- Or, for a connected agent's request, choose Decline. Dismiss hides any other plan.
Check it worked: the plan's card says the VM is being created, then that it is ready.
VMs and environments explains who may plan and create VMs.
Resize a VM
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs. Only VMs on OpenOrange capacity or Hetzner resize.
- Open Compute.
- Open the menu at the end of the VM's row, and choose Resize.
- Choose a size. Current size marks the one it has.
- If a restart box shows, tick it.
- Choose Resize to and the size.
Check it worked: the VM's row shows the new size once the resize is done.
VMs and environments explains what a resize restarts.
Add a disk to a VM
Before you start: you need to be an administrator, as volumes are paid. An administrator can make you one. Only VMs on OpenOrange capacity take volumes.
- Open Compute, open the VM's row menu and choose Open VM page.
- On Disks, choose Add disk.
- Fill in Name, Size (GB) and Mount path.
- Check the monthly price, then choose Add disk.
- On a service VM, run the mount command the job shows, as root in Terminal.
For an agent's VM, use the Server tab on the agent's page instead.
Check it worked: the volume shows under Volumes as Ready.
VMs and environments explains what volumes cost.
Power a VM off or on
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs.
- Open Compute.
- Open the menu at the end of the VM's row.
- Choose Power off, Power on or Reboot.
- To power off, type the VM's name and choose Power off.
Check it worked: the VM's status shows Stopped, or Ready once it is back.
VMs and environments explains what VMs cost.
Rename a VM
Before you start: you need Manage machines (hosts.manage) on the VM. Not an administrator? Ask one to give you See machines and Manage machines.
- Open Compute.
- Open the menu at the end of the VM's row, and choose Rename.
- Type the new Name and choose Save.
Check it worked: Machines shows the new name.
oo and the API still take the name the VM was made with.VMs and environments explains the kinds of VMs.
Check a VM's usage
Before you start: you need to be an administrator. On an agent's VM, oo also works with Chat and settings on every agent there, which an administrator gives on each agent's Access tab (Let people use an agent).
- Open Compute. A row may show Mostly idle, CPU busy or Memory busy.
- Open the VM's row menu and choose Open VM page.
- Monitor shows CPU, memory, disk and network, live.
- This week shows its CPU and memory at the 95th percentile, and whether a size change is suggested.
- Processes lists the top 10 by CPU or memory.
Check it worked: Monitor shows Live.
VMs and environments explains sizes and resizing.
Delete a service VM
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs. Remove the VM's domains first.
- Open Compute and choose Domains. Remove every route on the VM.
- Choose Machines.
- Open the menu at the end of the VM's row, and choose Delete VM.
- Type the VM's name and choose Submit deletion.
Check it worked: Recent operations shows Deleted, and the VM moves to Retired.
VMs and environments explains what VMs cost.
Open a VM terminal
Before you start: you need to be an administrator with Manage machines (hosts.manage). On an agent's VM, oo also works with Chat and settings on every agent there, which an administrator gives on each agent's Access tab (Let people use an agent).
- Open Compute, open the VM's row menu and choose Open VM page.
- On Terminal, choose Open terminal.
- Confirm with Open terminal.
For an agent's VM, use the Server tab on the agent's page instead.
Check it worked: the terminal shows Connected, and you work as root.
VMs and environments explains who may work on a VM.
Transfer files to a VM
Before you start: you need to be an administrator. On an agent's VM, oo also works with Chat and settings on every agent there, which an administrator gives on each agent's Access tab (Let people use an agent).
- Open Compute, open the VM's row menu and choose Open VM page.
- On Files, choose Show files.
- Open a folder, or type its path and choose Open.
- Choose a file or folder's download button, or Upload files.
For an agent's VM, use the Server tab on the agent's page instead.
Check it worked: the uploaded file shows in the folder, or the download is on your computer.
VMs and environments explains who may work on a VM.
Reach a VM over SSH
Before you start: you need to be an administrator with Manage machines (hosts.manage). On an agent's VM, Chat and settings on every agent there is enough, which an administrator gives on each agent's Access tab (Let people use an agent).
oo sets this up; the dashboard has no such step.
-
Print the SSH settings for the VM:
oo vm ssh-config web-1 oo vm ssh-config support-bot --agent -
Add what it prints to
~/.ssh/config. -
Connect to the host named after the VM, for example
ssh web-1.
Check it worked: ssh web-1 opens a shell on the VM.
--root signs in as root, as the host NAME-root.VMs and environments explains who may work on a VM.
Give an agent VM access
Before you start: you need to be an administrator. An administrator can make you one. The agent asks first.
- Open Compute, open the VM's row menu and choose Open VM page.
- On Access, find the agent under Access requests.
- Read its level and reason, then choose Approve.
- Confirm with Approve. Or choose Deny, then Deny request.
For an agent's VM, use VM access on the Server tab of that agent's page.
Check it worked: the agent shows under Who can run commands here, with its access and when it expires.
To end it early, choose Revoke, then Revoke access.
VMs and environments explains read and root access.
Publish an app
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs. The app listens on one port of a service VM or an agent's VM.
- Open Compute and choose Domains.
- Choose Add domain.
- Under VM, choose the VM the app runs on.
- Under Connection, if it shows, choose Through Sunport.
- In Hostname, type one name, such as
shop. Your Sunport's domain follows it. - In Application port, type the app's port, such as
8080. - Keep Ask for OpenOrange sign-in on, unless the app must be public.
- Choose Apply route.
Check it worked: the domain shows DNS ready, and its address opens the app.
VMs and environments explains the ways a domain connects.
Publish on your own domain
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs. You need a ready edge gateway, a VM with Public HTTP / HTTPS on, and access to the domain's DNS. In the dashboard, a service VM your Sunport reaches takes only Through Sunport.
- Open Compute and choose Domains.
- Choose Add domain, and under VM choose the VM.
- Under Connection, if it shows, choose Through edge gateway.
- In Hostname, type the full name, such as
shop.example.com. - Under Edge gateway, choose a gateway, then choose Apply route.
- Open the domain's menu and choose DNS & details.
- In your DNS, create the CNAME it shows.
- Once the domain shows Edge verified, create the A record it shows.
Check it worked: the domain shows Edge verified, and the name opens your app.
VMs and environments explains the ways a domain connects.
Control access to an app
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs. This works for domains Through Sunport only.
- Open Compute and choose Domains.
- Open the domain's menu.
- Choose Turn on sign-in or Turn off sign-in.
- To turn it off, confirm with Turn off.
Check it worked: the domain shows OpenOrange sign-in, or says anyone with the address reaches it.
VMs and environments explains the ways a domain connects.
Remove a domain
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs.
- Open Compute and choose Domains.
- Open the domain's menu and choose Remove route.
- Type the route's name and choose Remove route.
Check it worked: the domain leaves the list.
VMs and environments explains the ways a domain connects.
Add an edge gateway
Before you start: you need to be an administrator with Manage machines (hosts.manage) and Start jobs (jobs.create). An administrator can make you one. The gateway is charged every month until you remove it.
- Open Compute and choose New VM.
- Under Role, choose Edge gateway.
- Fill in Name and ID.
- Choose a Provider, a Location / capacity node and a Capacity.
- Choose Review and check the monthly price.
- Choose Create edge gateway.
Check it worked: the gateway shows under Machines, as Setting up until it is ready.
VMs and environments explains edge gateways and what they cost.
Forward a domain
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create). Not an administrator? Ask one to give you See machines, Manage machines and Start jobs. You need a ready edge gateway of your own, and a server that serves HTTPS.
- Open Compute and choose Domains.
- Under Routes to servers, choose Forward a domain.
- Fill in Hostname, Route name and Edge gateway.
- Fill in the Server address and Port.
- If the server's certificate is for its address, type that in Certificate name.
- Optionally, limit Paths, or turn on Refuse other sites' pages or No cookies.
- Choose Apply route.
Check it worked: the route shows under Routes to servers, and the name opens the server.
oo vm domains list names both. oo vm domains unforward vnc stops forwarding.VMs and environments explains the ways a domain connects.
Route traffic through a gateway
Before you start: you need Manage machines (hosts.manage) and Start jobs (jobs.create), and a ready edge gateway. Not an administrator? Ask one to give you See machines, Manage machines and Start jobs.
- Open Compute and choose Domains.
- Under Sunport traffic, choose a gateway for Web and for Model calls.
- Choose Save.
- For a backup, turn on Failover, pick Backup 1, and choose Turn on failover. It needs a second ready gateway.
Check it worked: Web and Model calls show the gateways you saved. With failover on, Serving now names the gateway in use.
VMs and environments explains edge gateways and what they cost.
Create an environment
Before you start: you need Request environments (environments.create), and a profile to create from. Not an administrator? Ask one to give you See environments and Request environments.
- Open Compute and choose Environments.
- Choose Create machine.
- Choose a Profile, and how long it Runs for.
- Under Lifetime, keep On-demand, or choose Keep running until deadline.
- Add a Purpose (optional).
- If Delete its data on shows, choose the day.
- Choose Create machine.
Check it worked: it says Machine created, and the list shows it Running.
VMs and environments explains lifetimes and what environments cost.
Run commands in an environment
Before you start: you need Run commands and open environments (environments.use), on your own environment. Not an administrator? Ask one to give you See environments and Run commands and open environments. It must be running.
- Open Compute, choose Environments and open the environment.
- On Runs, type the Command, such as
make test. - Optionally, set a Working folder and Files to keep.
- Choose Run.
Check it worked: the run shows Succeeded and its exit code, with its Output.
VMs and environments explains environments.
Transfer files to an environment
Before you start: you need Run commands and open environments (environments.use), on your own environment. Not an administrator? Ask one to give you See environments and Run commands and open environments. It must be running.
- Open Compute, choose Environments and open the environment.
- On Files, type a folder's path and choose Open.
- Choose a file to read or edit it, then Save. Or choose Download.
- To add one, choose Upload a file. It takes up to 8 MB.
Check it worked: the file shows in the folder.
VMs and environments explains environments.
Open an environment terminal
Before you start: you need Run commands and open environments (environments.use), on your own environment. Not an administrator? Ask one to give you See environments and Run commands and open environments. It must be running.
- Open Compute, choose Environments and open the environment.
- Choose Terminal.
Check it worked: the terminal shows Connected.
VMs and environments explains lifetimes.
Preview an app
Before you start: you need Run commands and open environments (environments.use), on your own environment. Not an administrator? Ask one to give you See environments and Run commands and open environments. It must be running.
- Open Compute, choose Environments and open the environment.
- On Ports, type the Port and choose Open port.
- Choose Open preview. It opens in a new tab.
Check it worked: the new tab shows your app.
To stop it, choose Close, then Close port.
VMs and environments explains environments.
Control a macOS environment
Before you start: you need Run commands and open environments (environments.use), on your own macOS environment. Not an administrator? Ask one to give you See environments and Run commands and open environments. It must be running.
- Open Compute, choose Environments and open the environment.
- Choose Desktop. The screen shows live.
- Click on it, or press Command shortcuts.
Check it worked: the screen changes as you click.
VMs and environments explains environments.
Stop, extend or delete an environment
Before you start: it must be your environment, or you need Manage everyone's environments and connections (environments.manage). Stopping and deleting need Stop and delete environments (environments.delete). Extending needs Request environments (environments.create). An administrator can give you each.
- Open Compute, choose Environments and open the environment.
- Choose what you need:
- Extend: pick a New deadline, then choose Extend.
- Stop: confirm with Stop. It keeps its data; Start runs it again before its deadline.
- Delete: confirm with Delete. The machine and its data are gone.
Check it worked: the environment shows its new deadline, Stopped, or Deleted.
VMs and environments explains lifetimes and kept data.
Restore an environment
Before you start: this works only on your own Namespace workspace. Restoring needs Run commands and open environments (environments.use) on your environment, and it must be stopped. Cloning needs Request environments (environments.create). An administrator can give you either.
- Open Compute, choose Environments and open the environment.
- Under Snapshots, find the restore point.
- Choose Restore and confirm with Restore.
- Or choose Clone, then Create machine, for a new machine from it.
Check it worked: the machine starts from the snapshot, or Machine created shows with Open it.
VMs and environments explains environments.
Set environment spending caps
Before you start: you need to be an administrator. An administrator can make you one.
- Open Compute and choose Environments.
- Under Spending caps, choose Set caps.
- Choose the Member or agent.
- Fill in Maximum machines at once, Maximum spend (USD) or both.
- With a spending cap, set the Window (days), from 1 to 30.
- Choose Set caps.
Check it worked: the caps show under Spending caps, with current use.
To lift them, choose Remove caps.
VMs and environments explains what environments cost.
Add an environment profile
Before you start: you need Manage everyone's environments and connections (environments.manage). Not an administrator? Ask one to give you See environments and Manage everyone's environments and connections.
- Open Compute and choose Environments.
- Under Profiles, choose New profile.
- Choose the Machine, and fill in Name.
- Under When its time is over, choose what happens to its data.
- Set Longest it runs.
- Choose Create profile.
Check it worked: the profile shows under Profiles.
VMs and environments explains profiles.