[User Guides] Rename Admin-Guide-Cloud to Admin-Guide

This patch changes the name of the Admin-Guide from the Cloud
Admin Guide to the Administrator guide. This affects the
filename in the repository, and references to cloud administrators
within the document texts.

1.) Changing instances of 'cloud administrator'
    to 'administrator'.

2.) Change links from '/admin-guide-cloud/' to
    '/admin-guide/' within the Admin Guide.

3.) Adjust .htaccess file.

Change-Id: I7f21a710e922981aa295afc0616de36fd819b523
Implements: blueprint user-guides-reorganised
This commit is contained in:
Joseph Robinson 2016-03-30 14:41:59 +10:00 committed by KATO Tomoyuki
parent 494752ea31
commit 2ce5b11b1a
219 changed files with 66 additions and 70 deletions

View File

@ -29,7 +29,7 @@ DOC_DIR="doc/"
declare -A SPECIAL_BOOKS=( declare -A SPECIAL_BOOKS=(
# This needs special handling, handle it with the RST tools. # This needs special handling, handle it with the RST tools.
["common"]="RST" ["common"]="RST"
["admin-guide-cloud"]="RST" ["admin-guide"]="RST"
["arch-design"]="RST" ["arch-design"]="RST"
["image-guide"]="RST" ["image-guide"]="RST"
["install-guide"]="RST" ["install-guide"]="RST"

View File

@ -25,7 +25,7 @@ System architecture
The Bare Metal service is composed of the following components: The Bare Metal service is composed of the following components:
#. An admin-only RESTful API service, by which privileged users, such #. An admin-only RESTful API service, by which privileged users, such
as cloud operators and other services within the cloud control as operators and other services within the cloud control
plane, may interact with the managed bare-metal servers. plane, may interact with the managed bare-metal servers.
#. A conductor service, which conducts all activity related to #. A conductor service, which conducts all activity related to

View File

@ -97,7 +97,7 @@ Volume replication extra specs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack Block Storage has the ability to create volume replicas. OpenStack Block Storage has the ability to create volume replicas.
Cloud administrators can define a storage policy that includes Administrators can define a storage policy that includes
replication by adjusting the cinder volume driver. Volume replication replication by adjusting the cinder volume driver. Volume replication
for OpenStack Block Storage helps safeguard OpenStack environments from for OpenStack Block Storage helps safeguard OpenStack environments from
data loss during disaster recovery. data loss during disaster recovery.
@ -117,11 +117,11 @@ At each data center, a cinder host supports the Block Storage service.
Both data centers include storage back ends. Both data centers include storage back ends.
Depending on the storage requirements, there can be one or two cinder Depending on the storage requirements, there can be one or two cinder
hosts. The cloud administrator accesses the hosts. The administrator accesses the
``/etc/cinder/cinder.conf`` configuration file and sets ``/etc/cinder/cinder.conf`` configuration file and sets
``capabilities:replication="<is> True"``. ``capabilities:replication="<is> True"``.
If one data center experiences a service failure, cloud administrators If one data center experiences a service failure, administrators
can redeploy the VM. The VM will run using a replicated, backed up can redeploy the VM. The VM will run using a replicated, backed up
volume on a host in the second data center. volume on a host in the second data center.

View File

@ -17,8 +17,7 @@ Internet.
section in the OpenStack End User Guide. section in the OpenStack End User Guide.
- For details on creating public networks using OpenStack Networking - For details on creating public networks using OpenStack Networking
(``neutron``), refer to `Advanced features through API extensions (``neutron``), refer to :ref:`networking-adv-features`.
<http://docs.openstack.org/admin-guide-cloud/networking_adv-features.html>`_.
No floating IP addresses are created by default in OpenStack Networking. No floating IP addresses are created by default in OpenStack Networking.
As an administrator using legacy networking (``nova-network``), you As an administrator using legacy networking (``nova-network``), you

View File

@ -9,8 +9,7 @@ that they are stored on the same back end, whereas anti-affinity
means that they are stored on different back ends. means that they are stored on different back ends.
For information on how to set up multiple back ends for Cinder, For information on how to set up multiple back ends for Cinder,
refer to the guide for `Configuring multiple-storage back ends refer to :ref:`multi_backend`.
<http://docs.openstack.org/admin-guide-cloud/blockstorage_multi_backend.html>`__.
Example Usages Example Usages
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~

View File

@ -12,8 +12,7 @@ that can be launched.
Flavors can also determine on which compute host a flavor Flavors can also determine on which compute host a flavor
can be used to launch an instance. For information can be used to launch an instance. For information
about customizing flavors, refer to `Flavors about customizing flavors, refer to :ref:`compute-flavors`.
<http://docs.openstack.org/admin-guide-cloud/compute-flavors.html>`_.
A flavor consists of the following parameters: A flavor consists of the following parameters:
@ -132,7 +131,7 @@ Create a flavor
``Random-number generator``. ``Random-number generator``.
For information about supporting metadata keys, see For information about supporting metadata keys, see
`Flavors `Flavors
<http://docs.openstack.org/admin-guide-cloud/compute-flavors.html>`__. <http://docs.openstack.org/admin-guide/compute-flavors.html>`__.
For a list of optional parameters, run this command: For a list of optional parameters, run this command:

View File

@ -2,7 +2,7 @@
Manage projects, users, and roles Manage projects, users, and roles
================================= =================================
As a cloud administrator, you manage projects, users, and As an administrator, you manage projects, users, and
roles. Projects are organizational units in the cloud to which roles. Projects are organizational units in the cloud to which
you can assign users. Projects are also known as *tenants* or you can assign users. Projects are also known as *tenants* or
*accounts*. Users can be members of one or more projects. Roles *accounts*. Users can be members of one or more projects. Roles

View File

@ -42,7 +42,7 @@ current VM host is not operational. Otherwise, the evacuation fails.
#. To preserve the user disk data on the evacuated server, deploy Compute #. To preserve the user disk data on the evacuated server, deploy Compute
with a shared file system. To configure your system, see with a shared file system. To configure your system, see
`Configure migrations <http://docs.openstack.org/admin-guide-cloud/compute-configuring-migrations.html>`_. :ref:`section_configuring-compute-migrations`.
The following example does not change the password. The following example does not change the password.
.. code-block:: console .. code-block:: console

View File

@ -30,8 +30,7 @@ If set to:
Additionally, the number of maximum rules per security group is Additionally, the number of maximum rules per security group is
controlled by the ``security_group_rules`` and the number of allowed controlled by the ``security_group_rules`` and the number of allowed
security groups per project is controlled by the ``security_groups`` security groups per project is controlled by the ``security_groups``
quota (see the `Manage quotas <http://docs.openstack.org/admin-guide-cloud/cli_set_quotas.html>`_ quota (see :ref:`manage-quotas`).
section).
List and view current security groups List and view current security groups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -1,3 +1,5 @@
.. _manage-quotas:
============= =============
Manage quotas Manage quotas
============= =============

View File

@ -9,7 +9,7 @@ Configure migrations
.. note:: .. note::
Only cloud administrators can perform live migrations. If your cloud Only administrators can perform live migrations. If your cloud
is configured to use cells, you can perform live migration within is configured to use cells, you can perform live migration within
but not between cells. but not between cells.

View File

@ -57,7 +57,7 @@ available vCPU, memory, and local disk resources. Additionally, the
**The base image state with no running instances** **The base image state with no running instances**
.. figure:: ../../admin-guide-cloud/source/figures/instance-life-1.png .. figure:: figures/instance-life-1.png
| |
@ -76,7 +76,7 @@ disk on this instance, ``vdc``.
**Instance creation from an image** **Instance creation from an image**
.. figure:: ../../admin-guide-cloud/source/figures/instance-life-2.png .. figure:: figures/instance-life-2.png
| |
@ -117,7 +117,7 @@ process.
**The end state of an image and volume after the instance exits** **The end state of an image and volume after the instance exits**
.. figure:: ../../admin-guide-cloud/source/figures/instance-life-3.png .. figure:: figures/instance-life-3.png
| |
@ -125,22 +125,22 @@ process.
Image properties and property protection Image properties and property protection
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
An image property is a key and value pair that the cloud administrator An image property is a key and value pair that the administrator
or the image owner attaches to an OpenStack Image service image, as or the image owner attaches to an OpenStack Image service image, as
follows: follows:
- The cloud administrator defines core properties, such as the image - The administrator defines core properties, such as the image
name. name.
- The cloud administrator and the image owner can define additional - The administrator and the image owner can define additional
properties, such as licensing and billing information. properties, such as licensing and billing information.
The cloud administrator can configure any property as protected, which The administrator can configure any property as protected, which
limits which policies or user roles can perform CRUD operations on that limits which policies or user roles can perform CRUD operations on that
property. Protected properties are generally additional properties to property. Protected properties are generally additional properties to
which only cloud administrators have access. which only administrators have access.
For unprotected image properties, the cloud administrator can manage For unprotected image properties, the administrator can manage
core properties and the image owner can manage additional properties. core properties and the image owner can manage additional properties.
**To configure property protection** **To configure property protection**
@ -436,7 +436,7 @@ make it their only format.
**To configure UEFI environment** **To configure UEFI environment**
To successfully launch an instance from an UEFI image in QEMU/KVM To successfully launch an instance from an UEFI image in QEMU/KVM
environment, the cloud administrator has to install the following environment, the administrator has to install the following
packages on compute node: packages on compute node:
- OVMF, a port of Intel's tianocore firmware to QEMU virtual machine. - OVMF, a port of Intel's tianocore firmware to QEMU virtual machine.
@ -444,7 +444,7 @@ packages on compute node:
- libvirt, which has been supporting UEFI boot since version 1.2.9. - libvirt, which has been supporting UEFI boot since version 1.2.9.
Because default UEFI loader path is ``/usr/share/OVMF/OVMF_CODE.fd``, the Because default UEFI loader path is ``/usr/share/OVMF/OVMF_CODE.fd``, the
cloud administrator must create one link to this location after UEFI package administrator must create one link to this location after UEFI package
is installed. is installed.
**To upload UEFI images** **To upload UEFI images**

View File

@ -55,8 +55,8 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Cloud Administrator Guide' project = u'Administrator Guide'
bug_tag = u'admin-guide-cloud' bug_tag = u'admin-guide'
copyright = u'2015-2016, OpenStack contributors' copyright = u'2015-2016, OpenStack contributors'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
@ -73,7 +73,7 @@ release = '0.9'
# gitsha: The SHA checksum of the bug description. Automatically extracted from git log. # gitsha: The SHA checksum of the bug description. Automatically extracted from git log.
# bug_tag: Tag for categorizing the bug. Must be set manually. # bug_tag: Tag for categorizing the bug. Must be set manually.
# These variables are passed to the logabug code via html_context. # These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/admin-guide-cloud/source' giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/admin-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag, html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
@ -204,7 +204,7 @@ html_show_sourcelink = False
# html_file_suffix = None # html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'admin-guide-cloud' htmlhelp_basename = 'admin-guide'
# If true, publish source files # If true, publish source files
html_copy_source = False html_copy_source = False
@ -230,7 +230,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', 'CloudAdminGuide.tex', u'Cloud Administrator Guide', ('index', 'AdminGuide.tex', u'Administrator Guide',
u'OpenStack contributors', 'manual'), u'OpenStack contributors', 'manual'),
] ]
@ -260,7 +260,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'cloudadminguide', u'Cloud Administrator Guide', ('index', 'adminguide', u'Administrator Guide',
[u'OpenStack contributors'], 1) [u'OpenStack contributors'], 1)
] ]
@ -274,8 +274,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'CloudAdminGuide', u'Cloud Administrator Guide', ('index', 'AdminGuidereview/joseph_robinson/bp/user-guides-reorganised',
u'OpenStack contributors', 'CloudAdminGuide', u'Administrator Guide', u'OpenStack contributors', 'AdminGuide',
'This guide shows OpenStack end users how to create and manage resources ' 'This guide shows OpenStack end users how to create and manage resources '
'in an OpenStack cloud with the OpenStack dashboard and OpenStack client ' 'in an OpenStack cloud with the OpenStack dashboard and OpenStack client '
'commands.', 'Miscellaneous'), 'commands.', 'Miscellaneous'),
@ -299,6 +299,6 @@ locale_dirs = ['locale/']
# -- Options for PDF output -------------------------------------------------- # -- Options for PDF output --------------------------------------------------
pdf_documents = [ pdf_documents = [
('index', u'CloudAdminGuide', u'Cloud Administrator Guide', ('index', u'AdminGuide', u'Administrator Guide',
u'OpenStack contributors') u'OpenStack contributors')
] ]

View File

@ -144,8 +144,7 @@ Update Metadata
+-------------------------------+-------------------------------+ +-------------------------------+-------------------------------+
For information about supporting metadata keys, see the For information about supporting metadata keys, see the
`OpenStack Cloud Administrator Guide :ref:`compute-flavors`.
<http://docs.openstack.org/admin-guide-cloud/compute-flavors.html>`__.
Delete flavors Delete flavors
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~

View File

Before

Width:  |  Height:  |  Size: 123 KiB

After

Width:  |  Height:  |  Size: 123 KiB

View File

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View File

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 96 KiB

View File

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

View File

Before

Width:  |  Height:  |  Size: 67 KiB

After

Width:  |  Height:  |  Size: 67 KiB

View File

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 85 KiB

Some files were not shown because too many files have changed in this diff Show More