Skip to main content

Accessing LH Cloud Orchestrator

In order to access LittleHorse Cloud, you need to purchase a cluster or request a sandbox from LittleHorse Enterprises LLC. You can do so by contacting sales@littlehorse.io.

tip

If you want to get started quickly, you can try LittleHorse using our open-source lh-standalone image according to our open-source documentation.

When you are given access to LittleHorse, you will receive the following:

  • A OnePassword note containing the LHC_CLIENT_ID and LHC_CLIENT_SECRET configurations.
  • A OnePassword note containing credentials to log in to the dashboard.
  • The LHC_API_HOST configuration.
  • The LHC_OAUTH_SERVER_URL configuration.
  • The
  • A URL to access the Dashboard.
  • For sandbox trials only: the LHC_TENANT_ID configuration.

Configuring lhctl Access​

First, you need to install lhctl, which is the command-line interface for LittleHorse. You can do so using homebrew, go install, or our GitHub Release page.

Installation via Homebrew is compatible with Mac and Linux.

brew install littlehorse-enterprises/lh/lhctl

Once you have lhctl installed, it's time to configure it. Create a file ~/.config/littlehorse.config (or ${HOME}\.config\littlehorse.config in Windows) as follows:

LHC_API_PROTOCOL=TLS
LHC_OAUTH_CLIENT_ID=lhctl
LHC_API_PORT=2023

LHC_API_HOST=<LHC_API_HOST>  # replace me!
LHC_OAUTH_SERVER_URL=<LHC_OAUTH_SERVER_URL>  # replace me!
LHC_TENANT_ID=<LHC_TENANT_ID>  # replace me!

Once everything is configured, you need to log in:

lhctl login

It will redirect you to our auth server. Log in with the user from one password. Once that's done, you should be able to access the LittleHorse server via the CLI. Some commands you can try out:

  • lhctl whoami
  • lhctl search wfSpec

Accessing the Dashboard​

LittleHorse Enterprises will provide you with a URL on which you can access the LittleHorse Orchestrator Dashboard, and with the necessary credentials.

Configuring Programmatic Access​

You'll need to create an LHConfig with the following values:

LHC_API_PORT=2023
LHC_API_PROTOCOL=TLS

LHC_API_HOST=<LHC_API_HOST>  replace me!

LHC_OAUTH_CLIENT_ID=<LHC_CLIENT_ID>  # replace me!
LHC_OAUTH_CLIENT_SECRET=<LHC_CLIENT_SECRET>  # replace me!
LHC_OAUTH_ACCESS_TOKEN_URL=<LHC_OAUTH_ACCESS_TOKEN_URL>  # replace me!

LHC_TENANT_ID=<LHC_TENANT_ID>  # replace me!

As described in our documentation, there are three ways to pass those values into the LHConfig:

  1. recommended: setting the values as environment variables.
  2. Saving the values in a Properties file and passing that file location into the LHConfig constructor.
  3. Passing a map or dict or Properties (depending on which language) into the LHConfig constructor or initializer.