Migrate From Community Deploy Plugin to Standard Plugin in Release
The community xlr-xldeploy-plugin and the officially-supported xlr-xld-plugin can both exist within the same Release instance without any conflicts. For more information about the officially-supported xlr-xld-plugin, see Using Deploy plugin for Release.
Migration best practices
When migrating from the community plugin to the officially-supported plugin:
-
You must define a new shared configuration in Connections > Deploy Server for the standard plugin. The Deploy server configuration defined for the community-supported plugin does not apply for tasks created with the officially-supported plugin.
-
To migrate a task from the community plugin to the official plugin, you must use the change task type option Change Task Type > Deploy and then choose the appropriate task type using the mapping table below. For example, to migrate the deploy task defined from community plugin to the official plugin, you must use change task type option Change Task Type > Deploy > Deploy and then provide the missing information in the fields defined for the official plugin.
The Deploy: Deploy task accepts the package name as Application_name/package_name (e.g., PetClinic/1.0) or Applications/Application_name/package_name (e.g., Applications/PetClinic/1.0) and the environment as env_name (e.g., MyTomcatEnv) or Environments/env_name (e.g., Environments/MyTomcatEnv). The prefixes Applications and Environments are optional. The Deploy: Undeploy and Control tasks only accept the full name for the package name and environment.
Mapping of CIs
| Community plugin | Officially-supported plugin | Properties not migrated from Community task |
|---|---|---|
xldeploy.Server | xldeploy.XLDeployServer | None |
xldeploy.Task | xldeploy.XldTask | None |
xldeploy.TaskRunningTask | xldeploy.RetryTask | None |
xldeploy.DeployTask | xldeploy.Deploy | Server, Environment, Deployed Properties |
xldeploy.UndeployTask | xldeploy.Undeploy | Server |
xldeploy.ControlTask | xldeploy.Controltask | Server, Control task name, Parameters |
xldeploy.MigrateTask | xld.Migrate | Server |
xldeploy.ImportTask | xld.ImportTask | Server |
xldeploy.GetLatestVersionTask | xld.GetLatestVersion | Server |
xldeploy.GetAllVersionsTask | xld.GetAllVersions | Server |
xldeploy.GetLastVersionDeployedTask | xld.GetLastVersionDeployed | Server |
xldeploy.DoesCIExist | xld.DoesCIExist | Server |
xldeploy.CreateCI | xld.CreateCI | Server |
xldeploy.DeleteCI | xld.DeleteCI | Server |
xldeploy.DeleteInfrastructure | xld.DeleteInfrastructure | Server |
xldeploy.UpdateCIProperty | xld.UpdateCIProperty | Server |
xldeploy.CreateFolderTree | xld.CreateFolderTree | Server, Folders |
xldeploy.GetCITask | xld.GetCITask | Server |
xldeploy.GetCITags | xld.GetCITags | Server |
xldeploy.AddCITag | xld.AddCITag | Server |
xldeploy.SetCITags | xld.SetCITags | Server |
xldeploy.CliConfig | xld.CliConfig | None |
xldeploy.cliTask | xld.cliTask | None |
xldeploy.cli | xld.cli | Deploy CLI |
xldeploy.cliFile | xld.cliFile | Deploy CLI |
xldeploy.cliUrl | xld.cliUrl | Deploy CLI |
xldeploy.XLDVersionsTile | xlrelease.XLDeployTile | None |
The Deployed Properties in the Deploy: Deploy task does not support xpath expression in the official plugin. This property is now a dictionary with key value pairs when using the official plugin, with the key being the ID of the deployable and the value in json format with the property name and values to be overridden.