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

how to specify network access with example #381

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Fienne
Copy link
Contributor

@Fienne Fienne commented Feb 24, 2023

fixes #249

src/faq.md Outdated Show resolved Hide resolved
```
url: https://www.commonwl.org/v1.2/
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we also need to document what happens when networkAccess: false. I believe this flag is a suggestion, and it may or may not block the network access (it does not in cwltool, yet, common-workflow-language/cwltool#1733).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The flag doesn't block the network access; I ran the above code with networkAcess: false and it still downloaded the file.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct. It's planned work for cwltool. But would be useful to document the expected behavior in the spec and maybe in cwltool as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So can I say that when the networkAccess value is false, the code still runs, but we do not expect it to?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we must say what happens in both cases. We can probably use or adapt the text from the specification, where it explains it's an indicative flag, what implementations/users can expect, and the meaning of true or false for the flag: https://www.commonwl.org/v1.2/CommandLineTool.html#NetworkAccess

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, thanks!

src/faq.md Outdated Show resolved Hide resolved
src/faq.md Outdated
If `networkAccess` is `true`the tool must be able to make
outgoing connections to network resources.
If `networkAccess` is `false` or not specified, tools must not
assume network access, except for localhost(the loopback device).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

localhost(the loopback device).

Missing space, and maybe format it as localhost (the loopback device).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document NetworkAccess
2 participants