Skip to content

Access points

Mount a folder of a file system as its own root, optionally as a fixed POSIX user, and create the folder with an owner and mode.

Updated View as Markdown

An access point is a folder of a file system that clients mount as if it were the root. It can also make every request through it act as one POSIX user, whatever user the client runs as. Use one per application, or per site, that shares a file system.

Clients mount an access point by its ID, through any mount target of its file system:

sudo mount -t nfs4 -o nfsvers=4.1,xprtsec=tls,hard,noresvport,rsize=1048576,wsize=1048576,timeo=600,retrans=2 \
  dfc6fl64neocrciu5ogrl4kccq.fs.us-west-1.ezghcompute.com:/fap_9d3f1h6j2lnr /mnt/uploads

Create an access point

CreateAccessPoint takes the file system, a name and two optional settings:

{
  "fileSystem": "fsy_4k2m9x0a7qpe",
  "name": "uploads",
  "rootDirectory": {
    "path": "/sites/blog/uploads",
    "creationInfo": { "ownerUid": 33, "ownerGid": 33, "permissions": "755" }
  },
  "posixUser": { "uid": 33, "gid": 33, "secondaryGids": [] }
}
Field Meaning
rootDirectory.path The folder clients see as the root, an absolute path. Default /, the whole file system
rootDirectory.creationInfo If the folder doesn’t exist, it’s created with this owner, group and mode (octal, such as "755"). Without it, a missing folder fails the create with root_directory_missing
posixUser Every request through the access point acts as this user and group. null: requests act as the client’s own user, with the file system’s rootSquash
posixUser.secondaryGids Secondary groups aren’t supported: leave it out or send []. Any group ID is refused with 400 invalid_request. Always [] in responses

The answer is 202 with an operation, which also creates the folder when creationInfo asks for it.

An access point can’t be changed after create, except its name, description and tags. Deleting one (DeleteAccessPoint) removes the access point, never its folder or files.

Who can mount

An access point narrows what a client sees, not who may mount. A client that may mount through a mount target can mount the whole file system, or any of its access points. Decide who mounts with the mount target’s allowed sources and your firewalls.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close