From 4bf765758ceaff1e837df31f44b9f6a862aecfe8 Mon Sep 17 00:00:00 2001 From: Tom Fifield Date: Thu, 7 Aug 2014 16:46:25 +0800 Subject: [PATCH] Clean Common This patch works several files that were not in common use back into the documents they should live with. The intended end result of this activity is to make common as lean as possible so it can be more easily translated. Also: Don't include configdrive table in user-guide since it's not relevant for audience Change-Id: Iacd5c68c639e60e8c711cb18351543e477444299 --- .../compute/section_compute-security.xml | 2 +- .../compute/section_compute-system-admin.xml | 2 +- .../section_compute_config-firewalls.xml | 0 .../compute}/section_trusted-compute-pools.xml | 10 +++++----- doc/common/ch_getstart.xml | 1 + doc/config-reference/ch_computeconfigure.xml | 2 +- .../section_compute-configure-console.xml | 16 ---------------- .../compute/section_introduction-to-xen.xml | 2 +- .../compute}/section_rpc.xml | 10 +++++----- .../compute}/section_xapi-ami-setup.xml | 0 .../compute}/section_xapi-install-plugins.xml | 0 .../compute}/section_xapi-resize-setup.xml | 0 .../compute}/section_xen-install.xml | 0 .../section_networking-options-reference.xml | 2 +- .../networking}/section_rpc-for-networking.xml | 12 ++++++------ .../section_cli_keystone_services.xml | 0 .../section_cli_manage_services.xml | 2 +- doc/user-guide/ch_cli.xml | 4 ++-- .../section_cli_nova_baremetal.xml | 0 .../section_cli_nova_boot.xml | 2 +- doc/user-guide/section_cli_nova_config-drive.xml | 6 ------ .../section_cli_nova_get_console.xml | 0 .../section_cli_nova_manage_instances.xml | 14 +++++++------- .../section_cli_nova_reboot.xml | 0 .../section_cli_nova_resizerebuild.xml | 0 .../section_cli_nova_search_ip.xml | 0 .../section_cli_nova_startstop.xml | 0 .../section_cli_nova_terminate.xml | 0 .../section_cli_nova_userdata.xml | 0 29 files changed, 33 insertions(+), 54 deletions(-) rename doc/{common => admin-guide-cloud/compute}/section_compute_config-firewalls.xml (100%) rename doc/{common => admin-guide-cloud/compute}/section_trusted-compute-pools.xml (94%) delete mode 100644 doc/config-reference/compute/section_compute-configure-console.xml rename doc/{common => config-reference/compute}/section_rpc.xml (93%) rename doc/{common => config-reference/compute}/section_xapi-ami-setup.xml (100%) rename doc/{common => config-reference/compute}/section_xapi-install-plugins.xml (100%) rename doc/{common => config-reference/compute}/section_xapi-resize-setup.xml (100%) rename doc/{common => config-reference/compute}/section_xen-install.xml (100%) rename doc/{common => config-reference/networking}/section_rpc-for-networking.xml (92%) rename doc/{common => user-guide-admin}/section_cli_keystone_services.xml (100%) rename doc/{common => user-guide}/section_cli_nova_baremetal.xml (100%) rename doc/{common => user-guide}/section_cli_nova_boot.xml (99%) rename doc/{common => user-guide}/section_cli_nova_get_console.xml (100%) rename doc/{common => user-guide}/section_cli_nova_reboot.xml (100%) rename doc/{common => user-guide}/section_cli_nova_resizerebuild.xml (100%) rename doc/{common => user-guide}/section_cli_nova_search_ip.xml (100%) rename doc/{common => user-guide}/section_cli_nova_startstop.xml (100%) rename doc/{common => user-guide}/section_cli_nova_terminate.xml (100%) rename doc/{common => user-guide}/section_cli_nova_userdata.xml (100%) diff --git a/doc/admin-guide-cloud/compute/section_compute-security.xml b/doc/admin-guide-cloud/compute/section_compute-security.xml index 1a4efa3079..fad3255381 100644 --- a/doc/admin-guide-cloud/compute/section_compute-security.xml +++ b/doc/admin-guide-cloud/compute/section_compute-security.xml @@ -5,7 +5,7 @@ You can integrate OpenStack Compute with various third-party technologies to increase security. For information, see the OpenStack Security Guide. - +
Encrypt Compute metadata traffic OpenStack Juno supports encrypting Compute metadata traffic with HTTPS. You enable SSL diff --git a/doc/admin-guide-cloud/compute/section_compute-system-admin.xml b/doc/admin-guide-cloud/compute/section_compute-system-admin.xml index a2bc9311fc..d7ddf91e93 100644 --- a/doc/admin-guide-cloud/compute/section_compute-system-admin.xml +++ b/doc/admin-guide-cloud/compute/section_compute-system-admin.xml @@ -88,7 +88,7 @@
- +
Inject administrator password diff --git a/doc/common/section_compute_config-firewalls.xml b/doc/admin-guide-cloud/compute/section_compute_config-firewalls.xml similarity index 100% rename from doc/common/section_compute_config-firewalls.xml rename to doc/admin-guide-cloud/compute/section_compute_config-firewalls.xml diff --git a/doc/common/section_trusted-compute-pools.xml b/doc/admin-guide-cloud/compute/section_trusted-compute-pools.xml similarity index 94% rename from doc/common/section_trusted-compute-pools.xml rename to doc/admin-guide-cloud/compute/section_trusted-compute-pools.xml index 04d3896087..fab8c10d4c 100644 --- a/doc/common/section_trusted-compute-pools.xml +++ b/doc/admin-guide-cloud/compute/section_trusted-compute-pools.xml @@ -42,12 +42,12 @@ @@ -126,7 +126,7 @@ auth_blob=i-am-openstack To customize the trusted compute pools, use the following configuration option settings: - +
@@ -147,12 +147,12 @@ auth_blob=i-am-openstack diff --git a/doc/common/ch_getstart.xml b/doc/common/ch_getstart.xml index 37d751accd..5b675604b6 100644 --- a/doc/common/ch_getstart.xml +++ b/doc/common/ch_getstart.xml @@ -203,6 +203,7 @@ +
Feedback diff --git a/doc/config-reference/ch_computeconfigure.xml b/doc/config-reference/ch_computeconfigure.xml index 238b8373ff..4e1d2ca26c 100644 --- a/doc/config-reference/ch_computeconfigure.xml +++ b/doc/config-reference/ch_computeconfigure.xml @@ -84,7 +84,7 @@ - + diff --git a/doc/config-reference/compute/section_compute-configure-console.xml b/doc/config-reference/compute/section_compute-configure-console.xml deleted file mode 100644 index b5d88fefa2..0000000000 --- a/doc/config-reference/compute/section_compute-configure-console.xml +++ /dev/null @@ -1,16 +0,0 @@ -
- Configure remote console access - - OpenStack has two main methods for providing a remote - console or remote desktop access to guest Virtual - Machines. They are VNC, and SPICE HTML5 and can be used - either through the OpenStack dashboard and the command - line. Best practice is to select one or the other to - run. - - -
diff --git a/doc/config-reference/compute/section_introduction-to-xen.xml b/doc/config-reference/compute/section_introduction-to-xen.xml index 3e40be2348..24919ee5fa 100644 --- a/doc/config-reference/compute/section_introduction-to-xen.xml +++ b/doc/config-reference/compute/section_introduction-to-xen.xml @@ -256,6 +256,6 @@
- + diff --git a/doc/common/section_rpc.xml b/doc/config-reference/compute/section_rpc.xml similarity index 93% rename from doc/common/section_rpc.xml rename to doc/config-reference/compute/section_rpc.xml index 255a9afd2f..aa5e05c45e 100644 --- a/doc/common/section_rpc.xml +++ b/doc/config-reference/compute/section_rpc.xml @@ -33,8 +33,8 @@ nova.conf file. The default for sending usage data is sixty seconds plus a random number of seconds from zero to sixty. - - + +
Configure Qpid @@ -70,7 +70,7 @@ qpid_password=password This table lists additional options that you use to configure the Qpid messaging driver for OpenStack Oslo RPC. These options are used infrequently. - +
Configure ZeroMQ @@ -80,13 +80,13 @@ qpid_password=password default messaging system, so you must enable it by setting the option in the nova.conf file. - +
Configure messaging Use these options to configure the RabbitMQ and Qpid messaging drivers. - +
diff --git a/doc/common/section_xapi-ami-setup.xml b/doc/config-reference/compute/section_xapi-ami-setup.xml similarity index 100% rename from doc/common/section_xapi-ami-setup.xml rename to doc/config-reference/compute/section_xapi-ami-setup.xml diff --git a/doc/common/section_xapi-install-plugins.xml b/doc/config-reference/compute/section_xapi-install-plugins.xml similarity index 100% rename from doc/common/section_xapi-install-plugins.xml rename to doc/config-reference/compute/section_xapi-install-plugins.xml diff --git a/doc/common/section_xapi-resize-setup.xml b/doc/config-reference/compute/section_xapi-resize-setup.xml similarity index 100% rename from doc/common/section_xapi-resize-setup.xml rename to doc/config-reference/compute/section_xapi-resize-setup.xml diff --git a/doc/common/section_xen-install.xml b/doc/config-reference/compute/section_xen-install.xml similarity index 100% rename from doc/common/section_xen-install.xml rename to doc/config-reference/compute/section_xen-install.xml diff --git a/doc/config-reference/networking/section_networking-options-reference.xml b/doc/config-reference/networking/section_networking-options-reference.xml index 5c08f38dfe..cedef859f2 100644 --- a/doc/config-reference/networking/section_networking-options-reference.xml +++ b/doc/config-reference/networking/section_networking-options-reference.xml @@ -14,7 +14,7 @@ - +
Agent diff --git a/doc/common/section_rpc-for-networking.xml b/doc/config-reference/networking/section_rpc-for-networking.xml similarity index 92% rename from doc/common/section_rpc-for-networking.xml rename to doc/config-reference/networking/section_rpc-for-networking.xml index 2625167578..c79adf312d 100644 --- a/doc/common/section_rpc-for-networking.xml +++ b/doc/config-reference/networking/section_rpc-for-networking.xml @@ -40,7 +40,7 @@ rpc_backend=neutron.openstack.common.rpc.impl_kombu must set the option to neutron.notifier.rabbit_notifier in the neutron.conf file: - +
Configure Qpid @@ -95,7 +95,7 @@ qpid_protocol=ssl driver for OpenStack Oslo RPC. These options are used infrequently. - +
@@ -106,7 +106,7 @@ qpid_protocol=ssl default messaging system, so you must enable it by setting the option in the neutron.conf file: - +
Configure messaging @@ -116,8 +116,8 @@ qpid_protocol=ssl Qpid, and ZeroMq messaging drivers: - - - + + +
diff --git a/doc/common/section_cli_keystone_services.xml b/doc/user-guide-admin/section_cli_keystone_services.xml similarity index 100% rename from doc/common/section_cli_keystone_services.xml rename to doc/user-guide-admin/section_cli_keystone_services.xml diff --git a/doc/user-guide-admin/section_cli_manage_services.xml b/doc/user-guide-admin/section_cli_manage_services.xml index 58442e7804..3a0d5c239b 100644 --- a/doc/user-guide-admin/section_cli_manage_services.xml +++ b/doc/user-guide-admin/section_cli_manage_services.xml @@ -6,7 +6,7 @@ xml:id="section_cli_manage_services"> Manage services - + diff --git a/doc/user-guide/ch_cli.xml b/doc/user-guide/ch_cli.xml index 1339bd34bd..d90e9759c3 100644 --- a/doc/user-guide/ch_cli.xml +++ b/doc/user-guide/ch_cli.xml @@ -21,11 +21,11 @@ - + - + diff --git a/doc/common/section_cli_nova_baremetal.xml b/doc/user-guide/section_cli_nova_baremetal.xml similarity index 100% rename from doc/common/section_cli_nova_baremetal.xml rename to doc/user-guide/section_cli_nova_baremetal.xml diff --git a/doc/common/section_cli_nova_boot.xml b/doc/user-guide/section_cli_nova_boot.xml similarity index 99% rename from doc/common/section_cli_nova_boot.xml rename to doc/user-guide/section_cli_nova_boot.xml index 244ec5dc79..11b6398471 100644 --- a/doc/common/section_cli_nova_boot.xml +++ b/doc/user-guide/section_cli_nova_boot.xml @@ -292,5 +292,5 @@ - + diff --git a/doc/user-guide/section_cli_nova_config-drive.xml b/doc/user-guide/section_cli_nova_config-drive.xml index 1f08a5fe82..7fbbcb6a8e 100644 --- a/doc/user-guide/section_cli_nova_config-drive.xml +++ b/doc/user-guide/section_cli_nova_config-drive.xml @@ -244,10 +244,4 @@ openstack/latest/user_data 64 MB. -
- Configuration drive reference - The following table shows the configuration options for the - configuration drive. - -
diff --git a/doc/common/section_cli_nova_get_console.xml b/doc/user-guide/section_cli_nova_get_console.xml similarity index 100% rename from doc/common/section_cli_nova_get_console.xml rename to doc/user-guide/section_cli_nova_get_console.xml diff --git a/doc/user-guide/section_cli_nova_manage_instances.xml b/doc/user-guide/section_cli_nova_manage_instances.xml index 8e9106f9b5..14fc98c2a0 100644 --- a/doc/user-guide/section_cli_nova_manage_instances.xml +++ b/doc/user-guide/section_cli_nova_manage_instances.xml @@ -15,12 +15,12 @@ instances. This section also discusses node management tasks. - - - - - - - + + + + + + + diff --git a/doc/common/section_cli_nova_reboot.xml b/doc/user-guide/section_cli_nova_reboot.xml similarity index 100% rename from doc/common/section_cli_nova_reboot.xml rename to doc/user-guide/section_cli_nova_reboot.xml diff --git a/doc/common/section_cli_nova_resizerebuild.xml b/doc/user-guide/section_cli_nova_resizerebuild.xml similarity index 100% rename from doc/common/section_cli_nova_resizerebuild.xml rename to doc/user-guide/section_cli_nova_resizerebuild.xml diff --git a/doc/common/section_cli_nova_search_ip.xml b/doc/user-guide/section_cli_nova_search_ip.xml similarity index 100% rename from doc/common/section_cli_nova_search_ip.xml rename to doc/user-guide/section_cli_nova_search_ip.xml diff --git a/doc/common/section_cli_nova_startstop.xml b/doc/user-guide/section_cli_nova_startstop.xml similarity index 100% rename from doc/common/section_cli_nova_startstop.xml rename to doc/user-guide/section_cli_nova_startstop.xml diff --git a/doc/common/section_cli_nova_terminate.xml b/doc/user-guide/section_cli_nova_terminate.xml similarity index 100% rename from doc/common/section_cli_nova_terminate.xml rename to doc/user-guide/section_cli_nova_terminate.xml diff --git a/doc/common/section_cli_nova_userdata.xml b/doc/user-guide/section_cli_nova_userdata.xml similarity index 100% rename from doc/common/section_cli_nova_userdata.xml rename to doc/user-guide/section_cli_nova_userdata.xml