diff --git a/pages/user-guide/cli.rst b/pages/user-guide/cli.rst index 5713b9347..f26a22bce 100644 --- a/pages/user-guide/cli.rst +++ b/pages/user-guide/cli.rst @@ -14,19 +14,23 @@ Basic usage Fuel CLI has following usage pattern: +:: + fuel [global optional args] [action] -Example: +*Example*:: fuel --env-id=1 node set --node-id=1,4,5 --role=controller,compute where ``--env-id=1`` is global optional argument pointing to specific environment, ``node`` - is a namespace for all node control functions, ``set`` is action that assigns specific nodes to some environments in some 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 --help @@ -38,14 +42,20 @@ Release Get list of all avaliable releases: +:: + fuel release or short version +:: + fuel rel for specific release +:: + fuel rel --rel 1 @@ -54,22 +64,32 @@ Environment 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 +:: + fuel env create --name MyEnv --rel 1 --mode ha --network-mode neutron For changing environments name, mode or network mode exists ``set`` action - + +:: + fuel --env 1 env set --name NewEmvName --mode ha_compact To delete the environment: - + +:: + fuel --env 1 env delete @@ -77,24 +97,34 @@ Node ++++ To list all available nodes run: - + +:: + fuel node list and filter them by environment - + +:: + fuel --env-id 1 node list Assign some nodes to environemnt 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 respectevly. - + +:: + fuel node remove --node 2,3 fuel node remove --env 1 @@ -105,17 +135,21 @@ Configuration of environment or some node is universal and done in three stages 1. Download current or default configuration. works for (network, settings, deployment, provisioning, node --disk, node --network) - 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 +*Example*:: -2. Add or edit downloaded files with your favorite text editor. + 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 + +2. Add to downloaded files or edit them with your favorite text editor. 3. Upload files to nailgun server - - fuel --env 1 provisioning upload - fuel node --node-id 2 --disk --upload + +*Example*:: + + fuel --env 1 provisioning upload + fuel node --node-id 2 --disk --upload Deployment