From bb8cdd7e08c9268cd37fc9c824871d72b1963919 Mon Sep 17 00:00:00 2001 From: Kory Draughn Date: Tue, 21 Apr 2026 16:36:32 -0400 Subject: [PATCH] [irods/irods#8928] Document univmss context string enhancements --- docs/plugins/composable_resources.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/plugins/composable_resources.md b/docs/plugins/composable_resources.md index ce18c45..34d7abb 100644 --- a/docs/plugins/composable_resources.md +++ b/docs/plugins/composable_resources.md @@ -379,16 +379,25 @@ The mock archive storage resource was created *only* for testing purposes to emu ### Universal Mass Storage Service -The univMSS storage resource delegates stage_to_cache and sync_to_arch operations to an external script which is located in the `msiExecCmd_bin` directory. It currently writes to the Vault path of that resource instance, treating it as a unix file system. +The univMSS storage resource delegates stage-to-cache and sync-to-archive operations to an external executable which is located in the `msiExecCmd_bin` directory. It currently writes to the Vault path of that resource instance, treating it as a unixfilesystem. -When creating a "univmss" resource, the context string provides the location of the Universal MSS script. +When creating a "univmss" resource, the context string must include a reference to an executable via the `script` property. For example: -Example: +~~~ +irods@hostname:~/ $ iadmin mkresc myArchiveResc univmss :/full/path/to/Vault 'script=univMSSInterface.sh;escape_single_quotes=1' +~~~ + +!!! Note + `escape_single_quotes` was introduced in iRODS 5.1.0. When set to 1, it instructs the resource to escape single quotes in paths. It defaults to 0 for backward compatibility. + +Setting the context string to the name of an executable is supported for backward compatibility. ~~~ -irods@hostname:~/ $ iadmin mkresc myArchiveResc univmss HOSTNAME:/full/path/to/Vault univMSSInterface.sh +irods@hostname:~/ $ iadmin mkresc myArchiveResc univmss :/full/path/to/Vault univMSSInterface.sh ~~~ +Using this form will result in `escape_single_quotes` being set to 0. + ## Managing Child Resources There are two new `iadmin` subcommands introduced with this feature.