...
The directory must be unique to a DataStage project
It must be directly accessible from the CLI (i.e.. You can't specify an engine path if the CLI is running on a Client)
If multiple instances of the CLI are to be used for incremental operations (and hence multiple independent CLI instances need to share a common view of the incremental environment’s status) then theStatus colour Red title ADVANCED -project-cache
needs to be available and synchronised across all of those CLI instances. This is normally achieved using shared storage.
Using multiple CLI environments
The last point becomes important if you are running a ‘pool’ of agents on the CI/CD pipeline. If they were to all maintain their own independent copies of the -project-cache
files then incremental fingerprints will differ between CLI instances, resulting in a significant drop in the performance benefits delivered by the incremental approach.
As an example of what could happen if a mettleci datastage deploy
command deploys to the same DataStage project with two different -project-cache
directories:
Initial Deployment using
MyCache
Command
mettleci datastage deploy ... -project-cache MyCache
is invoked.This imports and compiles all ISX files as
MyCache
does not currently contain any stage information.This initially expensive process will always be required to establish. the initial contents of the project cache.
First Deployed Change using
OtherCache
Job
MyFirstJob
is checked in.Command
mettleci datastage deploy ... -project-cache OtherCache
is invoked.This imports and compiles all ISX files as
OtherCache
does not currently contain any stage information.
Second Deployed Change using
MyCache
Command
mettleci datastage deploy ... -project-cache MyCache
is run.This compares the Git codebase to the target DataStage environment and sees that all fingerprints are misaligned. The command consequently re-imports and re-compiles all ISX files as
MyCache
contains state information which is not aligned with the target. This could have been avoided using the proper project cache.
Alternatively you can use you agent labelling strategy to ensure that only a single CLI instance is used by your pipeline which eliminates the need to coordinate the project-cache amongst multiple environments. In these cases a locally-stored project cache can be used. If you subsequently decide to horizontally scale your agent capability then you will need to…
move your project cache to shared storage, and
Modify your build pipelines to refer to that new shared location.