How to configure the SDL Web 8.x/SDL Tridion Sites 9.x Deployer for manual deployments

Article Number:000015309 | Last Updated:7/15/2021 9:44 PM

Scope/Environment

SDL Tridion Sites 9.x, SDL Web 8.x

Symptoms/Context

Prior to the Microservice architecture, an administrator could configure the Deployer to deploy (or undeploy) manually by dropping in a transport package into the “incoming” folder.
With the Microservice architecture, this mechanism is not enabled by default.

Resolution

Below are the steps to re-enable that mechanism.

1. Make a duplicate of your entire Microservice Deployer

2. In the newly duplicated Deployer, either edit the bin\installservice.ps1 or bin\start.ps1 powershell script to use a different port. For example, the default port for the Deployer is 8084. Feel free to pick an available port, for example: 8085
If you plan to install as a service and you already have a Deployer microservice installed as a windows service, you would need to slightly alter the $displayName variable and $name variable to avoid a conflict.

3. In the new Deployer, edit the config\deployer-conf.xml and add an attribute called “LegacyTransport=”true” to the <Deployer element as in below example.

<Deployer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="11.0" xsi:noNamespaceSchemaLocation="schemas/deployer-conf.xsd" LegacyTransport="true">

4. In the config\cd_storage_conf.xml, comment out the <ConfigRepository tag

<!--    <ConfigRepository CacheEnabled="true" CacheExpirationDuration="600" ClientId="registration" ClientSecret="ENCRYPTED_PASSWORD" 
ConnectionTimeout="10000" ServiceMonitorPollDuration="10" ServiceUri="http://localhost:8082/discovery.svc" TokenServiceUrl="http://localhost:8082/token.svc">
        <Roles>
            <Role Name="DeployerCapability" Url="http://localhost:8085/httpupload">
                <Property Name="encoding" Value="UTF-8"/>
            </Role>
        </Roles>
    </ConfigRepository> -->

5. Save all the changes and install and start the Deployer.
6. Verify the incoming folder location of the Deployer deployer-conf.xml file, and change it for this Deployer.

<BinaryStorage Id="PackageStorage" Adapter="FileSystem">
         <Property Name="Path" Value="D:/incoming-8085"/>
</BinaryStorage>

7. Also change the Queue Destination folders in the deployer-conf.xml file.

<Queue Default="true" Verbs="Content" Adapter="FileSystem" Id="ContentQueue">
            <Property Name="Destination" Value="D:/incoming-8085/contentQueue"/>
        </Queue>
        <Queue Verbs="Commit,Rollback" Adapter="FileSystem" Id="CommitQueue">
             <Property Name="Destination" Value="D:/incoming-8085/CommitQueue"/>
        </Queue>
        <Queue Verbs="Prepare" Adapter="FileSystem" Id="PrepareQueue">
            <Property Name="Destination" Value="D:/incoming-8085/PrepareQueue"/>
</Queue>

8. Stop the new Deployer, and remove old Deployer log files before starting it again.

The newly modified Deployer now should allow you to drop a transport package into the “incoming-8085” folder and be picked up by the Deployer to process. After the Deployer processes the zip file, in the state.xml file of the incoming-8085 folder the below should be found, indicating the transaction was successful.

<FinalizeStep id="FinalizeStep" started="true" startTime="2021-07-15T12:20:15.253-07:00" failed="false" endTime="2021-07-15T12:20:15.347-07:00" completed="true">

Root Cause

Reference

Also see KB article For Tridion Sites 9.0, how to capture a Deployer transaction?

Send Article Feedback