What is the Command Line Interface?

The Hortonworks Data Cloud Command Line Interface (CLI) is a tool to help you manage your Hortonworks Data Cloud cluster instances. This tool can be used to interact with the cloud controller for automating cluster creation and termination.

Installing

After you have launched your cloud controller, the CLI is available for download from that cloud controller instance.

  1. Browse to your cloud controller instance and log in. For example: https://ec2-11-111-111-11.compute-1.amazonaws.com/

  2. From the controller UI navigation menu, select DOWNLOAD CLI. The CLI is available for Linux, Mac OS X and Windows.

  3. Select the bundle and download it to your local machine. Extract the bundle:
    tar xvf hdc-cli_Linux_x86_64.tgz.

  4. Run the executable to verify the CLI:
    hdc --version

  5. You can optionally add hdc to your system path.

Configuring

Once you have installed the CLI, you need to configure the CLI to work with your cloud controller.

  1. Use the hdc configure command to set up the CLI configuration file. The configuration options are:

    • --server server address [$CB_SERVER_ADDRESS]
    • --username user name (e-mail address) [$CB_USER_NAME]
    • --password password [$CB_PASSWORD]

    The password configuration is optional. If you do not provide the password, no password is stored in the CLI configuration file. Therefore, you will need to provide the password with each command you execute or via an environment variable.

  2. The CLI configuration file will be saved at ~/.hdc/config.

Configuration Precedence

The CLI can look for configuration options from different locations. You can optionally pass the configuration options on each command or from environment variables. The following order is used for the CLI to look for configuration options: Command Line, Environment Variables and the Configuration File.