Constellation Messaging service on Docker

Note:

This documentation assumes that the consumers trying to setup the service have a basic idea about containers and docker in general. In case you need help with the setup or would like to try the constellation-messaging service without the setup please contact pega support.

Before you begin

Prepare for the installation

  1. Ensure that you have the Docker command line interface installed on your on-premises environment.
  2. Obtain an API key from the Pega Digital Delivery site. For more information please check this page
  3. Prepare docker authentication. For more information please check this page

Installing the constellation messaging service

  1. Log in to Pega’s Docker repository from your terminal.

    For example : docker login pega-docker.downloads.pega.com

  2. Now pull the highest version of constellation messaging docker image.

    For example : docker pull pega-docker.downloads.pega.com/constellation-messaging/docker-image:5.3.0-20230925171643

    Note: Launch Parameters for messaging service

    Mandatory

    param description
    urlPath The url path that the service is deployed on – should match load balancer or router traffic routing
    port The port that the container is mapping the connection to
    path(deprecated) The url path that the service is deployed on – should match load balancer or router traffic routing

    https certificates

    This is only required if the cert is to be put on the service. Puttting the cert on the LB is the recommended path.

    param description
    httpsKey key file name
    httpsCert cert file name
    key(deprecated) key file name
    cert(deprecated) cert file name

    Folder holding key and cert file should be mounted with -v to path /host_folder.

  3. Start the service by entering

    docker run -p 3443:3443 -v :/host_folder --name c11n-messaging pega-docker.downloads.pega.com/constellation-messaging/docker-image:5.3.0-20230925171643 port=3443 urlPath=/c11n-messaging httpsKey=/host_folder/<SSL_KEY> httpsCert=/host_folder/<SSL_CERT>

  4. Constellation messaging service should now be available at https://localhost:3443/c11n-messsaging

  5. Now you can set the ConstellationMessagingSvcHost DSS to the above url to use the service.