Deploying HCL CDP SMSEmailSender

This section provides detailed instructions on how to deploy HCL CDP SMS Email Sender using the Devtron in the OpenShift.

Prerequisites

Make sure to create cdp-smsemailsender secret in HashiCorp vault before deploying HCL CDP Trigger.

To create CDP SMS Email Sender secret in the HashiCorp vault, follow the steps below:

  1. Create a cdp-smsemailsender secret sample key and value, and update the actual values as shown below.
    {
  "5979_ACL_APP_ID": "test",
  "5979_ACL_PASS": "test",
  "5979_ACL_SUB_APP_ID": "test",
  "5979_ACL_USER_ID": "test",
  "ADCB_DEVMAG_CERTIFICATE_PASSWORD": "",
  "ADCB_PRODMAG_CERTIFICATE_PASSWORD": "",
  "AerospikeCluster": "<AerospikeCluster>",
  "AerospikePort": "13000",
  "BLOW_FISH_KEY": "test",
  "ExcludedCampaigns": "",
  "Expiry": "-1",
  "IncludedCampaigns": "4658,6035,6238,6037,6184,6349,6450,6455,6525",
  "KAFKA_TOPIC_CONSUMERS": "6,6,6,6",
  "KAFKA_TOPIC_CONSUMER_BATCHSIZE": "10,10,10,10",
  "KAFKA_TOPIC_CONSUMER_DEFAULT_BATCHTIMEOUT_TRIGGER": "5000,5000,5000,5000",
  "KAFKA_TOPIC_CONSUMER_DEFAULT_BATCH_TIMEOUT_MS": "1000,1000,1000,1000",
  "KAFKA_TOPIC_LIST": "dmp_sms_core_aps1,dmp_email_core_aps1,dmp_wsap_core_aps1,dmp_trapi_core_aps1",
  "KENSCIO_CLIENT_END_POINT_URL": "",
  "KENSCIO_MESSAGE_ID": "",
  "KENSCIO_MESSAGE_ID_KEY": "",
  "KENSCIO_PASSWORD": "",
  "KENSCIO_SYSTEM_ID": "",
  "KENSCIO_SYSTEM_ID_KEY": "",
  "KENSCIO_USERNAME": "",
  "KafkaBootstrapServer": "<KafkaBootstrapServer>",
  "KafkaBootstrapServerUS": "",
  "KafkaConsumerConfig": "<KafkaConsumerConfig>",
  "KafkaPassword": "<KafkaPassword>",
  "KafkaPasswordUS": "",
  "KafkaProducerConfig": "<KafkaProducerConfig>",
  "KafkaProducerConfigaps1": "<KafkaProducerConfigaps1>",
  "KafkaProducerHostName": "trigger-sender-mu",
  "KafkaProducerRegion": "aps1",
  "KafkaUsername": "<KafkaUsername>",
  "KafkaUsernameUS": "",
  "MGAGE_XML_API": "test",
  "MUAerospikeCluster": "<MUAerospikeCluster>",
  "MUAerospikePort": "13000",
  "MUNamespace": "cdpstore",
  "MysqlDb": "vrm?autoReconnect=true ",
  "MysqlHost": "<MysqlHost>",
  "MysqlPort": "3306",
  "Namespace": "cdpstore",
  "PIILookUpEnabled": "true",
  "PII_MAX_IDLE_THREADS": "4",
  "PII_MIN_IDLE_THREADS": "2",
  "RedisIP": "10.14.108.45",
  "RedisPort": "6379",
  "SesEnabled": "true",
  "SupportedRegion": "aps1",
  "TSDB_HOST": "<TSDB_HOST>",
  "Timeout": "3000",
  "URL_SHORTENER_S3_BUCKET": "lem-url-shortener",
  "URL_SHORTENER_S3_BUCKET_EMAIL": "lem-email-url-shortener",
  "USAerospikeCluster": "",
  "USAerospikePort": "13000",
  "USNamespace": "",
  "VrmDbPassword": "<VrmDbPassword>",
  "VrmDbUsername": "<VrmDbUsername>",
  "allowTrafficForSpecificCampaign": "false",
  "s3.accessKeyId": "",
  "s3.region": "ap-south-1",
  "s3.secretKey": ""
}
  2. Update ConfigMaps data with actual values, and create required Kafka topics before deployment.

