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 a cdp-smsemailsender secret in the HashiCorp vault before deploying the HCL CDP SMSEmailSender.

To create a 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-smsemailsender charts.

  3. In the YAML section, update the ConfigMap using the below details and deploy the chart.
    5979_ACL_APP_ID: "<ACL_APP_ID>"
5979_ACL_PASS: "<ACL_PASS>"
5979_ACL_SUB_APP_ID: "<ACL_SUB_APP_ID>"
5979_ACL_USER_ID: "<ACL_USER_ID>"

ADCB_DEVMAG_CERTIFICATE_PASSWORD: "<CERT_PASSWORD>"
ADCB_DEVMAG_TRAPI_CERTIFICATE_FILE_PATH: "<CERT_FILE_PATH>"
ADCB_DEVMAG_TRAPI_CERTIFICATE_S3_FILE_PATH: "<CERT_S3_FILE_PATH>"
ADCB_PRODMAG_TRAPI_CERTIFICATE_FILE_PATH: "<CERT_FILE_PATH>"
ADCB_PRODMAG_TRAPI_CERTIFICATE_S3_FILE_PATH: "<CERT_S3_FILE_PATH>"

ADCB_STAGE_HTTPS_CONNECT_TIMEOUT_SECONDS: "<TIMEOUT_SECONDS>"
ADCB_STAGE_HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
ADCB_STAGE_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"
ADCB_STAGE_HTTPS_CONNECTION_READ_TIMEOUT_SECONDS: "<READ_TIMEOUT_SECONDS>"
ADCB_STAGE_HTTPS_CONNECTION_WRITE_TIMEOUT_SECONDS: "<WRITE_TIMEOUT_SECONDS>"

ADOBE_HTTPS_CONNECT_TIMEOUT_SECONDS: "<TIMEOUT_SECONDS>"
ADOBE_HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
ADOBE_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"
ADOBE_HTTPS_CONNECTION_READ_TIMEOUT_SECONDS: "<READ_TIMEOUT_SECONDS>"
ADOBE_HTTPS_CONNECTION_WRITE_TIMEOUT_SECONDS: "<WRITE_TIMEOUT_SECONDS>"

ALERT_TO_EMAIL_ID: "<ALERT_TO_EMAIL>"
APP_INFRA: "<APP_INFRA>"
APP_REGION: "<APP_REGION>"
APP_TYPE: "<APP_TYPE>"
AWSRegion: "<AWS_REGION>"

BLOW_FISH_KEY: "<BLOWFISH_KEY>"

CELERY_PARAM_IGNORE: "<CELERY_IGNORE_MODE>"
CELERY_PARAM_SENDER: "<CELERY_SENDER>"
CELERY_TOPIC: "<CELERY_TOPIC>"

CLICK_TRACKER: "<CLICK_TRACKER_URL>"
CLICK_TRACKER_SMS: "<CLICK_TRACKER_SMS_URL>"

COMMON_HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
COMMON_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"

COMPONENT_NAME: "<COMPONENT_NAME>"
DB_REFRESH_INTERVAL_MS: "<DB_REFRESH_INTERVAL_MS>"
DBDRIVER: "<DB_DRIVER>"

EMAIL_HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
EMAIL_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"
EMAIL_IMPRESSION_TOPIC: "<EMAIL_IMPRESSION_TOPIC>"

FROM_EMAIL_ID: "<FROM_EMAIL_ID>"

HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"

KAFKA_CONSUMER_GROUP: "<KAFKA_CONSUMER_GROUP>"
KAFKA_EXECUTOR_SERVICE_MAX_THREADS: "<MAX_THREADS>"
KAFKA_EXECUTOR_SERVICE_MIN_THREADS: "<MIN_THREADS>"
KAFKA_EXECUTOR_SERVICE_QUEUES_SIZE: "<QUEUE_SIZE>"
KAFKA_EXECUTOR_SERVICE_THREAD_TTL: "<THREAD_TTL>"

