From fc1481ee0489f1de425f2780f83c6c06e5253062 Mon Sep 17 00:00:00 2001 From: Olena Logvinova Date: Fri, 19 Aug 2016 19:04:22 +0300 Subject: [PATCH] [UG] Add `Remove and Redeploy a node` section This patch: - adds 2 new articles to the Maintain env section; - changes the Headings formatting to fit the docs conventions; - fixes noticed formatting typos. Change-Id: If016d05bddf05102a5028765e6ffbd9eb259c9df --- .../post-deployment-settings.rst | 2 +- .../fuel-user-guide/maintain-environment.rst | 2 + .../maintain-environment/custom-graph.rst | 1 + .../maintain-environment/data-driven.rst | 1 + .../deployment-history.rst | 1 + .../deployment-information.rst | 7 ++-- .../preserve-partition.rst | 3 +- .../maintain-environment/redeploy-node.rst | 38 +++++++++++++++++++ .../maintain-environment/reinstall-node.rst | 1 + .../reinstall-virtual-role.rst | 3 +- .../maintain-environment/remove-node.rst | 28 ++++++++++++++ .../rollback-compute-node.rst | 3 +- .../maintain-environment/rollback-ug.rst | 1 + .../maintain-environment/use-shotgun.rst | 1 + .../fuel-user-guide/post-deployment-conf.rst | 2 +- 15 files changed, 86 insertions(+), 8 deletions(-) create mode 100644 userdocs/fuel-user-guide/maintain-environment/redeploy-node.rst create mode 100644 userdocs/fuel-user-guide/maintain-environment/remove-node.rst diff --git a/userdocs/fuel-user-guide/configure-environment/post-deployment-settings.rst b/userdocs/fuel-user-guide/configure-environment/post-deployment-settings.rst index 47a9328ee..525512e8f 100644 --- a/userdocs/fuel-user-guide/configure-environment/post-deployment-settings.rst +++ b/userdocs/fuel-user-guide/configure-environment/post-deployment-settings.rst @@ -35,4 +35,4 @@ environment with new parameters. #. Click :guilabel:`Deploy Changes` to redeploy the OpenStack environment with the new configuration. Or click :guilabel:`Discard` to discard the changes and load the last - successfully deployed OpenStack environment configuration. \ No newline at end of file + successfully deployed OpenStack environment configuration. diff --git a/userdocs/fuel-user-guide/maintain-environment.rst b/userdocs/fuel-user-guide/maintain-environment.rst index 8f2f886ef..60f8e8c15 100644 --- a/userdocs/fuel-user-guide/maintain-environment.rst +++ b/userdocs/fuel-user-guide/maintain-environment.rst @@ -14,6 +14,8 @@ This section includes the following topics: .. toctree:: :maxdepth: 1 + maintain-environment/remove-node.rst + maintain-environment/redeploy-node.rst maintain-environment/access-shell.rst maintain-environment/rollback-ug.rst maintain-environment/reinstall-node.rst diff --git a/userdocs/fuel-user-guide/maintain-environment/custom-graph.rst b/userdocs/fuel-user-guide/maintain-environment/custom-graph.rst index 63dcd6af7..a70faa95d 100644 --- a/userdocs/fuel-user-guide/maintain-environment/custom-graph.rst +++ b/userdocs/fuel-user-guide/maintain-environment/custom-graph.rst @@ -1,6 +1,7 @@ .. _custom-graph: +================== Run a custom graph ================== diff --git a/userdocs/fuel-user-guide/maintain-environment/data-driven.rst b/userdocs/fuel-user-guide/maintain-environment/data-driven.rst index 31b7ecfba..b2992348f 100644 --- a/userdocs/fuel-user-guide/maintain-environment/data-driven.rst +++ b/userdocs/fuel-user-guide/maintain-environment/data-driven.rst @@ -1,6 +1,7 @@ .. _data-driven: +===================== Run data-driven tasks ===================== diff --git a/userdocs/fuel-user-guide/maintain-environment/deployment-history.rst b/userdocs/fuel-user-guide/maintain-environment/deployment-history.rst index fa9114f3e..c2b9c9ee2 100644 --- a/userdocs/fuel-user-guide/maintain-environment/deployment-history.rst +++ b/userdocs/fuel-user-guide/maintain-environment/deployment-history.rst @@ -1,6 +1,7 @@ .. _deployment-history: +======================= Deployment task history ======================= diff --git a/userdocs/fuel-user-guide/maintain-environment/deployment-information.rst b/userdocs/fuel-user-guide/maintain-environment/deployment-information.rst index 3b3718dd3..2c91250c0 100644 --- a/userdocs/fuel-user-guide/maintain-environment/deployment-information.rst +++ b/userdocs/fuel-user-guide/maintain-environment/deployment-information.rst @@ -1,6 +1,7 @@ .. _deployment-information: +=============================== Download deployment information =============================== @@ -15,17 +16,17 @@ deployment. #. Log in to the Fuel Master node. #. Get the ID of the deployment task: - .. code-block:: console + .. code-block:: console fuel task fuel2 task list #. Download the deployment information: - .. code-block:: console + .. code-block:: console fuel2 task deployment-info download --file deployment-info.yaml fuel2 task settings download --file settings.yaml fuel2 task network-configuration download --file networks.yaml - The ```` value is the ID of the deployment task. \ No newline at end of file + The ```` value is the ID of the deployment task. diff --git a/userdocs/fuel-user-guide/maintain-environment/preserve-partition.rst b/userdocs/fuel-user-guide/maintain-environment/preserve-partition.rst index eaa6bc8f8..e5d2e14c8 100644 --- a/userdocs/fuel-user-guide/maintain-environment/preserve-partition.rst +++ b/userdocs/fuel-user-guide/maintain-environment/preserve-partition.rst @@ -1,7 +1,8 @@ .. _preserve-partition: +==================== Preserve a partition -~~~~~~~~~~~~~~~~~~~~ +==================== This section is a part of the :ref:`Rollback a node ` procedure. With partition preservation you can keep any type of data that meets the diff --git a/userdocs/fuel-user-guide/maintain-environment/redeploy-node.rst b/userdocs/fuel-user-guide/maintain-environment/redeploy-node.rst new file mode 100644 index 000000000..cb8070263 --- /dev/null +++ b/userdocs/fuel-user-guide/maintain-environment/redeploy-node.rst @@ -0,0 +1,38 @@ +.. _redeploy-node: + +=============== +Redeploy a node +=============== + +Redeploying a node refers to the process of changing the roles that are +assigned to a node. For example, you want to redeploy some compute and storage +nodes to be MongoDB nodes. + +**To redeploy a node:** + +#. Prepare your environment: + + #. Live migrate instances from the compute nodes. For more information, + see `Configure migrations `_. + #. Back up or copy information from the Operating System nodes being + redeployed. + +#. Log in to the Fuel web UI. +#. In the :guilabel:`Nodes` tab, select the node(s) that you want to remove + and click :guilabel:`Delete`. + + The deployed node will be marked as :guilabel:`PENDING DELETION`. + +#. In the :guilabel:`Dashboard` tab, click :guilabel:`Deploy Changes`. + +#. Wait for the node to become available in the list of :guilabel:`Discovered` + nodes in the :guilabel:`Nodes` tab. +#. Assign a new role to the node being redeployed. +#. Adjust the settings of your environment as required. +#. In the :guilabel:`Dashboard` tab, click :guilabel:`Deploy Changes`. +#. Wait for the environment to be redeployed. + +.. caution:: After redeploying an Operating System node, you will have to + manually apply any configuration changes you made and reinstall the software + that was running on the node or restore the system from the backup you made + before redeploying the node. diff --git a/userdocs/fuel-user-guide/maintain-environment/reinstall-node.rst b/userdocs/fuel-user-guide/maintain-environment/reinstall-node.rst index 22ee40ed9..1a954f2f4 100644 --- a/userdocs/fuel-user-guide/maintain-environment/reinstall-node.rst +++ b/userdocs/fuel-user-guide/maintain-environment/reinstall-node.rst @@ -1,5 +1,6 @@ .. _reinstall-node: +================ Reinstall a node ================ diff --git a/userdocs/fuel-user-guide/maintain-environment/reinstall-virtual-role.rst b/userdocs/fuel-user-guide/maintain-environment/reinstall-virtual-role.rst index c97935eee..3817c8315 100644 --- a/userdocs/fuel-user-guide/maintain-environment/reinstall-virtual-role.rst +++ b/userdocs/fuel-user-guide/maintain-environment/reinstall-virtual-role.rst @@ -1,7 +1,8 @@ .. _reinstall-virtual-role: +======================== Reinstall a virtual role ------------------------- +======================== If you have the Reduced Footprint feature enabled, you may need to reinstall the virtual role. diff --git a/userdocs/fuel-user-guide/maintain-environment/remove-node.rst b/userdocs/fuel-user-guide/maintain-environment/remove-node.rst new file mode 100644 index 000000000..1f68423a9 --- /dev/null +++ b/userdocs/fuel-user-guide/maintain-environment/remove-node.rst @@ -0,0 +1,28 @@ +.. _remove-node: + +============= +Remove a node +============= + +You may need to remove a node from your environment to replace +hardware, repair an error, complete maintenance operations, and so on. + +**To remove a node:** + +#. Log in to the Fuel web UI. +#. In the :guilabel:`Nodes` tab, select the node that you want to remove and + click :guilabel:`Delete`. + + The deployed node will be marked as :guilabel:`PENDING DELETION` and will + be removed from the environment after redeployment. +#. Adjust the settings of your environment as required. +#. In the :guilabel:`Dashboard` tab, click :guilabel:`Deploy Changes`. + + Puppet removes the node from the configuration files and + re-triggers corresponding services. + +.. seealso:: + + - `Node management commands `_ + - :ref:`add-nodes-ug` + - :ref:`redeploy-node` diff --git a/userdocs/fuel-user-guide/maintain-environment/rollback-compute-node.rst b/userdocs/fuel-user-guide/maintain-environment/rollback-compute-node.rst index d694123c1..98fdb520d 100644 --- a/userdocs/fuel-user-guide/maintain-environment/rollback-compute-node.rst +++ b/userdocs/fuel-user-guide/maintain-environment/rollback-compute-node.rst @@ -1,7 +1,8 @@ .. _rollback-compute-node: +======================= Rollback a compute node ------------------------ +======================= You can rollback a compute node to its original state, for example, the state before it failed. diff --git a/userdocs/fuel-user-guide/maintain-environment/rollback-ug.rst b/userdocs/fuel-user-guide/maintain-environment/rollback-ug.rst index 42d23be45..cda62b974 100644 --- a/userdocs/fuel-user-guide/maintain-environment/rollback-ug.rst +++ b/userdocs/fuel-user-guide/maintain-environment/rollback-ug.rst @@ -1,5 +1,6 @@ .. _rollback-ug: +=============== Rollback a node =============== diff --git a/userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst b/userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst index ed37d2a6f..aba2ace4d 100644 --- a/userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst +++ b/userdocs/fuel-user-guide/maintain-environment/use-shotgun.rst @@ -1,6 +1,7 @@ .. _shotgun-ug: +======================================== Create diagnostic snapshot using shotgun ======================================== diff --git a/userdocs/fuel-user-guide/post-deployment-conf.rst b/userdocs/fuel-user-guide/post-deployment-conf.rst index b699c065d..ba49e453c 100644 --- a/userdocs/fuel-user-guide/post-deployment-conf.rst +++ b/userdocs/fuel-user-guide/post-deployment-conf.rst @@ -13,4 +13,4 @@ This section includes the following topics: .. toctree:: :maxdepth: 3 - configure-environment/post-deployment-settings.rst \ No newline at end of file + configure-environment/post-deployment-settings.rst