From 3527d175ef900aa504da36f267b6cb9645a5e0be Mon Sep 17 00:00:00 2001 From: yangsngshaoxue Date: Tue, 30 Aug 2022 10:46:32 +0800 Subject: [PATCH] docs: Update user dashboard guide. Update user dashboard guide. Change-Id: Ib3f507a1e2df4911b7f24408b6f9be8e23056f89 --- doc/source/admin/dashboard.rst | 5 - doc/source/admin/index.rst | 4 +- doc/source/admin/skyline-configuration.rst | 2 - doc/source/user/compute.rst | 54 ++++++ doc/source/user/dashboard.rst | 188 ++++++++++++++++++++- doc/source/user/network.rst | 4 +- 6 files changed, 241 insertions(+), 16 deletions(-) delete mode 100644 doc/source/admin/dashboard.rst delete mode 100644 doc/source/admin/skyline-configuration.rst diff --git a/doc/source/admin/dashboard.rst b/doc/source/admin/dashboard.rst deleted file mode 100644 index bf7504d0..00000000 --- a/doc/source/admin/dashboard.rst +++ /dev/null @@ -1,5 +0,0 @@ -Openstack Dashboard -==================== - -Administrator page -------------------- diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 89c10779..03f7a2be 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -8,10 +8,10 @@ operate by users, and has higher concurrency performance. .. toctree:: - skyline-configuration - dashboard compute storage identity +For more information about dashboard, see :ref:`skyline-dashboard`. To deploy skyline, see :ref:`skyline-installation-guide`. +To configure skyline, see :ref:`skyline-settings`. diff --git a/doc/source/admin/skyline-configuration.rst b/doc/source/admin/skyline-configuration.rst deleted file mode 100644 index b9166494..00000000 --- a/doc/source/admin/skyline-configuration.rst +++ /dev/null @@ -1,2 +0,0 @@ -Skyline Configuration -===================== diff --git a/doc/source/user/compute.rst b/doc/source/user/compute.rst index 992f8095..24a725f6 100644 --- a/doc/source/user/compute.rst +++ b/doc/source/user/compute.rst @@ -50,10 +50,64 @@ Launch an instance #. On the :guilabel:`Create Instance` page, enter the instance values. + :guilabel:`Available Zone`: The availability zone from which to launch the server. + + :guilabel:`Specification`: Select a flavor for your server instance. + + :guilabel:`Start Source`: Select one of the following options: + + * Image: If choose this option, a new field for :guilabel:`Operating System` + displays. You can select the image from the list. And enter the size of the + volume used as :guilabel:`System Disk` of the instance. + + .. note:: + + click the :guilabel:`Deleted with the instance` option to delete + the volume on deleting the instance. + + * Instance Snapshot: Using this option, you can boot from a volume + snapshot and create a new volume by choosing :guilabel:`Instance Snapshot` + from a list. + + * Bootable Volume: If you choose this option, a new field for + :guilabel:`Bootable Volume` displays. You can select the volume from the list. + + :guilabel:`Data Disk`: The disks mounted on the instance. + #. Click :guilabel:`Next: Network Config`. + You can choose :guilabel:`Networks`, :guilabel:`Ports` or a mix of both for + the instance network config. + + :guilabel:`Networks`: Add a network to the instance. If you specify the networks, + :guilabel:`Virtual LAN` and :guilabel:`Security Group` are required fields. + + :guilabel:`Virtual LAN`: Specify a subnet of the network and assign fixed IP + address automatically or manually for the instance. + + :guilabel:`Security Group`: Security groups are a kind of cloud firewall that + define which incoming network traffic is forwarded to instances. + + :guilabel:`Ports`: Activate the ports that you want to assign to the instance. + + .. note:: + + The port executes its own security group rules by default. + #. Click :guilabel:`Next: System Config`. + :guilabel:`Name`: The server name. + + :guilabel:`Login Type`: Select one of the following options: + + * Keypair: If you choose this option, a new field for + :guilabel:`Keypair` displays. The key pair allows you to SSH into your + newly created instance. You can select an existing key pair, import a + key pair, or generate a new key pair. + + * Password: Enter the :guilabel:`Login Password` and confirm it. And you + can login to the instance by using password. + #. Click :guilabel:`Next: Confirm Config` and confirm your choice. The instance are created and you can wait for a few seconds to diff --git a/doc/source/user/dashboard.rst b/doc/source/user/dashboard.rst index 09503997..9675fde0 100644 --- a/doc/source/user/dashboard.rst +++ b/doc/source/user/dashboard.rst @@ -1,8 +1,188 @@ +.. _skyline-dashboard: + +=================== Openstack Dashboard =================== -User page ----------- - Console page -------------- +~~~~~~~~~~~~~ + +Home tab +--------- + +Home tab shows user information and details of quota about +Compute, Storage, Network, etc. And it provides a button to quickly +jump to Instances, Volumes, Networks and Routers page. + +Compute tab +------------ + +* :guilabel:`Instances`: View, launch, delete, create a snapshot from, + attach or detach interface to, attach or detach volume to, + associate floating ip to, manage security group of, stop, pause, + lock, shelve, suspend, reboot or soft reboot instances, modify + instance tags, or connect to them through VNC. + +* :guilabel:`Instance snapshots`: View, edit, delete instance snapshots, + launch instances or create volumes from them. + +* :guilabel:`Flavors`: View flavors. + +* :guilabel:`Server Groups`: View, create or delete server groups. + +* :guilabel:`Images`: View, create, edit, delete images, launch instances + or create volumes from them. + +* :guilabel:`Key Pairs`: View, create, edit, import, and delete key pairs. + +Storage tab +------------ + +* :guilabel:`Volumes`: View, create, edit, and delete volumes. Create volume + snapshot, create volume backup, clone volume, extend volume or change volume + type, attach or detach them to instance. + +* :guilabel:`Volume Backups`: View, create, edit, and delete volume backups. + Also, create volumes from them and restore backup. + +* :guilabel:`Volume Snapshots`: View, create, edit, delete volume snapshots. + And create volumes from them. + +Network tab +------------ + +* :guilabel:`Networks`: View, create, edit and delete networks. + +* :guilabel:`Ports`: View, create, edit, delete ports and manage + security group for ports. + +* :guilabel:`Routers`: View, create, edit, delete and manage routers. + +* :guilabel:`Floating IPs`: Allocate IP addresses or release them. + +* :guilabel:`Topology`: View the network topology. + +* :guilabel:`Security Groups`: View, create, edit, and delete security + groups and security group rules. + +User page +~~~~~~~~~~ + +User center tab +---------------- + +User center shows the details of user, including Username, Email, Phone, +Real Name and User ID. + +Application credentials tab +---------------------------- + +Application credentials provide a way to delegate a user authorization +to an application without sharing the user password authentication. +This is a useful security measure, especially for situations where +the user identification is provided by an external source, such as +LDAP or a single-sign-on service. Instead of storing user passwords in +config files, a user creates an application credential for a specific +project, with all or a subset of the role assignments they have on +that project, and then stores the application credential identifier +and secret in the config file. + +Administrator page +~~~~~~~~~~~~~~~~~~ + +Home tab +--------- + +Home tab shows basic platform information (the numbers of projects, users, +nodes), virtual resource usage (CPU usages, memory usages), compute and +network services status. + +Compute tab +------------ + +* :guilabel:`Instances`: View, stop, suspend, cold or live migrate, + soft or hard reboot, and delete instances that belong to all projects. + Also, view the log for an instance or access an instance through VNC. + +* :guilabel:`Instance snapshots`: View, edit, delete instance snapshots. + +* :guilabel:`Flavors`: View, create, edit, manage metadata for, + and delete flavors. + +* :guilabel:`Server Groups`: View, create or delete server groups. + +* :guilabel:`Images`: View, create, edit, manage metadata for, and delete + images. + +* :guilabel:`Hypervisors`: View the hypervisor summary. Also, view and manage + compute nodes. + +* :guilabel:`Host Aggregates`: View, create, manage metadata for, edit and + delete host aggregates. View the list of availability zones. + +Storage tab +------------ + +* :guilabel:`Volumes`: View, update status for, migrate and delete volumes. + +* :guilabel:`Volume Backups`: View and delete restore backup. + +* :guilabel:`Volume Snapshots`: View and delete volume snapshots. + +* :guilabel:`Volume Types`: View, create, edit, encrypt, manage access + for and delete volume types. + +* :guilabel:`Storage Backends`: View storage backends. + +Network tab +------------ + +* :guilabel:`Networks`: View, create and delete networks. + +* :guilabel:`Ports`: View and delete ports. + +* :guilabel:`Routers`: View and delete routers. + +* :guilabel:`Floating IPs`: Allocate IP addresses or release them. + +* :guilabel:`Security Groups`: View and delete security groups. + +Identity tab +------------ + +* :guilabel:`Domains`: View, create, edit, enable, disable and delete domains. + +* :guilabel:`Projects`: View, create, edit, enable, disable and delete + projects. Also, manage users or user groups of projects, modify tags for them. + +* :guilabel:`Users`: View, create, edit, enable, disable, delete users. And + edit System Permission of users, update user password. + +* :guilabel:`User Groups`: View, create, edit and delete user groups. + +* :guilabel:`Roles`: View, create, edit and delete roles. + +Global setting tab +------------------ + +* :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 and + enable or disable them. + + * :guilabel:`Network Agents`: View the network agents and enable or + disable them. + + * :guilabel:`Block Storage Services`: View a list of all Block Storage + services and enable or disable them. + + * :guilabel:`Orchestration Services`: View a list of all Orchestration + services. + +* :guilabel:`System Config`: View, edit and reset system config. + +* :guilabel:`Metadata Definitions`: View, edit and delete system + metadata definitions. diff --git a/doc/source/user/network.rst b/doc/source/user/network.rst index 40cb7e85..15aa784f 100644 --- a/doc/source/user/network.rst +++ b/doc/source/user/network.rst @@ -114,9 +114,7 @@ create a port #. Select the appropriate project from the Switch Project menu at the top left. #. On the :guilabel:`Console` page, open the :guilabel:`Network` tab and - -#. On the :guilabel:`Project` tab, click :guilabel:`Networks` category. -click :guilabel:`Ports` category. + click :guilabel:`Ports` category. #. Click :guilabel:`Create Virtual Adapter`.