The Cloudbreak Shell is an interactive command line tool which supports:
- All functionality available through the REST API or Cloudbreak web UI
- Complete automation of management tasks via scripts
- Context-aware commands
- Required/optional parameters
- Tab completion
- The hint command that guides you when you need help
Install and Start Cloudbreak Shell
Install Cloudbreak shell using one of the following options:
- Install Cloudbreak Shell Using Cloudreak Deployer (Recommended)
- Use Our Prepared Docker Image
- Build From Source
Install Cloudbreak Shell Using Cloudbreak Deployer
Start the shell with
cbd util cloudbreak-shell. This will launch the Cloudbreak shell inside a Docker container, and you can start using it.
Use Our Prepared Docker image
You can find the docker image and its documentation here.
Build from Source
If want to use the code or extend it with new commands, follow the steps below.
Prerequisites: JDK 1.8.
Execute the folowing commands:
git clone https://github.com/sequenceiq/cloudbreak.git cd cloudbreak/shell ../gradlew clean build
Note: If you use the hosted version of Cloudbreak, use
latest-release.shto get the right version of the CLI.
Start Cloudbreak-shell from the build source using:
Usage: java -jar cloudbreak-shell-0.5-SNAPSHOT.jar : Starts Cloudbreak Shell in interactive mode. java -jar cloudbreak-shell-0.5-SNAPSHOT.jar --cmdfile=<FILE> : Cloudbreak executes commands read from the file. Options: --cloudbreak.address=<http[s]://HOSTNAME:PORT> Address of the Cloudbreak Server [default: https://cloudbreak-api.sequenceiq.com]. --identity.address=<http[s]://HOSTNAME:PORT> Address of the SequenceIQ identity server [default: https://identity.sequenceiq.com]. --sequenceiq.user=<USER> Username of the SequenceIQ user [default: firstname.lastname@example.org]. --sequenceiq.password=<PASSWORD> Password of the SequenceIQ user [default: password].
Note: You should specify at least your username and password.
Once you are connected, you can create a cluster. Use
hint if you get lost or need guidance through the process. Use TAB for completion.
Note: All commands are context-aware, which means that they are available only when they are relevant. This way the system guides you nad keeps you on the right path.
Connect Cloudbreak Shell with a Remote Cloudbreak Instance
Prerequisites: Docker is installed and running on the local machine
cbd util cloudbreak-shell-remoteon the remote host.
- Execute the result of the previous command on the local machine.
For complete documentation of the Cloudbreak shell, see Cloudbreak github repository.
For Provider-specific Documentation, see:Edit on GitHub