KAFKA_PRODUCER_CHANNELS: "<KAFKA_PRODUCER_CHANNELS>"
KAFKA_PRODUCER_META: "<BOOLEAN>"
KAFKA_PRODUCER_POOL_SIZE: "<POOL_SIZE>"

KENSCIO_MESSAGE_ID: "<KENSCIO_MESSAGE_ID>"
KENSCIO_MESSAGE_ID_KEY: "<KENSCIO_MESSAGE_ID_KEY>"
KENSCIO_PASSWORD: "<KENSCIO_PASSWORD>"
KENSCIO_SYSTEM_ID: "<KENSCIO_SYSTEM_ID>"
KENSCIO_SYSTEM_ID_KEY: "<KENSCIO_SYSTEM_ID_KEY>"
KENSCIO_USERNAME: "<KENSCIO_USERNAME>"

KMS_HASHICORPVAULT_ENDPOINT: "<KMS_VAULT_ENDPOINT>"
KMS_HASHICORPVAULT_ENDPOINT_TOKEN: "<KMS_VAULT_TOKEN>"
KMS_IMPLEMENTATION: "<KMS_IMPLEMENTATION>"

KafkaProducerConfigtaw1: "<KAFKA_PRODUCER_CONFIG>"
KafkaProducerConfiguse1: "<KAFKA_PRODUCER_CONFIG>"

LIVSPACE_IVR_BPEU_APID: "<LIVSPACE_APID>"
LIVSPACE_IVR_LPEU_APID: "<LIVSPACE_APID>"

LOG_LEVEL_APP: "<LOG_LEVEL>"
LOG_LEVEL_KMS: "<LOG_LEVEL>"
LOG_LEVEL_METRICS: "<LOG_LEVEL>"
LOG_LEVEL_PII_STORAGE: "<LOG_LEVEL>"
LOG_LEVEL_ROOT: "<LOG_LEVEL>"
LOG_LEVEL_UTILS: "<LOG_LEVEL>"

MANDRILL_CLIENT_END_POINT_URL: "<MANDRILL_ENDPOINT>"

MAX_EVENT_BATCH_LAG: "<MAX_EVENT_BATCH_LAG>"
MAXIMUM_IDLE_THREADS: "<MAX_IDLE_THREADS>"
MINIMUM_IDLE_THREADS: "<MIN_IDLE_THREADS>"

METRIC_DUMPER_FILE_PATH: "<METRIC_DUMPER_PATH>"
METRIC_FILE_PATH: "<METRIC_FILE_PATH>"

MGAGE_XML_API: "<MGAGE_API>"

OPEN_TRACKER: "<OPEN_TRACKER_URL>"

PASS_THROUGH_SUPPORTED_VENDOR: "<VENDOR>"

PRODUCER_EVENT_TYPE: "<EVENT_TYPE>"

REDIS_KEY_TTL_IN_SEC: "<REDIS_TTL>"
REDIS_MAX_CONNECTIONS: "<REDIS_MAX_CONNECTIONS>"

REPORTING_INTERVAL_IN_MIN: "<REPORTING_INTERVAL_MIN>"

S3_ACCESSKEYID: "<S3_ACCESS_KEY>"
S3_ENDPOINT: "<S3_ENDPOINT>"
S3_MAX_CONNECTIONS: "<S3_MAX_CONNECTIONS>"
S3_MAX_ERROR_RETRY: "<S3_MAX_ERROR_RETRY>"
S3_MAX_RW_RETRY: "<S3_MAX_RW_RETRY>"
S3_PROTOCOL: "<S3_PROTOCOL>"
S3_REGION: "<S3_REGION>"
S3_REQUEST_METADATA_FOLDER: "<S3_METADATA_FOLDER>"
S3_SECRETKEY: "<S3_SECRET_KEY>"
S3_TIMEOUT_CLIENTEXECUTION: "<TIMEOUT_MS>"
S3_TIMEOUT_CONNECTION: "<TIMEOUT_MS>"
S3_TIMEOUT_REQUEST: "<TIMEOUT_MS>"
S3_TIMEOUT_SOCKET: "<TIMEOUT_MS>"

