Skip to content

Commit

Permalink
Add user-data and config-drive information to End User Guide
Browse files Browse the repository at this point in the history
These three files have not been included in any of the current guides
and we have broken references to them:
common/section_user-data.xml
common/section_nova_cli_userdata.xml
user-guide/section_nova_cli_config-drive.xml

This patch adds them to the End User Guide and fixes references to
them.

Note: I'm not 100 per cent sure that the End User Guide is the right
place to add these. Please double check and advise.

Partial-Bug: #1225093

Change-Id: I12538a6c8f8f84e5a469a8b63b1dd1b71f44d21a
  • Loading branch information
ajaeger committed Sep 29, 2013
1 parent 2baa062 commit d99e908
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
4 changes: 2 additions & 2 deletions doc/admin-guide-cloud/ch_compute.xml
Expand Up @@ -737,8 +737,8 @@ header: Date: Thu, 13 Sep 2012 20:27:36 GMT
including authorized_keys key injection, user-data,
metadata service, and file injection.</para>
<para>For information, see the <link
xlink:href="http://docs.openstack.org/cli/quick-start/content/"
><citetitle>OpenStack Clients
xlink:href="http://docs.openstack.org/user-guide/content/"
><citetitle>OpenStack End User
Guide</citetitle></link>.</para>
</section>
<section xml:id="section_instance-networking">
Expand Down
4 changes: 2 additions & 2 deletions doc/image-guide/ch_openstack_images.xml
Expand Up @@ -274,13 +274,13 @@ done
<title>Process user data and other metadata (cloud-init)</title>
<para>In additional the ssh public key, an image may need to retrieve additional information
from OpenStack, such as <link
xlink:href="http://docs.openstack.org/trunk/openstack-compute/admin/content/user-data.html"
xlink:href="http://docs.openstack.org/user-guide/content/user-data.html"
>user data</link> that the user submitted when requesting the image. For example,
you may wish to set the host name of the instance to name given to the instance when it
is booted. Or, you may wish to configure your image so that it executes user data
content as a script on boot.</para>
<para>This information is accessible via the metadata service or the <link
xlink:href="http://docs.openstack.org/folsom/openstack-compute/admin/content/config-drive.html"
xlink:href="http://docs.openstack.org/user-guide/content/config-drive.html"
>config drive</link>. As the OpenStack metadata service is compatible with version
2009-04-04 of the Amazon EC2 metadata service, consult the Amazon EC2 documentation on
<link
Expand Down
6 changes: 6 additions & 0 deletions doc/user-guide/ch_cli.xml
Expand Up @@ -26,6 +26,12 @@
<?hard-pagebreak?>
<xi:include href="section_nova_cli_manage_instances.xml"/>
<?hard-pagebreak?>
<xi:include href="../common/section_user-data.xml"/>
<?hard-pagebreak?>
<xi:include href="../common/section_nova_cli_userdata.xml"/>
<?hard-pagebreak?>
<xi:include href="section_nova_cli_config-drive.xml"/>
<?hard-pagebreak?>
<xi:include
href="../common/section_neutron_cli_manage_networks.xml"/>
<?hard-pagebreak?>
Expand Down
2 changes: 1 addition & 1 deletion doc/user-guide/section_nova_cli_config-drive.xml
Expand Up @@ -10,7 +10,7 @@
special configuration drive that will be attached to the
instance when it boots. The instance can retrieve any
information that would normally be available through the
<link linkend="metadata-service">metadata
<link xlink:href="http://docs.openstack.org/admin-guide-cloud/content/section_metadata-service.html">metadata
service</link> by mounting this disk and reading files
from it.</para>
<para>One use case for the config drive is to pass networking
Expand Down

0 comments on commit d99e908

Please sign in to comment.