Deploying SDL Online Editor through Chef Solo

Deploying SDL Online Editor is the first step towards making SDL Online Editor work on your environment. You do not need an Internet connection to deploy SDL Online Editor.

Before you begin

To deploy SDL Online Editor, you need:
  • A separate machine only for SDL Online Editor.
  • Administrator permissions on the SDL Online Editor machine.
  • Windows Server 2012 R2 or 2016 (64-bit) on the SDL Online Editor machine.
  • Microsoft .NET Framework 4.5.2 on the SDL Online Editor machine.
  • The SDL Online Editor deployment kit (chef_solo_ue.zip). You can find it in the integrations\SDL Online Editor folder of the WorldServer distribution kit.
  • Prior knowledge about Chef Solo and about deployments performed through Chef Solo.

Minimum requirements for the SDL Online Editor machine: 2 CPU cores at 2.40 GHz each and 4 GB of RAM.

Recommended configuration for the SDL Online Editor machine: at least 4 CPU cores at 2.40 GHz each and 8 GB of RAM.

Load testing results suggest that on a WorldServer machine with 10 workflow engines where 4 of the 16 GB of RAM are allocated to Apache Tomcat, you can successfully upload ten 90000-word assets at the same time. In this case, uploading refers to the Enable Online Editing step in your workflow.

Procedure

  1. Copy the SDL Online Editor deployment kit to the machine where you want to deploy SDL Online Editor.
  2. On the same machine, start a Windows PowerShell session as an administrator.
  3. Run the following commands:
    cp -Recurse <kit location> C:\chef_solo_ue
    cd \chef_solo_ue\utils
    .\script.ps1
    , where <kit location> is the location where you copied the SDL Online Editor deployment kit (for example, E:\chef_solo_ue).
    The contents of the kit are copied and deployed and the following Windows services are installed:
    • SDL BCM Service
    • SDL Editor Service
    • SDL Editor Service Router
    • SDL Semantic Logging Service
  4. Go to C:\Program Files\SDL\Editor Service\bin and open the SDL.EditorService.Host.exe.config file with a text editor.
  5. Change the value of the AuthenticationServiceUrl property to http://<ws-host>:<port>/ws-api/v1/onlineAssets/{0}.

    For example, http://11.234.56.78:8080/ws-api/v1/onlineAssets/{0}.

  6. Change the value of the UserDetailsServiceUrl property to http://<ws-host>:<port>/ws-api/v1/users/me/details.

    For example, http://11.234.56.78:8080/ws-api/v1/users/me/details.

  7. Change the value of the ProfileProviderUrl property to http://<ws-host>:<port>/ws-api/v1/lp/ue/profile.

    For example, http://11.234.56.78:8080/ws-api/v1/lp/ue/profile.

  8. Change the value of the TqaProfileProviderUrl property to http://<ws-host>:<port>/ws-api/v1/lp/ue/tqa/profile.

    For example, http://11.234.56.78.8080/ws-api/v1/lp/ue/tqa/profile.

  9. Change the value of the ProfileProvider, TqaProfileProvider, AuthenticationProvider, and TranslationSettingsProvider properties to WS.

    For example, add key="ProfileProvider" value="WS", add key="TqaProfileProvider" value="WS", and so on.

  10. Change the value of the WsServiceRoot property to http://<ws-host>:<port>/ws-api/v1.

    For example, http://11.234.56.78:8080/ws-api/v1.

  11. Save and close the SDL.EditorService.Host.exe.config file.
  12. Go to C:\Program Files\SDL\Editor Service Router\bin and open the Sdl.EditorServiceRouter.Host.exe.config file with a text editor.
  13. Change the value of the EsPoolUrl to <oe-host>:80, where <oe-host> is the name or IP address of the machine on which SDL Online Editor is installed.

    For example, 87.654.32.11:80.

  14. Change the value of the AuthenticationServiceUrl property to http://<ws-host>:<port>/ws-api/v1/onlineAssets/{0}.

    For example, http://11.234.56.78:8080/ws-api/v1/onlineAssets/{0}.

  15. Change the value of the UserDetailsServiceUrl property to http://<ws-host>:<port>/ws-api/v1/users/me/details.

    For example, http://11.234.56.78:8080/ws-api/v1/users/me/details.

  16. Change the value of the AuthenticationProvider property to WS.

    For example, AuthenticationProvider=WS.

  17. Save and close the Sdl.EditorServiceRouter.Host.exe.config file.
  18. Go to C:\Program Files\SDL\BCM Service and open the Sdl.BcmService.Host.exe.config file with a text editor.
  19. Change the value of the PoolAddress property to <oe-host>:80, where <oe-host> is the name or IP address of the machine on which SDL Online Editor is installed.

    For example, 87.654.32.11:80.

  20. Go to C:\Deployment\ES\Dev and copy the DLL files from that folder to C:\Program Files\SDL\Editor Service\bin.
  21. Restart the SDL Editor Service Router service.
  22. Restart the SDL Editor Service.
  23. Restart the SDL BCM Service.
  24. Verify that the SDL BCM Service is working properly by typing <oe-host>:8080/bcms/health in your browser's address bar, and then pressing Enter:
    • If the service is working properly, the status is UP (<Status>UP</Status>).
    • If the service is not working properly, the page is not displayed.
  25. Verify that the SDL Editor Service is working properly by typing <oe-host>:80/api/es/health in your browser's address bar, and then pressing Enter:
    • If the service is working properly, the status in UP (<Status>UP</Status>).
    • If the service is not working properly, the status is DOWN (<Status>DOWN</Status>).
  26. Verify that the SDL Editor Service Router service is working properly by typing <oe-host>:90/api/esrouter/health in your browser's address bar, and then pressing Enter:

    If the service is working properly, the status is UP ("status":"UP").

  27. Optional: If any of the services is not working properly, do the following:
    1. Restart your machine.
    2. Start the SDL Editor Service Router service.
    3. Restart the SDL Editor Service.
    4. Start the SDL BCM Service.
    5. Verify again by using the links mentioned earlier. For the deployment to be successful, all the services need to be working properly.

What to do next

Configure WorldServer to connect to SDL Online Editor.