Skip to content

For a production environment, put the standard home, project, and container directories on external NFS, such as Google Cloud Filestore, Amazon EFS, or another NFS server you already run. NFS hosted on the login virtual machine is for test and small environments.

projectEureka mounts three standard trees at the same paths on the login node, the control node, and the session and job machines:

Directory Path What it holds
Home /vault/home User and project-user home folders, including a project user’s home at /vault/home/.project-<name>
Projects /vault/projects Project directories (prj-storage)
Containers /vault/containers Shared container images (SIF files)

By default, the login virtual machine exports those same paths over NFS (/vault/home, /vault/projects, and /vault/containers). The data then lives on the login VM’s disk.

  • The login disk is sized for a test or small environment. Homes, project files, and container images grow past that quickly.
  • If the login VM is replaced, resized, or lost, data on its disk goes with it unless you restored that disk. External NFS is independent of the login VM.
  • Filestore, EFS, and other NFS services have their own capacity, snapshots, and backups. You administer those on the storage service, not on the login VM.
  • The control node and the session and job machines already mount these trees as NFS clients. Pointing the mounts at an external server does not change the paths that users and flows see.

Login-hosted NFS remains the right default when you are trying the product or running a small environment.

projectEureka mounts an NFS server that already exists. It does not create a Filestore instance, an EFS file system, or another NFS server for you. Create the server and its exports first, and allow access from the environment’s nodes: the login node, the control node, and the session and job machines.

When projectEureka administers POSIX ACLs on these trees (the default for home, projects, and containers), it uses NFS version 3. NFSv4 has a different ACL model, and POSIX setfacl does not work on current images. Mount-only extra shares default to NFS 4.1. The External filesystems page lets you choose the version when you add or switch a mount.

You can do this when you launch the environment, or later on a running environment.

Put the server and exports in the launch configuration (~/.eureka/eureka.yaml, or the file you pass with --eureka-config or EUREKA_CONFIG). Validate it before you launch:

Terminal window
eureka config validate --path FILE

This example puts all three standard trees on one existing NFS server. Replace the server name, hostname, and export paths with yours. Use YAML booleans (false, not "false") and quote the NFS version, for example nfs_version: "3".

storage:
nfs_servers:
site_a:
management: external
endpoint: nfs.site-a.example.invalid
defaults:
nfs_version: "3"
backends:
home:
type: nfs
server: site_a
export: /exports/eureka/home
projects:
type: nfs
server: site_a
export: /exports/eureka/projects
containers:
type: nfs
server: site_a
export: /exports/eureka/containers

The server and exports must already exist and be reachable from the control, login, and compute virtual machines. With all three trees on external NFS, the login node does not serve Eureka NFS exports.

You can put each tree on a different server or leave one of them on login NFS (nfs) or on a dedicated OrangeFS virtual machine (orangefs). Changing this launch configuration later does not migrate a running environment; use a new environment to validate a new launch layout, or Switch an existing one as described below.

On External filesystems, under Mounts, Switch moves a standard tree (homes or projects) to another mount. The login node’s copy of that directory is hidden. The operation runs in the background and keeps running if you close the dialog or the page. Switch only when no flow or machine is using that directory, and close any shell that has it open. Switch is unavailable while sessions or jobs are using the directory.

See External filesystems and clusters for the form, NFS version, and how to add a mount first.

Option Use it when Notes
External NFS (Filestore, EFS, or another NFS) Production, or any environment whose data should outlive the login VM You create and back up the server. projectEureka mounts it.
NFS on the login VM Test and small environments Default. Data lives at /vault/home, /vault/projects, and /vault/containers on the login disk.
Other mounts You need an extra share, without moving the standard trees Add it under Other mounts. It is mounted only for the projects you allow.
OrangeFS You want a dedicated OrangeFS virtual machine for one or more of the standard trees Optional. Set orangefs on a backend at launch, or use the filesystems page where that is offered.

Google Cloud

On Google Cloud, a typical production choice is Filestore (or another NFS you already run in the project or a peered network). Create the instance and exports in Google Cloud, allow the environment’s nodes, then point the backends or a Switch at that endpoint.

When /vault is still on the default login-VM NFS, include those directories in the environment backup. When /vault is on external storage, that storage’s own backups cover it. See Backing up an environment.

External filesystems and clusters · Storage settings · Use buckets · Storage Manager