openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update docs for CLI changes to nova, keystone"

Browse Source
This commit is contained in:
Jenkins 2012-03-15 03:07:47 +00:00 committed by Gerrit Code Review
commit 139f69473e
5 changed files with 37 additions and 39 deletions
doc/src/docbkx
api-quick-start/src/docbkx
cli-uses.xml
openstack-compute-admin
computeadmin.xmlcomputeinstall.xml
openstack-install
enable-access-security-group.xml
samples
openrc.txt

17
doc/src/docbkx/api-quick-start/src/docbkx/cli-uses.xml

@ -19,19 +19,22 @@ $ pip install -e git+https://github.com/openstack/python-novaclient.git#egg=pyth
<para>Now that you have installed the python-novaclient, confirm the installation by entering:</para><programlisting>
$ nova help
usage: nova [--username USERNAME] [--apikey APIKEY] [--projectid PROJECTID]
[--url URL] [--version VERSION]
usage: nova [--debug] [--os_username OS_USERNAME] [--os_password OS_PASSWORD]
[--os_tenant_name OS_TENANT_NAME] [--os_auth_url OS_AUTH_URL]
[--os_region_name OS_REGION_NAME] [--service_type SERVICE_TYPE]
[--service_name SERVICE_NAME] [--endpoint_type ENDPOINT_TYPE]
[--version VERSION]
&lt;subcommand&gt; ...
</programlisting>
<para>In return, you will get a listing of all the commands and parameters for the nova command line client.
By setting up the required parameters as environment variables, you can fly through these commands on the command line.
You can add --username on the nova command, or set them as environment variables. When using an OpenStack, you are supplied with an endpoint,
You can add --os_username on the nova command, or set them as environment variables. When using an OpenStack, you are supplied with an endpoint,
which the nova client recognizes as the NOVA_URL. </para>
<para><programlisting>
export NOVA_USERNAME=joecool
export NOVA_API_KEY=coolword
export NOVA_PROJECT_ID=coolu
export NOVA_URL=http://trystack.org:5000/v2.0
export OS_USERNAME=joecool
export OS_PASSWORD=coolword
export OS_TENANT_NAME=coolu
export OS_AUTH_URL=http://trystack.org:5000/v2.0
export NOVA_VERSION=1.1
</programlisting>
</para>

19
doc/src/docbkx/openstack-compute-admin/computeadmin.xml

@ -722,20 +722,23 @@ $ sudo python setup.py install
<para>Now that you have installed the python-novaclient, confirm the installation by entering:</para>
<literallayout class="monospaced">$ nova help</literallayout>
<programlisting>
usage: nova [--username USERNAME] [--apikey APIKEY] [--projectid PROJECTID]
[--url URL] [--version VERSION]
usage: nova [--debug] [--os_username OS_USERNAME] [--os_password OS_PASSWORD]
[--os_tenant_name OS_TENANT_NAME] [--os_auth_url OS_AUTH_URL]
[--os_region_name OS_REGION_NAME] [--service_type SERVICE_TYPE]
[--service_name SERVICE_NAME] [--endpoint_type ENDPOINT_TYPE]
[--version VERSION]
&lt;subcommand&gt; ...
</programlisting>
<para>In return, you will get a listing of all the commands and parameters for the nova command line client. By setting up the required parameters as environment variables, you can fly through these commands on the command line. You can add --username on the nova command, or set them as environment variables: </para>
<para>In return, you will get a listing of all the commands and parameters for the nova command line client. By setting up the required parameters as environment variables, you can fly through these commands on the command line. You can add --os_username on the nova command, or set them as environment variables: </para>
<para><programlisting>
export NOVA_USERNAME=joecool
export NOVA_API_KEY=coolword
export NOVA_PROJECT_ID=coolu
export OS_USERNAME=joecool
export OS_PASSWORD=coolword
export OS_TENANT_NAME=coolu
</programlisting>
</para><para>Using the Identity Service, you are supplied with an authentication endpoint, which nova recognizes as the NOVA_URL. </para>
</para><para>Using the Identity Service, you are supplied with an authentication endpoint, which nova recognizes as the OS_AUTH_URL. </para>
<para>
<programlisting>
export NOVA_URL=http://hostname:5000/v2.0
export OS_AUTH_URL=http://hostname:5000/v2.0
export NOVA_VERSION=1.1
</programlisting>
</para></simplesect></section>

