---

Installation

Install

Roadie’s compiled binary files for some platforms are found in GitHub’s release page. Download one of them according to your environment and put the binary into a directory in your $PATH, or put it as same directory as your current project.

If you’re a Homebrew or Linuxbrew user, you can install Roadie by the following commands:

$ brew tap jkawamoto/roadie
$ brew install roadie

Initialization

The following command initializes Roadie:

$ roadie init

Since Roadie currently supports the following cloud services,

• Google Cloud Platform,
• Microsoft Azure,

the initialization command asks which cloud service you will use first.

Then you need to tell Roadie some information depended on cloud services.

Google Cloud Platform

Google Cloud Platform manages resources based on project, and Roadie needs to know which project it will work with. After choosing Google Cloud Platform in the initialization, Roadie asks a project ID.

You can find available project IDs in the cloud console.

Note that, Roadie requires a project ID, not project name.

After entering a project ID, Roadie starts authorization process and shows a URL. You need to open the URL by a web browser on the same computer Roadie running and grant permission.

Roadie then creates configuration file roadie.yml in the current directory. Roadie has other configurations, see configuration page for detailed information.

Microsoft Azure

In Microsoft Azure, each user account belongs to an Active Directory, which is identified by a tenant ID, and each user has several subscriptions. Roadie hence needs to know both tenant ID and subscription ID.

To find your tenant ID, open Azure Active Directory tab in the portal site.

Then, open Properties tab. The directory ID in the tab is the your tenant ID.

To find your subscription IDs, open Cost Management + Billing in the portal site.

In Overview tab, there is a list of your subscriptions.

Roadie also uses project ID to manage resources. This ID must be unique in the world and can have lower alphabets and numbers, but you can use any ID.

After entering a tenant ID, subscription ID, and project ID, Roadie starts authorization process. It shows a URL and a pass code. You need to open the URL by a web browser and enter the code.

Roadie then creates configuration file roadie.yml in the current directory. Roadie has other configurations, see configuration page for detailed information.