From 49d09622ea00ad8d60d757e9360b698dfa769599 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Fri, 5 Sep 2014 22:16:25 +0200 Subject: [PATCH] Use parameter instead of option for CLI parameters Change-Id: Ie494e326d708da4382d76ea8840175d4bd9bc2fb --- .../blockstorage/section_backup-block-storage-disks.xml | 2 +- .../compute/section_compute-configure-ipv6.xml | 4 ++-- .../compute/section_compute-networking-nova.xml | 8 ++++---- .../networking/section_networking-adv-config.xml | 4 ++-- .../block-storage/section_block-storage-overview.xml | 2 +- doc/config-reference/compute/section_rpc.xml | 2 +- .../networking/section_rpc-for-networking.xml | 2 +- doc/image-guide/section_glance-image-metadata.xml | 4 ++-- doc/install-guide/section_keystone-users.xml | 4 ++-- doc/networking-guide/section_networking_adv_agent.xml | 6 +++--- .../section_cli_swift_analyze_log_files.xml | 4 ++-- doc/user-guide/section_cli_nova_boot.xml | 8 ++++---- 12 files changed, 25 insertions(+), 25 deletions(-) diff --git a/doc/admin-guide-cloud/blockstorage/section_backup-block-storage-disks.xml b/doc/admin-guide-cloud/blockstorage/section_backup-block-storage-disks.xml index 51b1aa6069..1b0b7fe9dd 100644 --- a/doc/admin-guide-cloud/blockstorage/section_backup-block-storage-disks.xml +++ b/doc/admin-guide-cloud/blockstorage/section_backup-block-storage-disks.xml @@ -67,7 +67,7 @@ Create the snapshot; you can do this while the volume is attached to an instance: # lvcreate --size 10G --snapshot --name volume-00000001-snapshot /dev/cinder-volumes/volume-00000001 - Use the + Use the --snapshot configuration option to tell LVM that you want a snapshot of an already existing volume. The command includes the size of the space diff --git a/doc/admin-guide-cloud/compute/section_compute-configure-ipv6.xml b/doc/admin-guide-cloud/compute/section_compute-configure-ipv6.xml index 387294270e..417960b086 100644 --- a/doc/admin-guide-cloud/compute/section_compute-configure-ipv6.xml +++ b/doc/admin-guide-cloud/compute/section_compute-configure-ipv6.xml @@ -42,12 +42,12 @@ command. Specify or after the parameter. $ nova network-create public --fixed-range-v4 FIXED_RANGE_V4 --vlan VLAN_ID --vpn VPN_START --fixed-range-v6 FIXED_RANGE_V6 - You can set IPv6 global routing prefix by using the + You can set IPv6 global routing prefix by using the --fixed_range_v6 parameter. The default value for the parameter is fd00::/48. When you use FlatDHCPManager, the command uses the original - value. For example: + --fixed_range_v6 value. For example: $ nova network-create public --fixed-range-v4 10.0.2.0/24 --fixed-range-v6 fd00:1::/48 diff --git a/doc/admin-guide-cloud/compute/section_compute-networking-nova.xml b/doc/admin-guide-cloud/compute/section_compute-networking-nova.xml index 5710118e67..a72dc62fc5 100644 --- a/doc/admin-guide-cloud/compute/section_compute-networking-nova.xml +++ b/doc/admin-guide-cloud/compute/section_compute-networking-nova.xml @@ -164,15 +164,15 @@ Where: - specifies the network subnet. + --fixed-range-v4- specifies the network subnet. - specifies a range of fixed IP addresses to - allocate, and can be a subset of the + --fixed-cidr specifies a range of fixed IP addresses to + allocate, and can be a subset of the --fixed-range-v4 argument. - specifies the bridge device to which this network is + --bridge specifies the bridge device to which this network is connected on every compute node. diff --git a/doc/admin-guide-cloud/networking/section_networking-adv-config.xml b/doc/admin-guide-cloud/networking/section_networking-adv-config.xml index 968c00c810..8829b005d8 100644 --- a/doc/admin-guide-cloud/networking/section_networking-adv-config.xml +++ b/doc/admin-guide-cloud/networking/section_networking-adv-config.xml @@ -365,14 +365,14 @@ external_network_bridge = br-ex-2 Limitations - No equivalent for nova-network + No equivalent for nova-network --multi_host option. Nova-network has a model where the L3, NAT, and DHCP processing happen on the compute node itself, rather than a dedicated networking node. OpenStack Networking now support running multiple l3-agent and dhcp-agents with load being split across those agents, but the tight coupling of that scheduling with the location of the VM is not supported in Icehouse. The Juno release is expected to include an exact replacement for the - option in nova-network. + --multi_host option in nova-network. Linux network namespace required on nodes running Snapshots. A read-only point in time copy of a volume. The snapshot can be created from a volume that is currently in - use (through the use of ) or in an available + use (through the use of --force True) or in an available state. The snapshot can then be used to create a new volume through create from snapshot. diff --git a/doc/config-reference/compute/section_rpc.xml b/doc/config-reference/compute/section_rpc.xml index a44e3b0700..e9bbec74dc 100644 --- a/doc/config-reference/compute/section_rpc.xml +++ b/doc/config-reference/compute/section_rpc.xml @@ -50,7 +50,7 @@ to the host name where the broker runs in the nova.conf file. - The option accepts a host + The --qpid_hostname option accepts a host name or IP address value. qpid_hostname=hostname.example.com diff --git a/doc/config-reference/networking/section_rpc-for-networking.xml b/doc/config-reference/networking/section_rpc-for-networking.xml index 944836a96c..dc1c88aba6 100644 --- a/doc/config-reference/networking/section_rpc-for-networking.xml +++ b/doc/config-reference/networking/section_rpc-for-networking.xml @@ -59,7 +59,7 @@ rpc_backend=neutron.openstack.common.rpc.impl_qpid the broker runs in the neutron.conf file. - The option accepts a host + The --qpid_hostname option accepts a host name or IP address value. diff --git a/doc/image-guide/section_glance-image-metadata.xml b/doc/image-guide/section_glance-image-metadata.xml index 167e0ca943..cf6dc3206e 100644 --- a/doc/image-guide/section_glance-image-metadata.xml +++ b/doc/image-guide/section_glance-image-metadata.xml @@ -15,8 +15,8 @@ Compute's ImagePropertiesFilter value is specified in the value in the /etc/nova/nova.conf file. - You can add metadata to Image Service images by using the option with the + You can add metadata to Image Service images by using the --property + key=value option with the glance image-create or glance image-update command. More than one property can be specified. For example: $ glance image-update img-uuid --property architecture=arm --property hypervisor_type=qemu diff --git a/doc/install-guide/section_keystone-users.xml b/doc/install-guide/section_keystone-users.xml index 8d97b8cfe6..f69c2b32ec 100644 --- a/doc/install-guide/section_keystone-users.xml +++ b/doc/install-guide/section_keystone-users.xml @@ -15,11 +15,11 @@ (endpoint) of the Identity service before you run keystone commands. You can pass the value of the administration token to the - keystone command with the + keystone command with the --os-token option or set the temporary OS_SERVICE_TOKEN environment variable. Similarly, you can pass the location of the Identity service to the keystone command with the - option or set the temporary + --os-endpoint option or set the temporary OS_SERVICE_ENDPOINT environment variable. This guide uses environment variables to reduce command length. For more information, see the diff --git a/doc/networking-guide/section_networking_adv_agent.xml b/doc/networking-guide/section_networking_adv_agent.xml index 3968bb5758..42de024bc1 100644 --- a/doc/networking-guide/section_networking_adv_agent.xml +++ b/doc/networking-guide/section_networking_adv_agent.xml @@ -362,14 +362,14 @@ external_network_bridge = br-ex-2 Limitations - No equivalent for nova-network + No equivalent for nova-network --multi_host option. Nova-network has a model where the L3, NAT, and DHCP processing happen on the compute node itself, rather than a dedicated networking node. OpenStack Networking now support running multiple l3-agent and dhcp-agents with load being split across those agents, but the tight coupling of that scheduling with the location of the VM is not supported in Icehouse. The Juno release is expected to include an exact replacement for the - option in nova-network. + --multi_host option in nova-network. Linux network namespace required on nodes running - \ No newline at end of file + diff --git a/doc/user-guide-admin/section_cli_swift_analyze_log_files.xml b/doc/user-guide-admin/section_cli_swift_analyze_log_files.xml index b1b8a2fdc4..be710279bf 100644 --- a/doc/user-guide-admin/section_cli_swift_analyze_log_files.xml +++ b/doc/user-guide-admin/section_cli_swift_analyze_log_files.xml @@ -9,7 +9,7 @@ The swift client is simple to use, scalable, and flexible.Use the swift client or option to get short answers to questions about logs, - You can use the or option with a + You can use the -o or --output option with a single object download to redirect the command output to a specific file or to STDOUT (-). The ability to redirect the output to STDOUT enables you to pipe @@ -112,7 +112,7 @@ Write ACL: 8 PUT-499 Discover how many PUT requests are in each log file. Use a bash for loop with awk and swift with - the or option and a + the -o or --output option and a hyphen (-) to discover how many PUT requests are in each log file. diff --git a/doc/user-guide/section_cli_nova_boot.xml b/doc/user-guide/section_cli_nova_boot.xml index 11b6398471..9c5a47ed0e 100644 --- a/doc/user-guide/section_cli_nova_boot.xml +++ b/doc/user-guide/section_cli_nova_boot.xml @@ -139,7 +139,7 @@ List the available security groups: If you are an admin user, specify the - parameter + --all-tenants parameter to list groups for all tenants. $ nova secgroup-list --all-tenants @@ -249,15 +249,15 @@ You can also place arbitrary local files into the instance file system at creation time - by using the option. + by using the --file + <dst-path=src-path> option. You can store up to five files. For example, if you have a special authorized keys file named special_authorized_keysfile that you want to put on the instance rather than using the regular SSH key injection, you - can use the option as + can use the --file option as shown in the following example: $ nova boot --image ubuntu-cloudimage --flavor 1 vm-name \ --file /root/.ssh/authorized_keys=special_authorized_keysfile