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.

Sign up for GitHub

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

Update Wave and Fusion docs #4149

Merged
merged 2 commits into from
Aug 3, 2023
Merged

Update Wave and Fusion docs #4149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bef2616
Update Wave and Fusion docs
bentsherman Aug 3, 2023
3c09f56
Fix version notes
bentsherman Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/fusion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,10 @@ The following configuration options are available:
: Enable/disable the use of Fusion file system.

`fusion.exportStorageCredentials`
: When `true` the access credentials required by the underlying object storage are exported the pipeline jobs execution environment
(requires version `23.05.0-edge` or later).
: :::{versionadded} 23.05.0-edge
This option was previously named `fusion.exportAwsAccessKeys`.
:::
: When `true` the access credentials required by the underlying object storage are exported the pipeline jobs execution environment.

`fusion.containerConfigUrl`
: The URL from where the container layer provisioning the Fusion client is downloaded.
Expand All @@ -197,9 +199,8 @@ The following configuration options are available:
`fusion.logOutput`
: Where the logging output is written.

`tagsEnabled`
`fusion.tagsEnabled`
: Enable/disable the tagging of files created in the underlying object storage via the Fusion client (default: `true`).

`tagsPattern`
`fusion.tagsPattern`
: The pattern that determines how tags are applied to files created via the Fusion client (default: `[.command.*|.exitcode|.fusion.*](nextflow.io/metadata=true),[*](nextflow.io/temporary=true)`)

14 changes: 9 additions & 5 deletions docs/wave.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,27 +171,31 @@ The following configuration options are available:

`wave.build.spack.basePackages`
: :::{versionadded} 22.06.0-edge
:::
:::
: One or more Spack packages to be always added in the resulting container.

`wave.build.spack.commands`
: :::{versionadded} 22.06.0-edge
:::
:::
: One or more commands to be added to the Dockerfile used to build a Spack based image.

`wave.httpClient.connectTime`
: :::{versionadded} 22.06.0-edge
:::
:::
: Sets the connection timeout duration for the HTTP client connecting to the Wave service (default: `30s`).

`wave.strategy`
: The strategy to be used when resolving ambiguous Wave container requirements (default: `'container,dockerfile,conda,spack'`).

`wave.report.enabled` (preview)
: Enable the reporting of the Wave containers used during the pipeline execution (default: `false`, requires version `23.06.0-edge` or later).
: :::{versionadded} 23.06.0-edge
:::
: Enable the reporting of the Wave containers used during the pipeline execution (default: `false`).

`wave.report.file` (preview)
: The name of the containers report file (default: `containers-<timestamp>.config` requires version `23.06.0-edge` or later).
: :::{versionadded} 23.06.0-edge
:::
: The name of the containers report file (default: `'containers-<timestamp>.config'`).

`wave.retryPolicy.delay`
: :::{versionadded} 22.06.0-edge
Expand Down