Serverless Configuration
This section explains the serverless configurations categorized as:
Cloud AWS
Following are the properties to be updated in the install-aws.sh/install-aws-postgresql file.
| PROPERTY | DEFAULT VALUE | TO BE UPDATED AS | DESCRIPTION |
|---|---|---|---|
| AWS_ACCESS_KEY_ID | Developer's credentials | AWS Account Access Id | unique id of AWS access key |
| AWS_SECRET_ACCESS_KEY | Developer's credentials | AWS Account Secret Key | AWS Secret access key |
| AWS_REGION | Developer's credentials | AWS Account Region | AWS region name |
| DEPLOYMENT_ENVIRONMENT | As required |
If multiple instances of MS need to be deployed in the same region, then this property needs to be set [Should use only lower case letters in-order to comply with AWS resources naming convention] Ex: if the property is set as 'dev', the bucket name will be 'dev-ms-marketingcatalog-package' . |
|
| S3_BUCKET_ID | ms-mareketingcatalog-package | As required |
S3 bucket is an object storage service. The application JAR file will be copied into the s3 bucket. |
| temn_entitlement_service_enabled | false | As required |
Enable/Disable the entitlement service. If the property is enabled, the roles and permissions needed for the authentication will be taken from the entitlement microservices. |
| temn_msf_security_authz_enabled | false | true or false |
Enable/Disable the XACML policy authorization. XACML policy authorization is used to configure security policies and access rights to information for APIs. |
| PDP_CONFIG | classpath:xacml/pdp-config.xml | As required |
Mapping the PDP-callback configuration file available in the classpath. XAML Config file path needs to be set in the property. |
| PDP_RESOURCE_TYPE | API | As required |
The value that is set in the XAML config file needs to be provided. Resource type is used to identify the policy set in the XAML config. |
| PDP_RESOURCE_MANAGER | MARKETINGCATALOG | As required |
The value that is set in the XAML config file needs to be provided. Resource Manager is used to identify the policy set in the XAML config. |
| ms_security_tokencheck_enabled | Y | Y or N |
Enable/Disable the JWT validation. By default, JWT token check is enabled. JWT validation is used to validate the custom and mandatory claims from the provided token. |
| ID_TOKEN_SIGNED | true | true or false |
Enable/Disable JWT signature validation. By default, signature validation is enabled, Set it to 'false', if the validation is not required. JWT signature validates the public and private key from the given JWT token |
| JWT_TOKEN_ISSUER | Fabric | Issue value present in XACML Policy file | Identifies the issuer of the authentication token. |
| JWT_TOKEN_PRINCIPAL_CLAIM | sub | Value should match with JWT token used | Indicates the claim in which the user principal is provided. |
| JWT_TOKEN_PUBLIC_KEY | Base 64 encoded public key | Indicates Base64 encoded public key content that can be directly loaded as a public key certificate. | |
| SCHEMA_REGISTRY_URL | http://localhost:8081 | As required | URL of the schema registry which is used to get the schema of the Backoffice(Transact) applications like AA.PRODUCT.LINE, AA.PRODUCT.GROUP etc. |
| KINESIS_NAME | table-update | As required | Kinesis stream is mapped in the DES to get the application records from the Transact. Kinesis stream is used as a streaming application between Microservice and transact. |
Cloud Azure
| Property | Default Value | Description | Azure Configurations |
|---|---|---|---|
|
RESOURCE_GROUP_NAME |
marketingcatalog-ms |
Environment-specific resource name can be appended Groups all the function app and configuration of the deployment |
Resource Group Name |
|
APP_NAME |
marketingcatalogapp |
Environment-specific app name can be appended Function app for api created in azure, if App name is changed, then rename the folder in this path ms-marketingcatalog-package-azure-<version>\Markertingcatalog-Azure\target\azure-functions |
Function App |
|
LOCATION |
uksouth |
location of azure account |
Location of Azure Account |
|
DISABLE_INBOX |
true |
Enable or disable inbox outbox. If the property disabled , an event will be raised to the "ms-marketingcatalog-outbox" EventHub. |
tem_msf_disableInbox |
|
HTTP_BASE_PATH |
Update the IRIS base path |
HTTP_BASE_PATH |
|
|
EventHub Propeties: If DES application deployed and mapped to the eventhubnamespace, set the below properties with the respective details from the des eventhubnamespace.
|
|||
|
EVENT_HUB_NAME_SPACE |
marketingcatalogkafkaapp |
Kafka Event Hub Server Creation As per EVENT_HUB_NAME_SPACE defined in Marketing Catalog eg:marketingcatalogkafkaapp Note: If the eventhubnamespace already created, set the property with the created namespace value. |
EventHub Namespace |
|
INGESTION_TOPIC |
table-update |
DES EventHub name. |
INGESTION_TOPIC |
|
REGISTRY_URL |
URL of the schema registry which is used to get the schema of the Backoffice(Transact) applications like CUSTOMER, CUSTOMER.GROUP etc. |
REGISTRY_URL |
|
|
The below three properties KAFKA_SERVER, eventHubConnection & temn_msf_stream_kafka_sasl_jaas_config will be configured through the script. Note: If the values are known to the user, it can be overridden in the script.
|
|||
|
KAFKA_SERVER |
${EVENT_HUB_NAME_SPACE}.servicebus.windows.net:9093 |
Hostname of the eventHubnamespace. eg: partykafkaapp.servicebus.windows.net:9093 |
temn_msf_stream_kafka_bootstrap_servers |
|
eventHubConnection |
<Value> |
Kafka Connection string |
eventHubConnection |
|
SASL_JASS_CONFIG |
{org.apache.kafka.common.security.plain.PlainLoginModule required username=\"\$ConnectionString\" password=\"${eventHubConnection}\";} |
Property to stream or read the data from Event Hub Kafka |
temn_msf_stream_kafka_sasl_jaas_config |
|
Security Related Properties:
|
|||
|
AUTHZ_ENABLED |
false |
Enable/Disable the XACML policy authorization. XACML policy authorization is used to configure security policies and access rights to information for APIs. |
temn_msf_security_authz_enabled |
|
PDP_CONFIG_FILE |
classpath:xacml/pdp-config.xml |
Mapping the PDP-callback configuration file available in the classpath. XAML Config file path needs to be set in the property. |
PDP_CONFIG |
|
PDP_RESOURCE_TYPE |
API |
The value that is set in the XAML config file needs to be provided. Resource type is used to identify the policy set in the XAML config. |
temn_msf_pdp_resource_type |
|
PDP_RESOURCE_MANAGER |
MARKETINGCATALOG |
The value that is set in the XAML config file needs to be provided. Resource Manager is used to identify the policy set in the XAML config. |
temn_msf_pdp_resource_manager |
|
temn_entitlement_service_enabled |
"false" |
Enable/Disable the entitlement service. If the property is enabled, the roles and permissions needed for the authentication will be taken from the entitlement microservices. |
temn_entitlement_service_enabled |
|
MS_SECURITY_TOEKN_CHECK_ENABLED |
N |
Enable/Disable the JWT validation. By default, JWT token check is enabled. JWT validation is used to validate the custom and mandatory claims from the provided token. |
ms_security_tokencheck_enabled |
|
ID_TOKEN_SIGNED |
"true" |
Signed token used for fabric |
ID_TOKEN_SIGNED |
|
JWT_TOKEN_ISSUER |
Fabric |
Identifies the issuer of the authentication token. |
JWT_TOKEN_ISSUER |
|
JWT_TOKEN_PRINCIPAL_CLAIM |
sub |
Indicates the claim in which the user principal is provided. |
JWT_TOKEN_PRINCIPAL_CLAIM |
|
JWT_TOKEN_PUBLIC_KEY |
<JWT Token Value> |
Indicates Base64 encoded public key content that can be directly loaded as a public key certificate. |
JWT_TOKEN_PUBLIC_KEY |
In this topic