20
doc/src/docbkx/openstack-compute-admin/computeinstall.xml

@ -511,12 +511,10 @@ alias ec2-upload-bundle="ec2-upload-bundle -a ${EC2_ACCESS_KEY} -s ${EC2_SECRET_
</para>
<para>Lastly, here is an example openrc file that works
with nova client and ec2
tools.</para><programlisting>export NOVA_PASSWORD=${ADMIN_PASSWORD:-secrete}
export OS_PASSWORD=${NOVA_PASSWORD}
export NOVA_URL=${NOVA_URL:-http://$SERVICE_HOST:5000/v2.0}
export OS_AUTH_URL=${NOVA_URL}
tools.</para><programlisting>export OS_PASSWORD=${ADMIN_PASSWORD:-secrete}
export OS_AUTH_URL=${OS_AUTH_URL:-http://$SERVICE_HOST:5000/v2.0}
export NOVA_VERSION=${NOVA_VERSION:-1.1}
export NOVA_REGION_NAME=${NOVA_REGION_NAME:-RegionOne}
export OS_REGION_NAME=${OS_REGION_NAME:-RegionOne}
export EC2_URL=${EC2_URL:-http://$SERVICE_HOST:8773/services/Cloud}
export EC2_ACCESS_KEY=${DEMO_ACCESS}
export EC2_SECRET_KEY=${DEMO_SECRET}
@ -1578,10 +1576,10 @@ euca-associate-address -i $instance_id $address
<programlisting>
# Python-novaclient
export NOVA_API_KEY="SECRET_KEY"
export NOVA_PROJECT_ID="PROJECT-NAME"
export NOVA_USERNAME="USER"
export NOVA_URL="http://$NOVA-API-IP:8774/v1.1"
export OS_PASSWORD="SECRET_KEY"
export OS_TENANT_NAME="PROJECT-NAME"
export OS_USERNAME="USER"
export OS_AUTH_URL="http://$NOVA-API-IP:5000/v2.0"
export NOVA_VERSION=1.1
</programlisting> He are some nova commands you
should be able to run : <literallayout class="monospaced">
@ -1780,8 +1778,8 @@ export EC2_URL="http://$NOVA-API-IP:8773/services/Cloud"
class="monospaced">novaclient</literallayout> <programlisting>
# Novaclient
[...]
export NOVA_URL=http://$KEYSTONe-IP:5000/v.20/
export NOVA_REGION_NAME="$REGION"
export OS_AUTH_URL=http://$KEYSTONE-IP:5000/v2.0/
export OS_REGION_NAME="$REGION"
[...]
</programlisting></para>
</listitem>

2
doc/src/docbkx/openstack-install/enable-access-security-group.xml

@ -13,7 +13,7 @@
credentials used to interact with nova-api have been put
under /root/.bashrc. If the EC2 credentials have been put
into another user's .bashrc file, then, it is necessary to
run these commands as the user. You can also add --username
run these commands as the user. You can also add --os_username
as a parameter to the nova command when you want to run as a specific user. </para>
</note>
<literallayout class="monospaced">

18
doc/src/docbkx/openstack-install/samples/openrc.txt

@ -1,13 +1,7 @@
export NOVA_USERNAME=adminUser
export NOVA_PROJECT_ID=openstackDemo
export NOVA_PASSWORD=secretword
export NOVA_API_KEY=${NOVA_PASSWORD}
export NOVA_URL=http://192.168.206.130:5000/v2.0/
export NOVA_VERSION=1.1
export NOVA_REGION_NAME=RegionOne
export OS_AUTH_USER=${NOVA_USERNAME}
export OS_AUTH_KEY=${NOVA_PASSWORD}
export OS_AUTH_TENANT=${NOVA_PROJECT_ID}
export OS_AUTH_URL=${NOVA_URL}
export OS_USERNAME=adminUser
export OS_TENANT_NAME=openstackDemo
export OS_PASSWORD=secretword
export OS_AUTH_URL=http://192.168.206.130:5000/v2.0/
export OS_REGION_NAME=RegionOne
export OS_AUTH_STRATEGY=keystone
export NOVA_VERSION=1.1