diff --git a/doc/admin-guide-cloud/source/dashboard_sessions.rst b/doc/admin-guide-cloud/source/dashboard_sessions.rst index 77a922e8e2..235467423e 100644 --- a/doc/admin-guide-cloud/source/dashboard_sessions.rst +++ b/doc/admin-guide-cloud/source/dashboard_sessions.rst @@ -2,7 +2,7 @@ :linenothreshold: 5 ======================================== -Set up session storage for the dashboard +Set up session storage for the Dashboard ======================================== The dashboard uses `Django sessions @@ -14,8 +14,16 @@ CentOS: :file:`/etc/openstack-dashboard/local_settings`, on Ubuntu and Debian: :file:`/etc/openstack-dashboard/local_settings.py`, and on openSUSE: :file:`/srv/www/openstack-dashboard/openstack_dashboard/local/local_settings.py`). +After architecting and implementing the core OpenStack +services and other required services, combined with the Dashboard +service steps below, users and administrators can use +the OpenStack dashboard. Refer to the +`OpenStack Dashboard `__ chapter of the User Guide for further +instructions on logging in to the Dashboard. + The following sections describe the pros and cons of each option as it -pertains to deploying the dashboard. +pertains to deploying the Dashboard. Local memory cache ~~~~~~~~~~~~~~~~~~ @@ -147,7 +155,7 @@ far beyond the scope of this documentation. No fixtures found. #. To avoid a warning when you restart Apache on Ubuntu, create a - :file:`blackhole` directory in the dashboard directory, as follows:: + :file:`blackhole` directory in the Dashboard directory, as follows:: # mkdir -p /var/lib/dash/.blackhole @@ -167,7 +175,7 @@ far beyond the scope of this documentation. # systemctl restart apache2.service #. On Ubuntu, restart the nova-api service to ensure that the API server - can connect to the dashboard without error:: + can connect to the Dashboard without error:: # service nova-api restart diff --git a/doc/user-guide-admin/source/cli_admin_manage_stacks.rst b/doc/user-guide-admin/source/cli_admin_manage_stacks.rst index 31e8a9c503..9f8c5c2164 100644 --- a/doc/user-guide-admin/source/cli_admin_manage_stacks.rst +++ b/doc/user-guide-admin/source/cli_admin_manage_stacks.rst @@ -16,9 +16,9 @@ core services via a single modular template, with additional orchestration capabilities such as auto-scaling and basic high availability. -For information about the: +For information about: -- Basic creation and deletion of Orchestration stacks, refer +- basic creation and deletion of Orchestration stacks, refer to the `OpenStack End User Guide `_ - **heat** CLI commands, see the `OpenStack Command Line Interface Reference `_ diff --git a/doc/user-guide-admin/source/dashboard_admin_manage_stacks.rst b/doc/user-guide-admin/source/dashboard_admin_manage_stacks.rst index 86355dc74d..1c02a63947 100644 --- a/doc/user-guide-admin/source/dashboard_admin_manage_stacks.rst +++ b/doc/user-guide-admin/source/dashboard_admin_manage_stacks.rst @@ -2,16 +2,19 @@ Launch and manage stacks using the Dashboard ============================================ -The Orchestration service provides a template-based orchestration -engine for the OpenStack cloud, which can be used to create and manage -cloud infrastructure resources such as storage, networking, instances, -and applications as a repeatable running environment. +The Orchestration service provides a template-based +orchestration engine for the OpenStack cloud. Orchestration +services create and manage cloud infrastructure +resources such as storage, networking, instances, and +applications as a repeatable running environment. -Templates are used to create stacks, which are collections of resources. -For example, a stack might include instances, floating IPs, volumes, -security groups, or users. The Orchestration service offers access to -all OpenStack core services via a single modular template, with -additional orchestration capabilities such as auto-scaling and basic +Administrators use templates to create stacks, which are +collections of resources. For example, a stack might +include instances, floating IPs, volumes, +security groups, or users. The Orchestration service +offers access to all OpenStack +core services via a single modular template, with additional +orchestration capabilities such as auto-scaling and basic high availability. For information about: @@ -21,7 +24,7 @@ For information about: .. note:: There are no administration-specific tasks that can be done through - the dashboard. + the Dashboard. * the basic creation and deletion of Orchestration stacks, refer to the `OpenStack End User Guide diff --git a/doc/user-guide-admin/source/dashboard_manage_images.rst b/doc/user-guide-admin/source/dashboard_manage_images.rst index ac547400f2..425a56987d 100644 --- a/doc/user-guide-admin/source/dashboard_manage_images.rst +++ b/doc/user-guide-admin/source/dashboard_manage_images.rst @@ -27,7 +27,13 @@ Guide `_. #. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab and click the :guilabel:`Images` category. The images that you can administer for cloud users appear on this page. -#. Click :guilabel:`Create Image`. +#. Click :guilabel:`Create Image`, which opens the + :guilabel:`Create An Image` window. + + .. figure:: figures/create_image.png + + **Figure Dashboard—Create Image** + #. In the :guilabel:`Create An Image` window, enter or select the following values: @@ -72,8 +78,7 @@ Guide `_. Update images ~~~~~~~~~~~~~ -#. Log in to the dashboard. - +#. Log in to the Dashboard. Choose the :guilabel:`admin` project from the drop-down list at the top of the page. #. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab @@ -89,8 +94,7 @@ Update images Delete images ~~~~~~~~~~~~~ -#. Log in to the dashboard. - +#. Log in to the Dashboard. Choose the :guilabel:`admin` project from the drop-down list at the top of the page. #. On the :guilabel:`Admin tab`, open the :guilabel:`System` tab diff --git a/doc/user-guide-admin/source/dashboard_manage_instances.rst b/doc/user-guide-admin/source/dashboard_manage_instances.rst index 1cba3e66c3..3dfdf147c3 100644 --- a/doc/user-guide-admin/source/dashboard_manage_instances.rst +++ b/doc/user-guide-admin/source/dashboard_manage_instances.rst @@ -7,13 +7,13 @@ projects. You can view, terminate, edit, perform a soft or hard reboot, create a snapshot from, and migrate instances. You can also view the logs for instances or launch a VNC console for an instance. -For information about using the dashboard to launch instances as an end +For information about using the Dashboard to launch instances as an end user, see the `OpenStack End User Guide `__. Create instance snapshots ~~~~~~~~~~~~~~~~~~~~~~~~~ -#. Log in to the dashboard and choose the admin project from the +#. Log in to the Dashboard and choose the admin project from the drop-down list at the top of the page. #. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab @@ -24,7 +24,7 @@ Create instance snapshots #. In the :guilabel:`Create Snapshot` window, enter a name for the snapshot. -#. Click :guilabel:`Create Snapshot`. The dashboard shows the instance snapshot +#. Click :guilabel:`Create Snapshot`. The Dashboard shows the instance snapshot in the :guilabel:`Images & Snapshots` category. #. To launch an instance from the snapshot, select the snapshot and @@ -34,7 +34,7 @@ Create instance snapshots Control the state of an instance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#. Log in to the dashboard and choose the admin project from the +#. Log in to the Dashboard and choose the admin project from the drop-down list at the top of the page. #. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab @@ -62,7 +62,7 @@ Use the Overview category to track usage of instances for each project. You can track costs per month by showing meters like number of VCPUs, disks, RAM, and uptime of all your instances. -#. Log in to the dashboard and choose the admin project from the CURRENT +#. Log in to the Dashboard and choose the admin project from the CURRENT PROJECT drop-down list. #. On the :guilabel:`Admin` tab, click the :guilabel:`Instances` category. diff --git a/doc/user-guide-admin/source/figures/create_image.png b/doc/user-guide-admin/source/figures/create_image.png new file mode 100644 index 0000000000..f168630b2b Binary files /dev/null and b/doc/user-guide-admin/source/figures/create_image.png differ diff --git a/doc/user-guide/source/configure_access_and_security_for_instances.rst b/doc/user-guide/source/configure_access_and_security_for_instances.rst index 228a87865b..7b796cd2fa 100644 --- a/doc/user-guide/source/configure_access_and_security_for_instances.rst +++ b/doc/user-guide/source/configure_access_and_security_for_instances.rst @@ -60,14 +60,12 @@ group rules to a project, if your cloud requires them. #. In the :guilabel:`Add Rule` dialog box, enter the following values: - +------------------------------------+------------------------------------+ - | Rule | Remote | - | | | - | ``SSH`` | ``CIDR`` | - +------------------------------------+------------------------------------+ + * **Rule**: ``SSH`` + * **Remote**: ``CIDR`` - .. note:: To accept requests from a particular range of IP addresses, specify - the IP address block in the :guilabel:`CIDR` box. + .. note:: To accept requests from a particular range of IP + addresses, specify the IP address block in the + :guilabel:`CIDR` box. #. Click :guilabel:`Add`. @@ -78,11 +76,9 @@ group rules to a project, if your cloud requires them. #. In the :guilabel:`Add Rule` dialog box, enter the following values: - +------------------------------------+------------------------------------+ - | Rule | Direction | - | | | - | ``All ICMP`` | ``Ingress`` | - +------------------------------------+------------------------------------+ + * **Rule**: ``All ICMP`` + * **Remote**: ``Ingress`` + #. Click :guilabel:`Add`. @@ -95,6 +91,7 @@ Add a key pair Create at least one key pair for each project. + #. Log in to the dashboard. #. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the @@ -118,6 +115,7 @@ Create at least one key pair for each project. Import a key pair ~~~~~~~~~~~~~~~~~ + #. Log in to the dashboard. #. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the @@ -144,7 +142,7 @@ Import a key pair $ chmod 0600 yourPrivateKey.pem - .. note:: If you are using the dashboard from a Windows computer, use PuTTYgen + .. note:: If you are using the Dashboard from a Windows computer, use PuTTYgen to load the ``*.pem`` file and convert and save it as ``*.ppk``. For more information see the `WinSCP web page for PuTTYgen `__. @@ -157,7 +155,7 @@ Import a key pair The Compute database registers the public key of the key pair. -The dashboard lists the key pair on the :guilabel:`Access & Security` tab. +The Dashboard lists the key pair on the :guilabel:`Access & Security` tab. Allocate a floating IP address to an instance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -174,6 +172,7 @@ of the state of the instances involved. This procedure details the reservation of a floating IP address from an existing pool of addresses and the association of that address with a specific instance. + #. Log in to the dashboard. #. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the