Documentation


Client Setup

As noted previously, a client program that wishes to launch a Gurobi Instant Cloud machine must pass credential information to the Instant Cloud Manager. Every Instant Cloud license has such credentials associated with it. This information is captured in a pair strings, an access ID and a secret key. These strings can be retrieved from your account on the Instant Cloud Manager. Note that you shouldn't share these credentials with others, since anyone who knows these two strings can launch Instant Cloud machines in your account.

Once you have the credentials associated with your license, there are two ways to configure your client program to use them. The simplest is to use a cloud license file. This is just like any other Gurobi license file, except that its fields are specific to the cloud. A cloud license file will contain two lines with credential information:

CLOUDACCESSID=312e9gef-e0bc-4114-b6fb-26ed7klaeff9
CLOUDKEY=ae32L0H321dgaL
It may also contain an optional third line:
CLOUDPOOL=pool1
We'll discuss cloud pools a bit later. You can download a gurobi.lic file containing this information from the Instant Cloud website, or you can create one yourself in a text editor. If you follow the standard process for setting up a Gurobi license file (refer to the Quick Start Guide for details), then Gurobi will automatically use the Instant Cloud rather than running locally.

The other option for passing credential information to the Instant Cloud Manager is to call a Gurobi API routine. The appropriate routine depends on your programming language. Our C and Python APIs have calls devoted to launching cloud servers. Our C++, Java, and .NET APIs each have a special GRBEnv constructor (look for the one that accepts an access ID and secret key in its argument list). In all cases, you pass the access ID and secret key to the method or constructor, and the method creates a Gurobi environment that you can use like any other Gurobi environment (to build, solve, and modify optimization models, to retrieve solutions, etc.).