Documentation

Next: Overview

Gurobi Remote Services

Gurobi Remote Services is a set of Gurobi features that enables a cluster of one or more machines to perform Gurobi computations on behalf of other machines. The key components of Remote Services are:

• Compute Server, which allows you to offload all Gurobi computations from a client machine onto a remote cluster.
• Distributed Workers, which can be used to perform parallel computation on multiple machines.
• The Cluster Manager, a new (optional) application server that provides secured access to your Remote Services cluster, as well as providing a Web User Interface and a command-line tool that make it easier to manage and monitor your cluster.

This document is organized into a number of sections. The first section provides an overview of Gurobi Compute Server and Remote Services. The next section, meant for system administrators, provides details on setting up Remote Services. The next sections provide details on using Remote Services and programming with Remote Services. Finally, we discuss using Remote Services with Gurobi Instant Cloud.

• Overview
  • Client-Server Optimization
    • Client API
    • Queuing and Load Balancing
    • Cluster Manager
    • Interactive and Non-Interactive Optimization
    • Distributed Algorithms
  • Architecture
    • Architecture Topologies
  • Security
    • User Roles
    • Authentication
    • Password Policy
    • LDAP Integration
    • Encryption
    • Security in a Self-Managed Cluster
  • Simple Example
    • Log In to the Cluster
    • Submitting an Interactive Job
    • Submitting a Non-Interactive Job
  
  
• Cluster Setup and Administration
  • Quick Cluster Manager Installation
  • Installing the Remote Services Package
    • Linux Installation
    • macOS Installation
    • Windows Installation
  • Installing a Cluster Manager
    • Installing the Database
    • Cluster Manager Server (grb_rsm)
    • Configuring the Cluster Manager
    • Starting the Cluster Manager as a Process
    • Starting the Cluster Manager as a Service
    • Verification
  • Installing a Cluster Node
    • Licensing
    • Remote Services Agent (grb_rs)
    • Configuring a Cluster Node
    • Starting a Cluster Node as a Process
    • Starting a Cluster Node as a Service
    • Verification
  • Forming a Cluster
    • Connecting Nodes
    • Compute Servers and Distributed Workers
    • Grouping
    • Processing State and Scaling
  • Communication Options
    • Enabling HTTPS
    • Using HTTPS with Self-Signed Certificates
    • Firewalls
    • Using a Router without a Cluster Manager
  • Upgrading an Existing Installation
  
  
• Using Remote Services
  • Client Configuration
    • Client License File
    • Generating a Client License with grbcluster
    • Queueing, Load Balancing, and Job Priorities
  • Job Commands
    • Submitting Interactive Jobs
    • Listing Jobs
    • Accessing Job Logs
    • Accessing Job Parameters
    • Aborting Jobs
    • Accessing the Job History
  • Batch Commands
    • Creating Batches
    • Listing Batches
    • Aborting Batches
    • Retrying Batches
    • Discarding Batches
  • Repository Commands
    • Uploading a File to the Repository
    • Using a File from the Repository
    • Deleting a File from the Repository
  • Node Commands
    • Listing Cluster Nodes
    • Troubleshooting Connectivity Issues
    • Listing Cluster Licenses
    • Changing the Job Limit
  • Distributed Algorithms
    • Distributed Workers and the Distributed Manager
    • Configuration
    • Running a Distributed Algorithm as an Interactive Job
    • Submitting a Distributed Algorithm as a Batch
    • Using a Separate Distributed Manager
  
  
• Programming with Remote Services
  • Using an API to Create a Compute Server Job
  • Using an API to Create a Batch
  • Performance Considerations on a Wide-Area Network (WAN)
  • Callbacks
  • Developing for Compute Server
  • Distributed Algorithm Considerations
  • Cluster REST API
  
  
• Using Remote Services with Gurobi Instant Cloud
  • Client Setup
  • Client Commands
  • Region Router
  
  
• Appendix A: grb_rs
• Appendix B: grb_rs - Configuration Properties
• Appendix C: grb_rsm
• Appendix D: grb_rsm - Configuration Properties
• Appendix E: grbcluster
• Appendix F: gurobi_cl
• Appendix G: Acknowledgement of 3rd Party Icons
• Appendix H: Open Source Component Licenses

---

Next: Overview