diff --git a/_images/001-health-check-tab.png b/_images/001-health-check-tab.png new file mode 100644 index 000000000..21da43c68 Binary files /dev/null and b/_images/001-health-check-tab.png differ diff --git a/_images/002-health-check-results.png b/_images/002-health-check-results.png new file mode 100644 index 000000000..9bf5bc678 Binary files /dev/null and b/_images/002-health-check-results.png differ diff --git a/_images/fuel-network-settings.png b/_images/fuel-network-settings.png index 2be495445..f77987a30 100644 Binary files a/_images/fuel-network-settings.png and b/_images/fuel-network-settings.png differ diff --git a/_images/reset_environment_button.png b/_images/reset_environment_button.png index cebb7651f..b4067797d 100644 Binary files a/_images/reset_environment_button.png and b/_images/reset_environment_button.png differ diff --git a/_images/stop_deployment_button.png b/_images/stop_deployment_button.png index 770724e86..3fbd329cc 100644 Binary files a/_images/stop_deployment_button.png and b/_images/stop_deployment_button.png differ diff --git a/_images/user_screen_shots/add-nodes1.png b/_images/user_screen_shots/add-nodes1.png index 91fb82254..9ecaf1fa0 100644 Binary files a/_images/user_screen_shots/add-nodes1.png and b/_images/user_screen_shots/add-nodes1.png differ diff --git a/_images/user_screen_shots/assign-role-confirm.png b/_images/user_screen_shots/assign-role-confirm.png index ec7580375..2b9ad739a 100644 Binary files a/_images/user_screen_shots/assign-role-confirm.png and b/_images/user_screen_shots/assign-role-confirm.png differ diff --git a/_images/user_screen_shots/assign-roles1.png b/_images/user_screen_shots/assign-roles1.png index 697cf7ed3..23bd2b1b6 100644 Binary files a/_images/user_screen_shots/assign-roles1.png and b/_images/user_screen_shots/assign-roles1.png differ diff --git a/_images/user_screen_shots/assign-roles2.png b/_images/user_screen_shots/assign-roles2.png index cbdd4e652..a3d23d90d 100644 Binary files a/_images/user_screen_shots/assign-roles2.png and b/_images/user_screen_shots/assign-roles2.png differ diff --git a/_images/user_screen_shots/assign-roles3.png b/_images/user_screen_shots/assign-roles3.png new file mode 100644 index 000000000..c485f4ae8 Binary files /dev/null and b/_images/user_screen_shots/assign-roles3.png differ diff --git a/_images/user_screen_shots/assign-roles4.png b/_images/user_screen_shots/assign-roles4.png new file mode 100644 index 000000000..020637b15 Binary files /dev/null and b/_images/user_screen_shots/assign-roles4.png differ diff --git a/_images/user_screen_shots/change_pass_notification.png b/_images/user_screen_shots/change_pass_notification.png new file mode 100644 index 000000000..86f8cf1f3 Binary files /dev/null and b/_images/user_screen_shots/change_pass_notification.png differ diff --git a/_images/user_screen_shots/change_pass_ui.png b/_images/user_screen_shots/change_pass_ui.png new file mode 100644 index 000000000..fd71e9dd7 Binary files /dev/null and b/_images/user_screen_shots/change_pass_ui.png differ diff --git a/_images/user_screen_shots/create_new_environ.png b/_images/user_screen_shots/create_new_environ.png index 2f8cedf42..107bc880a 100644 Binary files a/_images/user_screen_shots/create_new_environ.png and b/_images/user_screen_shots/create_new_environ.png differ diff --git a/_images/user_screen_shots/deploy-changes-dashboard.png b/_images/user_screen_shots/deploy-changes-dashboard.png new file mode 100644 index 000000000..71b30cf69 Binary files /dev/null and b/_images/user_screen_shots/deploy-changes-dashboard.png differ diff --git a/_images/user_screen_shots/deploy_env.png b/_images/user_screen_shots/deploy_env.png index 3591519fb..91166723e 100644 Binary files a/_images/user_screen_shots/deploy_env.png and b/_images/user_screen_shots/deploy_env.png differ diff --git a/_images/user_screen_shots/fuel-dashboard01.png b/_images/user_screen_shots/fuel-dashboard01.png new file mode 100644 index 000000000..5ae664858 Binary files /dev/null and b/_images/user_screen_shots/fuel-dashboard01.png differ diff --git a/_images/user_screen_shots/manage-nodes.png b/_images/user_screen_shots/manage-nodes.png new file mode 100644 index 000000000..c39e874ed Binary files /dev/null and b/_images/user_screen_shots/manage-nodes.png differ diff --git a/_images/user_screen_shots/manage-nodes2.png b/_images/user_screen_shots/manage-nodes2.png new file mode 100644 index 000000000..c9b5244cd Binary files /dev/null and b/_images/user_screen_shots/manage-nodes2.png differ diff --git a/_images/user_screen_shots/manage-nodes3.png b/_images/user_screen_shots/manage-nodes3.png new file mode 100644 index 000000000..9cf52c225 Binary files /dev/null and b/_images/user_screen_shots/manage-nodes3.png differ diff --git a/_images/user_screen_shots/name_environ.png b/_images/user_screen_shots/name_environ.png index 6d1193163..95df0d29a 100644 Binary files a/_images/user_screen_shots/name_environ.png and b/_images/user_screen_shots/name_environ.png differ diff --git a/_images/user_screen_shots/network-services.png b/_images/user_screen_shots/network-services.png index 66790679f..eac021655 100644 Binary files a/_images/user_screen_shots/network-services.png and b/_images/user_screen_shots/network-services.png differ diff --git a/_images/user_screen_shots/partition-disks.png b/_images/user_screen_shots/partition-disks.png index 945725ca8..64a02c64c 100644 Binary files a/_images/user_screen_shots/partition-disks.png and b/_images/user_screen_shots/partition-disks.png differ diff --git a/_images/user_screen_shots/partition-disks0.png b/_images/user_screen_shots/partition-disks0.png new file mode 100644 index 000000000..25b86fdbc Binary files /dev/null and b/_images/user_screen_shots/partition-disks0.png differ diff --git a/_images/user_screen_shots/platform_services.png b/_images/user_screen_shots/platform_services.png index 9ccec20a5..fb42cf388 100644 Binary files a/_images/user_screen_shots/platform_services.png and b/_images/user_screen_shots/platform_services.png differ diff --git a/_images/user_screen_shots/remove-node-inventory.png b/_images/user_screen_shots/remove-node-inventory.png index 12c902d99..e33f0b000 100644 Binary files a/_images/user_screen_shots/remove-node-inventory.png and b/_images/user_screen_shots/remove-node-inventory.png differ diff --git a/_images/user_screen_shots/select-two-hypervisors.png b/_images/user_screen_shots/select-two-hypervisors.png index 7d45bd9db..bc9e1c782 100644 Binary files a/_images/user_screen_shots/select-two-hypervisors.png and b/_images/user_screen_shots/select-two-hypervisors.png differ diff --git a/_images/user_screen_shots/storage-backend.png b/_images/user_screen_shots/storage-backend.png index 3d09d7bd9..e31a82461 100644 Binary files a/_images/user_screen_shots/storage-backend.png and b/_images/user_screen_shots/storage-backend.png differ diff --git a/pages/user-guide/5000-deploy-environment.rst b/pages/user-guide/5000-deploy-environment.rst index add22deba..6447642a4 100644 --- a/pages/user-guide/5000-deploy-environment.rst +++ b/pages/user-guide/5000-deploy-environment.rst @@ -8,37 +8,17 @@ Deploy Changes ============== -When you have made all the configuration changes you want to make, -click the "Deploy Changes" button +When you have made all the configuration changes you want to make +and reviewed them on the Dashboard, click the "Deploy Changes" button to deploy the environment you have defined. -When you are satisfied with your configuration, -click on the "Deploy Changes" button. -The following screen is displayed -to summarize the configuration modifications you have made: - -.. image:: /_images/user_screen_shots/assign-role-confirm2.png - :width: 50% - -This is your last chance to change the configuration; -check it carefully and, -if this is not the configuration you want to deploy, click "Cancel". -If this is the configuration you want, -click "Deploy"; -after this, you cannot modify the configuration without starting over. +.. image:: /_images/user_screen_shots/deploy-changes-dashboard.png It can take fifteen minutes to an hour to deploy Mirantis OpenStack, depending on the options chosen; deployment times out at two hours. -You can monitor the progress by opening the **Nodes** tab -or by checking individual node logs in the **Logs** tab. +You can monitor the progress on the Dashboard, on the "Nodes" tab, or +on the Fuel UI home page. .. include:: /pages/user-guide/stop_reset/0200-stop-deploy-ui.rst .. include:: /pages/user-guide/stop_reset/0500-reset-environment.rst - -Note, that beginning with Fuel 6.1, the Fuel web UI -displays warnings if you try to press **Deploy** button -with network verification in progress, failed or -skipped. See :ref:`Verify networks ` for -more details and screenshots. - diff --git a/pages/user-guide/config-environment/0900-add-nodes.rst b/pages/user-guide/config-environment/0900-add-nodes.rst index 28ba5945c..14738f5f6 100644 --- a/pages/user-guide/config-environment/0900-add-nodes.rst +++ b/pages/user-guide/config-environment/0900-add-nodes.rst @@ -4,12 +4,31 @@ Add nodes to the environment ---------------------------- -The initial screen shows the total number of nodes -that have been discovered in your environment -and the number of nodes that are unallocated. -Click on the "Add nodes" button to add nodes +The default screen shows the total number of nodes +that have been discovered in your environment. +And the ratio of unallocated to total nodes is shown in the top right +of the page. +Click on the "Add nodes" button on the Dashboard to add nodes to your environment: .. image:: /_images/user_screen_shots/add-nodes1.png :width: 80% +You can review your nodes on the "Nodes" tab. Here you you can +also manage, sort, filter the list of nodes, as well as look for +a specific node by its name, MAC, or IP address: + +.. image:: /_images/user_screen_shots/manage-nodes.png + +To add a custom label to a node, select the node and click the label +icon: + +.. image:: /_images/user_screen_shots/manage-nodes2.png + +To remove a label, you will need to select the node, click the label +icon, remove the tick from the checkbox, and click "Apply": + +.. image:: /_images/user_screen_shots/manage-nodes3.png + +It is not possible to have two labels with the same name but different +values. Label names must be unique. diff --git a/pages/user-guide/config-environment/1000-assign-roles.rst b/pages/user-guide/config-environment/1000-assign-roles.rst index efb60759a..497e3f14d 100644 --- a/pages/user-guide/config-environment/1000-assign-roles.rst +++ b/pages/user-guide/config-environment/1000-assign-roles.rst @@ -28,51 +28,50 @@ and a list of unallocated nodes at the bottom. As you make your selections, Fuel displays an icon (a gold triangle with an exclamation point) -next to roles that are not allowed. +next to the roles that are not allowed. It also tells you about other environment settings that are required. .. image:: /_images/user_screen_shots/assign-roles2.png If you want to modify the roles assigned to a node: -- If you assigned the wrong role to a node - (for example, you defined a node as a Compute node but want it - to be a Ceph OSD node), - select that node and click the "Delete" button. +- If you assigned the wrong role to a node and deployed the + environment (for example, you defined a node as a Compute node + but want it to be a Ceph OSD node), select that node and click + the "Delete" button: + + .. image:: /_images/user_screen_shots/assign-roles3.png + This moves that node back to the pool of "Unallocated nodes" - so you can click on "Add Node" to assign a new role. -- If you want to add a role to a node + so you can click on "Add Node" to assign a new role. This means that + you will also have to redeploy the environment for the changes to + take effect. +- If you want to add a role to a node or edit the roles in an + environment that has not yet been deployed (for example, you defined a node as a Compute node but want it to also have a Ceph OSD role), - select that node and click the additional roles you want to assign - (in this case, click the "Ceph OSD" node - and leave the "Compute" role selected); - click the "Apply Changes" button. - -When you click the "Apply Changes" button, -Fuel displays the configuration you have chosen: - - -.. image:: /_images/user_screen_shots/assign-role-confirm.png + select that node and click "Edit Roles": + .. image:: /_images/user_screen_shots/assign-roles4.png To rename the nodes, click on the "Untitled" string for each node and then type in the name you want to use. The suffix is the last digits of the MAC address for this node; you can keep these digits or delete them. -Beginning with Fuel 6.1, you can remove -a node from inventory if it is dead or -there is need to delete it from the cluster. -To do that, you should click **Forget** button -next to the required node. This works for any offline -node both deployed and not. +You can remove an offline node from the inventory by selecting it +and clicking "Remove". This will remove the node from the pool +of available nodes completely. + +You can also delete any node from the environment by selecting it +and clicking "Delete". This will delete the node and return it to the +pool of unallocated nodes. + To remove any node from inventory using the Fuel CLI, see :ref:`Remove a node from Fuel DB `. .. image:: /_images/user_screen_shots/remove-node-inventory.png - For more information, see: - :ref:`nodes-roles-arch` describes the Controller, diff --git a/pages/user-guide/config-environment/1200-customize-partitions.rst b/pages/user-guide/config-environment/1200-customize-partitions.rst index 66b0b2d02..4a7988da3 100644 --- a/pages/user-guide/config-environment/1200-customize-partitions.rst +++ b/pages/user-guide/config-environment/1200-customize-partitions.rst @@ -28,12 +28,9 @@ The following partition types may be configured: - MongoDB: used for Ceilometer information stored in MongoDB - Mysql database: stores Zabbix statistics on Zabbix nodes -To modify the disk allocation, -click on the bar for a disk. -This example is for a node that runs -both a Compute node and a Storage - Cinder role; -clicking on the center bar gives a display -similar to the following: +To modify the disk allocation, click *Configure Disks*: + +.. image:: /_images/user_screen_shots/partition-disks0.png .. image:: /_images/user_screen_shots/partition-disks.png :width: 80% diff --git a/pages/user-guide/create-environment/1000-start-create-env.rst b/pages/user-guide/create-environment/1000-start-create-env.rst index 46b4cb9b3..3d79c3ade 100644 --- a/pages/user-guide/create-environment/1000-start-create-env.rst +++ b/pages/user-guide/create-environment/1000-start-create-env.rst @@ -22,6 +22,14 @@ The Fuel UI screen appears: .. image:: /_images/user_screen_shots/create_new_environ.png :width: 80% +The Dashboard tab is your go-to place to review all the necessary +information about your OpenStack environment: + +.. image:: /_images/user_screen_shots/fuel-dashboard01.png + +The Dashboard tab is also the place where you can delete or rename your +environment, discard the changes, start or stop the deployment, +access documentation, and view possible errors reported by Fuel. Click on the "New OpenStack environment" icon to launch the wizard that creates a new OpenStack environment. @@ -29,4 +37,3 @@ to launch the wizard that creates a new OpenStack environment. If you are deploying a Mirantis OpenStack environment that is integrated with VMware vSphere, follow the instructions in :ref:`vcenter-deploy`. - diff --git a/pages/user-guide/create-environment/1050-change-password.rst b/pages/user-guide/create-environment/1050-change-password.rst index 707c7a41f..84b74a576 100644 --- a/pages/user-guide/create-environment/1050-change-password.rst +++ b/pages/user-guide/create-environment/1050-change-password.rst @@ -2,9 +2,19 @@ Change Fuel Password -------------------- +It is highly recommended that you change the default password +to the one that meets your company's security requirements. + +Until you do, Fuel will keep reminding you that the password +has not been changed yet: + +.. image:: /_images/user_screen_shots/change_pass_notification.png + +You can change the Fuel password from the Fuel UI screen +Click the user icon at the upper right of the screen: + +.. image:: /_images/user_screen_shots/change_pass_ui.png -You can change the Fuel password from the Fuel UI screen; -click on "Change password" at the upper right of the screen. The following screen is displayed: .. image:: /_images/authx/change_pass_not_vis.png diff --git a/pages/user-guide/create-environment/1500-name-distro.rst b/pages/user-guide/create-environment/1500-name-distro.rst index cb00f29f7..f8daf3733 100644 --- a/pages/user-guide/create-environment/1500-name-distro.rst +++ b/pages/user-guide/create-environment/1500-name-distro.rst @@ -14,29 +14,24 @@ and select the Linux distribution from the drop-down list: :: - Juno on Ubuntu 14.04.1 (2014.2.2-6.1)(default) - Juno on CentOS 6.5 (2014.2.2-6.1) + Kilo on Ubuntu 14.04.1 (2015.1.0-7.0) (default) This is the operating system that will be installed on the target nodes in the environment. -See :ref:`linux-distro-plan` for guidelines -about choosing the distribution to use. The number in parentheses -is the version number for each environment version; -it is formed by concatenating the Juno Release number +is the version number for the environment; +it is formed by concatenating the Kilo Release number and the Mirantis OpenStack Release number. -In this case, the "2014.2" string corresponds to the Juno release version; -the "6.1" string is the Mirantis OpenStack release number. +In this case, the "2015.1" string corresponds to the Kilo release version; +the "7.0" string is the Mirantis OpenStack release number. Note that the list displayed under the "Releases" tab at the top of the Fuel home page -lists all the releases that Fuel 6.1 can manage +lists all the releases that Fuel 7.0 can manage in your environment. If you upgraded Fuel from an earlier Mirantis OpenStack release, -Fuel 6.1 can manage environments that were previously deployed +Fuel 7.0 can manage environments that were previously deployed using those releases. It cannot, however, deploy a new environment using those releases. - - diff --git a/pages/user-guide/health-checks/0200-run-tests.rst b/pages/user-guide/health-checks/0200-run-tests.rst index 1a99187eb..c0e21f8e1 100644 --- a/pages/user-guide/health-checks/0200-run-tests.rst +++ b/pages/user-guide/health-checks/0200-run-tests.rst @@ -4,7 +4,7 @@ Running Post-Deployment Checks Now, let`s take a closer look on what should be done to execute the tests and to understand if something is wrong with your OpenStack environment. -.. image:: /_images/001-health-check-tab.jpg +.. image:: /_images/001-health-check-tab.png :align: center :width: 100% @@ -34,7 +34,7 @@ this section. An actual test run looks like this: -.. image:: /_images/002-health-check-results.jpg +.. image:: /_images/002-health-check-results.png :align: center :width: 100% diff --git a/pages/user-guide/stop_reset/0200-stop-deploy-ui.rst b/pages/user-guide/stop_reset/0200-stop-deploy-ui.rst index 4bf425b70..4e20e87fc 100644 --- a/pages/user-guide/stop_reset/0200-stop-deploy-ui.rst +++ b/pages/user-guide/stop_reset/0200-stop-deploy-ui.rst @@ -3,8 +3,9 @@ Stopping Deployment from Web UI ------------------------------- -Click on the small red button that appears to the right of the progress bar -after you click "Deploy changes" and deployment itself starts: +On the Dashboard, click on the small red button that appears to the +right of the progress bar after you click "Deploy changes" and +deployment itself starts: .. image:: /_images/stop_deployment_button.png :align: center @@ -21,26 +22,26 @@ This may lead to one of two possible results: the environment may then be redeployed from scratch. Two things will happen in UI: - * All nodes are marked as offline - and are eventually return back online after reboot. - You can not deploy an environment that includes offline nodes, - so the next deployment should not be started - until all nodes have been successfully discovered - and reported as online in the UI. - * All settings will be unlocked on all tabs and for all nodes, - so that you can change any setting before starting a new deployment. + * All nodes are marked as offline + and are eventually return back online after reboot. + You can not deploy an environment that includes offline nodes, + so the next deployment should not be started + until all nodes have been successfully discovered + and reported as online in the UI. + * All settings will be unlocked on all tabs and for all nodes, + so that you can change any setting before starting a new deployment. - This is quite similar to resetting the environment (:ref:`Reset_Environment`). + This is quite similar to resetting the environment (:ref:`Reset_Environment`). #. Some nodes are already deployed (usually controllers) and have reached "ready" status in the UI. In this case, the behavior is different: - * Only nodes which did not reach "ready" status are rebooted - back to bootstrap; deployed ones remain intact. - * Settings remain locked - because they have been already applied to some nodes. - You may reset the environment (:ref:`Reset_Environment`) - to reboot all nodes, unlock all parameters, - and redeploy an environment from scratch to apply them again. + * Only nodes which did not reach "ready" status are rebooted + back to bootstrap; deployed ones remain intact. + * Settings remain locked + because they have been already applied to some nodes. + You may reset the environment (:ref:`Reset_Environment`) + to reboot all nodes, unlock all parameters, + and redeploy an environment from scratch to apply them again. diff --git a/pages/user-guide/stop_reset/0500-reset-environment.rst b/pages/user-guide/stop_reset/0500-reset-environment.rst index c5d3633a1..ac4b08696 100644 --- a/pages/user-guide/stop_reset/0500-reset-environment.rst +++ b/pages/user-guide/stop_reset/0500-reset-environment.rst @@ -16,7 +16,7 @@ The deployment process may be completed in one of three ways (see :ref:`Stop_Deployment`) Any of these three possibilities causes the "Reset" button -in the "Actions" tab to become unlocked: +on the Dashboard to become unlocked: .. image:: /_images/reset_environment_button.png :align: center @@ -26,10 +26,10 @@ Click this button to reset the whole environment back to the state it was in right before the "Deploy changes" button was first clicked. - * All nodes will be offline; they will come back online after reboot. - You can not deploy an environment that includes offline nodes, - so you should start the next deployment - after all nodes have been successfully discovered - and reported as online in UI. - * All settings will be unlocked on all tabs and for all nodes, - so you can modify any setting before starting a new deployment. +* All nodes will be offline; they will come back online after reboot. + You can not deploy an environment that includes offline nodes, + so you should start the next deployment + after all nodes have been successfully discovered + and reported as online in UI. +* All settings will be unlocked on all tabs and for all nodes, + so you can modify any setting before starting a new deployment.