openstack-manuals/doc/common/tables/neutron-metadata.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_neutron_metadata">
    <caption>Description of metadata configuration options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <th colspan="2">[DEFAULT]</th>
      </tr>
      <tr>
        <td><option>meta_flavor_driver_mappings</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Mapping between flavor and LinuxInterfaceDriver. It is specific to MetaInterfaceDriver used with admin_user, admin_password, admin_tenant_name, admin_url, auth_strategy, auth_region and endpoint_type.</td>
      </tr>
      <tr>
        <td><option>metadata_access_mark</option> = <replaceable>0x1</replaceable></td>
        <td>(StrOpt) Iptables mangle mark used to mark metadata valid requests. This mark will be masked with 0xffff so that only the lower 16 bits will be used.</td>
      </tr>
      <tr>
        <td><option>metadata_backlog</option> = <replaceable>4096</replaceable></td>
        <td>(IntOpt) Number of backlog requests to configure the metadata server socket with</td>
      </tr>
      <tr>
        <td><option>metadata_port</option> = <replaceable>9697</replaceable></td>
        <td>(IntOpt) TCP Port used by Neutron metadata namespace proxy.</td>
      </tr>
      <tr>
        <td><option>metadata_proxy_group</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Group (gid or name) running metadata proxy after its initialization (if empty: agent effective group).</td>
      </tr>
      <tr>
        <td><option>metadata_proxy_shared_secret</option> = <replaceable></replaceable></td>
        <td>(StrOpt) Shared secret to sign instance-id request</td>
      </tr>
      <tr>
        <td><option>metadata_proxy_socket</option> = <replaceable>$state_path/metadata_proxy</replaceable></td>
        <td>(StrOpt) Location for Metadata Proxy UNIX domain socket.</td>
      </tr>
      <tr>
        <td><option>metadata_proxy_socket_mode</option> = <replaceable>deduce</replaceable></td>
        <td>(StrOpt) Metadata Proxy UNIX domain socket mode, 3 values allowed: 'deduce': deduce mode from metadata_proxy_user/group values, 'user': set metadata proxy socket mode to 0o644, to use when metadata_proxy_user is agent effective user or root, 'group': set metadata proxy socket mode to 0o664, to use when metadata_proxy_group is agent effective group or root, 'all': set metadata proxy socket mode to 0o666, to use otherwise.</td>
      </tr>
      <tr>
        <td><option>metadata_proxy_user</option> = <replaceable></replaceable></td>
        <td>(StrOpt) User (uid or name) running metadata proxy after its initialization (if empty: agent effective user).</td>
      </tr>
      <tr>
        <td><option>metadata_proxy_watch_log</option> = <replaceable>None</replaceable></td>
        <td>(BoolOpt) Enable/Disable log watch by metadata proxy. It should be disabled when metadata_proxy_user/group is not allowed to read/write its log file and copytruncate logrotate option must be used if logrotate is enabled on metadata proxy log files. Option default value is deduced from metadata_proxy_user: watch log is enabled if metadata_proxy_user is agent effective user id/name.</td>
      </tr>
      <tr>
        <td><option>metadata_workers</option> = <replaceable>2</replaceable></td>
        <td>(IntOpt) Number of separate worker processes for metadata server (defaults to half of the number of CPUs)</td>
      </tr>
      <tr>
        <td><option>nova_metadata_insecure</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Allow to perform insecure SSL (https) requests to nova metadata</td>
      </tr>
      <tr>
        <td><option>nova_metadata_ip</option> = <replaceable>127.0.0.1</replaceable></td>
        <td>(StrOpt) IP address used by Nova metadata server.</td>
      </tr>
      <tr>
        <td><option>nova_metadata_port</option> = <replaceable>8775</replaceable></td>
        <td>(IntOpt) TCP Port used by Nova metadata server.</td>
      </tr>
      <tr>
        <td><option>nova_metadata_protocol</option> = <replaceable>http</replaceable></td>
        <td>(StrOpt) Protocol to access nova metadata, http or https</td>
      </tr>
    </tbody>
  </table>
</para>