diff --git a/doc/common/app-support.rst b/doc/common/app-support.rst index 3500b0095e..4329cfbe84 100644 --- a/doc/common/app-support.rst +++ b/doc/common/app-support.rst @@ -19,7 +19,7 @@ Documentation ~~~~~~~~~~~~~ For the available OpenStack documentation, see -`docs.openstack.org `__. +`docs.openstack.org `__. To provide feedback on documentation, join and use the openstack-docs@lists.openstack.org mailing list at `OpenStack @@ -34,45 +34,45 @@ associated components: * `Installation Tutorial for openSUSE Leap 42.2 and SUSE Linux Enterprise Server 12 SP2 - `__ + `__ * `Installation Tutorial for Red Hat Enterprise Linux 7 and CentOS 7 - `__ + `__ * `Installation Tutorial for Ubuntu 16.04 (LTS) - `__ + `__ * `Installation Tutorial for Debian with Debconf - `__ + `__ * `Installation Tutorial for Debian - `__ + `__ The following books explain how to configure and run an OpenStack cloud: -* `Architecture Design Guide `__ +* `Architecture Design Guide `__ -* `Administrator Guide `__ +* `Administrator Guide `__ -* `Configuration Reference `__ +* `Configuration Reference `__ -* `Operations Guide `__ +* `Operations Guide `__ -* `Networking Guide `__ +* `Networking Guide `__ -* `High Availability Guide `__ +* `High Availability Guide `__ -* `Security Guide `__ +* `Security Guide `__ -* `Virtual Machine Image Guide `__ +* `Virtual Machine Image Guide `__ The following books explain how to use the OpenStack Dashboard and command-line clients: -* `End User Guide `__ +* `End User Guide `__ * `Command-Line Interface Reference - `__ + `__ The following documentation provides reference and guidance information for the OpenStack APIs: @@ -81,7 +81,7 @@ for the OpenStack APIs: The following guide provides how to contribute to OpenStack documentation: -* `Documentation Contributor Guide `__ +* `Documentation Contributor Guide `__ ask.openstack.org ~~~~~~~~~~~~~~~~~ diff --git a/doc/common/cli-manage-images.rst b/doc/common/cli-manage-images.rst index 107fe1c413..ed5ad0da53 100644 --- a/doc/common/cli-manage-images.rst +++ b/doc/common/cli-manage-images.rst @@ -15,7 +15,7 @@ backup types. After you upload an image, you cannot change it. For details about image creation, see the `Virtual Machine Image -Guide `__. +Guide `__. List or get details for images (glance) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -121,7 +121,7 @@ To update an image by name or ID, use :command:`openstack image set`: The following list explains the optional arguments that you can use with the ``create`` and ``set`` commands to modify image properties. For more information, refer to the `OpenStack Image command reference -`_. +`_. The following example shows the command that you would use to upload a CentOS 6.3 image in qcow2 format and configure it for public access: @@ -142,7 +142,7 @@ model: :command:`openstack image create`. Also, we recommend that you set the ``hypervisor_type="vmware"`` property. For more information, see `Images with VMware vSphere - `_ + `_ in the OpenStack Configuration Reference. .. code-block:: console diff --git a/doc/common/cli-overview.rst b/doc/common/cli-overview.rst index 86a5187a10..5b4e2ccee4 100644 --- a/doc/common/cli-overview.rst +++ b/doc/common/cli-overview.rst @@ -32,7 +32,7 @@ Unified command-line client You can use the unified ``openstack`` command (**python-openstackclient**) for the most of OpenStack services. For more information, see `OpenStackClient document -`_. +`_. Individual command-line clients diff --git a/doc/common/get-started-compute.rst b/doc/common/get-started-compute.rst index f49ad57b20..cd98b4e614 100644 --- a/doc/common/get-started-compute.rst +++ b/doc/common/get-started-compute.rst @@ -27,7 +27,7 @@ OpenStack Compute consists of the following areas and their components: Accepts metadata requests from instances. The ``nova-api-metadata`` service is generally used when you run in multi-host mode with ``nova-network`` installations. For details, see `Metadata - service `__ + service `__ in the OpenStack Administrator Guide. ``nova-compute`` service @@ -54,7 +54,7 @@ OpenStack Compute consists of the following areas and their components: by the ``nova-compute`` service. The ``nova-conductor`` module scales horizontally. However, do not deploy it on nodes where the ``nova-compute`` service runs. For more information, see `Configuration - Reference Guide `__. + Reference Guide `__. ``nova-cert`` module A server daemon that serves the Nova Cert service for X509 @@ -67,7 +67,7 @@ OpenStack Compute consists of the following areas and their components: for console proxies to work. You can run proxies of either type against a single nova-consoleauth service in a cluster configuration. For information, see `About - nova-consoleauth `__. + nova-consoleauth `__. ``nova-novncproxy`` daemon Provides a proxy for accessing running instances through a VNC diff --git a/doc/common/get-started-image-service.rst b/doc/common/get-started-image-service.rst index e22da60cd0..f2ad4c4d23 100644 --- a/doc/common/get-started-image-service.rst +++ b/doc/common/get-started-image-service.rst @@ -24,7 +24,7 @@ systems to object-storage systems like OpenStack Object Storage. For information on requirements for other back ends, see `Configuration Reference - `__. + `__. The OpenStack Image service is central to Infrastructure-as-a-Service (IaaS) as shown in :ref:`get_started_conceptual_architecture`. It accepts API diff --git a/doc/common/get-started-logical-architecture.rst b/doc/common/get-started-logical-architecture.rst index 0f68f56eb4..5a51ceb20d 100644 --- a/doc/common/get-started-logical-architecture.rst +++ b/doc/common/get-started-logical-architecture.rst @@ -25,7 +25,7 @@ MySQL, MariaDB, and SQLite. Users can access OpenStack via the web-based user interface implemented by :doc:`Dashboard `, via `command-line -clients `__ and by +clients `__ and by issuing API requests through tools like browser plug-ins or :command:`curl`. For applications, `several SDKs `__ are available. Ultimately, all these access methods issue REST API calls diff --git a/doc/common/get-started-object-storage.rst b/doc/common/get-started-object-storage.rst index 407b43086f..34028e5024 100644 --- a/doc/common/get-started-object-storage.rst +++ b/doc/common/get-started-object-storage.rst @@ -41,7 +41,7 @@ swift-init Script that initializes the building of the ring file, takes daemon names as parameter and offers commands. Documented in `Managing Services - `_. + `_. swift-recon A cli tool used to retrieve various metrics and telemetry information @@ -50,4 +50,4 @@ swift-recon swift-ring-builder Storage ring build and rebalance utility. Documented in `Managing the Rings - `_. + `_. diff --git a/doc/common/get-started-shared-file-systems.rst b/doc/common/get-started-shared-file-systems.rst index 76af327031..9be9194d2a 100644 --- a/doc/common/get-started-shared-file-systems.rst +++ b/doc/common/get-started-shared-file-systems.rst @@ -35,4 +35,4 @@ manila-share Messaging queue Routes information between the Shared File Systems processes. -For more information, see `OpenStack Configuration Reference `__. +For more information, see `OpenStack Configuration Reference `__. diff --git a/doc/common/get-started-with-openstack.rst b/doc/common/get-started-with-openstack.rst index 30301a3b1d..f39c03868d 100644 --- a/doc/common/get-started-with-openstack.rst +++ b/doc/common/get-started-with-openstack.rst @@ -24,23 +24,23 @@ OpenStack architecture: - Project name - Description * - `Dashboard `__ - - `Horizon `__ + - `Horizon `__ - Provides a web-based self-service portal to interact with underlying OpenStack services, such as launching an instance, assigning IP addresses and configuring access controls. * - `Compute `__ - - `Nova `__ + - `Nova `__ - Manages the lifecycle of compute instances in an OpenStack environment. Responsibilities include spawning, scheduling and decommissioning of virtual machines on demand. * - `Networking `__ - - `Neutron `__ + - `Neutron `__ - Enables Network-Connectivity-as-a-Service for other OpenStack services, such as OpenStack Compute. Provides an API for users to define networks and the attachments into them. Has a pluggable architecture that supports many popular networking vendors and technologies. * - `Object Storage `__ - - `Swift `__ + - `Swift `__ - Stores and retrieves arbitrary unstructured data objects via a RESTful, HTTP based API. It is highly fault tolerant with its data replication and scale-out architecture. Its implementation is not like a file server @@ -48,35 +48,35 @@ OpenStack architecture: multiple drives, ensuring the data is replicated across a server cluster. * - `Block Storage `__ - - `Cinder `__ + - `Cinder `__ - Provides persistent block storage to running instances. Its pluggable driver architecture facilitates the creation and management of block storage devices. * - `Identity service `__ - - `Keystone `__ + - `Keystone `__ - Provides an authentication and authorization service for other OpenStack services. Provides a catalog of endpoints for all OpenStack services. * - `Image service `__ - - `Glance `__ + - `Glance `__ - Stores and retrieves virtual machine disk images. OpenStack Compute makes use of this during instance provisioning. * - `Telemetry `__ - - `Ceilometer `__ + - `Ceilometer `__ - Monitors and meters the OpenStack cloud for billing, benchmarking, scalability, and statistical purposes. * - `Orchestration `__ - - `Heat `__ + - `Heat `__ - Orchestrates multiple composite cloud applications by using either the native HOT template format or the AWS CloudFormation template format, through both an OpenStack-native REST API and a CloudFormation-compatible Query API. * - `Database service `__ - - `Trove `__ + - `Trove `__ - Provides scalable and reliable Cloud Database-as-a-Service functionality for both relational and non-relational database engines. * - `Data processing service `__ - - `Sahara `__ + - `Sahara `__ - Provides capabilities to provision and scale Hadoop clusters in OpenStack by specifying parameters like Hadoop version, cluster topology and nodes hardware details.