Add limitation regarding EFS file system #333
Conversation
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -26,6 +26,10 @@ Before you get started, you need the following: | |||
| Currently, Data Studios only supports AWS Batch compute environments that **do not** have Fargate enabled. | |||
| ::: | |||
|
|
|||
| ## Limitations | |||
|
|
|||
| If you configured your AWS Batch compute environment to include an EFS file system with **EFS file system > EFS mount path**, the mount path cannot be the same as your work directory. When the work directory and EFS mount path are identical, the Data Studio snapshots fail causing a data studio instance to fail. For more information on AWS Batch configuration, see [AWS Batch][aws-batch]. | |||
There was a problem hiding this comment.
Looks good to me!
The only thing I would also add that the mount path cannot be empty either (because then it defaults to the work directory, leading to failure)
Enter the EFS mount path (defaults to the pipeline work directory root path if omitted).
| @@ -26,6 +26,10 @@ Before you get started, you need the following: | |||
| Currently, Data Studios only supports AWS Batch compute environments that **do not** have Fargate enabled. | |||
| ::: | |||
|
|
|||
| ## Limitations | |||
|
|
|||
| If you configured your AWS Batch compute environment to include an EFS file system with **EFS file system > EFS mount path**, the mount path cannot be the same as your work directory. When the work directory and EFS mount path are identical, the Data Studio snapshots fail causing a data studio instance to fail. For more information on AWS Batch configuration, see [AWS Batch][aws-batch]. | |||
There was a problem hiding this comment.
| If you configured your AWS Batch compute environment to include an EFS file system with **EFS file system > EFS mount path**, the mount path cannot be the same as your work directory. When the work directory and EFS mount path are identical, the Data Studio snapshots fail causing a data studio instance to fail. For more information on AWS Batch configuration, see [AWS Batch][aws-batch]. | |
| If you configured your AWS Batch compute environment to include an EFS file system with **EFS file system > EFS mount path**, the mount path cannot be the same as your work directory as this will cause the Data Studio snapshots, and session, to fail. The mount path cannot be left empty, as this will default to the work directory and also result in snapshot and session failure. | |
| For more information on AWS Batch configuration, see [AWS Batch][aws-batch]. |
There was a problem hiding this comment.
@endre-seqera, does the suggested wording work?
There was a problem hiding this comment.
If you configured your AWS Batch compute environment to include an EFS file system with EFS file system > EFS mount path, the mount path cannot be the same as your work directory as this causes the Data Studio snapshots, and session, to fail. You must specify a mount path for the EFS file system or the mount path is set to your work directory.
maybe
There was a problem hiding this comment.
Last sentence is highly confusing (for me, at least)
There was a problem hiding this comment.
what about stating this in only one sentence:
If you configured your AWS Batch compute environment to include an EFS file system with EFS file system > EFS mount path, the mount path has to be explicitly specified and it cannot be the same as your CE work directory, as this causes the Data Studio snapshots, and session, to fail.
There was a problem hiding this comment.
@endre-seqera, I'm trying to avoid too much of a run-on sentence.
What does it mean for the session to fail exactly? It crashes? There aren't any checkpoints saved and user work vanishes after stopping a session?
There was a problem hiding this comment.
In this case failure means that the data studios session will fail to start, crashes. As part of the startup process the Compute Environment's work directory is used to set up snapshot creation. However, since EFS is not supported for this, the startup process fails. And there will be no snapshot.
We don't support a way to start and use DataStudios without the snapshoting functionality, it cannot be turned-off, so in case of EFS workdir, it will crash, fail to start up.
justinegeffen
added
1. Editor review
jason-seqera
force-pushed
the
PLAT-997-efs-volume-mounting
branch
from
59f2e28 to
0abea09
Compare
Targets: 24.2, 24.1