Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it obvious from the docs that emptyDir workspaces are not passed from task to task #2081

Closed
pierretasci opened this issue Feb 21, 2020 · 3 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@pierretasci
Copy link

The current docs for workspaces mention that emptyDir is an option for a volume that can back a workspace. It is implicit in this that the emptyDir won't be the same emptyDir from one task to another and thus user's should not expect anything placed in there to persist.

I believe this should be made explicit so that people don't get confused.

@bobcatfish
Copy link
Collaborator

@pierretasci do you think it would be enough to link to the docs on emptyDir or do you feel like we should do more?

It's an odd one b/c if you have seen emptyDir in kubernetes, you'd know that it's a pod specific thing, but you wouldn't if you aren't as familiar with kubernetes 🤔

One thing I definitely think tho is that when we link workspaces (#1936) if a user tries to provide emptyDir for workspaces that are linked between Tasks, we should catch that and fail execution.

@bobcatfish bobcatfish added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 21, 2020
@pierretasci
Copy link
Author

Actually I'm going to withdraw this issue around the documentation because I actually think the docs are clear enough here even if you don't know emptyDir volumes in Kubernetes:

An emptyDir volume type is not shared amongst Tasks. Instead each Task will simply receive a new emptyDir of its own from its underlying Pod.

It is perhaps a bit unfortunate that the PipelineRun and TaskRun docs for workspaces don't match here. Perhaps the real issue is to make Workspaces their own doc.

I think you make a really good point about validation. I wonder if anyone has a use case for attaching an emptyDir with the same workspace name to different tasks not to share the volume but just to have a consistently named scratch space. I'm not sure how likely that is though.

@ghost
Copy link

ghost commented Mar 22, 2020

We've added a workspaces.md and included a bit more explicit language that emptyDir is unsuitable for sharing content between Tasks.

@ghost ghost closed this as completed Mar 22, 2020
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants