From a4d05ce55da8e4e86dfd13933bfea6250085c72d Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sun, 3 Sep 2017 08:27:42 +0000 Subject: [PATCH] Clean up broken links due to doc-migration admin-manage-stacks.rst is dropped as we have no admin stack panel. view-cloud-resources.rst is dropped as the metering panel was dropped several releases ago. Closes-Bug: 1714753 Change-Id: I483cb3dbaab23722abd2f321e8666d8beea2f7c7 --- doc/source/admin/admin-manage-stacks.rst | 34 ----------------- doc/source/admin/index.rst | 3 +- doc/source/admin/manage-host-aggregates.rst | 2 +- doc/source/admin/manage-images.rst | 7 ++-- doc/source/admin/manage-instances.rst | 4 +- doc/source/admin/manage-resources.rst | 10 ----- doc/source/admin/manage-shares.rst | 2 +- doc/source/admin/manage-volumes.rst | 4 +- doc/source/admin/sessions.rst | 4 +- doc/source/admin/set-quotas.rst | 13 +++++-- doc/source/admin/view-cloud-resources.rst | 41 --------------------- doc/source/user/create-networks.rst | 5 +-- doc/source/user/launch-instances.rst | 2 +- doc/source/user/stacks.rst | 4 +- 14 files changed, 25 insertions(+), 110 deletions(-) delete mode 100644 doc/source/admin/admin-manage-stacks.rst delete mode 100644 doc/source/admin/manage-resources.rst delete mode 100644 doc/source/admin/view-cloud-resources.rst diff --git a/doc/source/admin/admin-manage-stacks.rst b/doc/source/admin/admin-manage-stacks.rst deleted file mode 100644 index d02ac98585..0000000000 --- a/doc/source/admin/admin-manage-stacks.rst +++ /dev/null @@ -1,34 +0,0 @@ -============================================ -Launch and manage stacks using the Dashboard -============================================ - -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. - -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: - -* administrative tasks on the command-line, see - the `OpenStack Administrator Guide - `__. - - .. note:: - - There are no administration-specific tasks that can be done through - the Dashboard. - -* the basic creation and deletion of Orchestration stacks, refer to - the `OpenStack End User Guide - `__. - diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 71795ddf4a..695259e37a 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -21,9 +21,8 @@ Dashboard, see the :doc:`/install/index` for your operating system. manage-volumes.rst manage-shares.rst set-quotas.rst - manage-resources.rst + manage-services.rst manage-host-aggregates.rst - admin-manage-stacks.rst - To deploy the dashboard, see the :doc:`/install/index`. - To launch instances with the dashboard as an end user, see the diff --git a/doc/source/admin/manage-host-aggregates.rst b/doc/source/admin/manage-host-aggregates.rst index c3134850c0..36c936b1dd 100644 --- a/doc/source/admin/manage-host-aggregates.rst +++ b/doc/source/admin/manage-host-aggregates.rst @@ -11,7 +11,7 @@ multiple aggregates. The scheduler uses this information to make scheduling decisions. For information, see -`Scheduling `__. +`Scheduling `__. To create a host aggregate ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/admin/manage-images.rst b/doc/source/admin/manage-images.rst index 689a820b4f..acde6dcd39 100644 --- a/doc/source/admin/manage-images.rst +++ b/doc/source/admin/manage-images.rst @@ -8,11 +8,10 @@ and manage images for users in all projects to which you have access. To create and manage images in specified projects as an end -user, see the `upload and manage images with Dashboard in -OpenStack End User Guide -`_ +user, see the :doc:`upload and manage images with Dashboard in +OpenStack End User Guide ` and `manage images with CLI in OpenStack End User Guide -`_ . +`_. To create and manage images as an administrator for other users, use the following procedures. diff --git a/doc/source/admin/manage-instances.rst b/doc/source/admin/manage-instances.rst index 9116f33218..64a70d6e42 100644 --- a/doc/source/admin/manage-instances.rst +++ b/doc/source/admin/manage-instances.rst @@ -8,7 +8,7 @@ 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 -user, see the `OpenStack End User Guide `__. +user, see the :doc:`OpenStack End User Guide `. Create instance snapshots ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -30,7 +30,7 @@ Create instance snapshots #. To launch an instance from the snapshot, select the snapshot and click :guilabel:`Launch`. For information about launching instances, see the - `OpenStack End User Guide `__. + :doc:`OpenStack End User Guide `. Control the state of an instance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/admin/manage-resources.rst b/doc/source/admin/manage-resources.rst deleted file mode 100644 index 7d4ed0bc1a..0000000000 --- a/doc/source/admin/manage-resources.rst +++ /dev/null @@ -1,10 +0,0 @@ -==================== -View cloud resources -==================== - - -.. toctree:: - :maxdepth: 2 - - manage-services.rst - view-cloud-resources.rst diff --git a/doc/source/admin/manage-shares.rst b/doc/source/admin/manage-shares.rst index 4c0933a431..9f99e2fe84 100644 --- a/doc/source/admin/manage-shares.rst +++ b/doc/source/admin/manage-shares.rst @@ -6,7 +6,7 @@ Shares are file storage that instances can access. Users can allow or deny a running instance to have access to a share at any time. For information about using the Dashboard to create and manage shares as an end user, see the -`OpenStack End User Guide `_. +:doc:`OpenStack End User Guide `. As an administrative user, you can manage shares and share types for users in various projects. You can create and delete share types, and view diff --git a/doc/source/admin/manage-volumes.rst b/doc/source/admin/manage-volumes.rst index 04d12e8ce8..8f187be5ad 100644 --- a/doc/source/admin/manage-volumes.rst +++ b/doc/source/admin/manage-volumes.rst @@ -6,7 +6,7 @@ Volumes are the Block Storage devices that you attach to instances to enable persistent storage. Users can attach a volume to a running instance or detach a volume and attach it to another instance at any time. For information about using the dashboard to create and manage volumes as an end user, see the -`OpenStack End User Guide `_. +:doc:`OpenStack End User Guide `. As an administrative user, you can manage volumes and volume types for users in various projects. You can create and delete volume types, and you can view @@ -118,7 +118,7 @@ volumes. To see further information and CLI instructions, see `Create an encrypted volume type - `_ + `__ in the OpenStack Configuration Reference. Delete volume types diff --git a/doc/source/admin/sessions.rst b/doc/source/admin/sessions.rst index b9a9068315..cb0208e8cf 100644 --- a/doc/source/admin/sessions.rst +++ b/doc/source/admin/sessions.rst @@ -11,8 +11,8 @@ back end. You customize the session back end through the 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 -`__ +the OpenStack dashboard. Refer to the +:doc:`OpenStack User Documentation ` chapter of the OpenStack End User Guide for further instructions on logging in to the Dashboard. diff --git a/doc/source/admin/set-quotas.rst b/doc/source/admin/set-quotas.rst index 904476a1cc..7ed7451eda 100644 --- a/doc/source/admin/set-quotas.rst +++ b/doc/source/admin/set-quotas.rst @@ -21,13 +21,18 @@ quotas for new projects, as well as update quotas for existing projects. .. note:: - Using the command-line interface, you can manage quotas for the - OpenStack Compute service, the OpenStack Block Storage service, and - the OpenStack Networking service (see `OpenStack Administrator Guide - `_). + Using the command-line interface, you can manage quotas for + `the OpenStack Compute service `__, + `the OpenStack Block Storage service `__, + and the OpenStack Networking service (For CLI details, + see `OpenStackClient CLI reference + `_). Additionally, you can update Compute service quotas for project users. +.. NOTE: Admin guide contents on the networking service quota + has not been migrated to neutron. Update the link once it is recovered. + The following table describes the Compute and Block Storage service quotas: .. _compute_quotas: diff --git a/doc/source/admin/view-cloud-resources.rst b/doc/source/admin/view-cloud-resources.rst deleted file mode 100644 index 223ea5553b..0000000000 --- a/doc/source/admin/view-cloud-resources.rst +++ /dev/null @@ -1,41 +0,0 @@ -=========================== -View cloud usage statistics -=========================== - -The Telemetry service provides user-level usage data for -OpenStack-based clouds, which can be used for customer billing, system -monitoring, or alerts. Data can be collected by notifications sent by -existing OpenStack components (for example, usage events emitted from -Compute) or by polling the infrastructure (for example, libvirt). - -.. note:: - - You can only view metering statistics on the dashboard (available - only to administrators). - The Telemetry service must be set up and administered through the - :command:`ceilometer` command-line interface (CLI). - - For basic administration information, refer to the `Measure Cloud - Resources `_ - chapter in the OpenStack End User Guide. - -.. _dashboard-view-resource-stats: - -View resource statistics -~~~~~~~~~~~~~~~~~~~~~~~~ - -#. Log in to the dashboard and select the :guilabel:`admin` project - from the drop-down list. - -#. On the :guilabel:`Admin` tab, click the :guilabel:`Resource Usage` category. - -#. Click the: - - * :guilabel:`Usage Report` tab to view a usage report per project - by specifying the time period (or even use a calendar to define - a date range). - - * :guilabel:`Stats` tab to view a multi-series line chart with - user-defined meters. You group by project, define the value type - (min, max, avg, or sum), and specify the time period (or even use - a calendar to define a date range). diff --git a/doc/source/user/create-networks.rst b/doc/source/user/create-networks.rst index 00006e3eb0..cbc2f32b43 100644 --- a/doc/source/user/create-networks.rst +++ b/doc/source/user/create-networks.rst @@ -9,9 +9,8 @@ creating and assigning new IP addresses). Networking in OpenStack is complex. This section provides the basic instructions for creating a network and a router. For detailed -information about managing networks, refer to the `OpenStack -Administrator -Guide `__. +information about managing networks, refer to the `OpenStack Networking Guide +`__. Create a network ~~~~~~~~~~~~~~~~ diff --git a/doc/source/user/launch-instances.rst b/doc/source/user/launch-instances.rst index ed50a905c4..834774e1ef 100644 --- a/doc/source/user/launch-instances.rst +++ b/doc/source/user/launch-instances.rst @@ -231,7 +231,7 @@ file. It is also possible to SSH into an instance without an SSH keypair, if the administrator has enabled root password injection. For more information about root password injection, see `Injecting the administrator password -`_ +`_ in the *OpenStack Administrator Guide*. Track usage for instances diff --git a/doc/source/user/stacks.rst b/doc/source/user/stacks.rst index b54d4f26a7..7767976b96 100644 --- a/doc/source/user/stacks.rst +++ b/doc/source/user/stacks.rst @@ -18,9 +18,7 @@ and users. Once created, the resources are referred to as stacks. The template languages are described in the `Template Guide -`_ in the `Heat developer documentation `_. +`_. Launch a stack ~~~~~~~~~~~~~~