The deployment process is the process by which Repose organizes the content of Artifacts in preparation for utilization.
To be more specific, the deployment process is comprised of the following steps:
Identify all artifacts in the
Compute the hash of each artifact.
Create a directory for each artifact as a subdirectory of the
Each artifact will be associated with its own directory.
The name of each directory will be the hash of the associated artifact.
Extract the contents of the each artifact to its associated directory.
Since each artifact is extracted to a directory named the hash of said artifact, deployment directory names are consistent and predictable.
As a result, there will be only one copy of the extracted contents of each artifact, and therefore, disk space usage should also be predictable.
If an artifact file exists on disk prior to the deployment process, the checksum of the artifact file will be compared to the checksum of the artifact to be deployed.
If the checksums match, deployment of the artifact in question will be skipped.
If the checksums do not match, the artifact will be deployed, overwriting the existing artifact file.
To prevent contention during the deployment process, a platform-dependent lock will be acquired on the artifact file.
The lock should prevent other processes from accessing the artifact file while it is being processed.
Ultimately, the checksum and locking strategy should ensure valid deployments while preventing unnecessary writes to disk and file contention when multiple Repose processes are running concurrently.
auto-clean feature may be used to delete deployment directories when Repose shuts down.
This feature helps manage disk space usage, and remove the contents of artifacts which are no longer in use.
Only deployment directories created by the instance of Repose which is shutting down will be deleted.
If all of the follow conditions are met, Repose may delete deployment directories that are in use by other Repose processes:
More than one Repose process is running.
More than one Repose process is using the same deployment directory.
At least one Repose process has enabled the
One of the Repose processes with the
auto-clean feature enabled stops gracefully.
To avoid this situation, it is highly recommended that the
deployment-directory is not shared between more than one Repose instance if the
auto-clean feature is used.
auto-clean feature is not being used, it should be safe to share the
deployment-directory between multiple Repose instances.
Files in the deployment directory are only removed if the
auto-clean feature is used, and even then, only when Repose shuts down.
Since files in the deployment directory are made accessible to Repose at runtime (via the classpath), files in the deployment directory that are not managed by Repose could affect the behavior of Repose and could even result in errors.
As such, care should be taken to ensure that errant files do not end up in the deployment directory.
Something else to be aware of is that the
artifact-directory values should be fully qualified paths.
This is the case as the exact location of the launching JVM may not remain in the same location and this would effect relative paths.
The path should not start or end with a whitespace character as all leading and trailing whitespace is ignored in reading this value.
All white space in the middle of the path name will be preserved and should not be escaped in any way.