SENDER_FEEDBACK_TOPIC: "<SENDER_FEEDBACK_TOPIC>"
SERVER_PORT: "<SERVER_PORT>"

SHORTEN_CLICK_TRACKER_EMAIL: "<SHORTEN_CLICK_TRACKER_EMAIL>"

SMS_HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
SMS_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"
SMS_IMPRESSION_TOPIC: "<SMS_IMPRESSION_TOPIC>"

TRAPI_CERTIFICATE_CAMPAIGN_SUFFIX: "<TRAPI_CERT_SUFFIX>"
TRAPI_CERTIFICATE_ENDPOINT: "<TRAPI_CERT_ENDPOINT>"
TRAPI_CONFIG_REFRESH_INTERVAL: "<REFRESH_INTERVAL>"
TRAPI_FEEDBACK_IMPRESSION_TOPIC: "<TRAPI_FEEDBACK_TOPIC>"
TRAPI_HTTPS_CONNECT_TIMEOUT_SECONDS: "<TIMEOUT_SECONDS>"
TRAPI_HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
TRAPI_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"
TRAPI_HTTPS_CONNECTION_READ_TIMEOUT_SECONDS: "<READ_TIMEOUT_SECONDS>"
TRAPI_HTTPS_CONNECTION_WRITE_TIMEOUT_SECONDS: "<WRITE_TIMEOUT_SECONDS>"
TRAPI_IMPRESSION_TOPIC: "<TRAPI_IMPRESSION_TOPIC>"

TRAPI_KAFKA_EXECUTOR_SERVICE_MAX_THREADS: "<MAX_THREADS>"
TRAPI_KAFKA_EXECUTOR_SERVICE_MIN_THREADS: "<MIN_THREADS>"
TRAPI_KAFKA_EXECUTOR_SERVICE_QUEUES_SIZE: "<QUEUE_SIZE>"
TRAPI_KAFKA_EXECUTOR_SERVICE_THREAD_TTL: "<THREAD_TTL>"

TRAPI_TOPIC_PREFIX: "<TRAPI_TOPIC_PREFIX>"

TSDB_PORT: "<TSDB_PORT>"

URL_SHORTENER_AVOID_CONFLICT: "<BOOLEAN>"
URL_SHORTENER_CONFLICT_MAX_RETRIES: "<MAX_RETRIES>"
URL_SHORTENER_DOMAIN: "<URL_SHORTENER_DOMAIN>"
URL_SHORTENER_DOMAIN_EMAIL: "<URL_SHORTENER_EMAIL_DOMAIN>"
URL_SHORTENER_MULTIPLY_FACTOR: "<MULTIPLY_FACTOR>"

USER_FAILURE_KAFKA_TOPIC: "<USER_FAILURE_TOPIC>"

VRM_DRIVER: "<VRM_DB_DRIVER>"

WASP_IMPRESSION_TOPIC: "<WASP_IMPRESSION_TOPIC>"

WHATSAPP_HTTPS_CONNECTION_COUNT: "<CONNECTION_COUNT>"
WHATSAPP_HTTPS_CONNECTION_KEEP_ALIVE_SECONDS: "<KEEPALIVE_SECONDS>"

defaultBusinessRegion: "<DEFAULT_BUSINESS_REGION>"
emailType: "<EMAIL_TYPE>"
ergoLeadApi: "<ERGO_LEAD_API>"
inboundKafkaTopic: "<INBOUND_KAFKA_TOPIC>"
kMS_DECRYPT_TIMEOUT: "<KMS_DECRYPT_TIMEOUT>"

smtpHost: "<SMTP_HOST>"
smtpPort: "<SMTP_PORT>"

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