Deploy CDP SMS Email Sender

  1. Navigate to the Devtron Chart Store, and select the cdp-smsemailsender chart to deploy.

  2. Now, configure and deploy the cdp-trigger charts.

  3. In the YAML section, update the ConfigMap using the below details and deploy the chart.
    5979_ACL_APP_ID: test
5979_ACL_PASS: test
5979_ACL_SUB_APP_ID: test
5979_ACL_USER_ID: test
ADCB_DEVMAG_CERTIFICATE_PASSWORD: test
ADCB_DEVMAG_TRAPI_CERTIFICATE_FILE_PATH: test
ADCB_DEVMAG_TRAPI_CERTIFICATE_S3_FILE_PATH: test
ADCB_PRODMAG_TRAPI_CERTIFICATE_FILE_PATH: test
ADCB_PRODMAG_TRAPI_CERTIFICATE_S3_FILE_PATH: test
ADCB_STAGE_HTTPS_CONNECT_TIMEOUT_SECONDS: "130"
ADCB_STAGE_HTTPS_CONNECTION_COUNT: "10"
ADCB_STAGE_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "600"
ADCB_STAGE_HTTPS_CONNECTION_READ_TIMEOUT_SECONDS: "125"
ADCB_STAGE_HTTPS_CONNECTION_WRITE_TIMEOUT_SECONDS: "120"
ADOBE_HTTPS_CONNECT_TIMEOUT_SECONDS: "124"
ADOBE_HTTPS_CONNECTION_COUNT: "15"
ADOBE_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "120"
ADOBE_HTTPS_CONNECTION_READ_TIMEOUT_SECONDS: "900"
ADOBE_HTTPS_CONNECTION_WRITE_TIMEOUT_SECONDS: "900"
ALERT_TO_EMAIL_ID: test
APP_INFRA: k8s
APP_REGION: ap-south-1
APP_TYPE: trigger-sender-us
AWSRegion: us-east-1
BLOW_FISH_KEY: test
CELERY_PARAM_IGNORE: IGNORE_IF_PRESENT
CELERY_PARAM_SENDER: SENDER_aps1
CELERY_TOPIC: CeleryETA
CLICK_TRACKER: <CLICK_TRACKER>/emailClick?
CLICK_TRACKER_SMS: <CLICK_TRACKER>/smsClick?
COMMON_HTTPS_CONNECTION_COUNT: "100"
COMMON_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "60"
COMPONENT_NAME: trigger_sender_us
DB_REFRESH_INTERVAL_MS: "120000"
DBDRIVER: jdbc:mariadb
EMAIL_HTTPS_CONNECTION_COUNT: "10"
EMAIL_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "6000"
EMAIL_IMPRESSION_TOPIC: sms_email_events
FROM_EMAIL_ID: test
HTTPS_CONNECTION_COUNT: "10"
HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "60"
KAFKA_CONSUMER_GROUP: k8s-trigger-sender
KAFKA_EXECUTOR_SERVICE_MAX_THREADS: "64"
KAFKA_EXECUTOR_SERVICE_MIN_THREADS: "32"
KAFKA_EXECUTOR_SERVICE_QUEUES_SIZE: "1000"
KAFKA_EXECUTOR_SERVICE_THREAD_TTL: "5"
KAFKA_PRODUCER_CHANNELS: email,sms,trapi,wasp
KAFKA_PRODUCER_META: "true"
KAFKA_PRODUCER_POOL_SIZE: "10"
KENSCIO_MESSAGE_ID: test
KENSCIO_MESSAGE_ID_KEY: test
KENSCIO_PASSWORD: test
KENSCIO_SYSTEM_ID: test
KENSCIO_SYSTEM_ID_KEY: test
KENSCIO_USERNAME: test
KMS_HASHICORPVAULT_ENDPOINT: <KMS_HASHICORPVAULT_ENDPOINT>
KMS_HASHICORPVAULT_ENDPOINT_TOKEN: <KMS_HASHICORPVAULT_ENDPOINT_TOKEN>
KMS_IMPLEMENTATION: HashiCorpVault
KafkaProducerConfigtaw1: test
KafkaProducerConfiguse1: test
LIVSPACE_IVR_BPEU_APID: "89"
LIVSPACE_IVR_LPEU_APID: "99"
LOG_LEVEL_APP: debug
LOG_LEVEL_KMS: debug
LOG_LEVEL_METRICS: debug
LOG_LEVEL_PII_STORAGE: debug
LOG_LEVEL_ROOT: debug
LOG_LEVEL_UTILS: debug
MANDRILL_CLIENT_END_POINT_URL: test
MAX_EVENT_BATCH_LAG: "16"
MAXIMUM_IDLE_THREADS: "6"
METRIC_DUMPER_FILE_PATH: /disk1/config/sms-email-sender/metricDumper.ini
METRIC_FILE_PATH: /disk1/config/sms-email-sender/metrics.ini
MGAGE_XML_API: test
MINIMUM_IDLE_THREADS: "3"
OPEN_TRACKER: <CLICK_TRACKER>/emailOpen?
PASS_THROUGH_SUPPORTED_VENDOR: Phonon
PRODUCER_EVENT_TYPE: "1234"
REDIS_KEY_TTL_IN_SEC: "7776000"
REDIS_MAX_CONNECTIONS: "20"
REPORTING_INTERVAL_IN_MIN: "55"
S3_ACCESSKEYID: ""
S3_ENDPOINT: s3.amazonaws.com
S3_MAX_CONNECTIONS: "10"
S3_MAX_ERROR_RETRY: "3"
S3_MAX_RW_RETRY: "3"
S3_PROTOCOL: HTTPS
S3_REGION: ap-south-1
S3_REQUEST_METADATA_FOLDER: trapi_req_metadata
S3_SECRETKEY: ""
S3_TIMEOUT_CLIENTEXECUTION: "50000"
S3_TIMEOUT_CONNECTION: "10000"
S3_TIMEOUT_REQUEST: "5000"
S3_TIMEOUT_SOCKET: "5000"
SENDER_FEEDBACK_TOPIC: dmp_sst_nba_di_api
SERVER_PORT: "8085"
SHORTEN_CLICK_TRACKER_EMAIL: <CLICK_TRACKER>/ecs
SMS_HTTPS_CONNECTION_COUNT: "10"
SMS_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "6000"
SMS_IMPRESSION_TOPIC: sms_email_events
TRAPI_CERTIFICATE_CAMPAIGN_SUFFIX: test
TRAPI_CERTIFICATE_ENDPOINT: test
TRAPI_CONFIG_REFRESH_INTERVAL: "600000"
TRAPI_FEEDBACK_IMPRESSION_TOPIC: sms_email_events
TRAPI_HTTPS_CONNECT_TIMEOUT_SECONDS: "124"
TRAPI_HTTPS_CONNECTION_COUNT: "45"
TRAPI_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "4000"
TRAPI_HTTPS_CONNECTION_READ_TIMEOUT_SECONDS: "122"
TRAPI_HTTPS_CONNECTION_WRITE_TIMEOUT_SECONDS: "123"
TRAPI_IMPRESSION_TOPIC: trapi_events
TRAPI_KAFKA_EXECUTOR_SERVICE_MAX_THREADS: "64"
TRAPI_KAFKA_EXECUTOR_SERVICE_MIN_THREADS: "32"
TRAPI_KAFKA_EXECUTOR_SERVICE_QUEUES_SIZE: "1000"
TRAPI_KAFKA_EXECUTOR_SERVICE_THREAD_TTL: "5"
TRAPI_TOPIC_PREFIX: dmp_trapi_core
TSDB_PORT: "80"
URL_SHORTENER_AVOID_CONFLICT: "true"
URL_SHORTENER_CONFLICT_MAX_RETRIES: "3"
URL_SHORTENER_DOMAIN: https://s.cdp.bz
URL_SHORTENER_DOMAIN_EMAIL: https://<url>/ck/ecs
URL_SHORTENER_MULTIPLY_FACTOR: "10000"
USER_FAILURE_KAFKA_TOPIC: sender_failure
VRM_DRIVER: org.mariadb.jdbc.Driver
WASP_IMPRESSION_TOPIC: whatsapp_events
WHATSAPP_HTTPS_CONNECTION_COUNT: "120"
WHATSAPP_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "10"
defaultBusinessRegion: aps1
emailType: SMTP
ergoLeadApi: ""
inboundKafkaTopic: sender_inbound
kMS_DECRYPT_TIMEOUT: "3"
smtpHost: <smtpHost>
smtpPort: "20225"

  4. On successful deployment, validate the deployment as shown below.