From bef2616789f3c7e65b39326809d5ffded544e424 Mon Sep 17 00:00:00 2001 From: Ben Sherman Date: Thu, 3 Aug 2023 09:40:37 -0500 Subject: [PATCH 1/2] Update Wave and Fusion docs Signed-off-by: Ben Sherman --- docs/fusion.md | 11 ++++++----- docs/wave.md | 8 ++++++-- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/fusion.md b/docs/fusion.md index 1aeaeda99d..8b0c1fbca4 100644 --- a/docs/fusion.md +++ b/docs/fusion.md @@ -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. @@ -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)`) - diff --git a/docs/wave.md b/docs/wave.md index a33bb9aa30..f2e87837f0 100644 --- a/docs/wave.md +++ b/docs/wave.md @@ -188,10 +188,14 @@ The following configuration options are available: : 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-.config` requires version `23.06.0-edge` or later). +: :::{versionadded} 23.06.0-edge + ::: +: The name of the containers report file (default: `'containers-.config'`). `wave.retryPolicy.delay` : :::{versionadded} 22.06.0-edge From 3c09f568e12090c952b4b42c3966f4373be52bd2 Mon Sep 17 00:00:00 2001 From: Ben Sherman Date: Thu, 3 Aug 2023 10:00:06 -0500 Subject: [PATCH 2/2] Fix version notes Signed-off-by: Ben Sherman --- docs/wave.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/wave.md b/docs/wave.md index f2e87837f0..8eec01b3d5 100644 --- a/docs/wave.md +++ b/docs/wave.md @@ -171,17 +171,17 @@ 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`