[UG] [CLI] Consolidated Fuel CLIs v1 and v2
This patch: - adds a deprecation note for Fuel CLI v1 to the Fuel CLI section of the Fuel User Guide; - adds a table with consolidated fuel and fuel2 commands; - fixes noticed typos and formatting discrepancies. Change-Id: Ibb005e3ecc4d094229f9b7c951a92fe9e5d6574e Closes-Bug: #1608883 Closes-Bug: #1609815 Closes-Bug: #1619200 Closes-Bug: #1618873 Closes-Bug: #1618456 Closes-Bug: #1612611 Closes-Bug: #1612609 Closes-Bug: #1611835 Closes-Bug: #1612148 Closes-Bug: #1612151 Closes-Bug: #1612218 Closes-Bug: #1612610 Closes-Bug: #1612606 Closes-Bug: #1612607 Closes-Bug: #1612227 Closes-Bug: #1621807 Closes-Bug: #1621838 Closes-Bug: #1623595 Closes-Bug: #1612608 Closes-Bug: #1619290 Closes-Bug: #1612598 Closes-Bug: #1624044
This commit is contained in:
Olena Logvinova
parent
9ccbd1ad6f
commit
87b50fe406
|
|
@ -16,7 +16,7 @@ when you install Fuel. Using the Fuel CLI you can:
|
|||
your environment if not used carefully.
|
||||
|
||||
Modifications that you make using the Fuel CLI take precedence over the
|
||||
settings applied from the Fuel Web UI. If a change has been applied using
|
||||
settings applied from the Fuel web UI. If a change has been applied using
|
||||
the Fuel CLI, Fuel displays the corresponding message in the Fuel web UI.
|
||||
|
||||
This section includes the following topics:
|
||||
|
|
@ -24,6 +24,7 @@ This section includes the following topics:
|
|||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
cli/cli_comparison_matrix.rst
|
||||
cli/cli_acronyms.rst
|
||||
cli/cli_basic_usage.rst
|
||||
cli/cli_client_config_file.rst
|
||||
|
|
|
|||
|
|
@ -1,26 +1,23 @@
|
|||
|
||||
.. _cli-acronyms:
|
||||
|
||||
|
||||
===========================================
|
||||
Interpretation of acronyms in Fuel commands
|
||||
-------------------------------------------
|
||||
===========================================
|
||||
|
||||
CLI commands contain a number
|
||||
of acronyms.
|
||||
For better understanding of those,
|
||||
see the example command output below.
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
Fuel CLI commands contain a number of acronyms. For a better understanding of
|
||||
those, see the example command output below.
|
||||
|
||||
.. note:: Nailgun populates the database
|
||||
with hardware configuration information
|
||||
about all the managed nodes it discovers
|
||||
as well as the configuration and status of each node.
|
||||
|
||||
The ``fuel node list`` command is used on the Fuel Master node
|
||||
to list out the current information about the nodes
|
||||
for the environment:
|
||||
The :command:`fuel node list` command is used on the Fuel Master node to list out
|
||||
the current information about the nodes for the environment:
|
||||
|
||||
::
|
||||
.. code-block:: console
|
||||
|
||||
[root@fuel ~]# fuel nodes
|
||||
|
||||
|
|
@ -87,13 +84,12 @@ The meaning of these fields is:
|
|||
The following two columns appear at the right end of this display;
|
||||
they are not shown here:
|
||||
|
||||
:pending_roles: Before deployment, lists the roles that have been assigned to this node.
|
||||
When deployment is complete,
|
||||
the contents of this field are moved to the **roles** column
|
||||
:pending_roles: Before deployment, lists the roles that have been assigned
|
||||
to this node. When deployment is complete, the contents
|
||||
of this field are moved to the **roles** column.
|
||||
|
||||
For Release 6.x and later,
|
||||
this field can also contain the **primary** value
|
||||
to indicate that this node is the Primary Controller node.
|
||||
This field can also contain the **primary** value
|
||||
to indicate that this node is the primary controller node.
|
||||
The **primary** value is persisted in the database
|
||||
through the use of the **has_primary** field
|
||||
in the ``openstack.yaml`` file.
|
||||
|
|
@ -106,7 +102,5 @@ they are not shown here:
|
|||
|
||||
:group_id: The group node identifier.
|
||||
When you assign roles to your target nodes,
|
||||
Fuel tries to automatically determine the node's group based on the DHCP address.
|
||||
|
||||
|
||||
|
||||
Fuel tries to automatically determine the node's group based on
|
||||
the DHCP address.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli_basic_usage:
|
||||
|
||||
===========
|
||||
Basic usage
|
||||
-----------
|
||||
===========
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
Use the following usage pattern for Fuel commands:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,10 @@
|
|||
|
||||
.. _cli_change_ip_range:
|
||||
|
||||
|
||||
==================
|
||||
Add network ranges
|
||||
------------------
|
||||
==================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
To add network ranges, edit the network configuration file:
|
||||
add the IP network range to ``ip_ranges`` and change
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-client-config-file:
|
||||
|
||||
======================================
|
||||
Modify the Fuel CLI configuration file
|
||||
--------------------------------------
|
||||
======================================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The Fuel CLI uses the ``fuel_client.yaml`` file as a source for default
|
||||
settings. By default, Fuel stores the ``fuel_client.yaml`` file in the
|
||||
|
|
|
|||
|
|
@ -0,0 +1,117 @@
|
|||
.. _cli_comparison_matrix:
|
||||
|
||||
===================================
|
||||
Fuel CLI commands comparison matrix
|
||||
===================================
|
||||
|
||||
The Fuel command-line interface has been changed to simplify usage and
|
||||
improve user experience. In most of the Fuel CLI commands, the word ``fuel``
|
||||
has been removed. Some of the keys and options have been modified as well.
|
||||
The following table describes new Fuel commands and their old alternatives.
|
||||
|
||||
.. csv-table:: **Fuel CLI commands comparison matrix**
|
||||
:header: Command, Description, Old ``fuel`` alternative
|
||||
:widths: 8, 8, 6
|
||||
|
||||
``complete``, Print the completion of a command in CLI, None
|
||||
``help``, Print a detailed help for all commands, ``fuel <cmd> --help``
|
||||
``env add nodes``, Add nodes to an environment with specified roles, ``fuel node --set``
|
||||
``env create``, Create an environment with given attributes, ``fuel env --create``
|
||||
``env delete``, Delete an environment with a given ID, ``fuel env --delete``
|
||||
``env deploy``, Deploy changes on a specified environment, ``fuel deploy-changes``
|
||||
``env deployment-facts delete``, Delete current deployment facts, ``fuel deployment --delete``
|
||||
``env deployment-facts download``, Download the user-defined deployment facts, ``fuel deployment --download``
|
||||
``env deployment-facts get-default``, Download the default deployment facts, ``fuel deployment --default``
|
||||
``env deployment-facts upload``, Upload deployment facts, ``fuel deployment --upload``
|
||||
``env extension disable``, Disable specified extensions for an environment with a given ID, None
|
||||
``env extension enable``, Enable specified extensions for an environment with a given ID, None
|
||||
``env extension list``, Show a list of all available extensions, None
|
||||
``env extension show``, Show a list of enabled extensions for an environment with a given ID, None
|
||||
``env list``, Show a list of all available environments, ``fuel env``
|
||||
``env network download``, Download and store network configuration of an environment, ``fuel network --download``
|
||||
``env network upload``, Upload network configuration and apply it to an environment, ``fuel network --upload``
|
||||
``env network verify``, Run network verification for a specified environment, ``fuel network --verify``
|
||||
``env nodes deploy``, Deploy specified nodes for a specified environment, ``fuel node --deploy``
|
||||
``env nodes provision``, Provision specified nodes for a specified environment, ``fuel node --provision``
|
||||
``env provisioning-facts delete``, Delete current provisioning facts, ``fuel provisioning --delete``
|
||||
``env provisioning-facts download``, Download the user-defined provisioning facts, ``fuel provisioning --download``
|
||||
``env provisioning-facts get-default``, Download the default provisioning facts, ``fuel provisioning --default``
|
||||
``env provisioning-facts upload``, Upload provisioning facts, ``fuel provisioning --upload``
|
||||
``env redeploy``, Redeploy changes on a specified environment, ``fuel redeploy-changes``
|
||||
``env remove nodes``, Remove nodes from an environment, ``fuel node remove``
|
||||
``env reset``, Reset a deployed environment, ``fuel reset``
|
||||
``env settings download``, Download and store an environment settings, ``fuel settings --download``
|
||||
``env settings upload``, Upload and apply an environment settings, ``fuel settings --upload``
|
||||
``env show``, Show information about environment with a given ID, None
|
||||
``env spawn-vms``, Provision a specified environment, None
|
||||
``env stop-deployment``, Stop deployment process for a specific environment, ``fuel stop``
|
||||
``env update``, Change given attributes for an environment, ``fuel env --set``
|
||||
``fuel-version``, Show the current version of Fuel, ``fuel --fuel-version``
|
||||
``graph download``, Download a deployment graph configuration, ``fuel env --deployment-tasks --download``
|
||||
``graph execute``, Start a deployment with a given graph type, None
|
||||
``graph list``, List deployment graphs, None
|
||||
``graph upload``, Upload a deployment graph configuration, ``fuel env --deployment-tasks --upload``
|
||||
``network-group create``, Create a new network group, ``fuel network-group --create``
|
||||
``network-group delete``, Delete a specified network group, ``fuel network-group --delete``
|
||||
``network-group list``, List all network groups, ``fuel network-group``
|
||||
``network-group show``, Show a network group, None
|
||||
``network-group update``, Set parameters for a specified network group, ``fuel network-group --set``
|
||||
``network-template delete``, Delete the network template of a specified environment, ``fuel network-template --delete``
|
||||
``network-template download``, Download the network configuration for a specified environment, ``fuel network-template --download``
|
||||
``network-template upload``, Upload the network configuration for a specified environment, ``fuel network-template --upload``
|
||||
``node ansible-inventory``, Generate an ansible inventory file based on the nodes list, None
|
||||
``node attributes-download``, Download a node attributes, None
|
||||
``node attributes-upload``, Upload a node attributes, None
|
||||
``node create-vms-conf``, Create the VMs configuration in metadata for a specified node, None
|
||||
``node disks download``, Download and store configuration of disks for a node to a file, ``fuel node --disk --download``
|
||||
``node disks get-default``, Download the default configuration of disks for a node to a file, ``fuel node --disk --default``
|
||||
``node disks upload``, Upload a stored configuration of disks for a node from a file, ``fuel node --disk --upload``
|
||||
``node interfaces download``, Download and store a configuration of interfaces for a node to a file, ``fuel node --network --download``
|
||||
``node interfaces get-default``, Download the default configuration of interfaces for a node to a file, ``fuel node --network --default``
|
||||
``node interfaces upload``, Upload the stored configuration of interfaces for a node from a file, ``fuel node --network --download``
|
||||
``node label delete``, Delete specific labels on nodes, None
|
||||
``node label list``, Show a list of all labels, None
|
||||
``node label set``, Create or update specific labels on nodes, None
|
||||
``node list``, Show list of all available nodes, ``fuel node``
|
||||
``node list-vms-conf``, Show a list VMs for a node, None
|
||||
``node show``, Show information about a node with a given ID, None
|
||||
``node undiscover``, Remove nodes from a database, ``fuel node --delete-from-db``
|
||||
``node update``, Change a node name and/or host name, ``fuel node --name <NEW_NAME>`` and/or ``fuel node --hostname <NEW_HOSTNAME>``
|
||||
``openstack-config delete``, Delete an OpenStack configuration with a given ID, ``fuel openstack-config --delete``
|
||||
``openstack-config download``, Download a specified OpenStack configuration file, ``fuel openstack-config --download``
|
||||
``openstack-config execute``, Execute an OpenStack configuration deployment, ``fuel openstack-config --execute``
|
||||
``openstack-config list``, List all OpenStack configurations, ``fuel openstack-config --list``
|
||||
``openstack-config upload``, Upload a new OpenStack configuration from file, ``fuel openstack-config --upload``
|
||||
``plugins list``, Show a list of all available plugins, ``fuel plugins --list``
|
||||
``plugins sync``, Synchronize plugins on a file system with plugins in the API service, ``fuel plugins --sync``
|
||||
``release component list``, Show a list of components for a given release, None
|
||||
``release list``, Show a list of all available releases, ``fuel release``
|
||||
``release repos list``, Show repositories for a given release, None
|
||||
``release repos update``, Update repositories for a given release, None
|
||||
``role create``, Create a role from a file description, ``fuel role --rel 1 --create``
|
||||
``role delete``, Delete a role from an OpenStack release, ``fuel role --delete``
|
||||
``role download``, Download a full role description to a file, ``fuel role --file``
|
||||
``role list``, Show a list of all available roles for a release, ``fuel role``
|
||||
``role update``, Update a role description from a file, ``fuel role --update``
|
||||
``sequence create``, Create a new deployment sequence, None
|
||||
``sequence upload``, Upload a new deployment sequence, None
|
||||
``sequence download``, Download a deployment sequence data, None
|
||||
``sequence delete``, Delete an existing sequence, None
|
||||
``sequence update``, Update an existing sequence, None
|
||||
``sequence list``, Show a list of all existing sequences, None
|
||||
``sequence show``, Display information about a sequence, None
|
||||
``sequence execute``, Execute a sequence on a specified environment, None
|
||||
``snapshot create``, Generate a diagnostic snapshot, ``fuel snapshot``
|
||||
``snapshot create -c/--config``, Generate a diagnostic snapshot with a custom configuration, ``fuel snapshot < config_file.yml``
|
||||
``snapshot get-default-config``, Download the default configuration to generate a custom diagnostic snapshot, ``fuel snapshot --conf > config_file.yml``
|
||||
``snapshot get-link``, Show the link to download diagnostic snapshot, None
|
||||
``task delete``, Delete a task with a given ID, ``fuel task --delete``
|
||||
``task deployment-info download``, Save a task deployment information to a file, None
|
||||
``task history show``, Show a deployment history about a task with a given ID, None
|
||||
``task list``, Show a list of all available tasks, None
|
||||
``task network-configuration download``, Save a task network configuration to a file, None
|
||||
``task settings download``, Download and save a task settings to a file, None
|
||||
``task show``, Show information about a task with a given ID, None
|
||||
``vip create``, Create a VIP, ``fuel vip --create``
|
||||
``vip download``, Download a configuration of VIPs, ``fuel vip --download``
|
||||
``vip upload``, Upload a new configuration of VIPs from a file, ``fuel vip --upload``
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-config-openstack-services:
|
||||
|
||||
==================================================
|
||||
Modify the configuration of the OpenStack services
|
||||
--------------------------------------------------
|
||||
==================================================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
You can customize the hardcoded, or provided by Nailgun,
|
||||
configuration values, as well as introduce new configuration options
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
Deployment commands
|
||||
===================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes the usage of the :command:`fuel deployment`
|
||||
command available in the Fuel CLI.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
Environment commands
|
||||
====================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes environment management commands
|
||||
available in the Fuel CLI.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-management:
|
||||
|
||||
========================
|
||||
Fuel management commands
|
||||
------------------------
|
||||
========================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes basic management commands
|
||||
available in the Fuel CLI.
|
||||
|
|
@ -19,7 +22,7 @@ available in the Fuel CLI.
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
fuel <namespace> --help
|
||||
fuel <namespace> --help
|
||||
* - View the list of all available releases
|
||||
- ``fuel release``
|
||||
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
Modify an Openstack environment using CLI
|
||||
=========================================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
You can modify your OpenStack environment after deployment
|
||||
by downloading the ``.yaml`` configuration files, editing settings, and
|
||||
then uploading the configuration files back to the Nailgun
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-network:
|
||||
|
||||
================
|
||||
Network commands
|
||||
----------------
|
||||
================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
You can manage network configurations using the following command:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-network-group:
|
||||
|
||||
=================================
|
||||
Network group management commands
|
||||
---------------------------------
|
||||
=================================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes network group management commands
|
||||
available in the Fuel CLI.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-network-template:
|
||||
|
||||
====================================
|
||||
Network template management commands
|
||||
------------------------------------
|
||||
====================================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes network template management commands
|
||||
available in the Fuel CLI.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-nodes:
|
||||
|
||||
========================
|
||||
Node management commands
|
||||
------------------------
|
||||
========================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes node management commands
|
||||
available in the Fuel CLI.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-nodes-empty-role:
|
||||
|
||||
================================
|
||||
Deploy a node with an empty role
|
||||
--------------------------------
|
||||
================================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
You may need to deploy a node with an operating system installed only,
|
||||
that is an empty role, where you can further deploy your own service
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli_plugins:
|
||||
|
||||
==========================
|
||||
Plugin management commands
|
||||
--------------------------
|
||||
==========================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes the plugin management commands
|
||||
available in the Fuel CLI.
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
Provisioning commands
|
||||
=====================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes the usage of the :command:`fuel provisioning`
|
||||
command available in the Fuel CLI usage.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-roles:
|
||||
|
||||
========================
|
||||
Role management commands
|
||||
------------------------
|
||||
========================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
Fuel CLI implements standard CRUD for operations on a node role.
|
||||
The following table describes the role management commands
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
.. _cli-vip:
|
||||
|
||||
==============================
|
||||
Virtual IP management commands
|
||||
------------------------------
|
||||
==============================
|
||||
|
||||
.. include:: /userdocs/snippets/notes/deprecated-cli-v1.rst
|
||||
|
||||
The following table describes virtual IP management commands
|
||||
available in the Fuel CLI.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,3 @@
|
|||
.. caution:: The Fuel command-line interface has been updated. Although old
|
||||
commands are still available, we recommend that you use the new
|
||||
Fuel commands instead. See the :ref:`cli_comparison_matrix`.
|
||||
Loading…
Reference in New Issue