diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/filesystems/nfs/nfs.txt | 44 | ||||
| -rw-r--r-- | Documentation/kernel-parameters.txt | 5 |
2 files changed, 46 insertions, 3 deletions
diff --git a/Documentation/filesystems/nfs/nfs.txt b/Documentation/filesystems/nfs/nfs.txt index f50f26ce6cd0..f2571c8bef74 100644 --- a/Documentation/filesystems/nfs/nfs.txt +++ b/Documentation/filesystems/nfs/nfs.txt | |||
| @@ -12,9 +12,47 @@ and work is in progress on adding support for minor version 1 of the NFSv4 | |||
| 12 | protocol. | 12 | protocol. |
| 13 | 13 | ||
| 14 | The purpose of this document is to provide information on some of the | 14 | The purpose of this document is to provide information on some of the |
| 15 | upcall interfaces that are used in order to provide the NFS client with | 15 | special features of the NFS client that can be configured by system |
| 16 | some of the information that it requires in order to fully comply with | 16 | administrators. |
| 17 | the NFS spec. | 17 | |
| 18 | |||
| 19 | The nfs4_unique_id parameter | ||
| 20 | ============================ | ||
| 21 | |||
| 22 | NFSv4 requires clients to identify themselves to servers with a unique | ||
| 23 | string. File open and lock state shared between one client and one server | ||
| 24 | is associated with this identity. To support robust NFSv4 state recovery | ||
| 25 | and transparent state migration, this identity string must not change | ||
| 26 | across client reboots. | ||
| 27 | |||
| 28 | Without any other intervention, the Linux client uses a string that contains | ||
| 29 | the local system's node name. System administrators, however, often do not | ||
| 30 | take care to ensure that node names are fully qualified and do not change | ||
| 31 | over the lifetime of a client system. Node names can have other | ||
| 32 | administrative requirements that require particular behavior that does not | ||
| 33 | work well as part of an nfs_client_id4 string. | ||
| 34 | |||
| 35 | The nfs.nfs4_unique_id boot parameter specifies a unique string that can be | ||
| 36 | used instead of a system's node name when an NFS client identifies itself to | ||
| 37 | a server. Thus, if the system's node name is not unique, or it changes, its | ||
| 38 | nfs.nfs4_unique_id stays the same, preventing collision with other clients | ||
| 39 | or loss of state during NFS reboot recovery or transparent state migration. | ||
| 40 | |||
| 41 | The nfs.nfs4_unique_id string is typically a UUID, though it can contain | ||
| 42 | anything that is believed to be unique across all NFS clients. An | ||
| 43 | nfs4_unique_id string should be chosen when a client system is installed, | ||
| 44 | just as a system's root file system gets a fresh UUID in its label at | ||
| 45 | install time. | ||
| 46 | |||
| 47 | The string should remain fixed for the lifetime of the client. It can be | ||
| 48 | changed safely if care is taken that the client shuts down cleanly and all | ||
| 49 | outstanding NFSv4 state has expired, to prevent loss of NFSv4 state. | ||
| 50 | |||
| 51 | This string can be stored in an NFS client's grub.conf, or it can be provided | ||
| 52 | via a net boot facility such as PXE. It may also be specified as an nfs.ko | ||
| 53 | module parameter. Specifying a uniquifier string is not support for NFS | ||
| 54 | clients running in containers. | ||
| 55 | |||
| 18 | 56 | ||
| 19 | The DNS resolver | 57 | The DNS resolver |
| 20 | ================ | 58 | ================ |
diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt index f777fa96243d..e2ed3360b708 100644 --- a/Documentation/kernel-parameters.txt +++ b/Documentation/kernel-parameters.txt | |||
| @@ -1730,6 +1730,11 @@ bytes respectively. Such letter suffixes can also be entirely omitted. | |||
| 1730 | will be autodetected by the client, and it will fall | 1730 | will be autodetected by the client, and it will fall |
| 1731 | back to using the idmapper. | 1731 | back to using the idmapper. |
| 1732 | To turn off this behaviour, set the value to '0'. | 1732 | To turn off this behaviour, set the value to '0'. |
| 1733 | nfs.nfs4_unique_id= | ||
| 1734 | [NFS4] Specify an additional fixed unique ident- | ||
| 1735 | ification string that NFSv4 clients can insert into | ||
| 1736 | their nfs_client_id4 string. This is typically a | ||
| 1737 | UUID that is generated at system install time. | ||
| 1733 | 1738 | ||
| 1734 | nfs.send_implementation_id = | 1739 | nfs.send_implementation_id = |
| 1735 | [NFSv4.1] Send client implementation identification | 1740 | [NFSv4.1] Send client implementation identification |
