Jump to: navigation, search

Fuel CLI

Understanding Environment deployment with Fuel CLI


Fuel CLI tool is a powerful tool that allows you to:

  • Operate with environments using the text console only.
  • Modify directly the internal data that you can't modify via the web UI.
  • Avoid data verifications done by the web UI logic.

Fuel CLI may break your environment if not used carefully.

Basic usage

Fuel CLI has the following usage pattern:

fuel [global optional args] <namespace> [action] <optional args>


fuel --env-id=1 node set --node-id=1,4,5 --role=controller

where --env-id=1 is a global optional argument pointing to the specific environment, node - is a namespace for all node control functions, set is an action that assigns specific nodes to some environments in certain roles.

for getting list of all global optional args and namespaces you can run: :

fuel --help

and for getting actions and optional args for some namespace run: :

fuel <namespace> --help

CLI commands reference


Get list of all available releases:

fuel release

or short version

fuel rel

for specific release

fuel rel --rel 1


To list environments:

fuel env

To create an environment, run:

fuel env create --name MyEnv --rel 1 

By default it creates environment in multinode mode, and nova network mode. To specify other modes, you can add optional arguments; for example:

fuel env create --name MyEnv --rel 1 --mode ha --network-mode neutron --net-segment-type vlan

Use the set action to change the name, mode, or network mode for the environment; for example:

fuel --env 1 env set --name NewEmvName --mode ha_compact

To delete the environment:

fuel --env 1 env delete


To list all available nodes run:

fuel node list

and filter them by environment

fuel --env-id 1 node list

Assign some nodes to environment with with specific roles

fuel node set --node 1 --role controller --env 1
fuel node set --node 2,3,4 --role compute,cinder --env 1

Remove some nodes from environment

fuel node remove --node 2,3 --env 1

Also you can do it without --env or --node to remove some nodes without knowing their environment and remove all nodes of some environment respectively.

fuel node remove --node 2,3
fuel node remove --env 1


Configuration of environment or some node is universal and done in three stages

  1. Download current or default configuration. works for (network, settings, node --disk, node --network). Operations with deployment and provisioning can be node specific. (e.g. fuel --env 1 deployment --node-id=1,2)


fuel --env 1 network download
fuel --env 1 settings download
fuel --env 1 deployment default
fuel --env 1 provisioning download
fuel node --node-id 2 --disk --download
  1. Add to downloaded files or edit them with your favorite text editor.
  2. Upload files to nailgun server


fuel --env 1 provisioning upload
fuel node --node-id 2 --disk --upload
note: To protect yourself from sudden errors, please follow these simple rules:
 * Back up all of your configuration before you begin any modifications.
 * If you remove something from a configuration file, be sure you don't need it. Fuel CLI doesn't merge new data with the existing - it will overwrite the old data with the new.
 * Keep in mind that if you upload any changes in provisioning or deployment operations, you will freeze the entire environment configuration - any changes with networks, cluster settings, or disk configurations won't take effect. In order to modify such parameters, you will need to change the appropriate section of each node configuration.


Finally you can deploying environment changes with

fuel --env 1 deploy-changes

Also, you can deploy and provision only some nodes like this

fuel --env 1 node --provision --node 1,2
fuel --env 1 node --deploy --node 1,2