civo

The rumi cloud civo commands provision and manage Rumi private clouds in Civo.

Overview

Civo commands provide lifecycle management for Rumi private clouds on Civo:

• Catalog Inspection - List the SSH keys, disk images, and instance sizes available in your account

• Network Infrastructure - Create, list, and delete private networks

• Platform Services - Launch the bastion, Admin, Monitor, and messaging broker nodes

• Service Instances - Launch application workers with optional public IPs and data volumes

• HTTPS - Terminate TLS on the bastion with a Let's Encrypt wildcard certificate

• Lifecycle Management - Provision a whole environment in one step, deploy applications, start/stop to save cost, and tear it all down

Civo uses an install-at-boot model: every node boots from a barebones Rocky image and installs its role's software via cloud-init on first boot (rather than booting from a prebaked image or snapshot, as on Hetzner and AWS). This keeps the image catalog simple, at the cost of a slower first boot while software is installed — the launch commands wait for the node to finish coming up.

Prerequisites

Before using Civo commands, you must:

1. Have a Civo API token - Supply it with -k, --api-key or set the CIVO_API_TOKEN environment variable.

2. Choose a region - Every command takes a required -r, --region (e.g. FRA1).

3. Have an SSH key pair - Upload an SSH key to Civo (e.g. named rumi) and pass its name with -K, --keyPair; launches associate it with each instance so the fleet can be reached.

Commands

All three providers (AWS, Hetzner, Civo) now share one command vocabulary: per-component lifecycle verbs (start-admin, stop-solace, terminate-monitor, …), an env-wide start/stop, and deprovision.

Catalog

Command	Description
list-sshkeys	List the SSH keys uploaded to your account
list-diskimages	List the available disk (OS) images (alias: list-images)
list-instance-sizes	List the available instance sizes (alias: list-instance-types)

Network Management

Command	Description
create-network	Create a private network
list-networks	List the networks in a region
delete-network	Delete a network

Bastion

The bastion is the network's public entry point and internal DNS server. It fronts the fleet's nginx reverse proxies and is the SSH entry point; it must be launched before any other role.

Command	Description
launch-bastion	Launch the bastion (DNS + public entry point)
start-bastion	Start the bastion
stop-bastion	Stop the bastion
terminate-bastion	Terminate the bastion
add-proxy	Reverse-proxy a service publicly at <service>.<domain>
enable-https	Issue a Let's Encrypt wildcard certificate and terminate TLS on the bastion

Admin Service

Command	Description
launch-admin	Launch the Admin node (agent + admin server + discovery broker + InfluxDB/Grafana)
start-admin	Start the Admin node
stop-admin	Stop the Admin node
terminate-admin	Terminate the Admin node

Monitor Service

Command	Description
launch-monitor	Launch the Monitor node (Grafana)
start-monitor	Start the Monitor node
stop-monitor	Stop the Monitor node
terminate-monitor	Terminate the Monitor node

Message Brokers

Command	Description
launch-solace / start-solace / stop-solace / terminate-solace	Solace broker
launch-kafka / start-kafka / stop-kafka / terminate-kafka	Kafka broker
launch-amq / start-amq / stop-amq / terminate-amq	ActiveMQ (rumi-messaging) broker

Platform

Command	Description
launch-platform	Launch a standard platform (bastion, admin, monitor, solace)
start-platform	Start the platform
stop-platform	Stop the platform
terminate-platform	Terminate the platform

Instance Management

Command	Description
launch-instance	Launch a service (worker) instance
start-instance	Start a service instance
stop-instance	Stop a service instance
terminate-instance	Terminate a service instance
resize-instance	Resize a service instance to a new size
list-instances	List the instances in a network

Remote Execution

Command	Description
run-command	Run a shell command on a service instance
run-admin-script	Run an admin script against a deployed system

High-Level Lifecycle

Command	Description
provision	Provision a complete environment (network + platform)
deploy	Deploy a XAR system to an environment
configure	Add or update a controller config property
start	Start every instance in an environment
stop	Stop every instance in an environment
deprovision	Tear down an environment

Common Options

Most Civo commands support these common options:

Option	Short	Description	Default
--api-key	-k	The Civo API token (or set CIVO_API_TOKEN)	Required
--region	-r	The Civo region to operate in (e.g. FRA1)	Required
--network	-n	Name of the Rumi network / environment	Required
--keyPair	-K	The SSH key pair to launch with	Required for launches
--nowait	-o	Do not wait for the instance to reach its target state	false

Typical Workflow

# 1. Provision a complete environment (network + platform)
rumi cloud civo provision \
  --api-key $CIVO_API_TOKEN --region FRA1 --network my-cloud --keyPair rumi

# 2. Deploy your application
rumi cloud civo deploy \
  --api-key $CIVO_API_TOKEN --region FRA1 --network my-cloud --keyPair rumi \
  --xar ./my-app.xar

# 3. (optional) Terminate TLS on the bastion
rumi cloud civo enable-https \
  --api-key $CIVO_API_TOKEN --region FRA1 --network my-cloud --keyPair rumi \
  --domain example.com --dns-provider route53 --dns-credentials "AKIA...:wJalr...:us-east-1"

# 4. Stop when not in use (saves cost), then start again later
rumi cloud civo stop  --api-key $CIVO_API_TOKEN --region FRA1 --network my-cloud
rumi cloud civo start --api-key $CIVO_API_TOKEN --region FRA1 --network my-cloud

# 5. Tear it all down
rumi cloud civo deprovision \
  --api-key $CIVO_API_TOKEN --region FRA1 --network my-cloud --keyPair rumi

Getting Help

Use --help (or -h) on any command:

rumi cloud civo --help
rumi cloud civo provision --help
rumi cloud civo launch-instance --help

Related Documentation

• Cloud Commands - The standardized Rumi private cloud model

• Hetzner Commands - The equivalent commands on Hetzner Cloud

• AWS Commands - The equivalent commands on AWS

• Installation - Install the Rumi CLI