Blame README.amd-maps

Packit Service a4b2a9
Packit Service a4b2a9
amd map parser
Packit Service a4b2a9
==============
Packit Service a4b2a9
Packit Service a4b2a9
The ability to parse amd format maps has been added to autofs.
Packit Service a4b2a9
Packit Service a4b2a9
How to use amd maps in autofs
Packit Service a4b2a9
-----------------------------
Packit Service a4b2a9
Packit Service a4b2a9
To add amd map parsing to autofs a new "format" module has been added.
Packit Service a4b2a9
Packit Service a4b2a9
There are two ways to use this new map format module. First, the existing
Packit Service a4b2a9
master map syntax can be used as described below, and second, sections that
Packit Service a4b2a9
use the top level mount path may be added to the autofs configuration below
Packit Service a4b2a9
the "amd" section in much the same way as is done with amd.
Packit Service a4b2a9
Packit Service a4b2a9
The master map entry syntax is:
Packit Service a4b2a9
Packit Service a4b2a9
mount-point [map-type[,format]:]map [options]
Packit Service a4b2a9
Packit Service a4b2a9
For amd format maps this becomes:
Packit Service a4b2a9
Packit Service a4b2a9
/amd/mp   file,amd:amd.mp
Packit Service a4b2a9
Packit Service a4b2a9
which will use file as the map source and the amd format parser for
Packit Service a4b2a9
the map.
Packit Service a4b2a9
Packit Service a4b2a9
In order to use nsswitch to specify the map source an amd per-mount
Packit Service a4b2a9
section needs to be added to the autofs configuration so autofs
Packit Service a4b2a9
knows the master map entry is an amd format mount.
Packit Service a4b2a9
Packit Service a4b2a9
If an amd-per-mount section is added to the autofs configuration a
Packit Service a4b2a9
corresponding master map entry is optional. If both are present the
Packit Service a4b2a9
map name given in the master map entry will override a "map_name"
Packit Service a4b2a9
option in the amd per-mount section.
Packit Service a4b2a9
Packit Service a4b2a9
If an amd per-mount section is used alone then not giving the "map_type"
Packit Service a4b2a9
option will alow the use of nsswicth for map selection.
Packit Service a4b2a9
Packit Service a4b2a9
See below for an example of an amd per-mount configuration entry.
Packit Service a4b2a9
Packit Service a4b2a9
Packit Service a4b2a9
Configuration sub-system changes
Packit Service a4b2a9
--------------------------------
Packit Service a4b2a9
Packit Service a4b2a9
The configuration sub-system has changed to accommodate the amd parser.
Packit Service a4b2a9
See autofs.conf(5) for more information on format changes.
Packit Service a4b2a9
Packit Service a4b2a9
The configuration is now split into system initialization only
Packit Service a4b2a9
configuration and the daemon configuration. Previously everything was
Packit Service a4b2a9
located in the system initialization configuration file, but now the
Packit Service a4b2a9
configuration is located in autofs.conf in the directory the distribution
Packit Service a4b2a9
uses for the autofs configuration.
Packit Service a4b2a9
Packit Service a4b2a9
There is information about what amd configuration entries can be used
Packit Service a4b2a9
in comments of the installed configuration so that's worth a look.
Packit Service a4b2a9
Packit Service a4b2a9
All that's needed to add an existing amd configuration to autofs is to
Packit Service a4b2a9
add it below the autofs configuration. Apart from changing the amd
Packit Service a4b2a9
"[ global ]" section name to "[ amd ]" nothing else should need to be
Packit Service a4b2a9
changed. However, quite a few amd configuration options don't have
Packit Service a4b2a9
meaning within autofs. When these options are seen they are logged.
Packit Service a4b2a9
Packit Service a4b2a9
Be aware that, if the an old configuration exists and the configuration
Packit Service a4b2a9
hasn't been updated after the installation, changes to the the old
Packit Service a4b2a9
configuration will override changes to the new configuration because
Packit Service a4b2a9
backward compatibility takes priority over the new implementation.
Packit Service a4b2a9
Packit Service a4b2a9
The amd per-mount sections have two functions, to allow per-mount
Packit Service a4b2a9
configuration, as it does in amd, and to allow master map entries to
Packit Service a4b2a9
avoid the need to specify the "type,format" part of the master map
Packit Service a4b2a9
entry. This allows them to use the nsswitch map source functionality
Packit Service a4b2a9
in the same way autofs master map entries do.
Packit Service a4b2a9
Packit Service a4b2a9
If amd per-mount sections are present in the autofs configuration
Packit Service a4b2a9
their corresponding master map entries are optional. This allows
Packit Service a4b2a9
amd maps to be used without adding incompatible entries to the autofs
Packit Service a4b2a9
master map in shared infrastructure environments.
Packit Service a4b2a9
Packit Service a4b2a9
If a section for an amd mount is added below the global amd section
Packit Service a4b2a9
using the mount point path (as is done in amd.conf) then autofs will
Packit Service a4b2a9
know the map format is amd (it doesn't matter if there are no other
Packit Service a4b2a9
configuration options in the mount point section).
Packit Service a4b2a9
Packit Service a4b2a9
If there is a corresponding master map entry the map given in the
Packit Service a4b2a9
master map entry will be used over the map_name option if it is
Packit Service a4b2a9
present in an amd per-mount section.
Packit Service a4b2a9
Packit Service a4b2a9
If a mount point is present in the master map and the source of the
Packit Service a4b2a9
map is nis then it is sufficient to use (for example):
Packit Service a4b2a9
Packit Service a4b2a9
/amd/mp           amd.mp
Packit Service a4b2a9
Packit Service a4b2a9
in the master map and
Packit Service a4b2a9
Packit Service a4b2a9
automount: nis
Packit Service a4b2a9
Packit Service a4b2a9
in /etc/nsswitch.conf or
Packit Service a4b2a9
Packit Service a4b2a9
[ amd ]
Packit Service a4b2a9
map_type = nis
Packit Service a4b2a9
Packit Service a4b2a9
in the configuration along with
Packit Service a4b2a9
Packit Service a4b2a9
[ /amd/mp ]
Packit Service a4b2a9
Packit Service a4b2a9
or
Packit Service a4b2a9
Packit Service a4b2a9
[ /amd/mp ]
Packit Service a4b2a9
map_type = nis
Packit Service a4b2a9
Packit Service a4b2a9
An example of an amd per-mount configuration entry is:
Packit Service a4b2a9
Packit Service a4b2a9
[ amd ]
Packit Service a4b2a9
...
Packit Service a4b2a9
Packit Service a4b2a9
[ /test ]
Packit Service a4b2a9
map_name = /etc/amd.test
Packit Service a4b2a9
#map_type = file
Packit Service a4b2a9
#search_path =			/etc
Packit Service a4b2a9
#browsable_dirs =		yes | no
Packit Service a4b2a9
browsable_dirs =		yes
Packit Service a4b2a9
Packit Service a4b2a9
Packit Service a4b2a9
amd map options that can be used
Packit Service a4b2a9
--------------------------------
Packit Service a4b2a9
Packit Service a4b2a9
In an attempt to describe the usable amd map options, many of the amd
Packit Service a4b2a9
map options have been added to autofs(5).
Packit Service a4b2a9
Packit Service a4b2a9
Not all the amd functionality has been implemented. The autofs(5) man
Packit Service a4b2a9
page usually mentions if something hasn't been implemented so that's
Packit Service a4b2a9
worth checking.
Packit Service a4b2a9
Packit Service a4b2a9
What hasn't been implemented
Packit Service a4b2a9
----------------------------
Packit Service a4b2a9
Packit Service a4b2a9
The configuration options fully_qualified_hosts, unmount_on_exit and
Packit Service a4b2a9
browsable_dirs = full (and a couple of others) aren't implemented.
Packit Service a4b2a9
Packit Service a4b2a9
Map types (sources) ndbm, passwd are not implemented.
Packit Service a4b2a9
The map source "sss" can't be used for amd format maps.
Packit Service a4b2a9
Packit Service a4b2a9
Map caching options aren't used, the existing autofs map caching is
Packit Service a4b2a9
always used for available map sources.
Packit Service a4b2a9
Packit Service a4b2a9
The regex map key matching feature is not implemented.
Packit Service a4b2a9
Packit Service a4b2a9
Mount types lustre, nfsx, jfs and direct haven't been implemented
Packit Service a4b2a9
and other mount types that aren't implemented in amd are also not
Packit Service a4b2a9
available.
Packit Service a4b2a9
Packit Service a4b2a9
How to find out more
Packit Service a4b2a9
--------------------
Packit Service a4b2a9
Packit Service a4b2a9
Have a look at the man pages autofs.conf(5), autofs(5) and to a
Packit Service a4b2a9
lesser extent auto.master(5). These may help.
Packit Service a4b2a9
Packit Service a4b2a9
But the best way to get more information is to ask on the
Packit Service a4b2a9
autofs mailing list as described in the README file.
Packit Service a4b2a9
Packit Service a4b2a9
Ian