Attachment 1471280 Details for Bug 1609511 – revised ganesha-config.rst

revised ganesha-config.rst

ganesha-config.rst (text/plain), 5.86 KB, created by James on 2018-07-28 19:49:56 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: James

Created: 2018-07-28 19:49:56 UTC

Size: 5.86 KB

patch

obsolete

>===================================================================
>ganesha-config -- NFS Ganesha Configuration File
>===================================================================
>
>.. program:: ganesha-config
>
>
>SYNOPSIS
>==========================================================
>
>| /etc/ganesha/ganesha.conf
>
>DESCRIPTION
>==========================================================
>
>NFS-Ganesha obtains configuration data from the configuration file
>/etc/ganesha/ganesha.conf. The configuration file consists of following parts.
>
>Comments
>--------------------------------------------------------------------------------
>Empty lines and lines starting with '#' are comments. ::
>
>    # This whole line is a comment
>    Protocol = TCP; # The rest of this line is a comment
>
>Blocks
>--------------------------------------------------------------------------------
>Related options are grouped together into blocks. A block is a name followed
>by a '{ }' pair that encloses parameter values and other sub-blocks. For
>example::
>
>    EXPORT
>    {
>        Export_ID = 1;
>        FSAL {
>            Name = VFS;
>        }
>    }
>
>.. note::
>  Here, **FSAL** is a sub-block.
>
>Refer to the ``BLOCKS`` section for a list of blocks and options.
>
>Options
>--------------------------------------------------------------------------------
>Configuration options can be of the following types.
>
>1. **Numeric.** Numeric options can be given in octal, decimal or
>   hexadecimal following the ANSI C syntax. For example::
>
>    mode = 0755;  # This is octal 0755 = decimal 493
>
>   Numeric values may be negative. The '~' operator performs a logical-NOT. ::
>
>    anonomousuid = -2;  # this is negative
>    mask = ~0xff;       # equals 0xffffff00 (for 32 bit integers)
>
>2. **Boolean.** Possible values are 'true' (or 'yes'), and 'false' (or 'no').
>   1 and 0 are not acceptable.
>
>3. **List.** This is a list of possible values for the option. ::
>
>    Protocols = 3, 4, 9p;
>
>
>Including other configuration files
>--------------------------------------------------------------------------------
>Additional files can be imported to a configuration using the '%include' and
>'%url' directives. ::
>
>    %include <filename>
>    %url <url, e.g. rados://mypool/myobject>
>
>The included file is inserted into the configuration text in place of the
>'%include' or '%url' line. Sub-inclusions can be to any depth. Filenames and
>URLs may or may not be delimited by '"'::
>
>    %include base.conf
>    %include "base.conf"
>    %url rados://mypool/myobject
>    %url "rados://mypool/myobject"
>
>
>BLOCKS
>==========================================================
>NFS-Ganesha supports the following configuration blocks.
>
>EXPORT {}
>--------------------------------------------------------------------------------
>Along with its configuration options, the **EXPORT** block supports **FSAL**
>and **CLIENT** sub-blocks. See
>:doc:`ganesha-export-config <ganesha-export-config>`\(8) for usage of this
>block and its sub-blocks.
>
>EXPORT_DEFAULTS {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-export-config <ganesha-export-config>`\(8).
>
>CACHEINODE {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-cache-config <ganesha-cache-config>`\(8).
>
>NFS_CORE_PARAM {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-core-config <ganesha-core-config>`\(8).
>
>NFS_IP_NAME {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-core-config <ganesha-core-config>`\(8).
>
>NFS_KRB5 {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-core-config <ganesha-core-config>`\(8).
>
>NFSv4 {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-core-config <ganesha-core-config>`\(8).
>
>CEPH {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-ceph-config <ganesha-ceph-config>`\(8).
>
>9P {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-9p-config <ganesha-9p-config>`\(8).
>
>GPFS {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-gpfs-config <ganesha-gpfs-config>`\(8).
>
>LOG {}
>--------------------------------------------------------------------------------
>The **LOG** block supports **FACILITY** and **FORMAT** sub-blocks.
>See :doc:`ganesha-log-config <ganesha-log-config>`\(8).
>
>PROXY {}
>--------------------------------------------------------------------------------
>The **PROXY** block supports a **Remote_Server** sub-block.
>See :doc:`ganesha-proxy-config <ganesha-proxy-config>`\(8).
>
>RGW {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-rgw-config <ganesha-rgw-config>`\(8).
>
>VFS {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-vfs-config <ganesha-vfs-config>`\(8).
>
>XFS {}
>--------------------------------------------------------------------------------
>See :doc:`ganesha-xfs-config <ganesha-xfs-config>`\(8).
>
>
>EXAMPLE
>==========================================================
>Along with ganesha.conf, a sample configuration file for each installed FSAL
>can be found in /etc/ganesha.
>
>
>See also
>==============================
>:doc:`ganesha-log-config <ganesha-log-config>`\(8)
>:doc:`ganesha-rgw-config <ganesha-rgw-config>`\(8)
>:doc:`ganesha-vfs-config <ganesha-vfs-config>`\(8)
>:doc:`ganesha-xfs-config <ganesha-xfs-config>`\(8)
>:doc:`ganesha-gpfs-config <ganesha-gpfs-config>`\(8)
>:doc:`ganesha-gluster-config <ganesha-gluster-config>`\(8)
>:doc:`ganesha-9p-config <ganesha-9p-config>`\(8)
>:doc:`ganesha-proxy-config <ganesha-proxy-config>`\(8)
>:doc:`ganesha-ceph-config <ganesha-ceph-config>`\(8)
>:doc:`ganesha-core-config <ganesha-core-config>`\(8)
>:doc:`ganesha-export-config <ganesha-export-config>`\(8)

Actions: View

Attachments on bug 1609511: 1471280