From 0ebacee7a8359be9e79da32b54d705ff82ac9e54 Mon Sep 17 00:00:00 2001
From: Matt Riedemann <mriedem.os@gmail.com>
Date: Tue, 24 Oct 2017 12:19:24 -0400
Subject: [PATCH] Import user-data page from openstack-manuals

This imports the "provide-user-data-to-instances" page
from the old openstack-manuals user guide.

Since we don't have a glossary, the :term: link is removed
and replaced with just giving the glossary definition as
the first part of the doc.

Change-Id: Iae70d9b53d6cefb3bcb107fe68499cccb71fc15e
Partial-Bug: #1714017
(cherry picked from commit 3fc85389e5e500e25cebf4d89094e7d06bf63605)
---
 doc/source/index.rst          |  1 +
 doc/source/user/user-data.rst | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+)
 create mode 100644 doc/source/user/user-data.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 0cd69cc1bf99..d9c8dc1d4b95 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -268,6 +268,7 @@ looking parts of our architecture. These are collected below.
    user/quotas
    user/support-matrix
    user/upgrade
+   user/user-data
    user/vendordata
    user/wsgi
 
diff --git a/doc/source/user/user-data.rst b/doc/source/user/user-data.rst
new file mode 100644
index 000000000000..7e71482c531a
--- /dev/null
+++ b/doc/source/user/user-data.rst
@@ -0,0 +1,22 @@
+==============================
+Provide user data to instances
+==============================
+
+*User data* is a blob of data that the user can specify when they launch an
+instance. The instance can access this data through the metadata service or
+config drive. Commonly used to pass a shell script that the instance runs on
+boot.
+
+For example, one application that uses user data is the
+`cloud-init <https://help.ubuntu.com/community/CloudInit>`__ system,
+which is an open-source package from Ubuntu that is available on various
+Linux distributions and which handles early initialization of a cloud
+instance.
+
+You can place user data in a local file and pass it through the
+``--user-data <user-data-file>`` parameter at instance creation.
+
+.. code-block:: console
+
+   $ openstack server create --image ubuntu-cloudimage --flavor 1 \
+     --user-data mydata.file VM_INSTANCE