diff --git a/doc-tools-check-languages.conf b/doc-tools-check-languages.conf index 1a95b69f7f..3012e5be78 100644 --- a/doc-tools-check-languages.conf +++ b/doc-tools-check-languages.conf @@ -29,7 +29,7 @@ DOC_DIR="doc/" declare -A SPECIAL_BOOKS=( # This needs special handling, handle it with the RST tools. ["common"]="RST" - ["admin-guide-cloud"]="RST" + ["admin-guide"]="RST" ["arch-design"]="RST" ["image-guide"]="RST" ["install-guide"]="RST" diff --git a/doc/admin-guide-cloud/setup.cfg b/doc/admin-guide/setup.cfg similarity index 100% rename from doc/admin-guide-cloud/setup.cfg rename to doc/admin-guide/setup.cfg diff --git a/doc/admin-guide-cloud/setup.py b/doc/admin-guide/setup.py similarity index 100% rename from doc/admin-guide-cloud/setup.py rename to doc/admin-guide/setup.py diff --git a/doc/admin-guide-cloud/source/baremetal.rst b/doc/admin-guide/source/baremetal.rst similarity index 98% rename from doc/admin-guide-cloud/source/baremetal.rst rename to doc/admin-guide/source/baremetal.rst index 93fc30a5ea..5e11e6cede 100644 --- a/doc/admin-guide-cloud/source/baremetal.rst +++ b/doc/admin-guide/source/baremetal.rst @@ -25,7 +25,7 @@ System architecture The Bare Metal service is composed of the following components: #. 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. #. A conductor service, which conducts all activity related to diff --git a/doc/admin-guide-cloud/source/blockstorage-api-throughput.rst b/doc/admin-guide/source/blockstorage-api-throughput.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage-api-throughput.rst rename to doc/admin-guide/source/blockstorage-api-throughput.rst diff --git a/doc/admin-guide-cloud/source/blockstorage-boot-from-volume.rst b/doc/admin-guide/source/blockstorage-boot-from-volume.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage-boot-from-volume.rst rename to doc/admin-guide/source/blockstorage-boot-from-volume.rst diff --git a/doc/admin-guide-cloud/source/blockstorage-consistency-groups.rst b/doc/admin-guide/source/blockstorage-consistency-groups.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage-consistency-groups.rst rename to doc/admin-guide/source/blockstorage-consistency-groups.rst diff --git a/doc/admin-guide-cloud/source/blockstorage-driver-filter-weighing.rst b/doc/admin-guide/source/blockstorage-driver-filter-weighing.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage-driver-filter-weighing.rst rename to doc/admin-guide/source/blockstorage-driver-filter-weighing.rst diff --git a/doc/admin-guide-cloud/source/blockstorage-lio-iscsi-support.rst b/doc/admin-guide/source/blockstorage-lio-iscsi-support.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage-lio-iscsi-support.rst rename to doc/admin-guide/source/blockstorage-lio-iscsi-support.rst diff --git a/doc/admin-guide-cloud/source/blockstorage-manage-volumes.rst b/doc/admin-guide/source/blockstorage-manage-volumes.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage-manage-volumes.rst rename to doc/admin-guide/source/blockstorage-manage-volumes.rst diff --git a/doc/admin-guide-cloud/source/blockstorage-troubleshoot.rst b/doc/admin-guide/source/blockstorage-troubleshoot.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage-troubleshoot.rst rename to doc/admin-guide/source/blockstorage-troubleshoot.rst diff --git a/doc/admin-guide-cloud/source/blockstorage.rst b/doc/admin-guide/source/blockstorage.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage.rst rename to doc/admin-guide/source/blockstorage.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_backup_disks.rst b/doc/admin-guide/source/blockstorage_backup_disks.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_backup_disks.rst rename to doc/admin-guide/source/blockstorage_backup_disks.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_get_capabilities.rst b/doc/admin-guide/source/blockstorage_get_capabilities.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_get_capabilities.rst rename to doc/admin-guide/source/blockstorage_get_capabilities.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_glusterfs_backend.rst b/doc/admin-guide/source/blockstorage_glusterfs_backend.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_glusterfs_backend.rst rename to doc/admin-guide/source/blockstorage_glusterfs_backend.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_glusterfs_removal.rst b/doc/admin-guide/source/blockstorage_glusterfs_removal.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_glusterfs_removal.rst rename to doc/admin-guide/source/blockstorage_glusterfs_removal.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_image_volume_cache.rst b/doc/admin-guide/source/blockstorage_image_volume_cache.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_image_volume_cache.rst rename to doc/admin-guide/source/blockstorage_image_volume_cache.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_multi_backend.rst b/doc/admin-guide/source/blockstorage_multi_backend.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_multi_backend.rst rename to doc/admin-guide/source/blockstorage_multi_backend.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_nfs_backend.rst b/doc/admin-guide/source/blockstorage_nfs_backend.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_nfs_backend.rst rename to doc/admin-guide/source/blockstorage_nfs_backend.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_over_subscription.rst b/doc/admin-guide/source/blockstorage_over_subscription.rst similarity index 96% rename from doc/admin-guide-cloud/source/blockstorage_over_subscription.rst rename to doc/admin-guide/source/blockstorage_over_subscription.rst index 51507d4950..b01c0a691a 100644 --- a/doc/admin-guide-cloud/source/blockstorage_over_subscription.rst +++ b/doc/admin-guide/source/blockstorage_over_subscription.rst @@ -97,7 +97,7 @@ Volume replication extra specs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 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 for OpenStack Block Storage helps safeguard OpenStack environments from 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. 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 ``capabilities:replication=" 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 volume on a host in the second data center. diff --git a/doc/admin-guide-cloud/source/blockstorage_ratelimit_volume_copy_bandwidth.rst b/doc/admin-guide/source/blockstorage_ratelimit_volume_copy_bandwidth.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_ratelimit_volume_copy_bandwidth.rst rename to doc/admin-guide/source/blockstorage_ratelimit_volume_copy_bandwidth.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_volume_backed_image.rst b/doc/admin-guide/source/blockstorage_volume_backed_image.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_volume_backed_image.rst rename to doc/admin-guide/source/blockstorage_volume_backed_image.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_volume_backups.rst b/doc/admin-guide/source/blockstorage_volume_backups.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_volume_backups.rst rename to doc/admin-guide/source/blockstorage_volume_backups.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_volume_backups_export_import.rst b/doc/admin-guide/source/blockstorage_volume_backups_export_import.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_volume_backups_export_import.rst rename to doc/admin-guide/source/blockstorage_volume_backups_export_import.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_volume_migration.rst b/doc/admin-guide/source/blockstorage_volume_migration.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_volume_migration.rst rename to doc/admin-guide/source/blockstorage_volume_migration.rst diff --git a/doc/admin-guide-cloud/source/blockstorage_volume_number_weigher.rst b/doc/admin-guide/source/blockstorage_volume_number_weigher.rst similarity index 100% rename from doc/admin-guide-cloud/source/blockstorage_volume_number_weigher.rst rename to doc/admin-guide/source/blockstorage_volume_number_weigher.rst diff --git a/doc/admin-guide-cloud/source/cli.rst b/doc/admin-guide/source/cli.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli.rst rename to doc/admin-guide/source/cli.rst diff --git a/doc/admin-guide-cloud/source/cli_admin_manage_environment.rst b/doc/admin-guide/source/cli_admin_manage_environment.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_admin_manage_environment.rst rename to doc/admin-guide/source/cli_admin_manage_environment.rst diff --git a/doc/admin-guide-cloud/source/cli_admin_manage_ip_addresses.rst b/doc/admin-guide/source/cli_admin_manage_ip_addresses.rst similarity index 96% rename from doc/admin-guide-cloud/source/cli_admin_manage_ip_addresses.rst rename to doc/admin-guide/source/cli_admin_manage_ip_addresses.rst index 97caa03793..313d080a6e 100644 --- a/doc/admin-guide-cloud/source/cli_admin_manage_ip_addresses.rst +++ b/doc/admin-guide/source/cli_admin_manage_ip_addresses.rst @@ -17,8 +17,7 @@ Internet. section in the OpenStack End User Guide. - For details on creating public networks using OpenStack Networking - (``neutron``), refer to `Advanced features through API extensions - `_. + (``neutron``), refer to :ref:`networking-adv-features`. No floating IP addresses are created by default in OpenStack Networking. As an administrator using legacy networking (``nova-network``), you diff --git a/doc/admin-guide-cloud/source/cli_admin_manage_stacks.rst b/doc/admin-guide/source/cli_admin_manage_stacks.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_admin_manage_stacks.rst rename to doc/admin-guide/source/cli_admin_manage_stacks.rst diff --git a/doc/admin-guide-cloud/source/cli_analyzing-log-files-with-swift.rst b/doc/admin-guide/source/cli_analyzing-log-files-with-swift.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_analyzing-log-files-with-swift.rst rename to doc/admin-guide/source/cli_analyzing-log-files-with-swift.rst diff --git a/doc/admin-guide-cloud/source/cli_cinder_quotas.rst b/doc/admin-guide/source/cli_cinder_quotas.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_cinder_quotas.rst rename to doc/admin-guide/source/cli_cinder_quotas.rst diff --git a/doc/admin-guide-cloud/source/cli_cinder_scheduling.rst b/doc/admin-guide/source/cli_cinder_scheduling.rst similarity index 90% rename from doc/admin-guide-cloud/source/cli_cinder_scheduling.rst rename to doc/admin-guide/source/cli_cinder_scheduling.rst index a1566fabe8..51a2370682 100644 --- a/doc/admin-guide-cloud/source/cli_cinder_scheduling.rst +++ b/doc/admin-guide/source/cli_cinder_scheduling.rst @@ -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. 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`. Example Usages ~~~~~~~~~~~~~~ diff --git a/doc/admin-guide-cloud/source/cli_keystone_manage_services.rst b/doc/admin-guide/source/cli_keystone_manage_services.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_keystone_manage_services.rst rename to doc/admin-guide/source/cli_keystone_manage_services.rst diff --git a/doc/admin-guide-cloud/source/cli_manage_flavors.rst b/doc/admin-guide/source/cli_manage_flavors.rst similarity index 95% rename from doc/admin-guide-cloud/source/cli_manage_flavors.rst rename to doc/admin-guide/source/cli_manage_flavors.rst index 05630283b2..0a450d9f5c 100644 --- a/doc/admin-guide-cloud/source/cli_manage_flavors.rst +++ b/doc/admin-guide/source/cli_manage_flavors.rst @@ -12,8 +12,7 @@ that can be launched. Flavors can also determine on which compute host a flavor can be used to launch an instance. For information - about customizing flavors, refer to `Flavors - `_. + about customizing flavors, refer to :ref:`compute-flavors`. A flavor consists of the following parameters: @@ -132,7 +131,7 @@ Create a flavor ``Random-number generator``. For information about supporting metadata keys, see `Flavors - `__. + `__. For a list of optional parameters, run this command: diff --git a/doc/admin-guide-cloud/source/cli_manage_projects_users_and_roles.rst b/doc/admin-guide/source/cli_manage_projects_users_and_roles.rst similarity index 99% rename from doc/admin-guide-cloud/source/cli_manage_projects_users_and_roles.rst rename to doc/admin-guide/source/cli_manage_projects_users_and_roles.rst index 1929076dd3..771e7b20fb 100644 --- a/doc/admin-guide-cloud/source/cli_manage_projects_users_and_roles.rst +++ b/doc/admin-guide/source/cli_manage_projects_users_and_roles.rst @@ -2,7 +2,7 @@ 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 you can assign users. Projects are also known as *tenants* or *accounts*. Users can be members of one or more projects. Roles diff --git a/doc/admin-guide-cloud/source/cli_manage_services.rst b/doc/admin-guide/source/cli_manage_services.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_manage_services.rst rename to doc/admin-guide/source/cli_manage_services.rst diff --git a/doc/admin-guide-cloud/source/cli_manage_shares.rst b/doc/admin-guide/source/cli_manage_shares.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_manage_shares.rst rename to doc/admin-guide/source/cli_manage_shares.rst diff --git a/doc/admin-guide-cloud/source/cli_networking_advanced_quotas.rst b/doc/admin-guide/source/cli_networking_advanced_quotas.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_networking_advanced_quotas.rst rename to doc/admin-guide/source/cli_networking_advanced_quotas.rst diff --git a/doc/admin-guide-cloud/source/cli_nova_evacuate.rst b/doc/admin-guide/source/cli_nova_evacuate.rst similarity index 94% rename from doc/admin-guide-cloud/source/cli_nova_evacuate.rst rename to doc/admin-guide/source/cli_nova_evacuate.rst index 00e50d1de4..0f75d9c7e7 100644 --- a/doc/admin-guide-cloud/source/cli_nova_evacuate.rst +++ b/doc/admin-guide/source/cli_nova_evacuate.rst @@ -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 with a shared file system. To configure your system, see - `Configure migrations `_. + :ref:`section_configuring-compute-migrations`. The following example does not change the password. .. code-block:: console diff --git a/doc/admin-guide-cloud/source/cli_nova_manage_projects_security.rst b/doc/admin-guide/source/cli_nova_manage_projects_security.rst similarity index 98% rename from doc/admin-guide-cloud/source/cli_nova_manage_projects_security.rst rename to doc/admin-guide/source/cli_nova_manage_projects_security.rst index 065d05c997..fe6dc85600 100644 --- a/doc/admin-guide-cloud/source/cli_nova_manage_projects_security.rst +++ b/doc/admin-guide/source/cli_nova_manage_projects_security.rst @@ -30,8 +30,7 @@ If set to: Additionally, the number of maximum rules per security group is controlled by the ``security_group_rules`` and the number of allowed security groups per project is controlled by the ``security_groups`` -quota (see the `Manage quotas `_ -section). +quota (see :ref:`manage-quotas`). List and view current security groups ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/admin-guide-cloud/source/cli_nova_manage_services.rst b/doc/admin-guide/source/cli_nova_manage_services.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_nova_manage_services.rst rename to doc/admin-guide/source/cli_nova_manage_services.rst diff --git a/doc/admin-guide-cloud/source/cli_nova_migrate.rst b/doc/admin-guide/source/cli_nova_migrate.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_nova_migrate.rst rename to doc/admin-guide/source/cli_nova_migrate.rst diff --git a/doc/admin-guide-cloud/source/cli_nova_migrate_cfg_ssh.rst b/doc/admin-guide/source/cli_nova_migrate_cfg_ssh.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_nova_migrate_cfg_ssh.rst rename to doc/admin-guide/source/cli_nova_migrate_cfg_ssh.rst diff --git a/doc/admin-guide-cloud/source/cli_nova_numa_libvirt.rst b/doc/admin-guide/source/cli_nova_numa_libvirt.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_nova_numa_libvirt.rst rename to doc/admin-guide/source/cli_nova_numa_libvirt.rst diff --git a/doc/admin-guide-cloud/source/cli_nova_specify_host.rst b/doc/admin-guide/source/cli_nova_specify_host.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_nova_specify_host.rst rename to doc/admin-guide/source/cli_nova_specify_host.rst diff --git a/doc/admin-guide-cloud/source/cli_set_compute_quotas.rst b/doc/admin-guide/source/cli_set_compute_quotas.rst similarity index 100% rename from doc/admin-guide-cloud/source/cli_set_compute_quotas.rst rename to doc/admin-guide/source/cli_set_compute_quotas.rst diff --git a/doc/admin-guide-cloud/source/cli_set_quotas.rst b/doc/admin-guide/source/cli_set_quotas.rst similarity index 98% rename from doc/admin-guide-cloud/source/cli_set_quotas.rst rename to doc/admin-guide/source/cli_set_quotas.rst index 920ae3f782..9f383b8007 100644 --- a/doc/admin-guide-cloud/source/cli_set_quotas.rst +++ b/doc/admin-guide/source/cli_set_quotas.rst @@ -1,3 +1,5 @@ +.. _manage-quotas: + ============= Manage quotas ============= diff --git a/doc/admin-guide-cloud/source/common b/doc/admin-guide/source/common similarity index 100% rename from doc/admin-guide-cloud/source/common rename to doc/admin-guide/source/common diff --git a/doc/admin-guide-cloud/source/compute-admin-password-injection.rst b/doc/admin-guide/source/compute-admin-password-injection.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-admin-password-injection.rst rename to doc/admin-guide/source/compute-admin-password-injection.rst diff --git a/doc/admin-guide-cloud/source/compute-configuring-migrations.rst b/doc/admin-guide/source/compute-configuring-migrations.rst similarity index 99% rename from doc/admin-guide-cloud/source/compute-configuring-migrations.rst rename to doc/admin-guide/source/compute-configuring-migrations.rst index 0c1dd8f5f9..357733e5da 100644 --- a/doc/admin-guide-cloud/source/compute-configuring-migrations.rst +++ b/doc/admin-guide/source/compute-configuring-migrations.rst @@ -9,7 +9,7 @@ Configure migrations .. 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 but not between cells. diff --git a/doc/admin-guide-cloud/source/compute-default-ports.rst b/doc/admin-guide/source/compute-default-ports.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-default-ports.rst rename to doc/admin-guide/source/compute-default-ports.rst diff --git a/doc/admin-guide-cloud/source/compute-euca2ools.rst b/doc/admin-guide/source/compute-euca2ools.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-euca2ools.rst rename to doc/admin-guide/source/compute-euca2ools.rst diff --git a/doc/admin-guide-cloud/source/compute-flavors.rst b/doc/admin-guide/source/compute-flavors.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-flavors.rst rename to doc/admin-guide/source/compute-flavors.rst diff --git a/doc/admin-guide-cloud/source/compute-images-instances.rst b/doc/admin-guide/source/compute-images-instances.rst similarity index 95% rename from doc/admin-guide-cloud/source/compute-images-instances.rst rename to doc/admin-guide/source/compute-images-instances.rst index 12c1152efa..65dbaaffb3 100644 --- a/doc/admin-guide-cloud/source/compute-images-instances.rst +++ b/doc/admin-guide/source/compute-images-instances.rst @@ -57,7 +57,7 @@ available vCPU, memory, and local disk resources. Additionally, the **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** -.. 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** -.. 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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 follows: -- The cloud administrator defines core properties, such as the image +- The administrator defines core properties, such as the image 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. -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 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. **To configure property protection** @@ -436,7 +436,7 @@ make it their only format. **To configure UEFI environment** 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: - 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. 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. **To upload UEFI images** diff --git a/doc/admin-guide-cloud/source/compute-live-migration-usage.rst b/doc/admin-guide/source/compute-live-migration-usage.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-live-migration-usage.rst rename to doc/admin-guide/source/compute-live-migration-usage.rst diff --git a/doc/admin-guide-cloud/source/compute-manage-logs.rst b/doc/admin-guide/source/compute-manage-logs.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-manage-logs.rst rename to doc/admin-guide/source/compute-manage-logs.rst diff --git a/doc/admin-guide-cloud/source/compute-manage-the-cloud.rst b/doc/admin-guide/source/compute-manage-the-cloud.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-manage-the-cloud.rst rename to doc/admin-guide/source/compute-manage-the-cloud.rst diff --git a/doc/admin-guide-cloud/source/compute-manage-users.rst b/doc/admin-guide/source/compute-manage-users.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-manage-users.rst rename to doc/admin-guide/source/compute-manage-users.rst diff --git a/doc/admin-guide-cloud/source/compute-manage-volumes.rst b/doc/admin-guide/source/compute-manage-volumes.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-manage-volumes.rst rename to doc/admin-guide/source/compute-manage-volumes.rst diff --git a/doc/admin-guide-cloud/source/compute-networking-nova.rst b/doc/admin-guide/source/compute-networking-nova.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-networking-nova.rst rename to doc/admin-guide/source/compute-networking-nova.rst diff --git a/doc/admin-guide-cloud/source/compute-node-down.rst b/doc/admin-guide/source/compute-node-down.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-node-down.rst rename to doc/admin-guide/source/compute-node-down.rst diff --git a/doc/admin-guide-cloud/source/compute-remote-console-access.rst b/doc/admin-guide/source/compute-remote-console-access.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-remote-console-access.rst rename to doc/admin-guide/source/compute-remote-console-access.rst diff --git a/doc/admin-guide-cloud/source/compute-root-wrap-reference.rst b/doc/admin-guide/source/compute-root-wrap-reference.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-root-wrap-reference.rst rename to doc/admin-guide/source/compute-root-wrap-reference.rst diff --git a/doc/admin-guide-cloud/source/compute-security.rst b/doc/admin-guide/source/compute-security.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-security.rst rename to doc/admin-guide/source/compute-security.rst diff --git a/doc/admin-guide-cloud/source/compute-service-groups.rst b/doc/admin-guide/source/compute-service-groups.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-service-groups.rst rename to doc/admin-guide/source/compute-service-groups.rst diff --git a/doc/admin-guide-cloud/source/compute-system-admin.rst b/doc/admin-guide/source/compute-system-admin.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute-system-admin.rst rename to doc/admin-guide/source/compute-system-admin.rst diff --git a/doc/admin-guide-cloud/source/compute.rst b/doc/admin-guide/source/compute.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute.rst rename to doc/admin-guide/source/compute.rst diff --git a/doc/admin-guide-cloud/source/compute_arch.rst b/doc/admin-guide/source/compute_arch.rst similarity index 100% rename from doc/admin-guide-cloud/source/compute_arch.rst rename to doc/admin-guide/source/compute_arch.rst diff --git a/doc/admin-guide-cloud/source/conf.py b/doc/admin-guide/source/conf.py similarity index 95% rename from doc/admin-guide-cloud/source/conf.py rename to doc/admin-guide/source/conf.py index 6ef2dc7f00..a88920cf11 100644 --- a/doc/admin-guide-cloud/source/conf.py +++ b/doc/admin-guide/source/conf.py @@ -55,8 +55,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Cloud Administrator Guide' -bug_tag = u'admin-guide-cloud' +project = u'Administrator Guide' +bug_tag = u'admin-guide' copyright = u'2015-2016, OpenStack contributors' # 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. # bug_tag: Tag for categorizing the bug. Must be set manually. # 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' '" gitsha = os.popen(git_cmd).read().strip('\n') html_context = {"gitsha": gitsha, "bug_tag": bug_tag, @@ -204,7 +204,7 @@ html_show_sourcelink = False # html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'admin-guide-cloud' +htmlhelp_basename = 'admin-guide' # If true, publish source files html_copy_source = False @@ -230,7 +230,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'CloudAdminGuide.tex', u'Cloud Administrator Guide', + ('index', 'AdminGuide.tex', u'Administrator Guide', u'OpenStack contributors', 'manual'), ] @@ -260,7 +260,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'cloudadminguide', u'Cloud Administrator Guide', + ('index', 'adminguide', u'Administrator Guide', [u'OpenStack contributors'], 1) ] @@ -274,8 +274,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'CloudAdminGuide', u'Cloud Administrator Guide', - u'OpenStack contributors', 'CloudAdminGuide', + ('index', 'AdminGuidereview/joseph_robinson/bp/user-guides-reorganised', + u'Administrator Guide', u'OpenStack contributors', 'AdminGuide', 'This guide shows OpenStack end users how to create and manage resources ' 'in an OpenStack cloud with the OpenStack dashboard and OpenStack client ' 'commands.', 'Miscellaneous'), @@ -299,6 +299,6 @@ locale_dirs = ['locale/'] # -- Options for PDF output -------------------------------------------------- pdf_documents = [ - ('index', u'CloudAdminGuide', u'Cloud Administrator Guide', + ('index', u'AdminGuide', u'Administrator Guide', u'OpenStack contributors') ] diff --git a/doc/admin-guide-cloud/source/cross_project.rst b/doc/admin-guide/source/cross_project.rst similarity index 100% rename from doc/admin-guide-cloud/source/cross_project.rst rename to doc/admin-guide/source/cross_project.rst diff --git a/doc/admin-guide-cloud/source/cross_project_cors.rst b/doc/admin-guide/source/cross_project_cors.rst similarity index 100% rename from doc/admin-guide-cloud/source/cross_project_cors.rst rename to doc/admin-guide/source/cross_project_cors.rst diff --git a/doc/admin-guide-cloud/source/dashboard.rst b/doc/admin-guide/source/dashboard.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard.rst rename to doc/admin-guide/source/dashboard.rst diff --git a/doc/admin-guide-cloud/source/dashboard_admin_manage_roles.rst b/doc/admin-guide/source/dashboard_admin_manage_roles.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_admin_manage_roles.rst rename to doc/admin-guide/source/dashboard_admin_manage_roles.rst diff --git a/doc/admin-guide-cloud/source/dashboard_admin_manage_stacks.rst b/doc/admin-guide/source/dashboard_admin_manage_stacks.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_admin_manage_stacks.rst rename to doc/admin-guide/source/dashboard_admin_manage_stacks.rst diff --git a/doc/admin-guide-cloud/source/dashboard_manage_flavors.rst b/doc/admin-guide/source/dashboard_manage_flavors.rst similarity index 98% rename from doc/admin-guide-cloud/source/dashboard_manage_flavors.rst rename to doc/admin-guide/source/dashboard_manage_flavors.rst index 3c2cd48ed1..9ead159320 100644 --- a/doc/admin-guide-cloud/source/dashboard_manage_flavors.rst +++ b/doc/admin-guide/source/dashboard_manage_flavors.rst @@ -144,8 +144,7 @@ Update Metadata +-------------------------------+-------------------------------+ For information about supporting metadata keys, see the - `OpenStack Cloud Administrator Guide - `__. + :ref:`compute-flavors`. Delete flavors ~~~~~~~~~~~~~~ diff --git a/doc/admin-guide-cloud/source/dashboard_manage_host_aggregates.rst b/doc/admin-guide/source/dashboard_manage_host_aggregates.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_manage_host_aggregates.rst rename to doc/admin-guide/source/dashboard_manage_host_aggregates.rst diff --git a/doc/admin-guide-cloud/source/dashboard_manage_images.rst b/doc/admin-guide/source/dashboard_manage_images.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_manage_images.rst rename to doc/admin-guide/source/dashboard_manage_images.rst diff --git a/doc/admin-guide-cloud/source/dashboard_manage_instances.rst b/doc/admin-guide/source/dashboard_manage_instances.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_manage_instances.rst rename to doc/admin-guide/source/dashboard_manage_instances.rst diff --git a/doc/admin-guide-cloud/source/dashboard_manage_resources.rst b/doc/admin-guide/source/dashboard_manage_resources.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_manage_resources.rst rename to doc/admin-guide/source/dashboard_manage_resources.rst diff --git a/doc/admin-guide-cloud/source/dashboard_manage_services.rst b/doc/admin-guide/source/dashboard_manage_services.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_manage_services.rst rename to doc/admin-guide/source/dashboard_manage_services.rst diff --git a/doc/admin-guide-cloud/source/dashboard_manage_shares.rst b/doc/admin-guide/source/dashboard_manage_shares.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_manage_shares.rst rename to doc/admin-guide/source/dashboard_manage_shares.rst diff --git a/doc/admin-guide-cloud/source/dashboard_manage_volumes.rst b/doc/admin-guide/source/dashboard_manage_volumes.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_manage_volumes.rst rename to doc/admin-guide/source/dashboard_manage_volumes.rst diff --git a/doc/admin-guide-cloud/source/dashboard_sessions.rst b/doc/admin-guide/source/dashboard_sessions.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_sessions.rst rename to doc/admin-guide/source/dashboard_sessions.rst diff --git a/doc/admin-guide-cloud/source/dashboard_set_quotas.rst b/doc/admin-guide/source/dashboard_set_quotas.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_set_quotas.rst rename to doc/admin-guide/source/dashboard_set_quotas.rst diff --git a/doc/admin-guide-cloud/source/dashboard_view_cloud_resources.rst b/doc/admin-guide/source/dashboard_view_cloud_resources.rst similarity index 100% rename from doc/admin-guide-cloud/source/dashboard_view_cloud_resources.rst rename to doc/admin-guide/source/dashboard_view_cloud_resources.rst diff --git a/doc/admin-guide-cloud/source/database.rst b/doc/admin-guide/source/database.rst similarity index 100% rename from doc/admin-guide-cloud/source/database.rst rename to doc/admin-guide/source/database.rst diff --git a/doc/admin-guide-cloud/source/figures/OpenStackTrustedComputePool1.png b/doc/admin-guide/source/figures/OpenStackTrustedComputePool1.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/OpenStackTrustedComputePool1.png rename to doc/admin-guide/source/figures/OpenStackTrustedComputePool1.png diff --git a/doc/admin-guide-cloud/source/figures/OpenStackTrustedComputePool2.png b/doc/admin-guide/source/figures/OpenStackTrustedComputePool2.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/OpenStackTrustedComputePool2.png rename to doc/admin-guide/source/figures/OpenStackTrustedComputePool2.png diff --git a/doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-DHCP-manager.jpg b/doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-DHCP-manager.jpg similarity index 100% rename from doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-DHCP-manager.jpg rename to doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-DHCP-manager.jpg diff --git a/doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-manager.jpg b/doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-manager.jpg similarity index 100% rename from doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-manager.jpg rename to doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-Flat-manager.jpg diff --git a/doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-VLAN-manager.jpg b/doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-VLAN-manager.jpg similarity index 100% rename from doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-VLAN-manager.jpg rename to doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack-VLAN-manager.jpg diff --git a/doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack.vsd b/doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack.vsd similarity index 100% rename from doc/admin-guide-cloud/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack.vsd rename to doc/admin-guide/source/figures/SCH_5007_V00_NUAC-multi_nic_OpenStack.vsd diff --git a/doc/admin-guide-cloud/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.png b/doc/admin-guide/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.png rename to doc/admin-guide/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.png diff --git a/doc/admin-guide-cloud/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.svg b/doc/admin-guide/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.svg similarity index 100% rename from doc/admin-guide-cloud/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.svg rename to doc/admin-guide/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.svg diff --git a/doc/admin-guide-cloud/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.vsd b/doc/admin-guide/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.vsd similarity index 100% rename from doc/admin-guide-cloud/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.vsd rename to doc/admin-guide/source/figures/SCH_5009_V00_NUAC-VNC_OpenStack.vsd diff --git a/doc/admin-guide-cloud/source/figures/change_instance_state.png b/doc/admin-guide/source/figures/change_instance_state.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/change_instance_state.png rename to doc/admin-guide/source/figures/change_instance_state.png diff --git a/doc/admin-guide-cloud/source/figures/create_flavor.png b/doc/admin-guide/source/figures/create_flavor.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/create_flavor.png rename to doc/admin-guide/source/figures/create_flavor.png diff --git a/doc/admin-guide-cloud/source/figures/create_image.png b/doc/admin-guide/source/figures/create_image.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/create_image.png rename to doc/admin-guide/source/figures/create_image.png diff --git a/doc/admin-guide-cloud/source/figures/create_volume_type_encryption.png b/doc/admin-guide/source/figures/create_volume_type_encryption.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/create_volume_type_encryption.png rename to doc/admin-guide/source/figures/create_volume_type_encryption.png diff --git a/doc/admin-guide-cloud/source/figures/demo_multiple_dhcp_agents.png b/doc/admin-guide/source/figures/demo_multiple_dhcp_agents.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/demo_multiple_dhcp_agents.png rename to doc/admin-guide/source/figures/demo_multiple_dhcp_agents.png diff --git a/doc/admin-guide-cloud/source/figures/fwaas.png b/doc/admin-guide/source/figures/fwaas.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/fwaas.png rename to doc/admin-guide/source/figures/fwaas.png diff --git a/doc/admin-guide-cloud/source/figures/fwaas.svg b/doc/admin-guide/source/figures/fwaas.svg similarity index 100% rename from doc/admin-guide-cloud/source/figures/fwaas.svg rename to doc/admin-guide/source/figures/fwaas.svg diff --git a/doc/admin-guide-cloud/source/figures/instance-life-1.png b/doc/admin-guide/source/figures/instance-life-1.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/instance-life-1.png rename to doc/admin-guide/source/figures/instance-life-1.png diff --git a/doc/admin-guide-cloud/source/figures/instance-life-2.png b/doc/admin-guide/source/figures/instance-life-2.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/instance-life-2.png rename to doc/admin-guide/source/figures/instance-life-2.png diff --git a/doc/admin-guide-cloud/source/figures/instance-life-3.png b/doc/admin-guide/source/figures/instance-life-3.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/instance-life-3.png rename to doc/admin-guide/source/figures/instance-life-3.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-accountscontainers.png b/doc/admin-guide/source/figures/objectstorage-accountscontainers.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-accountscontainers.png rename to doc/admin-guide/source/figures/objectstorage-accountscontainers.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-arch.png b/doc/admin-guide/source/figures/objectstorage-arch.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-arch.png rename to doc/admin-guide/source/figures/objectstorage-arch.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-buildingblocks.png b/doc/admin-guide/source/figures/objectstorage-buildingblocks.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-buildingblocks.png rename to doc/admin-guide/source/figures/objectstorage-buildingblocks.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-nodes.png b/doc/admin-guide/source/figures/objectstorage-nodes.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-nodes.png rename to doc/admin-guide/source/figures/objectstorage-nodes.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-partitions.png b/doc/admin-guide/source/figures/objectstorage-partitions.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-partitions.png rename to doc/admin-guide/source/figures/objectstorage-partitions.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-replication.png b/doc/admin-guide/source/figures/objectstorage-replication.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-replication.png rename to doc/admin-guide/source/figures/objectstorage-replication.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-ring.png b/doc/admin-guide/source/figures/objectstorage-ring.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-ring.png rename to doc/admin-guide/source/figures/objectstorage-ring.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-usecase.png b/doc/admin-guide/source/figures/objectstorage-usecase.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-usecase.png rename to doc/admin-guide/source/figures/objectstorage-usecase.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage-zones.png b/doc/admin-guide/source/figures/objectstorage-zones.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage-zones.png rename to doc/admin-guide/source/figures/objectstorage-zones.png diff --git a/doc/admin-guide-cloud/source/figures/objectstorage.png b/doc/admin-guide/source/figures/objectstorage.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/objectstorage.png rename to doc/admin-guide/source/figures/objectstorage.png diff --git a/doc/admin-guide-cloud/source/figures/vmware_nsx_ex1.graffle b/doc/admin-guide/source/figures/vmware_nsx_ex1.graffle similarity index 100% rename from doc/admin-guide-cloud/source/figures/vmware_nsx_ex1.graffle rename to doc/admin-guide/source/figures/vmware_nsx_ex1.graffle diff --git a/doc/admin-guide-cloud/source/figures/vmware_nsx_ex1.png b/doc/admin-guide/source/figures/vmware_nsx_ex1.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/vmware_nsx_ex1.png rename to doc/admin-guide/source/figures/vmware_nsx_ex1.png diff --git a/doc/admin-guide-cloud/source/figures/vmware_nsx_ex1.svg b/doc/admin-guide/source/figures/vmware_nsx_ex1.svg similarity index 100% rename from doc/admin-guide-cloud/source/figures/vmware_nsx_ex1.svg rename to doc/admin-guide/source/figures/vmware_nsx_ex1.svg diff --git a/doc/admin-guide-cloud/source/figures/vmware_nsx_ex2.graffle b/doc/admin-guide/source/figures/vmware_nsx_ex2.graffle similarity index 100% rename from doc/admin-guide-cloud/source/figures/vmware_nsx_ex2.graffle rename to doc/admin-guide/source/figures/vmware_nsx_ex2.graffle diff --git a/doc/admin-guide-cloud/source/figures/vmware_nsx_ex2.png b/doc/admin-guide/source/figures/vmware_nsx_ex2.png similarity index 100% rename from doc/admin-guide-cloud/source/figures/vmware_nsx_ex2.png rename to doc/admin-guide/source/figures/vmware_nsx_ex2.png diff --git a/doc/admin-guide-cloud/source/figures/vmware_nsx_ex2.svg b/doc/admin-guide/source/figures/vmware_nsx_ex2.svg similarity index 100% rename from doc/admin-guide-cloud/source/figures/vmware_nsx_ex2.svg rename to doc/admin-guide/source/figures/vmware_nsx_ex2.svg diff --git a/doc/admin-guide-cloud/source/identity_auth_token_middleware.rst b/doc/admin-guide/source/identity_auth_token_middleware.rst similarity index 100% rename from doc/admin-guide-cloud/source/identity_auth_token_middleware.rst rename to doc/admin-guide/source/identity_auth_token_middleware.rst diff --git a/doc/admin-guide-cloud/source/identity_concepts.rst b/doc/admin-guide/source/identity_concepts.rst similarity index 100% rename from doc/admin-guide-cloud/source/identity_concepts.rst rename to doc/admin-guide/source/identity_concepts.rst diff --git a/doc/admin-guide-cloud/source/identity_keystone_usage_and_features.rst b/doc/admin-guide/source/identity_keystone_usage_and_features.rst similarity index 100% rename from doc/admin-guide-cloud/source/identity_keystone_usage_and_features.rst rename to doc/admin-guide/source/identity_keystone_usage_and_features.rst diff --git a/doc/admin-guide-cloud/source/identity_management.rst b/doc/admin-guide/source/identity_management.rst similarity index 100% rename from doc/admin-guide-cloud/source/identity_management.rst rename to doc/admin-guide/source/identity_management.rst diff --git a/doc/admin-guide-cloud/source/identity_service_api_protection.rst b/doc/admin-guide/source/identity_service_api_protection.rst similarity index 98% rename from doc/admin-guide-cloud/source/identity_service_api_protection.rst rename to doc/admin-guide/source/identity_service_api_protection.rst index 9292e89535..8ad855edce 100644 --- a/doc/admin-guide-cloud/source/identity_service_api_protection.rst +++ b/doc/admin-guide/source/identity_service_api_protection.rst @@ -118,7 +118,7 @@ example of multi-domain configuration installations where a cloud provider wants to delegate administration of the contents of a domain to a particular ``admin domain``. This example policy file also shows the use of an ``admin_domain`` to allow a cloud provider to -enable cloud administrators to have wider access across the APIs. +enable administrators to have wider access across the APIs. A clean installation could start with the standard policy file, to allow creation of the ``admin_domain`` with the first users within diff --git a/doc/admin-guide-cloud/source/identity_start.rst b/doc/admin-guide/source/identity_start.rst similarity index 100% rename from doc/admin-guide-cloud/source/identity_start.rst rename to doc/admin-guide/source/identity_start.rst diff --git a/doc/admin-guide-cloud/source/identity_troubleshoot.rst b/doc/admin-guide/source/identity_troubleshoot.rst similarity index 100% rename from doc/admin-guide-cloud/source/identity_troubleshoot.rst rename to doc/admin-guide/source/identity_troubleshoot.rst diff --git a/doc/admin-guide-cloud/source/index.rst b/doc/admin-guide/source/index.rst similarity index 78% rename from doc/admin-guide-cloud/source/index.rst rename to doc/admin-guide/source/index.rst index 9322253958..37489605bc 100644 --- a/doc/admin-guide-cloud/source/index.rst +++ b/doc/admin-guide/source/index.rst @@ -1,11 +1,11 @@ -=================================== -OpenStack Cloud Administrator Guide -=================================== +============================= +OpenStack Administrator Guide +============================= Abstract ~~~~~~~~ -OpenStack offers open source software for cloud administrators to +OpenStack offers open source software for OpenStack administrators to manage and troubleshoot an OpenStack cloud. This guide documents OpenStack Mitaka, OpenStack Liberty, and OpenStack Kilo diff --git a/doc/admin-guide-cloud/source/keystone_caching_layer.rst b/doc/admin-guide/source/keystone_caching_layer.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_caching_layer.rst rename to doc/admin-guide/source/keystone_caching_layer.rst diff --git a/doc/admin-guide-cloud/source/keystone_certificates_for_pki.rst b/doc/admin-guide/source/keystone_certificates_for_pki.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_certificates_for_pki.rst rename to doc/admin-guide/source/keystone_certificates_for_pki.rst diff --git a/doc/admin-guide-cloud/source/keystone_configure_with_SSL.rst b/doc/admin-guide/source/keystone_configure_with_SSL.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_configure_with_SSL.rst rename to doc/admin-guide/source/keystone_configure_with_SSL.rst diff --git a/doc/admin-guide-cloud/source/keystone_external_authentication.rst b/doc/admin-guide/source/keystone_external_authentication.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_external_authentication.rst rename to doc/admin-guide/source/keystone_external_authentication.rst diff --git a/doc/admin-guide-cloud/source/keystone_fernet_token_faq.rst b/doc/admin-guide/source/keystone_fernet_token_faq.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_fernet_token_faq.rst rename to doc/admin-guide/source/keystone_fernet_token_faq.rst diff --git a/doc/admin-guide-cloud/source/keystone_integrate_assignment_backend_ldap.rst b/doc/admin-guide/source/keystone_integrate_assignment_backend_ldap.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_integrate_assignment_backend_ldap.rst rename to doc/admin-guide/source/keystone_integrate_assignment_backend_ldap.rst diff --git a/doc/admin-guide-cloud/source/keystone_integrate_identity_backend_ldap.rst b/doc/admin-guide/source/keystone_integrate_identity_backend_ldap.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_integrate_identity_backend_ldap.rst rename to doc/admin-guide/source/keystone_integrate_identity_backend_ldap.rst diff --git a/doc/admin-guide-cloud/source/keystone_integrate_with_ldap.rst b/doc/admin-guide/source/keystone_integrate_with_ldap.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_integrate_with_ldap.rst rename to doc/admin-guide/source/keystone_integrate_with_ldap.rst diff --git a/doc/admin-guide-cloud/source/keystone_secure_identity_to_ldap_backend.rst b/doc/admin-guide/source/keystone_secure_identity_to_ldap_backend.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_secure_identity_to_ldap_backend.rst rename to doc/admin-guide/source/keystone_secure_identity_to_ldap_backend.rst diff --git a/doc/admin-guide-cloud/source/keystone_token-binding.rst b/doc/admin-guide/source/keystone_token-binding.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_token-binding.rst rename to doc/admin-guide/source/keystone_token-binding.rst diff --git a/doc/admin-guide-cloud/source/keystone_tokens.rst b/doc/admin-guide/source/keystone_tokens.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_tokens.rst rename to doc/admin-guide/source/keystone_tokens.rst diff --git a/doc/admin-guide-cloud/source/keystone_use_trusts.rst b/doc/admin-guide/source/keystone_use_trusts.rst similarity index 100% rename from doc/admin-guide-cloud/source/keystone_use_trusts.rst rename to doc/admin-guide/source/keystone_use_trusts.rst diff --git a/doc/admin-guide-cloud/source/locale/admin-guide-cloud.pot b/doc/admin-guide/source/locale/admin-guide-cloud.pot similarity index 100% rename from doc/admin-guide-cloud/source/locale/admin-guide-cloud.pot rename to doc/admin-guide/source/locale/admin-guide-cloud.pot diff --git a/doc/admin-guide-cloud/source/networking.rst b/doc/admin-guide/source/networking.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking.rst rename to doc/admin-guide/source/networking.rst diff --git a/doc/admin-guide-cloud/source/networking_adv-config.rst b/doc/admin-guide/source/networking_adv-config.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_adv-config.rst rename to doc/admin-guide/source/networking_adv-config.rst diff --git a/doc/admin-guide-cloud/source/networking_adv-features.rst b/doc/admin-guide/source/networking_adv-features.rst similarity index 99% rename from doc/admin-guide-cloud/source/networking_adv-features.rst rename to doc/admin-guide/source/networking_adv-features.rst index 4a10cb4116..997e0ca3fe 100644 --- a/doc/admin-guide-cloud/source/networking_adv-features.rst +++ b/doc/admin-guide/source/networking_adv-features.rst @@ -1,3 +1,5 @@ +.. _networking-adv-features: + ======================================== Advanced features through API extensions ======================================== @@ -16,8 +18,8 @@ networks are created with administrative credentials, specifying the details of how the network is physically realized, usually to match some existing network in the data center. -Provider networks enable cloud administrators to create Networking -networks that map directly to the physical networks in the data center. +Provider networks enable administrators to create networks that map +directly to the physical networks in the data center. This is commonly used to give tenants direct access to a public network that can be used to reach the Internet. It might also be used to integrate with VLANs in the network that already have a defined meaning diff --git a/doc/admin-guide-cloud/source/networking_adv-operational-features.rst b/doc/admin-guide/source/networking_adv-operational-features.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_adv-operational-features.rst rename to doc/admin-guide/source/networking_adv-operational-features.rst diff --git a/doc/admin-guide-cloud/source/networking_arch.rst b/doc/admin-guide/source/networking_arch.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_arch.rst rename to doc/admin-guide/source/networking_arch.rst diff --git a/doc/admin-guide-cloud/source/networking_auth.rst b/doc/admin-guide/source/networking_auth.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_auth.rst rename to doc/admin-guide/source/networking_auth.rst diff --git a/doc/admin-guide-cloud/source/networking_config-agents.rst b/doc/admin-guide/source/networking_config-agents.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_config-agents.rst rename to doc/admin-guide/source/networking_config-agents.rst diff --git a/doc/admin-guide-cloud/source/networking_config-identity.rst b/doc/admin-guide/source/networking_config-identity.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_config-identity.rst rename to doc/admin-guide/source/networking_config-identity.rst diff --git a/doc/admin-guide-cloud/source/networking_config-plugins.rst b/doc/admin-guide/source/networking_config-plugins.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_config-plugins.rst rename to doc/admin-guide/source/networking_config-plugins.rst diff --git a/doc/admin-guide-cloud/source/networking_introduction.rst b/doc/admin-guide/source/networking_introduction.rst similarity index 99% rename from doc/admin-guide-cloud/source/networking_introduction.rst rename to doc/admin-guide/source/networking_introduction.rst index 850bfeaa97..d24223b579 100644 --- a/doc/admin-guide-cloud/source/networking_introduction.rst +++ b/doc/admin-guide/source/networking_introduction.rst @@ -63,7 +63,7 @@ The Networking service: multi-tiered web applications and enabling migration of applications to the cloud without changing IP addresses. -- Offers flexibility for the cloud administrator to customize network +- Offers flexibility for administrators to customize network offerings. - Enables developers to extend the Networking API. Over time, the diff --git a/doc/admin-guide-cloud/source/networking_multi-dhcp-agents.rst b/doc/admin-guide/source/networking_multi-dhcp-agents.rst similarity index 100% rename from doc/admin-guide-cloud/source/networking_multi-dhcp-agents.rst rename to doc/admin-guide/source/networking_multi-dhcp-agents.rst diff --git a/doc/admin-guide-cloud/source/networking_use.rst b/doc/admin-guide/source/networking_use.rst similarity index 98% rename from doc/admin-guide-cloud/source/networking_use.rst rename to doc/admin-guide/source/networking_use.rst index 9af2e1c63d..ac14055fd9 100644 --- a/doc/admin-guide-cloud/source/networking_use.rst +++ b/doc/admin-guide/source/networking_use.rst @@ -16,8 +16,8 @@ Log files are in the ``/var/log/neutron`` directory. Configuration files are in the ``/etc/neutron`` directory. -Cloud administrators and tenants can use OpenStack Networking to build -rich network topologies. Cloud administrators can create network +Administrators and tenants can use OpenStack Networking to build +rich network topologies. Administrators can create network connectivity on behalf of tenants. Core Networking API features @@ -90,7 +90,7 @@ basic network operations: Administrative operations ------------------------- -The cloud administrator can run any :command:`neutron` command on behalf of +The administrator can run any :command:`neutron` command on behalf of tenants by specifying an Identity ``tenant_id`` in the command, as follows: diff --git a/doc/admin-guide-cloud/source/objectstorage-admin.rst b/doc/admin-guide/source/objectstorage-admin.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage-admin.rst rename to doc/admin-guide/source/objectstorage-admin.rst diff --git a/doc/admin-guide-cloud/source/objectstorage-monitoring.rst b/doc/admin-guide/source/objectstorage-monitoring.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage-monitoring.rst rename to doc/admin-guide/source/objectstorage-monitoring.rst diff --git a/doc/admin-guide-cloud/source/objectstorage-troubleshoot.rst b/doc/admin-guide/source/objectstorage-troubleshoot.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage-troubleshoot.rst rename to doc/admin-guide/source/objectstorage-troubleshoot.rst diff --git a/doc/admin-guide-cloud/source/objectstorage.rst b/doc/admin-guide/source/objectstorage.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage.rst rename to doc/admin-guide/source/objectstorage.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_EC.rst b/doc/admin-guide/source/objectstorage_EC.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_EC.rst rename to doc/admin-guide/source/objectstorage_EC.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_account_reaper.rst b/doc/admin-guide/source/objectstorage_account_reaper.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_account_reaper.rst rename to doc/admin-guide/source/objectstorage_account_reaper.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_arch.rst b/doc/admin-guide/source/objectstorage_arch.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_arch.rst rename to doc/admin-guide/source/objectstorage_arch.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_auditors.rst b/doc/admin-guide/source/objectstorage_auditors.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_auditors.rst rename to doc/admin-guide/source/objectstorage_auditors.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_characteristics.rst b/doc/admin-guide/source/objectstorage_characteristics.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_characteristics.rst rename to doc/admin-guide/source/objectstorage_characteristics.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_components.rst b/doc/admin-guide/source/objectstorage_components.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_components.rst rename to doc/admin-guide/source/objectstorage_components.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_features.rst b/doc/admin-guide/source/objectstorage_features.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_features.rst rename to doc/admin-guide/source/objectstorage_features.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_intro.rst b/doc/admin-guide/source/objectstorage_intro.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_intro.rst rename to doc/admin-guide/source/objectstorage_intro.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_large-objects.rst b/doc/admin-guide/source/objectstorage_large-objects.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_large-objects.rst rename to doc/admin-guide/source/objectstorage_large-objects.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_replication.rst b/doc/admin-guide/source/objectstorage_replication.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_replication.rst rename to doc/admin-guide/source/objectstorage_replication.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_ringbuilder.rst b/doc/admin-guide/source/objectstorage_ringbuilder.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_ringbuilder.rst rename to doc/admin-guide/source/objectstorage_ringbuilder.rst diff --git a/doc/admin-guide-cloud/source/objectstorage_tenant_specific_image_storage.rst b/doc/admin-guide/source/objectstorage_tenant_specific_image_storage.rst similarity index 100% rename from doc/admin-guide-cloud/source/objectstorage_tenant_specific_image_storage.rst rename to doc/admin-guide/source/objectstorage_tenant_specific_image_storage.rst diff --git a/doc/admin-guide-cloud/source/orchestration-auth-model.rst b/doc/admin-guide/source/orchestration-auth-model.rst similarity index 100% rename from doc/admin-guide-cloud/source/orchestration-auth-model.rst rename to doc/admin-guide/source/orchestration-auth-model.rst diff --git a/doc/admin-guide-cloud/source/orchestration-introduction.rst b/doc/admin-guide/source/orchestration-introduction.rst similarity index 100% rename from doc/admin-guide-cloud/source/orchestration-introduction.rst rename to doc/admin-guide/source/orchestration-introduction.rst diff --git a/doc/admin-guide-cloud/source/orchestration-stack-domain-users.rst b/doc/admin-guide/source/orchestration-stack-domain-users.rst similarity index 100% rename from doc/admin-guide-cloud/source/orchestration-stack-domain-users.rst rename to doc/admin-guide/source/orchestration-stack-domain-users.rst diff --git a/doc/admin-guide-cloud/source/orchestration.rst b/doc/admin-guide/source/orchestration.rst similarity index 100% rename from doc/admin-guide-cloud/source/orchestration.rst rename to doc/admin-guide/source/orchestration.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems.rst b/doc/admin-guide/source/shared_file_systems.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems.rst rename to doc/admin-guide/source/shared_file_systems.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_cgroups.rst b/doc/admin-guide/source/shared_file_systems_cgroups.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_cgroups.rst rename to doc/admin-guide/source/shared_file_systems_cgroups.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_crud_share.rst b/doc/admin-guide/source/shared_file_systems_crud_share.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_crud_share.rst rename to doc/admin-guide/source/shared_file_systems_crud_share.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_intro.rst b/doc/admin-guide/source/shared_file_systems_intro.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_intro.rst rename to doc/admin-guide/source/shared_file_systems_intro.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_key_concepts.rst b/doc/admin-guide/source/shared_file_systems_key_concepts.rst similarity index 97% rename from doc/admin-guide-cloud/source/shared_file_systems_key_concepts.rst rename to doc/admin-guide/source/shared_file_systems_key_concepts.rst index 6744cbefcc..e745bdd35c 100644 --- a/doc/admin-guide-cloud/source/shared_file_systems_key_concepts.rst +++ b/doc/admin-guide/source/shared_file_systems_key_concepts.rst @@ -61,7 +61,7 @@ Share Type ``Share type`` is an abstract collection of criteria used to characterize ``shares``. They are most commonly used to create a hierarchy of functional capabilities. This hierarchy represents tiered storage services levels. For -example, a cloud administrator might define a premium ``share type`` that +example, an administrator might define a premium ``share type`` that indicates a greater level of performance than a basic ``share type``. Premium represents the best performance level. @@ -70,7 +70,7 @@ Share Access Rules ~~~~~~~~~~~~~~~~~~ ``Share access rules`` define which users can access a particular ``share``. -For example, cloud administrators can declare rules for NFS shares by +For example, administrators can declare rules for NFS shares by listing the valid IP networks which will access the ``share``. List the IP networks in CIDR notation. diff --git a/doc/admin-guide-cloud/source/shared_file_systems_manage_and_unmanage_share.rst b/doc/admin-guide/source/shared_file_systems_manage_and_unmanage_share.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_manage_and_unmanage_share.rst rename to doc/admin-guide/source/shared_file_systems_manage_and_unmanage_share.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_manage_shares_cli.rst b/doc/admin-guide/source/shared_file_systems_manage_shares_cli.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_manage_shares_cli.rst rename to doc/admin-guide/source/shared_file_systems_manage_shares_cli.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_multi_backend.rst b/doc/admin-guide/source/shared_file_systems_multi_backend.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_multi_backend.rst rename to doc/admin-guide/source/shared_file_systems_multi_backend.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_network_plugins.rst b/doc/admin-guide/source/shared_file_systems_network_plugins.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_network_plugins.rst rename to doc/admin-guide/source/shared_file_systems_network_plugins.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_networking.rst b/doc/admin-guide/source/shared_file_systems_networking.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_networking.rst rename to doc/admin-guide/source/shared_file_systems_networking.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_quotas.rst b/doc/admin-guide/source/shared_file_systems_quotas.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_quotas.rst rename to doc/admin-guide/source/shared_file_systems_quotas.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_scheduling.rst b/doc/admin-guide/source/shared_file_systems_scheduling.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_scheduling.rst rename to doc/admin-guide/source/shared_file_systems_scheduling.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_security_services.rst b/doc/admin-guide/source/shared_file_systems_security_services.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_security_services.rst rename to doc/admin-guide/source/shared_file_systems_security_services.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_services_manage.rst b/doc/admin-guide/source/shared_file_systems_services_manage.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_services_manage.rst rename to doc/admin-guide/source/shared_file_systems_services_manage.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_share_management.rst b/doc/admin-guide/source/shared_file_systems_share_management.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_share_management.rst rename to doc/admin-guide/source/shared_file_systems_share_management.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_share_networks.rst b/doc/admin-guide/source/shared_file_systems_share_networks.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_share_networks.rst rename to doc/admin-guide/source/shared_file_systems_share_networks.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_share_resize.rst b/doc/admin-guide/source/shared_file_systems_share_resize.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_share_resize.rst rename to doc/admin-guide/source/shared_file_systems_share_resize.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_share_types.rst b/doc/admin-guide/source/shared_file_systems_share_types.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_share_types.rst rename to doc/admin-guide/source/shared_file_systems_share_types.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_snapshots.rst b/doc/admin-guide/source/shared_file_systems_snapshots.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_snapshots.rst rename to doc/admin-guide/source/shared_file_systems_snapshots.rst diff --git a/doc/admin-guide-cloud/source/shared_file_systems_troubleshoot.rst b/doc/admin-guide/source/shared_file_systems_troubleshoot.rst similarity index 100% rename from doc/admin-guide-cloud/source/shared_file_systems_troubleshoot.rst rename to doc/admin-guide/source/shared_file_systems_troubleshoot.rst diff --git a/doc/admin-guide-cloud/source/support-compute.rst b/doc/admin-guide/source/support-compute.rst similarity index 100% rename from doc/admin-guide-cloud/source/support-compute.rst rename to doc/admin-guide/source/support-compute.rst diff --git a/doc/admin-guide-cloud/source/telemetry-alarms.rst b/doc/admin-guide/source/telemetry-alarms.rst similarity index 97% rename from doc/admin-guide-cloud/source/telemetry-alarms.rst rename to doc/admin-guide/source/telemetry-alarms.rst index dcddcd7b69..626349e576 100644 --- a/doc/admin-guide-cloud/source/telemetry-alarms.rst +++ b/doc/admin-guide/source/telemetry-alarms.rst @@ -145,11 +145,11 @@ though it could alternatively be a webhook URL. .. note:: Alarm names must be unique for the alarms associated with an - individual project. - The cloud administrator can limit the maximum resulting actions - for three different states, and the ability for a normal user to - create ``log://`` and ``test://`` notifiers is disabled. This prevents - unintentional consumption of disk and memory resources by the + individual project. Administrator can limit the maximum + resulting actions for three different states, and the + ability for a normal user to create ``log://`` and ``test://`` + notifiers is disabled. This prevents unintentional + consumption of disk and memory resources by the Telemetry service. The sliding time window over which the alarm is evaluated is 30 diff --git a/doc/admin-guide-cloud/source/telemetry-best-practices.rst b/doc/admin-guide/source/telemetry-best-practices.rst similarity index 98% rename from doc/admin-guide-cloud/source/telemetry-best-practices.rst rename to doc/admin-guide/source/telemetry-best-practices.rst index 33a70c86ff..b419b0b71e 100644 --- a/doc/admin-guide-cloud/source/telemetry-best-practices.rst +++ b/doc/admin-guide/source/telemetry-best-practices.rst @@ -9,7 +9,7 @@ Data collection --------------- #. The Telemetry service collects a continuously growing set of data. Not - all the data will be relevant for a cloud administrator to monitor. + all the data will be relevant for an administrator to monitor. - Based on your needs, you can edit the ``pipeline.yaml`` configuration file to include a selected number of meters while disregarding the diff --git a/doc/admin-guide-cloud/source/telemetry-data-collection.rst b/doc/admin-guide/source/telemetry-data-collection.rst similarity index 100% rename from doc/admin-guide-cloud/source/telemetry-data-collection.rst rename to doc/admin-guide/source/telemetry-data-collection.rst diff --git a/doc/admin-guide-cloud/source/telemetry-data-retrieval.rst b/doc/admin-guide/source/telemetry-data-retrieval.rst similarity index 100% rename from doc/admin-guide-cloud/source/telemetry-data-retrieval.rst rename to doc/admin-guide/source/telemetry-data-retrieval.rst diff --git a/doc/admin-guide-cloud/source/telemetry-events.rst b/doc/admin-guide/source/telemetry-events.rst similarity index 100% rename from doc/admin-guide-cloud/source/telemetry-events.rst rename to doc/admin-guide/source/telemetry-events.rst diff --git a/doc/admin-guide-cloud/source/telemetry-measurements.rst b/doc/admin-guide/source/telemetry-measurements.rst similarity index 100% rename from doc/admin-guide-cloud/source/telemetry-measurements.rst rename to doc/admin-guide/source/telemetry-measurements.rst diff --git a/doc/admin-guide-cloud/source/telemetry-system-architecture.rst b/doc/admin-guide/source/telemetry-system-architecture.rst similarity index 100% rename from doc/admin-guide-cloud/source/telemetry-system-architecture.rst rename to doc/admin-guide/source/telemetry-system-architecture.rst diff --git a/doc/admin-guide-cloud/source/telemetry-troubleshooting-guide.rst b/doc/admin-guide/source/telemetry-troubleshooting-guide.rst similarity index 100% rename from doc/admin-guide-cloud/source/telemetry-troubleshooting-guide.rst rename to doc/admin-guide/source/telemetry-troubleshooting-guide.rst diff --git a/doc/admin-guide-cloud/source/telemetry.rst b/doc/admin-guide/source/telemetry.rst similarity index 100% rename from doc/admin-guide-cloud/source/telemetry.rst rename to doc/admin-guide/source/telemetry.rst diff --git a/doc/admin-guide-cloud/source/ts-HTTP-bad-req-in-cinder-vol-log.rst b/doc/admin-guide/source/ts-HTTP-bad-req-in-cinder-vol-log.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts-HTTP-bad-req-in-cinder-vol-log.rst rename to doc/admin-guide/source/ts-HTTP-bad-req-in-cinder-vol-log.rst diff --git a/doc/admin-guide-cloud/source/ts-duplicate-3par-host.rst b/doc/admin-guide/source/ts-duplicate-3par-host.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts-duplicate-3par-host.rst rename to doc/admin-guide/source/ts-duplicate-3par-host.rst diff --git a/doc/admin-guide-cloud/source/ts-eql-volume-size.rst b/doc/admin-guide/source/ts-eql-volume-size.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts-eql-volume-size.rst rename to doc/admin-guide/source/ts-eql-volume-size.rst diff --git a/doc/admin-guide-cloud/source/ts-failed-attach-vol-after-detach.rst b/doc/admin-guide/source/ts-failed-attach-vol-after-detach.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts-failed-attach-vol-after-detach.rst rename to doc/admin-guide/source/ts-failed-attach-vol-after-detach.rst diff --git a/doc/admin-guide-cloud/source/ts-failed-attach-vol-no-sysfsutils.rst b/doc/admin-guide/source/ts-failed-attach-vol-no-sysfsutils.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts-failed-attach-vol-no-sysfsutils.rst rename to doc/admin-guide/source/ts-failed-attach-vol-no-sysfsutils.rst diff --git a/doc/admin-guide-cloud/source/ts-failed-connect-vol-FC-SAN.rst b/doc/admin-guide/source/ts-failed-connect-vol-FC-SAN.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts-failed-connect-vol-FC-SAN.rst rename to doc/admin-guide/source/ts-failed-connect-vol-FC-SAN.rst diff --git a/doc/admin-guide-cloud/source/ts_cinder_config.rst b/doc/admin-guide/source/ts_cinder_config.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts_cinder_config.rst rename to doc/admin-guide/source/ts_cinder_config.rst diff --git a/doc/admin-guide-cloud/source/ts_multipath_warn.rst b/doc/admin-guide/source/ts_multipath_warn.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts_multipath_warn.rst rename to doc/admin-guide/source/ts_multipath_warn.rst diff --git a/doc/admin-guide-cloud/source/ts_no_emulator_x86_64.rst b/doc/admin-guide/source/ts_no_emulator_x86_64.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts_no_emulator_x86_64.rst rename to doc/admin-guide/source/ts_no_emulator_x86_64.rst diff --git a/doc/admin-guide-cloud/source/ts_non_existent_host.rst b/doc/admin-guide/source/ts_non_existent_host.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts_non_existent_host.rst rename to doc/admin-guide/source/ts_non_existent_host.rst diff --git a/doc/admin-guide-cloud/source/ts_non_existent_vlun.rst b/doc/admin-guide/source/ts_non_existent_vlun.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts_non_existent_vlun.rst rename to doc/admin-guide/source/ts_non_existent_vlun.rst diff --git a/doc/admin-guide-cloud/source/ts_vol_attach_miss_sg_scan.rst b/doc/admin-guide/source/ts_vol_attach_miss_sg_scan.rst similarity index 100% rename from doc/admin-guide-cloud/source/ts_vol_attach_miss_sg_scan.rst rename to doc/admin-guide/source/ts_vol_attach_miss_sg_scan.rst diff --git a/tools/build-all-rst.sh b/tools/build-all-rst.sh index c0850e34fc..4663228542 100755 --- a/tools/build-all-rst.sh +++ b/tools/build-all-rst.sh @@ -11,7 +11,7 @@ if [[ $# > 0 ]] ; then fi fi -for guide in user-guide user-guide-admin admin-guide-cloud \ +for guide in user-guide user-guide-admin admin-guide \ contributor-guide image-guide arch-design cli-reference; do tools/build-rst.sh doc/$guide $GLOSSARY --build build \ --target $guide $LINKCHECK diff --git a/www/static/.htaccess b/www/static/.htaccess index 4d095ff73d..546e93312a 100644 --- a/www/static/.htaccess +++ b/www/static/.htaccess @@ -35,10 +35,10 @@ redirect 301 /trunk/openstack-compute/install/content /trunk/openstack-compute/i redirect 301 /trunk/basic-install/apt/content /liberty/install-guide-ubuntu/ redirect 301 /trunk/basic-install/yum/content /liberty/install-guide-rdo/ -# Redirecting trunk admin guides to admin-guide-cloud -redirect 301 /trunk/openstack-block-storage/admin/content/ /admin-guide-cloud/ -redirect 301 /trunk/openstack-compute/admin/content/ /admin-guide-cloud/ -redirect 301 /trunk/openstack-object-storage/admin/content/ /admin-guide-cloud/ +# Redirecting trunk admin guides to admin-guide +redirect 301 /trunk/openstack-block-storage/admin/content/ /admin-guide/ +redirect 301 /trunk/openstack-compute/admin/content/ /admin-guide/ +redirect 301 /trunk/openstack-object-storage/admin/content/ /admin-guide/ # Redirecting Image Guide to new location redirect 301 /trunk/openstack-image/content/ /image-guide/ @@ -70,11 +70,8 @@ redirectmatch /identity/api/.*$ http://developer.openstack.org/ # Redirect old Networking Admin Guide to Configuration Reference redirect 301 /trunk/openstack-network/admin/content/under_the_hood_openvswitch.html /liberty/config-reference/content/networking-plugin-openvswitch_agent.html redirect 301 /trunk/openstack-network/admin/content/under_the_hood_linuxbridge.html /liberty/config-reference/content/networking-plugin-linuxbridge_agent.html -redirectmatch /trunk/openstack-network/admin/content/.*$ /admin-guide-cloud/index.html -redirectmatch /network-admin/admin/content/.*$ /admin-guide-cloud/index.html - -# Redirect old openstack-identity links -redirect 301 /trunk/openstack-identity/admin/content/ /admin-guide-cloud/content/ch-identity-mgmt-config.html +redirectmatch /trunk/openstack-network/admin/content/.*$ /admin-guide/index.html +redirectmatch /network-admin/admin/content/.*$ /admin-guide/index.html # Redirect O'Reilly Operations Guide PDF to trunk version redirect 301 /trunk/openstack-ops/oreilly-openstack-ops-guide.pdf /openstack-ops/openstack-ops-manual.pdf @@ -152,16 +149,16 @@ redirect 301 /user-guide-admin/content/admin_cli_manage_projects_users.html /use redirect 301 /user-guide-admin/content/specify-host-to-boot-instances-on.html /user-guide-admin/cli_nova_specify_host.html redirect 301 /user-guide-admin/content/nova_cli_migrate_single.html /user-guide-admin/cli_nova_migrate.html -redirect 301 /admin-guide-cloud/content/customize-flavors.html /admin-guide-cloud/compute-flavors.html +redirect 301 /admin-guide-cloud/content/customize-flavors.html /admin-guide/compute-flavors.html # Since we don't have a direct match for all file, redirect to the index page. redirectmatch 301 "^/user-guide/content/.*$" /user-guide/index.html redirectmatch 301 "^/user-guide-admin/content/.*" /user-guide-admin/index.html -redirectmatch 301 "^/admin-guide-cloud/content/.*$" /admin-guide-cloud/index.html redirectmatch 301 "^/image-guide/content/.*$" /image-guide/index.html redirectmatch 301 "^/arch-design/content/.*$" /arch-design/index.html redirectmatch 301 "^/cli-reference/content/.*$" /cli-reference/index.html +redirectmatch 301 "^/admin-guide-cloud/.*$" /admin-guide/index.html # Hot-guide has moved to heat repo redirect 301 /user-guide/hot-guide/hot.html /developer/heat/template_guide/hot_guide.html