Description
Use this plugin with HCL DevOps Deploy (Launch) to upload artifacts to HCL Deploy versioned file storage repository.
- Overview
- Documentation
- Version history
Quick Info
Product
HCL DevOps Deploy (HCL Launch)
Type
plugin
Compatibility
HCL Launch version 7.3.2.8 and later
Created by
HCLSoftware
Website
Published Date
Last Updated
Summary
Usage
Steps
Summary
The steps in this plugin work with versioned components. For example, the Download Artifacts step retrieves the latest version of a component. Most component deployment processes use this step to download the component artifacts to the agent system.
For AIX systems, file permissions defined at the operating system level are not supported by the HCL Deploy Versioned File Storage plugin. The plugin uses the permissions set by a process or script. The chmod command can be used to reset a permission to the value defined at the operating system level.
This plugin includes one or more steps, click Steps for step details and properties.
Compatibility
This plugin runs on all operating systems that are supported by the HCL Deploy agent.
Installation
See Installing plugins in HCL Deploy (Launch) for installing and removing plugins.
Usage
Step palette
To access this plugin in the palette, click Repositories > Artifact > HCL Launch.
Steps
The following process steps are available in the Versioned File Storage plugin.
- Download Artifacts
- Download Artifacts for zOS
- Sync Artifacts
- Upload Artifacts
- Verify Local Artifacts
Download Artifacts
Download artifacts from a VFS server.
| Name | Type | Description | Required |
|---|---|---|---|
| Artifact Directory Offset | String | The base directory from which artifacts will be retrieved from the Component Version. For example, using App/Dist will only get all files from in the App/Dist directory and put them in the Current Working Directory. All includes/excludes will be evaluated relative to this offset. |
No |
| Charset | String | The Character set that files whose metadata includes a character set should be converted to upon download (e.g. UTF-8). If this field is left blank then the system’s default charset will be used. |
No |
| Directory Offset | String | The working directory to use when executing this command. This is relative to current working directory. |
Yes |
| Excludes | String | The patterns to exclude files to upload. | No |
| Full Verification | Boolean | (Valid only with Sync Mode enabled) When selected, hashes will be computed on each file in the destination artifact set to determine whether network transfer is necessary. Otherwise, files will be compared by date modified and size. |
No |
| Handle Incremental Versions | Boolean | (Valid only with Sync Mode enabled) When selected, incremental version handling is enabled. When not selected, the legacy behavior is enabled, which is to handle incremental versions as though they are full versions. Enabling incremental version handling has two effects. First, when deploying a full version, all versions back to the most recently deployed full version are considered when determining which files to update or remove; the legacy behavior will only consider the the single most recently deployed version. Second, deploying an incremental version will not remove files from all currently deployed versions and will restore missing files from those versions; the legacy behavior will remove files from the single most recent currently deployed version and ignore files from other currently deployed versions. For server versions before 7.1.1.0, there is a negative performance impact to enabling this feature due to API availablity. The impact is the greatest for versions 6.2.7.0 through 7.1.0. Until 7.1.1.0, is not recommended to enable this feature unless you use incremental versions. |
No |
| Includes | String | The patterns to match files to upload. The wildcard ** indicates every directory and the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire file tree underneath the dist directory. |
Yes |
| Set File Execute Bits | Boolean | When enabled, sets file execute bits on the files which have them set in the repository. | No |
| Sync Mode | Enumeration | Sync transfers only changed files, removing files that exist only in the previously deployed version. Clean removes all files not contained in the currently deployed version. Specify true, false, or Full. | No |
| Verify File Integrity | Boolean | When enabled, verifies downloaded files match their hash. Enabling this may reduce performance. |
No |
Download Artifacts for zOS
Download zOS component artifacts from a VFS server.
zOS
| Name | Type | Description | Required |
|---|---|---|---|
| Directory Offset | String | The working directory to use when executing this command. This is relative to current working directory. |
Yes |
Sync Artifacts
Compare local artifacts with the artifacts expected to be on the resource according
to its inventory, and remediate any differences.
| Name | Type | Description | Required |
|---|---|---|---|
| Charset | String | The Character set that files whose metadata includes a character set should be converted to upon download (e.g. UTF-8). If this field is left blank then the system’s default charset will be used. |
No |
| Excludes | String | The patterns to exclude files to upload. | No |
| Includes | String | The patterns to match files to upload. The wildcard ** indicates every directory and the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire file tree underneath the dist directory. |
Yes |
| Set File Execute Bits | Boolean | When enabled, sets file execute bits on the files which have them set in the repository. | No |
| Verify File Integrity | Boolean | When enabled, verifies downloaded files match their hash. Enabling this may reduce performance. |
No |
Upload Artifacts
Upload artifacts to a VFS server.
| Name | Type | Description | Required |
|---|---|---|---|
| Directory Offset | String | The working directory to use when executing this command. This is relative to current working directory. |
Yes |
| Excludes | String | The patterns to exclude files to upload. | No |
| Includes | String | The patterns to match files to upload. The wildcard ** indicates every directory and the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire file tree underneath the dist directory. |
Yes |
| Save File Execute Bits | Boolean | When enabled, file execute bits are saved with the files. | No |
| Text File Extensions | String | A comma separated list of extensions of files need to be converted to a new character set on download (e.g. txt,properties,log). This should be used in cases where the OS the files are being deployed to requires a different character set than the one uploading the files into the server. |
No |
Verify Local Artifacts
Compare artifacts on local machine with inventory.
| Name | Type | Description | Required |
|---|---|---|---|
| Directory Offset | String | The working directory to use when executing this command. This is relative to current working directory. |
Yes |
| Excludes | String | The patterns to exclude files to upload. | No |
| Includes | String | The patterns to match files to upload. The wildcard ** indicates every directory and the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire file tree underneath the dist directory. |
Yes |
- 48.1168889
- 47.1167424
- 46.1155706
- 45.1150655
- 44.1142508
- 43.1139365
- 42.1132833
- 41.1131565
- 40.1128760
- 39.1126469
- 38.1112991
- 37.1109558
- 37.1105716
- 37.1100822
Version
launch-vfs-48.1168889.zip
Uploaded: 24-Apr-2025 3:15
Release Notes
- Display server identity when downloading artifacts
launch-vfs-47.1167424.zip
Uploaded: 23-Apr-2024 20:15
Release Notes
- Display more information when downloading artifacts from a Relay
launch-vfs-46.1155706.zip
Uploaded: 21-Apr-2023 13:55
Release Notes
- Updating Jettison library to 1.5.4 for CVE-2023-1436
launch-vfs-45.1150655.zip
Uploaded: 01-Feb-2023 13:59
Release Notes
- Updating jettison library for CVE-2022-45693 and CVE-2022-45685
launch-vfs-44.1142508.zip
Uploaded: 10-Oct-2022 15:58
Release Note
Updating jettison library for CVE-2022-40150 CVE-2022-40149
launch-vfs-43.1139365.zip
Uploaded: 08-Aug-2022 20:37
Release Note
APAR PH48521 - Fixed a defect where a local IO error is reported incorrectly as an HTTP network error, such as: "MalformedChunkCodingException: CRLF expected at end of chunk" or "TruncatedChunkException: Truncated chunk".
launch-vfs-42.1132833.zip
Uploaded: 13-May-2022 14:46
Release Note
Update output logging configuration.
launch-vfs-41.1131565.zip
Uploaded: 08-Apr-2022 15:33
Release Note
Update log4j 2.17 and uDeployRestClient libraries.
launch-vfs-40.1128760.zip
Uploaded: 07-Feb-2022 16:52
Release Note
Remove log4j functionality related to: CVE-2019-17571, CVE-2020-9488. CVE-2021-4104, CVE-2022-23302, CVE-2022-23305, CVE-2022-23307.
launch-vfs-39.1126469.zip
Uploaded: 08-Dec-2021 12:18
Release Note
2597 - Fixed a defect where in rare cases artifact downloads fail with the message "Premature end of chunk coded message body: closing chunk expected". To fully fix the issue, agent relays must also be patched or upgraded.
launch-vfs-38.1112991.zip
Uploaded: 19-Jul-2021 10:23
Release Note
Added new step to compare two zOS version artifacts with new package format.
launch-vfs-37.1109558.zip
Uploaded: 15-Jun-2021 11:16
Release Note
Fix a quoting issue in the Unix Java wrapper script that prevented correct execution when the agent is installed in path containing a space.
launch-vfs-37.1105716.zip
Uploaded: 27-Apr-2021 13:34
launch-vfs-37.1100822.zip
Uploaded: 16-Mar-2021 07:33