From d63afbf6c59c1565e1c6943747834555852f3bbc Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Wed, 28 Nov 2018 16:13:21 -0500 Subject: [PATCH] Mention size limit on user data in docs The API reference for the "user_data" parameter to server create and rebuild mentions the size restriction but the user docs did not, so this adds that note. While doing this, several other user-facing docs that mention user data link back to the overall user-data doc so that we can centralize any further documentation about that topic in a single location. Change-Id: Id4a61d58150337e0dec223d4d2741336ed6d5387 Closes-Bug: #1804653 --- doc/source/user/config-drive.rst | 2 +- doc/source/user/launch-instance-from-image.rst | 4 ++-- doc/source/user/launch-instances.rst | 8 ++++---- doc/source/user/metadata-service.rst | 7 ++++--- doc/source/user/user-data.rst | 3 +++ doc/source/user/vendordata.rst | 7 ++++--- 6 files changed, 18 insertions(+), 13 deletions(-) diff --git a/doc/source/user/config-drive.rst b/doc/source/user/config-drive.rst index feba61d2da84..3f4965267482 100644 --- a/doc/source/user/config-drive.rst +++ b/doc/source/user/config-drive.rst @@ -5,7 +5,7 @@ You can configure OpenStack to write metadata to a special configuration drive that attaches to the instance when it boots. The instance can mount this drive and read files from it to get information that is normally available through the :doc:`metadata service `. -This metadata is different from the user data. +This metadata is different from the :doc:`user data `. One use case for using the configuration drive is to pass a networking configuration when you do not use DHCP to assign IP addresses to diff --git a/doc/source/user/launch-instance-from-image.rst b/doc/source/user/launch-instance-from-image.rst index a31fc18c0d52..eeb416eecf66 100644 --- a/doc/source/user/launch-instance-from-image.rst +++ b/doc/source/user/launch-instance-from-image.rst @@ -18,8 +18,8 @@ Follow the steps below to launch an instance from an image. For example, you can add a description for your server by providing the ``--property description="My Server"`` parameter. - You can pass user data in a local file at instance launch by using the - ``--user-data USER-DATA-FILE`` parameter. + You can pass :doc:`user data ` in a local file at instance + launch by using the ``--user-data USER-DATA-FILE`` parameter. .. important:: diff --git a/doc/source/user/launch-instances.rst b/doc/source/user/launch-instances.rst index 57cbb8822c58..9f028b7b982c 100644 --- a/doc/source/user/launch-instances.rst +++ b/doc/source/user/launch-instances.rst @@ -16,10 +16,10 @@ Before you can launch an instance, gather the following parameters: available hardware configuration for a server. It defines the size of a virtual server that can be launched. -- Any **user data** files. A user data file is a special key in the - metadata service that holds a file that cloud-aware applications in - the guest instance can access. For example, one application that uses - user data is the +- Any **user data** files. A :doc:`user data ` file is a + special key in the metadata service that holds a file that cloud-aware + applications in the guest instance can access. For example, one application + that uses user data is the `cloud-init `__ system, which is an open-source package from Ubuntu that is available on various Linux distributions and that handles early initialization of diff --git a/doc/source/user/metadata-service.rst b/doc/source/user/metadata-service.rst index a812ca8e2bde..ec0281022a72 100644 --- a/doc/source/user/metadata-service.rst +++ b/doc/source/user/metadata-service.rst @@ -118,9 +118,10 @@ metadata, make a GET request to "name": "test" } -Instances also retrieve user data (passed as the ``user_data`` parameter in the -API call or by the ``--user-data`` flag in the :command:`openstack server -create` command) through the metadata service, by making a GET request to +Instances also retrieve :doc:`user data ` (passed as the +``user_data`` parameter in the API call or by the ``--user-data`` flag in the +:command:`openstack server create` command) through the metadata service, by +making a GET request to ``http://169.254.169.254/openstack/2018-08-27/user_data``: .. code-block:: console diff --git a/doc/source/user/user-data.rst b/doc/source/user/user-data.rst index 7e71482c531a..d8567de3babf 100644 --- a/doc/source/user/user-data.rst +++ b/doc/source/user/user-data.rst @@ -20,3 +20,6 @@ You can place user data in a local file and pass it through the $ openstack server create --image ubuntu-cloudimage --flavor 1 \ --user-data mydata.file VM_INSTANCE + +.. note:: The provided user data must be base64 encoded and is restricted to + 65535 bytes. diff --git a/doc/source/user/vendordata.rst b/doc/source/user/vendordata.rst index 1fc264d66c76..f42179c675b4 100644 --- a/doc/source/user/vendordata.rst +++ b/doc/source/user/vendordata.rst @@ -15,9 +15,10 @@ The user who booted the instance can pass metadata to the instance in several ways. For authentication keypairs, the keypairs functionality of the Nova APIs can be used to upload a key and then specify that key during the Nova boot API request. For less structured data, a small opaque blob of data may be passed -via the user-data feature of the Nova API. Examples of such unstructured data -would be the puppet role that the instance should use, or the HTTP address of a -server to fetch post-boot configuration information from. +via the :doc:`user data ` feature of the Nova API. Examples of +such unstructured data would be the puppet role that the instance should use, +or the HTTP address of a server to fetch post-boot configuration information +from. Nova provided data ------------------