Joulectl CLI

Use Joulectl to deploy and manage use cases within the Joule platform

Joulectl helps you deploy and manage use cases within the Joule platform. It uses a context configuration which connects to the desired Joule platform.

Installation

To install joulectl visit here.

Available Commands

Joulectl has a set of commands to support the deployment and management of use cases for both single node and cluster deployment:

• config

• deploy

• inspect

• list

• undeploy

• usecase

Running joulectl deploy --help will show further details on how to use the command:

$ joulectl --help
Usage: joulectl [OPTIONS] COMMAND [ARGS]...

  Joule deployment and management tool

  joulctl version 0.1.0

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  config    Configure tool setting.
  deploy    Deploy command for transports, streams and use cases.
  inspect   Get deployed specifications for transports, streams and use...
  list      List deployed transports, streams and use cases.
  undeploy  Undeploy command for transports, streams and use cases.
  usecase   Management command for use cases

Configure Command

Joulectl can be configured to execute commands against a cluster or single node. To configure the tool the joulectl config command is used.

$ joulectl config --help
Usage: joulectl config [OPTIONS] COMMAND [ARGS]...

  Configure joulectl setting.

Options:
  --help  Show this message and exit.

Commands:
  create  Create a new configuration file.
  show    Show configuration setting
  update  Update configuration setting

create

On first usage of the tool a configuration file must be created. A config.json file will created using default setting under the ~/.config/joule directory.

$ joulectl config create
Configuration created.

update

To change the host address and port using the update command.

$ joulectl config update 192.168.1.10:60110
Joule host set to '192.168.1.10:60110'.

show

Display the current configuration setting.

$ joulectl config show         
Key         Configuration
----------  ---------------------------
joule_dir   /Users/joule/.config/joule
joule_host  localhost:60110