local

The rumi cloud local commands provision and manage a Docker-based Rumi private cloud on your local machine.

Overview

The local environment provides a complete Rumi private cloud running in Docker containers. This private cloud has the exact same structure as production private clouds deployed to AWS, Civo, bare metal, or other infrastructure - just containerized locally.

Private Cloud Components

• Admin - Administrative interface and deployment management

• Agent - Monitoring and management agent

• Monitor - Observability dashboards and metrics

• Message Broker - Solace, Kafka, or ActiveMQ

• Platform Modules - Core Rumi runtime services

• Application Services - Your deployed Rumi microservices

Key Concept: By developing locally, you're working with the same standardized private cloud architecture used in production, ensuring your applications will behave identically when deployed to other environments.

Commands

Environment Management

Command	Description
provision	Provision the local private cloud environment
start	Start all services
stop	Stop all services
deprovision	Remove the environment

Admin Module

Command	Description
launch-admin	Provision and start the admin module
start-admin	Start the admin module
stop-admin	Stop the admin module
terminate-admin	Remove the admin module
run-admin-script	Execute an admin script

Monitor Module

Command	Description
launch-monitor	Provision and start the monitor module
start-monitor	Start the monitor module
stop-monitor	Stop the monitor module
terminate-monitor	Remove the monitor module

Message Brokers

Command	Description
launch-solace	Provision and start Solace
start-solace	Start Solace
stop-solace	Stop Solace
terminate-solace	Remove Solace
launch-kafka	Provision and start Kafka
start-kafka	Start Kafka
stop-kafka	Stop Kafka
terminate-kafka	Remove Kafka
launch-amq	Provision and start ActiveMQ
start-amq	Start ActiveMQ
stop-amq	Stop ActiveMQ
terminate-amq	Remove ActiveMQ

Platform Modules

Command	Description
launch-platform	Provision and start platform modules
start-platform	Start platform modules
stop-platform	Stop platform modules
terminate-platform	Remove platform modules

Service Instances

Command	Description
launch-instance	Provision and start a service instance
start-instance	Start a service instance
stop-instance	Stop a service instance
terminate-instance	Remove a service instance
list-instances	List all containers
run-command	Execute a command on a container

Deployment

Command	Description
deploy	Deploy a Rumi application
configure	Update configuration

Prerequisites

Before using local cloud commands:

1. Docker Desktop must be installed and running

2. Sufficient resources: 8GB+ RAM, 20GB+ disk space

3. Network ports: Ensure required ports are available

See Installation for Docker setup instructions.

Typical Workflow

# 1. Provision environment with a message broker
rumi cloud local provision --message-broker activemq

# 2. Deploy your application
rumi cloud local deploy --xar my-app.xar

# 3. Start everything
rumi cloud local start

# 4. Stop when done
rumi cloud local stop

# 5. Clean up
rumi cloud local deprovision

Related Documentation

• Installation - Install the Rumi CLI and Docker

• Quickstart - Generate applications to deploy

• AWS Commands - Deploy to AWS