Publish RST Command-Line Interface Reference
Change-Id: I40d746c330fdcc0dc4ccf81096e26ef4c287586f Implements: blueprint cli-ref-rst
This commit is contained in:
KATO Tomoyuki
parent
c8e859547a
commit
06be0d440d
@ -41,6 +41,11 @@ Virtual Machine Image Guide
|
||||
|
||||
* RST conversion finished.
|
||||
|
||||
Command-Line Interface Reference
|
||||
--------------------------------
|
||||
|
||||
* RST conversion finished.
|
||||
|
||||
Architecture Design Guide
|
||||
-------------------------
|
||||
|
||||
|
||||
@ -35,7 +35,6 @@ declare -A SPECIAL_BOOKS=(
|
||||
["user-guide-admin"]="RST"
|
||||
# Do not translate
|
||||
["cli-reference"]="skip"
|
||||
["cli-ref-rst"]="skip"
|
||||
["common"]="skip"
|
||||
["contributor-guide"]="skip"
|
||||
# Skip arch design while its being revised
|
||||
|
||||
@ -1,115 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<book xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="openstack-cli-reference">
|
||||
|
||||
<title>OpenStack Command-Line Interface Reference</title>
|
||||
<?rax title.font.size="28px" subtitle.font.size="28px"?>
|
||||
<titleabbrev>CLI Reference</titleabbrev>
|
||||
<info>
|
||||
<author>
|
||||
<personname>
|
||||
<firstname/>
|
||||
<surname/>
|
||||
</personname>
|
||||
<affiliation>
|
||||
<orgname>OpenStack Foundation</orgname>
|
||||
</affiliation>
|
||||
</author>
|
||||
<copyright>
|
||||
<year>2014</year>
|
||||
<year>2015</year>
|
||||
<holder>OpenStack Foundation</holder>
|
||||
</copyright>
|
||||
<releaseinfo>current</releaseinfo>
|
||||
<productname>OpenStack</productname>
|
||||
<pubdate/>
|
||||
<legalnotice role="cc-by">
|
||||
<annotation>
|
||||
<remark>Remaining licensing details are filled in by
|
||||
the template.</remark>
|
||||
</annotation>
|
||||
</legalnotice>
|
||||
<abstract>
|
||||
<para>This guide documents the OpenStack command-line
|
||||
clients.</para>
|
||||
</abstract>
|
||||
</info>
|
||||
<xi:include href="../common/ch_preface.xml"/>
|
||||
<xi:include href="ch_cli.xml"/>
|
||||
|
||||
<!-- Application catalog (murano) -->
|
||||
<xi:include href="generated/ch_cli_murano_commands.xml"/>
|
||||
|
||||
<!-- Bare metal (ironic) -->
|
||||
<xi:include href="generated/ch_cli_ironic_commands.xml"/>
|
||||
|
||||
<!-- Block Storage (cinder) -->
|
||||
<xi:include href="generated/ch_cli_cinder_commands.xml"/>
|
||||
|
||||
<!-- Clustering service (senlin) -->
|
||||
<xi:include href="generated/ch_cli_senlin_commands.xml"/>
|
||||
|
||||
<!-- Compute (nova) -->
|
||||
<xi:include href="generated/ch_cli_nova_commands.xml"/>
|
||||
|
||||
<!-- Containers service (magnum) -->
|
||||
<xi:include href="generated/ch_cli_magnum_commands.xml"/>
|
||||
|
||||
<!-- Database service (trove) -->
|
||||
<xi:include href="generated/ch_cli_trove_commands.xml"/>
|
||||
<xi:include href="generated/ch_cli_trove-manage_commands.xml"/>
|
||||
|
||||
<!-- Data processing (sahara) -->
|
||||
<xi:include href="generated/ch_cli_sahara_commands.xml"/>
|
||||
|
||||
<!-- Deployment service (tuskar) -->
|
||||
<xi:include href="generated/ch_cli_tuskar_commands.xml"/>
|
||||
|
||||
<!-- DNS service (designate) -->
|
||||
<xi:include href="generated/ch_cli_designate_commands.xml"/>
|
||||
|
||||
<!-- Identity service (keystone) -->
|
||||
<xi:include href="generated/ch_cli_keystone_commands.xml"/>
|
||||
|
||||
<!-- Image service (glance) -->
|
||||
<xi:include href="generated/ch_cli_glance_commands.xml"/>
|
||||
|
||||
<!-- Key Manager service (barbican) -->
|
||||
<xi:include href="generated/ch_cli_barbican_commands.xml"/>
|
||||
|
||||
<!-- Monitoring (monasca) -->
|
||||
<xi:include href="generated/ch_cli_monasca_commands.xml"/>
|
||||
|
||||
<!-- Networking (neutron) -->
|
||||
<xi:include href="generated/ch_cli_neutron_commands.xml"/>
|
||||
<xi:include href="ch_cli_neutron_misc_commands.xml"/>
|
||||
|
||||
<!-- Object Storage (swift) -->
|
||||
<xi:include href="generated/ch_cli_swift_commands.xml"/>
|
||||
|
||||
<!-- OpenStack (openstack) -->
|
||||
<xi:include href="generated/ch_cli_openstack_commands.xml"/>
|
||||
|
||||
<!-- Orchestration (heat) -->
|
||||
<xi:include href="generated/ch_cli_heat_commands.xml"/>
|
||||
|
||||
<!-- Rating (cloudkitty) -->
|
||||
<xi:include href="generated/ch_cli_cloudkitty_commands.xml"/>
|
||||
|
||||
<!-- Shared file systems (manila) -->
|
||||
<xi:include href="generated/ch_cli_manila_commands.xml"/>
|
||||
|
||||
<!-- Telemetry (ceilometer) -->
|
||||
<xi:include href="generated/ch_cli_ceilometer_commands.xml"/>
|
||||
|
||||
<!-- Telemetry v3 (gnocchi) -->
|
||||
<xi:include href="generated/ch_cli_gnocchi_commands.xml"/>
|
||||
|
||||
<!-- Workflow service (mistral) -->
|
||||
<xi:include href="generated/ch_cli_mistral_commands.xml"/>
|
||||
|
||||
<xi:include href="../common/app_support.xml"/>
|
||||
</book>
|
||||
@ -1,19 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="ch_cli">
|
||||
<info>
|
||||
<title>OpenStack command-line clients overview</title>
|
||||
</info>
|
||||
<xi:include href="../common/section_cli_overview.xml"/>
|
||||
<?hard-pagebreak?>
|
||||
<xi:include href="../common/section_cli_install.xml"/>
|
||||
<?hard-pagebreak?>
|
||||
<xi:include href="../common/section_cli_version.xml"/>
|
||||
<?hard-pagebreak?>
|
||||
<xi:include href="../common/section_cli_openrc.xml"/>
|
||||
</chapter>
|
||||
@ -1,669 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="neutron_misc_commands">
|
||||
|
||||
<!-- This file is manually generated, unlike many of the other chapters. -->
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>miscellaneous networking command-line client</title>
|
||||
|
||||
<section xml:id="neutron-debug_commands">
|
||||
|
||||
<title>neutron-debug command-line client</title>
|
||||
<para>The <command>neutron-debug</command> client is an extension
|
||||
to the <command>neutron</command> command-line interface (CLI) for the OpenStack
|
||||
neutron-debug tool. This chapter documents
|
||||
<command>neutron-debug</command> version 2.3.0.</para>
|
||||
<para>For help on a specific <command>neutron-debug</command>
|
||||
command, enter:</para>
|
||||
<screen><prompt>$</prompt> <userinput><command>neutron-debug</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
||||
<section xml:id="neutron-debug_command_usage">
|
||||
<title>neutron-debug usage</title>
|
||||
<screen><computeroutput> [--os-password <auth-password>]
|
||||
[--os-tenant-name <auth-tenant-name>]
|
||||
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
|
||||
[--os-region-name <region-name>] [--service-type <service-type>]
|
||||
[--service-name <service-name>]
|
||||
[--volume-service-name <volume-service-name>]
|
||||
[--endpoint-type <endpoint-type>]
|
||||
[--os-volume-api-version <volume-api-ver>]
|
||||
[--os-cacert <ca-certificate>] [--retries <retries>]
|
||||
<subcommand> ...
|
||||
</computeroutput></screen>
|
||||
<variablelist wordsize="10">
|
||||
<title>Subcommands</title>
|
||||
<varlistentry>
|
||||
<term><command>probe-create</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Create probe port - create port and interface within a network namespace.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>probe-list</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List all probes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>probe-clear</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Clear all probes.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>probe-delete</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Delete probe - delete port then delete the namespace.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>probe-exec</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Execute commands in the namespace of the probe.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>ping-all</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ping-all is an all-in-one command to ping all fixed IPs in a specified network.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_command_optional">
|
||||
<title>neutron-debug optional arguments</title>
|
||||
<variablelist wordsize="10">
|
||||
<varlistentry>
|
||||
<term><command>--version</command></term>
|
||||
<listitem>
|
||||
<para>Show version number and exit.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-v, --verbose, --debug</command></term>
|
||||
<listitem>
|
||||
<para>Increase verbosity of output and show tracebacks on
|
||||
errors. Can be repeated.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-q, --quiet</command></term>
|
||||
<listitem>
|
||||
<para>Suppress output except warnings and errors</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>Show this help message and exit</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-strategy
|
||||
<auth-strategy></command></term>
|
||||
<listitem>
|
||||
<para>Authentication strategy (Env: OS_AUTH_STRATEGY,
|
||||
default keystone). For now, any other value will disable
|
||||
the authentication</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-url <auth-url></command></term>
|
||||
<listitem>
|
||||
<para>Authentication URL (Env: OS_AUTH_URL)</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-tenant-name
|
||||
<auth-tenant-name></command></term>
|
||||
<listitem>
|
||||
<para>Authentication tenant name (Env: OS_TENANT_NAME)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-tenant-id
|
||||
<auth-tenant-id></command></term>
|
||||
<listitem>
|
||||
<para>Authentication tenant name (Env: OS_TENANT_ID)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-username
|
||||
<auth-username></command></term>
|
||||
<listitem>
|
||||
<para>Authentication username (Env: OS_USERNAME)</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-password
|
||||
<auth-password></command></term>
|
||||
<listitem>
|
||||
<para>Authentication password (Env: OS_PASSWORD)</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-region-name
|
||||
<auth-region-name></command></term>
|
||||
<listitem>
|
||||
<para>Authentication region name (Env: OS_REGION_NAME)
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-token <token></command></term>
|
||||
<listitem>
|
||||
<para>Defaults to <code>env[OS_TOKEN]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--endpoint-type
|
||||
<endpoint-type></command></term>
|
||||
<listitem>
|
||||
<para>Defaults to <code>env[OS_ENDPOINT_TYPE]</code> or
|
||||
public URL.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-url <url></command></term>
|
||||
<listitem>
|
||||
<para>Defaults to <code>env[OS_URL]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-cacert
|
||||
<ca-certificate></command></term>
|
||||
<listitem>
|
||||
<para>Specify a CA bundle file to use in verifying a TLS
|
||||
(HTTPS) server certificate. Defaults to
|
||||
<code>env[OS_CACERT]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--insecure</command></term>
|
||||
<listitem>
|
||||
<para>Explicitly allow neutron-debug to perform "insecure"
|
||||
SSL (HTTPS) requests. The server's certificate will not be
|
||||
verified against any certificate authorities. This option
|
||||
should be used with caution.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--config-file CONFIG_FILE</command></term>
|
||||
<listitem>
|
||||
<para>Config file for interface driver (You may also use
|
||||
l3_agent.ini)</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_subcommand_probe-create">
|
||||
<title>neutron-debug probe-create command</title>
|
||||
<screen><computeroutput>usage: neutron-debug probe-create NET</computeroutput></screen>
|
||||
<para>Create probe port - create port and interface, then
|
||||
place it into the created network namespace.</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>NET ID</command></term>
|
||||
<listitem>
|
||||
<para>ID of the network in which the probe will be
|
||||
created.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_subcommand_probe-list">
|
||||
<title>neutron-debug probe-list command</title>
|
||||
<screen><computeroutput>usage: neutron-debug probe-list</computeroutput></screen>
|
||||
<para>List probes.</para>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_subcommand_probe-clear">
|
||||
<title>neutron-debug probe-clear command</title>
|
||||
<screen><computeroutput>usage: neutron-debug probe-clear</computeroutput></screen>
|
||||
<para>Clear all probes.</para>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_subcommand_probe-delete">
|
||||
<title>neutron-debug probe-delete command</title>
|
||||
<screen><computeroutput>usage: neutron-debug probe-delete <port-id></computeroutput></screen>
|
||||
<para>
|
||||
Remove a probe.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><port-id></command></term>
|
||||
<listitem>
|
||||
<para>ID of the probe to delete.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_subcommand_probe-exec">
|
||||
<title>neutron-debug probe-exec command</title>
|
||||
<screen><computeroutput>usage: neutron-debug probe-exec <port-id> <command></computeroutput></screen>
|
||||
<para>Execute commands in the namespace of the probe</para>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_subcommand_ping-all">
|
||||
<title>neutron-debug ping-all command</title>
|
||||
<screen><computeroutput>usage: neutron-debug ping-all <port-id> --timeout <number</computeroutput></screen>
|
||||
<para>All-in-one command to ping all fixed IPs
|
||||
in a specified network. A probe creation is not needed
|
||||
for this command. A new probe is created automatically. It will,
|
||||
however, need to be deleted manually when it is no longer needed.
|
||||
When there are multiple networks, the newly created probe will be
|
||||
attached to a random network and thus the ping will take
|
||||
place from within that random network.</para>
|
||||
<variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><port-id></command></term>
|
||||
<listitem>
|
||||
<para>ID of the port to use.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--timeout <timeout in
|
||||
seconds></command></term>
|
||||
<listitem>
|
||||
<para>Optional ping timeout.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="neutron-debug_subcommand_backup-show">
|
||||
<title>neutron-debug example</title>
|
||||
<screen><computeroutput>usage: neutron-debug create-probe < NET_ID></computeroutput></screen>
|
||||
<para>Create a probe namespace within the network identified
|
||||
by NET_ID. The namespace will have the name of qprobe-<UUID
|
||||
of the probe port></para>
|
||||
<note><para>For the following examples to function, the security group rules
|
||||
may need to be modified to allow the SSH (TCP port 22) or ping
|
||||
(ICMP) traffic into network.</para></note>
|
||||
<screen><computeroutput>usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>"</computeroutput></screen>
|
||||
<para>SSH to an instance within the network.</para>
|
||||
<screen><computeroutput>usage: neutron-debug ping-all <network ID>"</computeroutput></screen>
|
||||
<para>Ping all instances on this network to verify they are
|
||||
responding.</para>
|
||||
<screen><computeroutput>usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>"</computeroutput></screen>
|
||||
<para>Ping the DHCP server for this network using dhcping to
|
||||
verify it is working.</para>
|
||||
</section>
|
||||
</section>
|
||||
<section xml:id="neutron-sanity-check_commands">
|
||||
<title>neutron-sanity-check command-line client</title>
|
||||
<para>The <command>neutron-sanity-check</command> client is a tool
|
||||
that checks various sanity about the Networking service. This chapter
|
||||
documents <command>neutron-sanity-check</command> version 7.0.2.</para>
|
||||
<section xml:id="neutron-sanity-check_command_usage">
|
||||
<title>neutron-sanity-check usage</title>
|
||||
<screen><computeroutput>usage: neutron-sanity-check [-h] [--arp_header_match] [--arp_responder]
|
||||
[--config-dir DIR] [--config-file PATH] [--debug]
|
||||
[--dibbler_version] [--dnsmasq_version]
|
||||
[--ebtables_installed] [--icmpv6_header_match]
|
||||
[--iproute2_vxlan] [--keepalived_ipv6_support]
|
||||
[--log-config-append PATH]
|
||||
[--log-date-format DATE_FORMAT]
|
||||
[--log-dir LOG_DIR] [--log-file PATH]
|
||||
[--log-format FORMAT] [--noarp_header_match]
|
||||
[--noarp_responder] [--nodebug]
|
||||
[--nodibbler_version] [--nodnsmasq_version]
|
||||
[--noebtables_installed] [--noicmpv6_header_match]
|
||||
[--noiproute2_vxlan] [--nokeepalived_ipv6_support]
|
||||
[--nonova_notify] [--noovs_geneve] [--noovs_patch]
|
||||
[--noovs_vxlan] [--noovsdb_native]
|
||||
[--noread_netns] [--nouse-syslog]
|
||||
[--nouse-syslog-rfc-format] [--nova_notify]
|
||||
[--noverbose] [--novf_management] [--ovs_geneve]
|
||||
[--ovs_patch] [--ovs_vxlan] [--ovsdb_native]
|
||||
[--read_netns] [--state_path STATE_PATH]
|
||||
[--syslog-log-facility SYSLOG_LOG_FACILITY]
|
||||
[--use-syslog] [--use-syslog-rfc-format]
|
||||
[--verbose] [--version] [--vf_management]</computeroutput></screen>
|
||||
</section>
|
||||
<section xml:id="neutron-sanity-check_command_optional">
|
||||
<title>neutron-sanity-check optional arguments</title>
|
||||
<variablelist wordsize="10">
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>show this help message and exit</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--arp_header_match</command></term>
|
||||
<listitem>
|
||||
<para>Check for ARP header match support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--arp_responder</command></term>
|
||||
<listitem>
|
||||
<para>Check for ARP responder support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--config-dir DIR</command></term>
|
||||
<listitem>
|
||||
<para>Path to a config directory to pull *.conf files from.
|
||||
This file set is sorted, so as to provide a
|
||||
predictable parse order if individual options are
|
||||
over-ridden. The set is parsed after the file(s)
|
||||
specified via previous --config-file, arguments hence
|
||||
over-ridden options in the directory take precedence.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--config-file PATH</command></term>
|
||||
<listitem>
|
||||
<para>Path to a config file to use. Multiple config files
|
||||
can be specified, with values in later files taking
|
||||
precedence. The default files used are: None.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--debug, -d</command></term>
|
||||
<listitem>
|
||||
<para>Print debugging output (set logging level to DEBUG
|
||||
instead of default INFO level).</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--dibbler_version</command></term>
|
||||
<listitem>
|
||||
<para>Check minimal dibbler version</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--dnsmasq_version</command></term>
|
||||
<listitem>
|
||||
<para>Check minimal dnsmasq version</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ebtables_installed</command></term>
|
||||
<listitem>
|
||||
<para>Check ebtables installation</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--icmpv6_header_match</command></term>
|
||||
<listitem>
|
||||
<para>Check for ICMPv6 header match support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--iproute2_vxlan</command></term>
|
||||
<listitem>
|
||||
<para>Check for iproute2 vxlan support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--keepalived_ipv6_support</command></term>
|
||||
<listitem>
|
||||
<para>Check keepalived IPv6 support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-config-append PATH, --log_config PATH</command></term>
|
||||
<listitem>
|
||||
<para>The name of a logging configuration file. This file is
|
||||
appended to any existing logging configuration files.
|
||||
For details about logging configuration files, see the
|
||||
Python logging module documentation.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-date-format DATE_FORMAT</command></term>
|
||||
<listitem>
|
||||
<para>Format string for %(asctime)s in log records. Default: None.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-dir LOG_DIR, --logdir LOG_DIR</command></term>
|
||||
<listitem>
|
||||
<para>(Optional) The base directory used for relative
|
||||
--log-file paths.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-file PATH, --logfile PATH</command></term>
|
||||
<listitem>
|
||||
<para>(Optional) Name of log file to output to. If no
|
||||
default is set, logging will go to stdout.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-format FORMAT</command></term>
|
||||
<listitem>
|
||||
<para>DEPRECATED. A logging.Formatter log message format
|
||||
string which may use any of the available
|
||||
logging.LogRecord attributes. This option is
|
||||
deprecated. Please use logging_context_format_string
|
||||
and logging_default_format_string instead.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noarp_header_match</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --arp_header_match</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noarp_responder</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --arp_responder</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nodebug</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --debug</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nodibbler_version</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --dibbler_version</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nodnsmasq_version</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --dnsmasq_version</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noebtables_installed</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --ebtables_installed</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noicmpv6_header_match</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --icmpv6_header_match</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noiproute2_vxlan</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --iproute2_vxlan</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nokeepalived_ipv6_support</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --keepalived_ipv6_support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nonova_notify</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --nova_notify</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noovs_geneve</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --ovs_geneve</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noovs_patch</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --ovs_patch</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noovs_vxlan</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --ovs_vxlan</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noovsdb_native</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --ovsdb_native</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noread_netns</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --read_netns</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nouse-syslog</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --use-syslog</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nouse-syslog-rfc-format</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --use-syslog-rfc-format</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nova_notify</command></term>
|
||||
<listitem>
|
||||
<para>Check for nova notification support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noverbose</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --verbose</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--novf_management</command></term>
|
||||
<listitem>
|
||||
<para>The inverse of --vf_management</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ovs_geneve</command></term>
|
||||
<listitem>
|
||||
<para>Check for OVS Geneve support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ovs_patch</command></term>
|
||||
<listitem>
|
||||
<para>Check for patch port support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ovs_vxlan</command></term>
|
||||
<listitem>
|
||||
<para>Check for OVS vxlan support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ovsdb_native</command></term>
|
||||
<listitem>
|
||||
<para>Check ovsdb native interface support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--read_netns</command></term>
|
||||
<listitem>
|
||||
<para>Check netns permission settings</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--state_path STATE_PATH</command></term>
|
||||
<listitem>
|
||||
<para>Where to store Neutron state files. This directory
|
||||
must be writable by the agent.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--syslog-log-facility SYSLOG_LOG_FACILITY</command></term>
|
||||
<listitem>
|
||||
<para>Syslog facility to receive log lines.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--use-syslog</command></term>
|
||||
<listitem>
|
||||
<para>Use syslog for logging. Existing syslog format is
|
||||
DEPRECATED and will be changed later to honor RFC5424.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--use-syslog-rfc-format</command></term>
|
||||
<listitem>
|
||||
<para>(Optional) Enables or disables syslog rfc5424 format
|
||||
for logging. If enabled, prefixes the MSG part of the
|
||||
syslog message with APP-NAME (RFC5424). The format
|
||||
without the APP-NAME is deprecated in Kilo, and will
|
||||
be removed in Mitaka, along with this option.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--verbose, -v</command></term>
|
||||
<listitem>
|
||||
<para>If set to false, will disable INFO logging level,
|
||||
making WARNING the default.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--version</command></term>
|
||||
<listitem>
|
||||
<para>show program's version number and exit</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--vf_management</command></term>
|
||||
<listitem>
|
||||
<para>Check for VF management support</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
</section>
|
||||
</chapter>
|
||||
@ -1,9 +0,0 @@
|
||||
Generated files
|
||||
+++++++++++++++
|
||||
|
||||
All files in this directory are generated from the output of the
|
||||
python commands they describe using the ``openstack-auto-commands``
|
||||
tool from the openstack-doc-tools package.
|
||||
|
||||
Do not change these files - change openstack-auto-commands and the
|
||||
python commands itself.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,880 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="swiftclient_commands">
|
||||
|
||||
<!-- This file is automatically generated, do not edit -->
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>Object Storage command-line client</title>
|
||||
|
||||
<para>The <command>swift</command> client is the command-line
|
||||
interface (CLI) for the OpenStack Object Storage API and its extensions.
|
||||
|
||||
This chapter documents <command>swift</command> version
|
||||
<literal>2.6.0</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>swift</command>
|
||||
command, enter:
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput><command>swift</command> <replaceable>COMMAND</replaceable> <option>--help</option></userinput></screen>
|
||||
|
||||
<section xml:id="swiftclient_command_usage">
|
||||
<title>swift usage</title>
|
||||
<screen><computeroutput> [--debug] [--info] [--quiet] [--auth <auth_url>]
|
||||
[--auth-version <auth_version>] [--user <username>]
|
||||
[--key <api_key>] [--retries <num_retries>]
|
||||
[--os-username <auth-user-name>] [--os-password <auth-password>]
|
||||
[--os-user-id <auth-user-id>]
|
||||
[--os-user-domain-id <auth-user-domain-id>]
|
||||
[--os-user-domain-name <auth-user-domain-name>]
|
||||
[--os-tenant-id <auth-tenant-id>]
|
||||
[--os-tenant-name <auth-tenant-name>]
|
||||
[--os-project-id <auth-project-id>]
|
||||
[--os-project-name <auth-project-name>]
|
||||
[--os-project-domain-id <auth-project-domain-id>]
|
||||
[--os-project-domain-name <auth-project-domain-name>]
|
||||
[--os-auth-url <auth-url>] [--os-auth-token <auth-token>]
|
||||
[--os-storage-url <storage-url>] [--os-region-name <region-name>]
|
||||
[--os-service-type <service-type>]
|
||||
[--os-endpoint-type <endpoint-type>]
|
||||
[--os-cacert <ca-certificate>] [--insecure]
|
||||
[--no-ssl-compression]
|
||||
<subcommand> [--help] [<subcommand options>]</computeroutput></screen>
|
||||
<variablelist wordsize="10">
|
||||
<title>Subcommands</title>
|
||||
<varlistentry>
|
||||
<term><command>delete</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Delete a container or objects within a container.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>download</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Download objects from containers.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>list</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Lists the containers for the account or the objects
|
||||
for a container.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>post</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Updates meta information for the account, container,
|
||||
or object; creates containers if not present.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>stat</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Displays information for the account, container,
|
||||
or object.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>upload</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Uploads files or directories to the given container.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>capabilities</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
List cluster capabilities.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>tempurl</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Create a temporary URL.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>auth</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Display auth related environment variables.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_command_examples">
|
||||
<title>swift examples</title>
|
||||
<screen><computeroutput> swift download --help
|
||||
swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K api_key stat -v
|
||||
swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \
|
||||
--os-username user --os-password password list
|
||||
swift --os-auth-url https://api.example.com/v3 --auth-version 3\
|
||||
--os-project-name project1 --os-project-domain-name domain1 \
|
||||
--os-username user --os-user-domain-name domain1 \
|
||||
--os-password password list
|
||||
swift --os-auth-url https://api.example.com/v3 --auth-version 3\
|
||||
--os-project-id 0123456789abcdef0123456789abcdef \
|
||||
--os-user-id abcdef0123456789abcdef0123456789 \
|
||||
--os-password password list
|
||||
swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \
|
||||
--os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \
|
||||
list
|
||||
swift list --lh</computeroutput></screen>
|
||||
</section>
|
||||
<section xml:id="swiftclient_command_optional">
|
||||
<title>swift optional arguments</title>
|
||||
<variablelist wordsize="10">
|
||||
<varlistentry>
|
||||
<term><command>--version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show program's version number and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show OpenStack authentication options.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-s, --snet</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Use SERVICENET internal network.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-v, --verbose</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print more info.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--debug</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show the curl commands and results of all http queries
|
||||
regardless of result status.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--info</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show the curl commands and results of all http queries
|
||||
which return an error.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-q, --quiet</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Suppress status output.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-A AUTH, --auth=AUTH URL</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
for obtaining an auth token.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-V AUTH_VERSION, --auth-version=AUTH_VERSION</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specify a version for authentication. Defaults to 1.0.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-U USER, --user=USER</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User name for obtaining an auth token.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-K KEY, --key=KEY</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Key for obtaining an auth token.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-R RETRIES, --retries=RETRIES</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of times to retry a failed connection.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--insecure</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Allow swiftclient to access servers without having to
|
||||
verify the SSL certificate. Defaults to
|
||||
<code>env[SWIFTCLIENT_INSECURE]</code> (set to 'true' to enable).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--no-ssl-compression</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
This option is deprecated and not used anymore. SSL
|
||||
compression should be disabled by default by the
|
||||
system SSL library.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_capabilities">
|
||||
<title>swift capabilities</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift capabilities</computeroutput></screen>
|
||||
<para>
|
||||
Retrieve capability of the proxy.
|
||||
Optional positional arguments:
|
||||
<proxy_url> Proxy URL of the cluster to retrieve capabilities.
|
||||
</para>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_delete">
|
||||
<title>swift delete</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift delete</computeroutput></screen>
|
||||
<para>
|
||||
Delete a container or objects within a container.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><container></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to delete from.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>[object]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of object to delete. Specify multiple times
|
||||
for multiple objects.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-a, --all</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Delete all containers and objects.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--leave-segments</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Do not delete segments of manifest objects.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--object-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for deleting objects.
|
||||
Default is 10.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--container-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for deleting containers.
|
||||
Default is 10.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_download">
|
||||
<title>swift download</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift download</computeroutput></screen>
|
||||
<para>
|
||||
Download objects from containers.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><container></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to download from. To download a
|
||||
whole account, omit this and specify --all.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><object></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of object to download. Specify multiple times
|
||||
for multiple objects. Omit this to download all
|
||||
objects from the container.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-a, --all</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Indicates that you really want to download
|
||||
everything in the account.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m, --marker</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Marker to use when starting a container or account
|
||||
download.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-p, --prefix <prefix></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Only download items beginning with <prefix>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-r, --remove-prefix</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An optional flag for --prefix <prefix>, use this
|
||||
option to download items without <prefix>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-o, --output <out_file></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
For a single file download, stream the output to
|
||||
<out_file>. Specifying "-" as <out_file> will
|
||||
redirect to stdout.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-D, --output-dir <out_directory></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An optional directory to which to store objects.
|
||||
By default, all objects are recreated in the current
|
||||
directory.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--object-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for downloading objects.
|
||||
Default is 10.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--container-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for downloading containers.
|
||||
Default is 10.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--no-download</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Perform download(s), but don't actually write anything
|
||||
to disk.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-H, --header <header:value></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Adds a customized request header to the query, like
|
||||
"Range" or "If-Match". This option may be repeated.
|
||||
Example --header "content-type:text/plain"
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--skip-identical</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Skip downloading files that are identical on both
|
||||
sides.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--no-shuffle</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
By default, when downloading a complete account or
|
||||
container, download order is randomised in order to
|
||||
to reduce the load on individual drives when multiple
|
||||
clients are executed simultaneously to download the
|
||||
same set of objects (e.g. a nightly automated download
|
||||
script to multiple servers). Enable this option to
|
||||
submit download jobs to the thread pool in the order
|
||||
they are listed in the object store.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_list">
|
||||
<title>swift list</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift list</computeroutput></screen>
|
||||
<para>
|
||||
Lists the containers for the account or the objects for a container.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>[container]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to list object in.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-l, --long</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Long listing format, similar to ls -l.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--lh</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Report sizes in human readable format similar to
|
||||
ls -lh.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-t, --totals</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Used with -l or --lh, only report totals.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-p, --prefix</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Only list items beginning with the prefix.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-d, --delimiter</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Roll up items with the given delimiter. For containers
|
||||
only. See OpenStack Swift API documentation for what
|
||||
this means.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_post">
|
||||
<title>swift post</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift post</computeroutput></screen>
|
||||
<para>
|
||||
Updates meta information for the account, container, or object.
|
||||
If the container is not found, it will be created automatically.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>[container]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to post to.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>[object]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of object to post.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-r, --read-acl <acl></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Read ACL for containers. Quick summary of ACL syntax:
|
||||
.r:*, .r:-.example.com, .r:www.example.com, account1,
|
||||
account2:user2
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-w, --write-acl <acl></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Write ACL for containers. Quick summary of ACL syntax:
|
||||
account1 account2:user2
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-t, --sync-to <sync-to></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Sync To for containers, for multi-cluster replication.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-k, --sync-key <sync-key></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Sync Key for containers, for multi-cluster replication.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m, --meta <name:value></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Sets a meta data item. This option may be repeated.
|
||||
Example: -m Color:Blue -m Size:Large
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-H, --header <header:value></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Adds a customized request header.
|
||||
This option may be repeated. Example
|
||||
-H "content-type:text/plain" -H "Content-Length: 4000"
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_stat">
|
||||
<title>swift stat</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift stat</computeroutput></screen>
|
||||
<para>
|
||||
Displays information for the account, container, or object.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>[container]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to stat from.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>[object]</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of object to stat.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--lh</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Report sizes in human readable format similar to
|
||||
ls -lh.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_tempurl">
|
||||
<title>swift tempurl</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift tempurl</computeroutput></screen>
|
||||
<para>
|
||||
Generates a temporary URL for a Swift object.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><method></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An HTTP method to allow for this temporary URL.
|
||||
Usually 'GET' or 'PUT'.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><seconds></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The amount of time in seconds the temporary URL will be
|
||||
valid for; or, if --absolute is passed, the Unix
|
||||
timestamp when the temporary URL will expire.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><path></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The full path to the Swift object. Example:
|
||||
/v1/AUTH_account/c/o.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><key></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The secret temporary URL key set on the Swift cluster.
|
||||
To set a key, run 'swift post -m
|
||||
"Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"'
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--absolute</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Interpet the <seconds> positional argument as a Unix
|
||||
timestamp rather than a number of seconds in the
|
||||
future.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="swiftclient_subcommand_upload">
|
||||
<title>swift upload</title>
|
||||
|
||||
<screen><computeroutput>Usage: swift upload</computeroutput></screen>
|
||||
<para>
|
||||
Uploads specified files and directories to the given container.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><container></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of container to upload to.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command><file_or_directory></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of file or directory to upload. Specify multiple
|
||||
times for multiple uploads.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-c, --changed</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Only upload files that have changed since the last
|
||||
upload.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--skip-identical</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Skip uploading files that are identical on both sides.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-S, --segment-size <size></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Upload files in segments no larger than <size> (in
|
||||
Bytes) and then create a "manifest" file that will
|
||||
download all the segments as if it were the original
|
||||
file.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--segment-container <container></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Upload the segments into the specified container. If
|
||||
not specified, the segments will be uploaded to a
|
||||
<container>_segments container to not pollute the
|
||||
main <container> listings.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--leave-segments</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Indicates that you want the older segments of manifest
|
||||
objects left alone (in the case of overwrites).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--object-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for uploading full objects.
|
||||
Default is 10.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--segment-threads <threads></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Number of threads to use for uploading object segments.
|
||||
Default is 10.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-H, --header <header:value></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Adds a customized request header. This option may be
|
||||
repeated. Example -H "content-type:text/plain"
|
||||
-H "Content-Length: 4000".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--use-slo</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
When used in conjunction with --segment-size it will
|
||||
create a Static Large Object instead of the default
|
||||
Dynamic Large Object.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--object-name <object-name></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Upload file and name object to <object-name> or upload
|
||||
dir and use <object-name> as object prefix instead of
|
||||
folder name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ignore-checksum</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Turn off checksum validation for uploads.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
</chapter>
|
||||
@ -1,586 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="trove-manageclient_commands">
|
||||
|
||||
<!-- This file is automatically generated, do not edit -->
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>Database service management command-line client</title>
|
||||
|
||||
<para>The <command>trove-manage</command> client is the command-line
|
||||
interface (CLI) for the Database Management Utility API and its extensions.
|
||||
|
||||
This chapter documents <command>trove-manage</command> version
|
||||
<literal>4.0.0</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>trove-manage</command>
|
||||
command, enter:
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput><command>trove-manage</command> <replaceable>COMMAND</replaceable> <option>--help</option></userinput></screen>
|
||||
|
||||
<section xml:id="trove-manageclient_command_usage">
|
||||
<title>trove-manage usage</title>
|
||||
<screen><computeroutput>usage: trove-manage [-h] [--config-dir DIR] [--config-file PATH] [--debug]
|
||||
[--log-config-append PATH] [--log-date-format DATE_FORMAT]
|
||||
[--log-dir LOG_DIR] [--log-file PATH]
|
||||
[--log-format FORMAT] [--nodebug] [--nouse-syslog]
|
||||
[--nouse-syslog-rfc-format] [--noverbose]
|
||||
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog]
|
||||
[--use-syslog-rfc-format] [--verbose] [--version]
|
||||
{db_sync,db_upgrade,db_downgrade,datastore_update,datastore_version_update,db_recreate,db_load_datastore_config_parameters,datastore_version_flavor_add,datastore_version_flavor_delete}
|
||||
...</computeroutput></screen>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_command_optional">
|
||||
<title>trove-manage optional arguments</title>
|
||||
<variablelist wordsize="10">
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--config-dir DIR</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to a config directory to pull *.conf files from.
|
||||
This file set is sorted, so as to provide a
|
||||
predictable parse order if individual options are
|
||||
over-ridden. The set is parsed after the file(s)
|
||||
specified via previous --config-file, arguments hence
|
||||
over-ridden options in the directory take precedence.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--config-file PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Path to a config file to use. Multiple config files
|
||||
can be specified, with values in later files taking
|
||||
precedence. The default files used are: None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--debug, -d</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print debugging output (set logging level to DEBUG
|
||||
instead of default INFO level).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-config-append PATH, --log_config PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of a logging configuration file. This file is
|
||||
appended to any existing logging configuration files.
|
||||
For details about logging configuration files, see the
|
||||
Python logging module documentation.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-date-format DATE_FORMAT</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Format string for %(asctime)s in log records. Default:
|
||||
None .
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-dir LOG_DIR, --logdir LOG_DIR</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
(Optional) The base directory used for relative --log-
|
||||
file paths.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-file PATH, --logfile PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
(Optional) Name of log file to output to. If no
|
||||
default is set, logging will go to stdout.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--log-format FORMAT</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<emphasis>DEPRECATED</emphasis>. A logging.Formatter log message format
|
||||
string which may use any of the available
|
||||
logging.LogRecord attributes. This option is
|
||||
deprecated. Please use logging_context_format_string
|
||||
and logging_default_format_string instead.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nodebug</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --debug
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nouse-syslog</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --use-syslog
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--nouse-syslog-rfc-format</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --use-syslog-rfc-format
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--noverbose</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The inverse of --verbose
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--syslog-log-facility SYSLOG_LOG_FACILITY</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Syslog facility to receive log lines.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--use-syslog</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Use syslog for logging. Existing syslog format is
|
||||
<emphasis>DEPRECATED</emphasis> and will be changed later to honor RFC5424.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--use-syslog-rfc-format</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
(Optional) Enables or disables syslog rfc5424 format
|
||||
for logging. If enabled, prefixes the MSG part of the
|
||||
syslog message with APP-NAME (RFC5424). The format
|
||||
without the APP-NAME is deprecated in Kilo, and will
|
||||
be removed in Mitaka, along with this option.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--verbose, -v</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
If set to false, will disable INFO logging level,
|
||||
making WARNING the default.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show program's version number and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_datastore_update">
|
||||
<title>trove-manage datastore_update</title>
|
||||
<screen><computeroutput>usage: trove-manage datastore_update [-h] datastore_name default_version</computeroutput></screen>
|
||||
<para>
|
||||
Add or update a datastore. If the datastore already exists, the default
|
||||
version will be updated.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>datastore_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>default_version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name or ID of an existing datastore version to set as the
|
||||
default. When adding a new datastore, use an empty string.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_datastore_version_flavor_add">
|
||||
<title>trove-manage datastore_version_flavor_add</title>
|
||||
<screen><computeroutput>usage: trove-manage datastore_version_flavor_add [-h]
|
||||
datastore_name
|
||||
datastore_version_name
|
||||
flavor_ids</computeroutput></screen>
|
||||
<para>
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>datastore_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>datastore_version_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>flavor_ids</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Comma separated list of flavor ids.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_datastore_version_flavor_delete">
|
||||
<title>trove-manage datastore_version_flavor_delete</title>
|
||||
<screen><computeroutput>usage: trove-manage datastore_version_flavor_delete [-h]
|
||||
datastore_name
|
||||
datastore_version_name
|
||||
flavor_id</computeroutput></screen>
|
||||
<para>
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>datastore_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>datastore_version_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>flavor_id</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The flavor to be deleted for a given datastore and
|
||||
datastore version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_datastore_version_update">
|
||||
<title>trove-manage datastore_version_update</title>
|
||||
<screen><computeroutput>usage: trove-manage datastore_version_update [-h]
|
||||
datastore version_name manager
|
||||
image_id packages active</computeroutput></screen>
|
||||
<para>
|
||||
Add or update a datastore version. If the datastore version already exists,
|
||||
all values except the datastore name and version will be updated.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>datastore</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>version_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>manager</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the manager that will administer the datastore
|
||||
version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>image_id</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of the image used to create an instance of the datastore
|
||||
version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>packages</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Packages required by the datastore version that are installed
|
||||
on the guest image.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>active</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Whether the datastore version is active or not. Accepted
|
||||
values are 0 and 1.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_db_downgrade">
|
||||
<title>trove-manage db_downgrade</title>
|
||||
<screen><computeroutput>usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version</computeroutput></screen>
|
||||
<para>
|
||||
Downgrade the database to the specified version.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Target version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repo_path REPO_PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
SQLAlchemy Migrate repository path.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_db_load_datastore_config_parameters">
|
||||
<title>trove-manage db_load_datastore_config_parameters</title>
|
||||
<screen><computeroutput>usage: trove-manage db_load_datastore_config_parameters [-h]
|
||||
datastore
|
||||
datastore_version
|
||||
config_file_location</computeroutput></screen>
|
||||
<para>
|
||||
Loads configuration group parameter validation rules for a datastore version
|
||||
into the database.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>datastore</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>datastore_version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the datastore version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>config_file_location</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Fully qualified file path to the configuration group
|
||||
parameter validation rules.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_db_recreate">
|
||||
<title>trove-manage db_recreate</title>
|
||||
<screen><computeroutput>usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH]</computeroutput></screen>
|
||||
<para>
|
||||
Drop the database and recreate it.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repo_path REPO_PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
SQLAlchemy Migrate repository path.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_db_sync">
|
||||
<title>trove-manage db_sync</title>
|
||||
<screen><computeroutput>usage: trove-manage db_sync [-h] [--repo_path REPO_PATH]</computeroutput></screen>
|
||||
<para>
|
||||
Populate the database structure
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repo_path REPO_PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
SQLAlchemy Migrate repository path.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="trove-manageclient_subcommand_db_upgrade">
|
||||
<title>trove-manage db_upgrade</title>
|
||||
<screen><computeroutput>usage: trove-manage db_upgrade [-h] [--version VERSION]
|
||||
[--repo_path REPO_PATH]</computeroutput></screen>
|
||||
<para>
|
||||
Upgrade the database to the specified version.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--version VERSION</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Target version. Defaults to the latest version.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repo_path REPO_PATH</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
SQLAlchemy Migrate repository path.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
</chapter>
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,585 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="tuskarclient_commands">
|
||||
|
||||
<!-- This file is automatically generated, do not edit -->
|
||||
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<title>Deployment command-line client</title>
|
||||
|
||||
<para>The <command>tuskar</command> client is the command-line
|
||||
interface (CLI) for the Deployment API and its extensions.
|
||||
|
||||
This chapter documents <command>tuskar</command> version
|
||||
<literal>0.1.18</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>tuskar</command>
|
||||
command, enter:
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput><command>tuskar</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
||||
|
||||
<section xml:id="tuskarclient_command_usage">
|
||||
<title>tuskar usage</title>
|
||||
<screen><computeroutput>usage: tuskar [-h] [--version] [-d] [--os-username OS_USERNAME]
|
||||
[--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID]
|
||||
[--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL]
|
||||
[--os-auth-token OS_AUTH_TOKEN] [--tuskar-url TUSKAR_URL]
|
||||
[--tuskar-api-version TUSKAR_API_VERSION]
|
||||
<subcommand> ...
|
||||
<subcommand>
|
||||
plan-add-role Associate role to a plan.
|
||||
plan-create Create a new plan.
|
||||
plan-delete Delete an plan by its UUID.
|
||||
plan-flavor Change flavor of role in the plan.
|
||||
plan-list Show a list of the Plans.
|
||||
plan-patch Change an existing plan [Deprecated].
|
||||
plan-remove-role Remove role from a plan.
|
||||
plan-scale Scale plan by changing count of roles.
|
||||
plan-show Show an individual Plan by its UUID.
|
||||
plan-show-flavors Show flavors assigned to roles of Plan.
|
||||
plan-show-scale Show scale counts of Plan.
|
||||
plan-templates Download the Heat templates for a Plan.
|
||||
plan-update Change an existing plan.
|
||||
role-list Show a list of the Roles.
|
||||
help Display help about this program or one of its
|
||||
subcommands.</computeroutput></screen>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_command_optional">
|
||||
<title>tuskar optional arguments</title>
|
||||
<variablelist wordsize="10">
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Print this help message and exit.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--version</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Shows the client version and exits.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-d, --debug</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[TUSKARCLIENT_DEBUG]</code>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-username OS_USERNAME</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_USERNAME]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-password OS_PASSWORD</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_PASSWORD]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-tenant-id OS_TENANT_ID</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_TENANT_ID]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-tenant-name OS_TENANT_NAME</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_TENANT_NAME]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-url OS_AUTH_URL</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_AUTH_URL]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[OS_AUTH_TOKEN]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--tuskar-url TUSKAR_URL</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[TUSKAR_URL]</code>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--tuskar-api-version TUSKAR_API_VERSION</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defaults to <code>env[TUSKAR_API_VERSION]</code> or 2
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-add-role">
|
||||
<title>tuskar plan-add-role</title>
|
||||
<screen><computeroutput>usage: tuskar plan-add-role [-h] -r <ROLE UUID> plan_uuid</computeroutput></screen>
|
||||
<para>
|
||||
Associate role to a plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>plan_uuid</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to assign role to.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-r <ROLE UUID>, --role-uuid <ROLE UUID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Role to be assigned.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-create">
|
||||
<title>tuskar plan-create</title>
|
||||
<screen><computeroutput>usage: tuskar plan-create [-h] [-d <DESCRIPTION>] name</computeroutput></screen>
|
||||
<para>
|
||||
Create a new plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the Plan to create.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-d <DESCRIPTION>, --description <DESCRIPTION></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User-readable text describing the Plan.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-delete">
|
||||
<title>tuskar plan-delete</title>
|
||||
<screen><computeroutput>usage: tuskar plan-delete [-h] <PLAN></computeroutput></screen>
|
||||
<para>
|
||||
Delete an plan by its UUID.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><PLAN></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the plan to delete.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-flavor">
|
||||
<title>tuskar plan-flavor</title>
|
||||
<screen><computeroutput>usage: tuskar plan-flavor [-h] -F FLAVOR role_name plan_uuid</computeroutput></screen>
|
||||
<para>
|
||||
Change flavor of role in the plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>role_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of role which you want to flavor.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>plan_uuid</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to modify.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-F FLAVOR, --flavor FLAVOR</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Flavor which shall be assigned to role.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-list">
|
||||
<title>tuskar plan-list</title>
|
||||
<screen><computeroutput>usage: tuskar plan-list [-h]</computeroutput></screen>
|
||||
<para>
|
||||
Show a list of the Plans.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-remove-role">
|
||||
<title>tuskar plan-remove-role</title>
|
||||
<screen><computeroutput>usage: tuskar plan-remove-role [-h] -r <ROLE UUID> plan_uuid</computeroutput></screen>
|
||||
<para>
|
||||
Remove role from a plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>plan_uuid</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to remove role from.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-r <ROLE UUID>, --role-uuid <ROLE UUID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Role to be removed.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-scale">
|
||||
<title>tuskar plan-scale</title>
|
||||
<screen><computeroutput>usage: tuskar plan-scale [-h] -C COUNT role_name plan_uuid</computeroutput></screen>
|
||||
<para>
|
||||
Scale plan by changing count of roles.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>role_name</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of role which you want scale.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>plan_uuid</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to modify.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-C COUNT, --count COUNT</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Count of nodes to be set.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-show">
|
||||
<title>tuskar plan-show</title>
|
||||
<screen><computeroutput>usage: tuskar plan-show [-h] [--verbose] [--only-empty-parameters] <PLAN></computeroutput></screen>
|
||||
<para>
|
||||
Show an individual Plan by its UUID.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><PLAN></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to show.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--verbose</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Display full plan details
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--only-empty-parameters</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Display only parameters with empty or None value
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-show-flavors">
|
||||
<title>tuskar plan-show-flavors</title>
|
||||
<screen><computeroutput>usage: tuskar plan-show-flavors [-h] <PLAN></computeroutput></screen>
|
||||
<para>
|
||||
Show flavors assigned to roles of Plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><PLAN></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to show a scale.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-show-scale">
|
||||
<title>tuskar plan-show-scale</title>
|
||||
<screen><computeroutput>usage: tuskar plan-show-scale [-h] <PLAN></computeroutput></screen>
|
||||
<para>
|
||||
Show scale counts of Plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><PLAN></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to show a scale.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-templates">
|
||||
<title>tuskar plan-templates</title>
|
||||
<screen><computeroutput>usage: tuskar plan-templates [-h] -O <OUTPUT DIR> plan_uuid</computeroutput></screen>
|
||||
<para>
|
||||
Download the Heat templates for a Plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>plan_uuid</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan whose Templates will be retrieved.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-O <OUTPUT DIR>, --output-dir <OUTPUT DIR></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Directory to write template files into. It will be
|
||||
created if it does not exist.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_plan-update">
|
||||
<title>tuskar plan-update</title>
|
||||
<screen><computeroutput>usage: tuskar plan-update [-h] [-A <KEY1=VALUE1>] [-P <KEY1=VALUE1>] plan_uuid</computeroutput></screen>
|
||||
<para>
|
||||
Change an existing plan.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>plan_uuid</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
UUID of the Plan to modify.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-A <KEY1=VALUE1>, --attribute <KEY1=VALUE1></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
This can be specified multiple times. This argument is
|
||||
deprecated, use -P and --parameter instead.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-P <KEY1=VALUE1>, --parameter <KEY1=VALUE1></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
This can be specified multiple times.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="tuskarclient_subcommand_role-list">
|
||||
<title>tuskar role-list</title>
|
||||
<screen><computeroutput>usage: tuskar role-list [-h]</computeroutput></screen>
|
||||
<para>
|
||||
Show a list of the Roles.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>-h, --help</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
show this help message and exit
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
</chapter>
|
||||
@ -1,81 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||
<parent>
|
||||
<groupId>org.openstack.docs</groupId>
|
||||
<artifactId>parent-pom</artifactId>
|
||||
<version>1.0.0-SNAPSHOT</version>
|
||||
<relativePath>../pom.xml</relativePath>
|
||||
</parent>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>openstack-cli-reference</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
<name>OpenStack Command-Line Interface Reference</name>
|
||||
<properties>
|
||||
<!-- This is set by Jenkins according to the branch. -->
|
||||
<release.path.name>local</release.path.name>
|
||||
<comments.enabled>0</comments.enabled>
|
||||
</properties>
|
||||
<!-- ################################################ -->
|
||||
<!-- USE "mvn clean generate-sources" to run this POM -->
|
||||
<!-- ################################################ -->
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>com.rackspace.cloud.api</groupId>
|
||||
<artifactId>clouddocs-maven-plugin</artifactId>
|
||||
<!-- version is set in ../pom.xml file -->
|
||||
<executions>
|
||||
<execution>
|
||||
<id>generate-webhelp</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<!-- These parameters only apply to webhelp -->
|
||||
<enableDisqus>0</enableDisqus>
|
||||
<disqusShortname>os-image-guide</disqusShortname>
|
||||
<enableGoogleAnalytics>1</enableGoogleAnalytics>
|
||||
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
|
||||
<generateToc>
|
||||
appendix toc,title
|
||||
article/appendix nop
|
||||
article toc,title
|
||||
book toc,title,figure,table,example,equation
|
||||
chapter toc
|
||||
section toc
|
||||
part toc
|
||||
preface toc
|
||||
qandadiv toc
|
||||
qandaset toc
|
||||
reference toc,title
|
||||
set toc,title
|
||||
</generateToc>
|
||||
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
|
||||
<sectionAutolabel>0</sectionAutolabel>
|
||||
<formalProcedures>0</formalProcedures>
|
||||
<tocSectionDepth>1</tocSectionDepth>
|
||||
<tocChapterDepth>1</tocChapterDepth>
|
||||
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
|
||||
<webhelpDirname>cli-reference</webhelpDirname>
|
||||
<pdfFilenameBase>cli-reference</pdfFilenameBase>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<!-- These parameters apply to pdf and webhelp -->
|
||||
<profileAudience>enduser</profileAudience>
|
||||
<xincludeSupported>true</xincludeSupported>
|
||||
<sourceDirectory>.</sourceDirectory>
|
||||
<includes>
|
||||
bk-cli-reference.xml
|
||||
</includes>
|
||||
<branding>openstack</branding>
|
||||
<canonicalUrlBase>http://docs.openstack.org/cli-reference/content</canonicalUrlBase>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
@ -1,482 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!ENTITY % openstack SYSTEM "../common/entities/openstack.ent">
|
||||
%openstack;
|
||||
]>
|
||||
<section xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
version="5.0"
|
||||
xml:id="section_cli-glance-property">
|
||||
<!-- This file is manually generated, unlike many of the other chapters. -->
|
||||
<title>Image service property keys</title>
|
||||
<para>The following keys, together with the components to which they are specific, can be used
|
||||
with the <option>property</option> option for both the <command>glance
|
||||
image-update</command> and <command>glance image-create</command> commands. For
|
||||
example:</para>
|
||||
<screen><prompt>$</prompt> <userinput>glance image-update <replaceable>IMG-UUID</replaceable> --property architecture=x86_64</userinput></screen>
|
||||
<note><para>Behavior set using image properties overrides
|
||||
behavior set using flavors. For more information, refer to
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/admin-guide-cloud/">
|
||||
<citetitle>OpenStack Cloud Administrator Guide</citetitle></link>
|
||||
</para></note>
|
||||
<table rules="all">
|
||||
<caption>Property keys</caption>
|
||||
<col width="12%"/>
|
||||
<col width="12%"/>
|
||||
<col width="38%"/>
|
||||
<col width="38%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Specific to</th>
|
||||
<th>Key</th>
|
||||
<th>Description</th>
|
||||
<th>Supported values</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>architecture</td>
|
||||
<td>The CPU architecture that must be supported by
|
||||
the hypervisor. For example,
|
||||
<literal>x86_64</literal>, <literal>arm</literal>, or <literal>ppc64</literal>. Run
|
||||
<command>uname -m</command> to get the architecture of a
|
||||
machine. We strongly recommend using the architecture data vocabulary
|
||||
defined by the <link xlink:href="http://libosinfo.org">libosinfo project</link>
|
||||
for this purpose.</td>
|
||||
<td>
|
||||
<itemizedlist>
|
||||
<listitem><para><literal>alpha</literal>—<link xlink:href="http://en.wikipedia.org/wiki/DEC_Alpha"
|
||||
>DEC 64-bit RISC</link></para></listitem>
|
||||
<listitem><para><literal>armv7l</literal>—<link xlink:href="http://en.wikipedia.org/wiki/ARM_architecture"
|
||||
>ARM Cortex-A7 MPCore</link></para></listitem>
|
||||
<listitem><para><literal>cris</literal>—<link xlink:href="http://en.wikipedia.org/wiki/ETRAX_CRIS"
|
||||
>Ethernet, Token Ring, AXis—Code Reduced Instruction Set</link></para></listitem>
|
||||
<listitem><para><literal>i686</literal>—<link xlink:href="http://en.wikipedia.org/wiki/X86"
|
||||
>Intel sixth-generation x86</link>
|
||||
(P6 micro architecture)</para></listitem>
|
||||
<listitem><para><literal>ia64</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Itanium"
|
||||
>Itanium</link></para></listitem>
|
||||
<listitem><para><literal>lm32</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Milkymist"
|
||||
>Lattice Micro32</link></para></listitem>
|
||||
<listitem><para><literal>m68k</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Motorola_68000_family"
|
||||
>Motorola 68000</link></para></listitem>
|
||||
<listitem><para><literal>microblaze</literal>—<link xlink:href="http://en.wikipedia.org/wiki/MicroBlaze"
|
||||
>Xilinx 32-bit FPGA (Big Endian)</link></para></listitem>
|
||||
<listitem><para><literal>microblazeel</literal>—<link xlink:href="http://en.wikipedia.org/wiki/MicroBlaze"
|
||||
>Xilinx 32-bit FPGA (Little Endian)</link></para></listitem>
|
||||
<listitem><para><literal>mips</literal>—<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
|
||||
>MIPS 32-bit RISC (Big Endian)</link></para></listitem>
|
||||
<listitem><para><literal>mipsel</literal>—<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
|
||||
>MIPS 32-bit RISC (Little Endian)</link></para></listitem>
|
||||
<listitem><para><literal>mips64</literal>—<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
|
||||
>MIPS 64-bit RISC (Big Endian)</link></para></listitem>
|
||||
<listitem><para><literal>mips64el</literal>—<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
|
||||
>MIPS 64-bit RISC (Little Endian)</link></para></listitem>
|
||||
<listitem><para><literal>openrisc</literal>—<link xlink:href="http://en.wikipedia.org/wiki/OpenRISC#QEMU_support"
|
||||
>OpenCores RISC</link></para></listitem>
|
||||
<listitem><para><literal>parisc</literal>—<link xlink:href="http://en.wikipedia.org/wiki/PA-RISC"
|
||||
>HP Precision Architecture RISC</link></para></listitem>
|
||||
<listitem><para><literal>parisc64</literal>—<link xlink:href="http://en.wikipedia.org/wiki/PA-RISC"
|
||||
>HP Precision Architecture 64-bit RISC</link></para></listitem>
|
||||
<listitem><para><literal>ppc</literal>—<link xlink:href="http://en.wikipedia.org/wiki/PowerPC"
|
||||
>PowerPC 32-bit</link></para></listitem>
|
||||
<listitem><para><literal>ppc64</literal>—<link xlink:href="http://en.wikipedia.org/wiki/PowerPC"
|
||||
>PowerPC 64-bit</link></para></listitem>
|
||||
<listitem><para><literal>ppcemb</literal>—<link xlink:href="http://en.wikipedia.org/wiki/PowerPC"
|
||||
>PowerPC (Embedded 32-bit)</link></para></listitem>
|
||||
<listitem><para><literal>s390</literal>—<link xlink:href="http://en.wikipedia.org/wiki/S390"
|
||||
>IBM Enterprise Systems Architecture/390</link></para></listitem>
|
||||
<listitem><para><literal>s390x</literal>—<link xlink:href="http://en.wikipedia.org/wiki/S390x"
|
||||
>S/390 64-bit</link></para></listitem>
|
||||
<listitem><para><literal>sh4</literal>—<link xlink:href="http://en.wikipedia.org/wiki/SuperH"
|
||||
>SuperH SH-4 (Little Endian)</link></para></listitem>
|
||||
<listitem><para><literal>sh4eb</literal>—<link xlink:href="http://en.wikipedia.org/wiki/SuperH"
|
||||
>SuperH SH-4 (Big Endian)</link></para></listitem>
|
||||
<listitem><para><literal>sparc</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Sparc"
|
||||
>Scalable Processor Architecture, 32-bit</link></para></listitem>
|
||||
<listitem><para><literal>sparc64</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Sparc"
|
||||
>Scalable Processor Architecture, 64-bit</link></para></listitem>
|
||||
<listitem><para><literal>unicore32</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Unicore"
|
||||
>Microprocessor Research and Development Center
|
||||
RISC Unicore32</link></para></listitem>
|
||||
<listitem><para><literal>x86_64</literal>—<link xlink:href="http://en.wikipedia.org/wiki/X86"
|
||||
>64-bit extension of IA-32</link></para></listitem>
|
||||
<listitem><para><literal>xtensa</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Xtensa#Processor_Cores"
|
||||
>Tensilica Xtensa configurable microprocessor core</link></para></listitem>
|
||||
<listitem><para><literal>xtensaeb</literal>—<link xlink:href="http://en.wikipedia.org/wiki/Xtensa#Processor_Cores"
|
||||
>Tensilica Xtensa configurable microprocessor core
|
||||
(Big Endian)</link></para></listitem>
|
||||
</itemizedlist>
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>hypervisor_type</td>
|
||||
<td>The hypervisor type. Note that
|
||||
<literal>qemu</literal> is used for both QEMU and KVM
|
||||
hypervisor types.</td>
|
||||
<td>
|
||||
<literal>hyperv</literal>,
|
||||
<literal>ironic</literal>,
|
||||
<literal>lxc</literal>,
|
||||
<literal>qemu</literal>,
|
||||
<literal>uml</literal>,
|
||||
<literal>vmware</literal>, or
|
||||
<literal>xen</literal>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>instance_type_rxtx_factor</td>
|
||||
<td>Optional property allows created servers to have a different bandwidth cap than
|
||||
that defined in the network they are attached to. This factor is multiplied by
|
||||
the rxtx_base property of the network. The rxtx_base property defaults to 1.0,
|
||||
which is the same as the attached network. This parameter is only available for
|
||||
Xen or NSX based systems.</td>
|
||||
<td>Float (default value is 1.0)</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>instance_uuid</td>
|
||||
<td>For snapshot images, this is the UUID of the server used to create this image.</td>
|
||||
<td>Valid server UUID</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>img_config_drive</td>
|
||||
<td>Specifies whether the image needs a config drive.</td>
|
||||
<td><literal>mandatory</literal> or <literal>optional</literal> (default if property is not used).</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>kernel_id</td>
|
||||
<td>The ID of an image stored in the Image service that should be used as the kernel
|
||||
when booting an AMI-style image.</td>
|
||||
<td>Valid image ID</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>os_distro</td>
|
||||
<td>The common name of the operating system distribution in lowercase (uses the same
|
||||
data vocabulary as the <link xlink:href="http://libosinfo.org">libosinfo
|
||||
project</link>). Specify only a recognized value for this field. Deprecated
|
||||
values are listed to assist you in searching for the recognized value.</td>
|
||||
<td>
|
||||
<itemizedlist>
|
||||
<listitem><para><literal>arch</literal>—Arch Linux. Do not use <literal>archlinux</literal> or
|
||||
<literal>org.archlinux</literal></para></listitem>
|
||||
<listitem><para><literal>centos</literal>—Community Enterprise Operating System. Do not use
|
||||
<literal>org.centos</literal> or
|
||||
<literal>CentOS</literal></para></listitem>
|
||||
<listitem><para><literal>debian</literal>—Debian. Do not use <literal>Debian</literal> or
|
||||
<literal>org.debian</literal></para></listitem>
|
||||
<listitem><para><literal>fedora</literal>—Fedora. Do not use <literal>Fedora</literal>,
|
||||
<literal>org.fedora</literal>, or
|
||||
<literal>org.fedoraproject</literal></para></listitem>
|
||||
<listitem><para><literal>freebsd</literal>—FreeBSD. Do not use <literal>org.freebsd</literal>,
|
||||
<literal>freeBSD</literal>, or <literal>FreeBSD</literal></para></listitem>
|
||||
<listitem><para><literal>gentoo</literal>—Gentoo Linux. Do not use <literal>Gentoo</literal> or
|
||||
<literal>org.gentoo</literal></para></listitem>
|
||||
<listitem><para><literal>mandrake</literal>—Mandrakelinux (MandrakeSoft) distribution. Do not use
|
||||
<literal>mandrakelinux</literal> or
|
||||
<literal>MandrakeLinux</literal></para></listitem>
|
||||
<listitem><para><literal>mandriva</literal>—Mandriva Linux. Do not use
|
||||
<literal>mandrivalinux</literal></para></listitem>
|
||||
<listitem><para><literal>mes</literal>—Mandriva Enterprise Server. Do not use
|
||||
<literal>mandrivaent</literal> or
|
||||
<literal>mandrivaES</literal></para></listitem>
|
||||
<listitem><para><literal>msdos</literal>—Microsoft Disc Operating System. Do not use
|
||||
<literal>ms-dos</literal></para></listitem>
|
||||
<listitem><para><literal>netbsd</literal>—NetBSD. Do not use <literal>NetBSD</literal> or
|
||||
<literal>org.netbsd</literal></para></listitem>
|
||||
<listitem><para><literal>netware</literal>—Novell NetWare. Do not use <literal>novell</literal> or
|
||||
<literal>NetWare</literal></para></listitem>
|
||||
<listitem><para><literal>openbsd</literal>—OpenBSD. Do not use <literal>OpenBSD</literal> or
|
||||
<literal>org.openbsd</literal></para></listitem>
|
||||
<listitem><para><literal>opensolaris</literal>—OpenSolaris. Do not use <literal>OpenSolaris</literal>
|
||||
or <literal>org.opensolaris</literal></para></listitem>
|
||||
<listitem><para><literal>opensuse</literal>—openSUSE. Do not use <literal>suse</literal>,
|
||||
<literal>SuSE</literal>, or
|
||||
<literal>org.opensuse</literal></para></listitem>
|
||||
<listitem><para><literal>rhel</literal>—Red Hat Enterprise Linux. Do not use
|
||||
<literal>redhat</literal>, <literal>RedHat</literal>, or
|
||||
<literal>com.redhat</literal></para></listitem>
|
||||
<listitem><para><literal>sled</literal>—SUSE Linux Enterprise Desktop. Do not use
|
||||
<literal>com.suse</literal></para></listitem>
|
||||
<listitem><para><literal>ubuntu</literal>—Ubuntu. Do not use <literal>Ubuntu</literal>,
|
||||
<literal>com.ubuntu</literal>, <literal>org.ubuntu</literal>, or
|
||||
<literal>canonical</literal></para></listitem>
|
||||
<listitem><para><literal>windows</literal>—Microsoft Windows. Do not use
|
||||
<literal>com.microsoft.server</literal> or
|
||||
<literal>windoze</literal></para></listitem>
|
||||
</itemizedlist>
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>os_version</td>
|
||||
<td>The operating system version as specified by the distributor.</td>
|
||||
<td>Version number (for example, "11.10")</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>ramdisk_id</td>
|
||||
<td>The ID of image stored in the Image service that should be used as the ramdisk
|
||||
when booting an AMI-style image.</td>
|
||||
<td>Valid image ID</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>All</td>
|
||||
<td>vm_mode</td>
|
||||
<td>The virtual machine mode. This represents the host/guest ABI (application binary
|
||||
interface) used for the virtual machine.</td>
|
||||
<td>
|
||||
<itemizedlist>
|
||||
<listitem><para><literal>hvm</literal>—Fully virtualized. This is the mode used by QEMU and
|
||||
KVM.</para></listitem>
|
||||
<listitem><para><literal>xen</literal>—Xen 3.0 paravirtualized.</para></listitem>
|
||||
<listitem><para><literal>uml</literal>—User Mode Linux paravirtualized.</para></listitem>
|
||||
<listitem><para><literal>exe</literal>—Executables in containers. This is the mode used by
|
||||
LXC.</para></listitem>
|
||||
</itemizedlist>
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_cpu_sockets</td>
|
||||
<td>The preferred number of sockets to expose to the guest.</td>
|
||||
<td>Integer</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_cpu_cores</td>
|
||||
<td>The preferred number of cores to expose to the guest.</td>
|
||||
<td>Integer</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_cpu_threads</td>
|
||||
<td>The preferred number of threads to expose to the guest.</td>
|
||||
<td>Integer</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_disk_bus</td>
|
||||
<td>Specifies the type of disk controller to attach
|
||||
disk devices to.</td>
|
||||
<td>
|
||||
One of <literal>scsi</literal>,
|
||||
<literal>virtio</literal>, <literal>uml</literal>,
|
||||
<literal>xen</literal>, <literal>ide</literal>, or
|
||||
<literal>usb</literal>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td><para>libvirt API driver</para></td>
|
||||
<td><para>hw_rng_model</para></td>
|
||||
<td><para>Adds a random-number generator device to the image's instances. The cloud
|
||||
administrator can enable and control device behavior by configuring the
|
||||
instance's flavor. By default:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>The generator device is disabled.</para></listitem>
|
||||
<listitem><para><systemitem>/dev/random</systemitem> is used as the default entropy source. To specify a
|
||||
physical HW RNG device, use the following option in the
|
||||
<filename>nova.conf</filename> file:
|
||||
<programlisting language="ini">rng_dev_path=/dev/hwrng</programlisting></para></listitem>
|
||||
</itemizedlist>
|
||||
</td>
|
||||
<td><para><literal>virtio</literal>, or other supported device.</para></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver, Hyper-V driver</td>
|
||||
<td>hw_machine_type</td>
|
||||
<td><emphasis>libvirt:</emphasis> Enables booting an ARM system using the specified machine type. By default, if
|
||||
an ARM image is used and its type is not specified, Compute uses
|
||||
<literal>vexpress-a15</literal> (for ARMv7) or <literal>virt</literal> (for AArch64) machine types.
|
||||
|
||||
|
||||
<emphasis>Hyper-V:</emphasis> Specifies whether the Hyper-V instance will be a generation 1 or generation 2 VM.
|
||||
By default, if the property is not provided, the instances will be generation 1 VMs. If the image is specific
|
||||
for generation 2 VMs but the property is not provided accordingly, the instance will fail to boot.
|
||||
</td>
|
||||
<td><emphasis>Libvirt machine type.</emphasis> Valid types can be viewed by using the
|
||||
<command>virsh capabilities</command> command (machine types are
|
||||
displayed in the <tag>machine</tag> tag).
|
||||
<emphasis>Hyper-V machine type.</emphasis> Acceptable values are: <literal>hyperv-gen1</literal>
|
||||
or <literal>hyperv-gen2</literal>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_scsi_model</td>
|
||||
<td>Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for
|
||||
compute instances; by default, instances use VirtIO Block (virtio-blk). VirtIO
|
||||
SCSI is a para-virtualized SCSI controller device that provides improved
|
||||
scalability and performance, and supports advanced SCSI hardware.</td>
|
||||
<td><literal>virtio-scsi</literal>
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_serial_port_count</td>
|
||||
<td>Specifies the count of serial ports that should be provided. If <option>hw:serial_port_count</option>
|
||||
is not set in the flavor's <option>extra_specs</option>, then any count is permitted.
|
||||
If <option>hw:serial_port_count</option> is set, then this provides the default serial port count.
|
||||
It is permitted to override the default serial port count, but only with a lower value.</td>
|
||||
<td>Integer</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_video_model</td>
|
||||
<td>The video image driver used.</td>
|
||||
<td><literal>vga</literal>, <literal>cirrus</literal>, <literal>vmvga</literal>,
|
||||
<literal>xen</literal>, or <literal>qxl</literal></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_video_ram</td>
|
||||
<td>Maximum RAM for the video image. Used only if a
|
||||
<option>hw_video:ram_max_mb</option> value has been set in the flavor's
|
||||
<option>extra_specs</option> and that value is higher than the value set in
|
||||
<literal>hw_video_ram</literal>.</td>
|
||||
<td>Integer in MB (for example, '64')</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_watchdog_action</td>
|
||||
<td>Enables a virtual hardware watchdog device that carries out the specified action
|
||||
if the server hangs. The watchdog uses the i6300esb device (emulating a PCI
|
||||
Intel 6300ESB). If <literal>hw_watchdog_action</literal> is not specified, the
|
||||
watchdog is disabled.</td>
|
||||
<td><itemizedlist>
|
||||
<listitem><para><literal>disabled</literal>—(default) The device is not
|
||||
attached. Allows the user to disable the watchdog
|
||||
for the image, even if it has been enabled using the image's flavor.
|
||||
</para></listitem>
|
||||
<listitem><para><literal>reset</literal>—Forcefully reset the guest.</para></listitem>
|
||||
<listitem><para><literal>poweroff</literal>—Forcefully power off the guest.</para></listitem>
|
||||
<listitem><para><literal>pause</literal>—Pause the guest.</para></listitem>
|
||||
<listitem><para><literal>none</literal>—Only enable the watchdog; do nothing if the server
|
||||
hangs.</para></listitem>
|
||||
</itemizedlist>
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>os_command_line</td>
|
||||
<td>The kernel command line to be used by the libvirt driver, instead of the
|
||||
default. For Linux Containers (LXC), the value is used as arguments for
|
||||
initialization. This key is valid only for Amazon kernel, ramdisk,
|
||||
or machine images (aki, ari, or ami).</td>
|
||||
<td/>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver and VMware API driver</td>
|
||||
<td>hw_vif_model</td>
|
||||
<td>Specifies the model of virtual network interface device to use.</td>
|
||||
<td>
|
||||
<para>
|
||||
The valid options depend on the configured
|
||||
hypervisor.
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>KVM and QEMU: <literal>e1000</literal>,
|
||||
<literal>ne2k_pci</literal>,
|
||||
<literal>pcnet</literal>,
|
||||
<literal>rtl8139</literal>, and
|
||||
<literal>virtio</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>VMware: <literal>e1000</literal>,
|
||||
<literal>e1000e</literal>,
|
||||
<literal>VirtualE1000</literal>,
|
||||
<literal>VirtualE1000e</literal>,
|
||||
<literal>VirtualPCNet32</literal>,
|
||||
<literal>VirtualSriovEthernetCard</literal>, and
|
||||
<literal>VirtualVmxnet</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Xen: <literal>e1000</literal>,
|
||||
<literal>netfront</literal>,
|
||||
<literal>ne2k_pci</literal>,
|
||||
<literal>pcnet</literal>, and
|
||||
<literal>rtl8139</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_vif_multiqueue_enabled</td>
|
||||
<td>If true, this enables the virtio-net multiqueue feature.
|
||||
In this case, the driver sets the number of
|
||||
queues equal to the number of guest vCPUs.
|
||||
This makes the network performance scale across
|
||||
a number of vCPUs.
|
||||
</td>
|
||||
<td><literal>true</literal> | <literal>false</literal></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>libvirt API driver</td>
|
||||
<td>hw_boot_menu</td>
|
||||
<td>If true, enables the BIOS bootmenu.
|
||||
In cases where both the image metadata and Extra Spec are set, the
|
||||
Extra Spec setting is used. This allows for flexibility in
|
||||
setting/overriding the default behavior as needed.</td>
|
||||
<td><literal>true</literal> | <literal>false</literal></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>VMware API driver</td>
|
||||
<td>vmware_adaptertype</td>
|
||||
<td>The virtual SCSI or IDE controller used by the hypervisor.</td>
|
||||
<td><literal>lsiLogic</literal>, <literal>lsiLogicsas</literal>,
|
||||
<literal>busLogic</literal>, <literal>ide</literal>, or
|
||||
<literal>paraVirtual</literal></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>VMware API driver</td>
|
||||
<td>vmware_ostype</td>
|
||||
<td>A VMware GuestID which describes the operating system installed in the image.
|
||||
This value is passed to the hypervisor when creating a virtual machine. If not
|
||||
specified, the key defaults to <literal>otherGuest</literal>.</td>
|
||||
<td>See <link xlink:href="http://www.thinkvirt.com/?q=node/181"
|
||||
>thinkvirt.com</link>.</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>VMware API driver</td>
|
||||
<td>vmware_image_version</td>
|
||||
<td>Currently unused.</td>
|
||||
<td><literal>1</literal></td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>XenAPI driver</td>
|
||||
<td>auto_disk_config</td>
|
||||
<td>If true, the root partition on the disk is automatically resized before the
|
||||
instance boots. This value is only taken into account by the Compute service
|
||||
when using a Xen-based hypervisor with the XenAPI driver. The Compute service
|
||||
will only attempt to resize if there is a single partition on the image, and
|
||||
only if the partition is in <literal>ext3</literal> or <literal>ext4</literal>
|
||||
format.</td>
|
||||
<td>true | false</td>
|
||||
</tr>
|
||||
<tr valign="top">
|
||||
<td>XenAPI driver</td>
|
||||
<td>os_type</td>
|
||||
<td>The operating system installed on the image. The XenAPI driver contains logic
|
||||
that takes different actions depending on the value of the
|
||||
<literal>os_type</literal> parameter of the image. For example, for
|
||||
<literal>os_type=windows</literal> images, it creates a FAT32-based swap
|
||||
partition instead of a Linux swap partition, and it limits the injected host
|
||||
name to less than 16 characters.</td>
|
||||
<td><literal>linux</literal> or <literal>windows</literal></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
@ -77,7 +77,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/cli-ref-rst/source'
|
||||
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-reference/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,
|
||||
@ -209,7 +209,7 @@ html_show_sourcelink = False
|
||||
# html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'cli-ref-rst'
|
||||
htmlhelp_basename = 'cli-reference'
|
||||
|
||||
# If true, publish source files
|
||||
html_copy_source = False
|
||||
@ -10,7 +10,6 @@
|
||||
<packaging>pom</packaging>
|
||||
|
||||
<modules>
|
||||
<module>cli-reference</module>
|
||||
<module>glossary</module>
|
||||
</modules>
|
||||
<profiles>
|
||||
|
||||
@ -12,7 +12,7 @@ if [[ $# > 0 ]] ; then
|
||||
fi
|
||||
|
||||
for guide in user-guide user-guide-admin admin-guide-cloud \
|
||||
contributor-guide image-guide arch-design; do
|
||||
contributor-guide image-guide arch-design cli-reference; do
|
||||
tools/build-rst.sh doc/$guide $GLOSSARY --build build \
|
||||
--target $guide $LINKCHECK
|
||||
# Build it only the first time
|
||||
@ -22,7 +22,7 @@ done
|
||||
# Draft guides
|
||||
# This includes guides that we publish from stable branches
|
||||
# as versioned like the networking-guide.
|
||||
for guide in networking-guide arch-design-draft config-reference cli-ref-rst; do
|
||||
for guide in networking-guide arch-design-draft config-reference; do
|
||||
tools/build-rst.sh doc/$guide --build build \
|
||||
--target "draft/$guide" $LINKCHECK
|
||||
done
|
||||
|
||||
@ -161,6 +161,7 @@ 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
|
||||
|
||||
# Hot-guide has moved to heat repo
|
||||
redirect 301 /user-guide/hot-guide/hot.html /developer/heat/template_guide/hot_guide.html
|
||||
|
||||
Loading…
Reference in New Issue
Block a user