Skip to main content

CloudRift App & CLI

CloudRift desktop app is a desktop application that allows you to run workloads on your own machines.

Sign Up​

To start using CloudRift please sign-up at cloudrift.ai.

Install CloudRift Desktop App​

1. Run the installer​

Install CloudRift desktop application onto the machine you want to use to run jobs. Use CloudRift CLI to schedule jobs.

Loading...

2. Configure credentials​

Configure credentials using CloudRift command line tool by running

rift configure

You can also configure credentials using CloudRift desktop app. To configure credentials, launch the app, right-click on the tray icon and click change credentials.

Lastly, you can edit the config manually. Location depends on your operating system.

%APPDATA%\Roaming\CloudRift\credentials.yml

3. Install Docker​

Install Docker if you're planning to use containers. Note that only Docker engine is required, desktop app is optional.

info

CloudRift needs to communicate with Docker engine. On Windows this is done via tcp connection. In Docker Settings -> General, ensure that "Expose daemon on tcp://localhost:2375 without TLS" is checked.

Using CloudRift​

1. Inspect the cluster​

Once you've authenticated and launched the client it is time to inspect the cluster. Use rift cluster info command for this purpose. Ensure that you see details of all the machines that you have launched CloudRift desktop application on.

rift cluster info

If cluster is empty, it means that no providers are running. You can start a provider on a machine using rift-desktop command:

rift-desktop

Afterward rift cluster info command should show that you have at least one node in the cluster.

2. Run your first job​

To run the task on the cluster you can leverage rift docker run command:

rift docker run alpine echo "Hello CloudRift"

If you need to see more details about program execution, pass -vv flag.