diff --git a/doc/source/dashboard_demo.rst b/doc/source/dashboard_demo.rst new file mode 100644 index 00000000..9a1ebd98 --- /dev/null +++ b/doc/source/dashboard_demo.rst @@ -0,0 +1,211 @@ +=================== +OpenStack dashboard +=================== + +As a cloud end user, you can use the OpenStack dashboard to provision +your own resources within the limits set by administrators. You can +modify the examples provided in this section to create other types and +sizes of server instances. + +Log in to the dashboard +----------------------- + +The dashboard is available on the node with the ``nova-dashboard`` +server role. + +#. Ask the cloud operator for the host name or public IP address from + which you can access the dashboard, and for your user name and + password. + +#. Open a web browser that has JavaScript and cookies enabled. + +.. note:: + + To use the Virtual Network Computing (VNC) client for the dashboard, + your browser must support HTML5 Canvas and HTML5 WebSockets. The VNC + client is based on noVNC. For details, see `noVNC: HTML5 VNC + Client `__. + For a list of supported browsers, see `Browser + support `__. + +#. In the address bar, enter the host name or IP address for the + dashboard. + + .. code:: + + https://ipAddressOrHostName/ + +.. note:: + + If a certificate warning appears when you try to access the URL for + the first time, a self-signed certificate is in use, which is not + considered trustworthy by default. Verify the certificate or add an + exception in the browser to bypass the warning. + +#. On the Log In page, enter your user name and password, and click Sign + In. + + The top of the window displays your user name. You can also access + Settings or sign out of the dashboard. + + The visible tabs and functions in the dashboard depend on the access + permissions, or roles, of the user you are logged in as. + + * If you are logged in as an end user, the :guilabel:`Project` tab is displayed. + + * If you are logged in as an administrator, the :guilabel:`Project` tab and + :guilabel:`Admin` tab are displayed. + +.. _dashboard-project-tab: + +OpenStack dashboard—Project tab +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Projects are organizational units in the cloud, and are also known as +tenants or accounts. Each user is a member of one or more projects. +Within a project, a user creates and manages instances. + +From the Project tab, you can view and manage the resources in a +selected project, including instances and images. You select the project +from the CURRENT PROJECT list at the top of the tab. + +**Figure: Project tab** + +.. image: figures/dashboard-project-tab.png + +----------- +Project tab +----------- + +From the :guilabel:`Project` tab, you can access the following tabs: + +----------------------- +:guilabel:`Compute` tab +----------------------- + +:guilabel:`Overview`: View reports for the project. + +:guilabel:`Instances`: View, launch, create a snapshot from, stop, pause, or +reboot instances, or connect to them through VNC. + +:guilabel:`Volumes`: Use the following tabs to complete these tasks: + +* :guilabel:`Volumes`: View, create, edit, and delete volumes. + +* :guilabel:`Volume Snapshots`: View, create, edit, and delete volume + snapshots. + +* :guilabel:`Images`: View images and instance snapshots created by project + users, plus any images that are publicly available. Create, edit, and delete + images, and launch instances from images and snapshots. + +:guilabel:`Access & Security`: Use the following tabs to complete these tasks: + +* :guilabel:`Security Groups`: View, create, edit, and delete security groups + and security group rules. + +* :guilabel:`Key Pairs`: View, create, edit, import, and delete key pairs. + +* :guilabel:`Floating IPs`: Allocate an IP address to or release it from a + project. + +* :guilabel:`API Access`: View API endpoints. + +----------------------- +:guilabel:`Network` tab +----------------------- + +:guilabel:`Network Topology`: View the network topology. + +:guilabel:`Networks`: Create and manage public and private networks. + +:guilabel:`Routers`: Create and manage subnets. + +---------------------------- +:guilabel:`Object Store` tab +---------------------------- + +:guilabel:`Containers`: Create and manage containers and objects. + +----------------------------- +:guilabel:`Orchestration` tab +----------------------------- + +:guilabel:`Stacks`: Use the REST API to orchestrate multiple composite cloud + applications. + +.. _dashboard-admin-tab: + + +OpenStack dashboard—Admin tab +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Administrative users can use the :guilabel:`Admin tab` to view usage and to +manage instances, volumes, flavors, images, projects, users, services, and +quotas. + +**Figure: Admin tab** + +.. image: figures/dashboard_admin_project_tab.png + + +--------- +Admin tab +--------- + +Access the following categories to complete these tasks: + +---------------------------- +:guilabel:`System Panel` tab +---------------------------- + +:guilabel:`Overview`: View basic reports. + +:guilabel:`Resource Usage`: Use the following tabs to view the following usages: + +:guilabel:`Daily Report`: View the daily report. + +:guilabel:`Stats`: View the statistics of all resources. + +:guilabel:`Hypervisors`: View the hypervisor summary. + +:guilabel:`Host Aggregates`: View, create, and edit host aggregates. View the +list of availability zones. + +:guilabel:`Instances`: View, pause, resume, suspend, migrate, soft or hard +reboot, and delete running instances that belong to users of some, but not all, +projects. Also, view the log for an instance or access an instance through VNC. + +:guilabel:`Volumes`: View, create, edit, and delete volumes and volume types. + +:guilabel:`Flavors`: View, create, edit, view extra specifications for, and +delete flavors. A flavor is size of an instance. + +:guilabel:`Images`: View, create, edit properties for, and delete custom +images. + +:guilabel:`Networks`: View, create, edit properties for, and delete networks. + +:guilabel:`Routers`: View, create, edit properties for, and delete routers. + +:guilabel:`System Info`: Use the following tabs to view the service +information: + + * :guilabel:`Services`: View a list of the services. + + * :guilabel:`Compute Services`: View a list of all Compute services. + +:guilabel:`Network Agents`: View the network agents. + +:guilabel:`Default Quotas`: View default quota values. Quotas are hard-coded in +OpenStack Compute and define the maximum allowable size and number of +resources. + +------------------------------ +:guilabel:`Identity Panel` tab +------------------------------ + +:guilabel:`Projects`: View, create, assign users to, remove users from, and +delete projects. + +:guilabel:`Users`: View, create, enable, disable, and delete users. \ No newline at end of file diff --git a/doc/source/figures/dashboard-project-tab.png b/doc/source/figures/dashboard-project-tab.png new file mode 100644 index 00000000..ae951121 Binary files /dev/null and b/doc/source/figures/dashboard-project-tab.png differ diff --git a/doc/source/figures/dashboard_admin_project_tab.png b/doc/source/figures/dashboard_admin_project_tab.png new file mode 100644 index 00000000..0e9d2418 Binary files /dev/null and b/doc/source/figures/dashboard_admin_project_tab.png differ diff --git a/doc/source/index.rst b/doc/source/index.rst index 92bf822d..afbecd33 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -27,4 +27,4 @@ Here's an example configuration:: :maxdepth: 1 section_dashboard_access_and_security - + dashboard_demo