Configuration

Edit the input parameters in the following file based on the type of solution that you want to create.

  • <Installation Directory>/conf/enterprise.properties
    For more information, refer to the sample.properties (zip) file.

There are two types of input properties:

  • User Defined Parameters: These are the mandatory inputs for which you must specify values.
  • Advanced Properties: These are either populated by default or populated by the script during installation. Typically, you don't need to update these properties. These are available in the sample.properties (zip) file.

List of properties under the User Defined Section

You need to provide the following parameters during Installation:

NOTE: The parameter values in the properties file must not contain quotes.

PARAMETER DESCRIPTION EXAMPLE

SERVER_DOMAIN_NAME

Specifies the domain name for the Fabric Console component.

This is not required if a shared cluster is already created in previous installations.

kfazure-console.konylabs.net

AZURE_SUBSCRIPTION_ID

Specifies the Azure subscription ID.

For more information, refer to Get the Subscription ID.

abcd1234ef-22ab-33cd-444f-xyz7890p1q2r3

AZURE_LOCATION

Specifies the region in which the AKS cluster must be created.

For more information, refer to Features and Supported Regions.

eastus

SERVICE_PRINCIPAL_CLIENT_ID

Specifies the Application ID of the service principal that is created for the Azure installation.

abcd1234ef-22ab-33cd-444f-xyz7890p1q2r3

SERVICE_PRINCIPAL_CLIENT_SECRET

Specifies the password of the Service Principal.

abcd1234ef-22ab-33cd-444f-xyz7890p1q2r3

SERVICE_PRINCIPAL_OBJECT_ID

Specifies the Service principal object ID.

For more information, refer to Generate the Service Principal Object ID.

abcd1234ef-22ab-33cd-444f-xyz7890p1q2r3

TENANT_ID

Specifies the Tenant ID of the Azure account.

For more information, refer to Get the Tenant ID.

abcd1234ef-22ab-33cd-444f-xyz7890p1q2r3

SSH_PUBLIC_KEY

Specifies the SSH Public Key, which is required for creation of the AKS.

For more information, refer to Generate an SSH Public Key.

NOTE: The same SSH key must not be used for different Non-Production installations within a subscription.

ssh-rsa ABCD123PQR456...

AZURE_RESOURCE_GROUP

Specifies the name of the resource group that must be created for the cluster. Ensure that the name does not conflict with any existing resource groups.

This is not required for Non-Production installation if a shared cluster is already created for the same subscription.

FabricXYZ

DATABASE_TYPE

Specifies the database type that you want to use to host Quantum Fabric on Azure.

The Quantum Fabric Containers on Azure Solution supports the MS SQL Server (including AzureSQL) and MySQL Databases.

 

Typically, Fabric uses six databases for different components. From the 202307 release, Fabric supports a single database configuration on Azure; to select this configuration, set the database type as sqlserversingledb.

IMPORTANT: The single database configuration is only applicable for fresh installations; it is not applicable if you are upgrading from an earlier version.

mysql

DATABASE_USER_NAME

Specifies the username for the database that is used by the Fabric components.

This is not required for Non-Production installation if a shared cluster is already created for the same subscription.

dbclient

DATABASE_PASSWORD

Specifies the password for the database that is used by the Fabric components.

NOTE: The following special character are not supported in the database password: $, *, &, !, (, ), \.

Test#/123

INTEGRATION_DATABASE_USER_NAME

Specifies the username for the integration (INT) database. This is required only if the database type is sqlserver.

This is not required in Non-Production installation if a shared cluster is already created in the previous installation.

dbclient

INTEGRATION_DATABASE_PASSWORD

Specifies a database password for the integration (INT) database. This is required only if the database type is sqlserver.

This is not required in Non-Production installation if a shared cluster is already created in the previous installation.

NOTE: The following special character are not supported in the database password: $, *, &, !, (, ), \.

FabR^c123

ENVIRONMENT_DB_USER

Specifies the username for the environment database. This is required only if the database type is mysql and the installation type is Non-Production.

dbclient

ENVIRONMENT_DB_PASSWORD

Specifies the password for the environment database. This is required only if the database type is mysql and the installation type is Non-Production.

FabR^c123

ENABLE_REDIS_SSL

Specifies whether an SSL connection must be enabled between the Authentication Service and REDIS.

The supported values are true and false.

true

APPGATEWAY_SSL_CERT_PASSWORD

Specifies the password of the SSL PFX certificate. The password is used for getting the pfx key for the SSL offloading.

Test@1234

Automatic Registration Details:

Auto registration inputs are not required to be provided for Non-Production if the Shared cluster is already created in a previous installation.

 

AUTO_REGISTRATION_USER_ID

Specifies the email ID that is used to register for Quantum Fabric. After the installation is complete, you can add more users from the Fabric console.

micheal.doe@xyz.com

AUTO_REGISTRATION_PASSWORD

Specifies the password that is used to register for Quantum Fabric.

Test@5264!

AUTO_REGISTRATION_FIRST_NAME

Specifies the first name that is used to register for Quantum Fabric.

Micheal

AUTO_REGISTRATION_LAST_NAME

Specifies the last name that is used to register for Quantum Fabric.

Doe

AZURE_CDN_ENABLED

Specifies whether CDN must be installed for the apps component.

The supported values are true and false.

IMPORTANT: If you select a region where CDN Profile is not supported, CDN will not be configured. For more information, refer to Features and Supported Regions.

true

ALERT_NOTIFICATION_ENABLED

Specifies whether notifications are enabled for Alerts. For example, sending an alert when the CPU Usage crosses 90% on integration pod.

The supported values are true and false.

true

AZURE_ACTION_GROUP_NAME

Specifies the name of the action group.

admin

USER_EMAIL_ID

Specifies the default email ID to which alert notifications are sent.

micheal.doe@xyz.com

ARRAY_TO_WHITELIST_IPS_TO_ACCESS_FILE_SHARE

Specifies the public Fabric IP address of the machine on which the installation script must run. You can specify multiple IP addresses by separating them with spaces. For example, ("w1.x1.y1.z1" "w2.x2.y2.z2" "w3.x3.y3.z3").

("103.140.124.130")

COMMON_RESOURCE_GROUP

Specifies the name of the resource group in which subscription level shared resources are created. This value must be separate for Production and Non-Production installations. This is the resource group in which the PCI related function app is created.

KonyInfra

MARKETING_CATALOG_MS

Specifies whether the Marketing Catalog Microservice is enabled.

The supported values are true and false.

false

MARKETING_CATALOG_RESOURCE_GROUP

Specifies the name of the resource group in which the Marketing Catalog microservice resources are created.

marketingcatalog-ms

MONGO_PATH

Specifies the path where the Mongo Shell is installed.

/opt/mongodb-linux-x86_64-ubuntu1804-4.2.10/bin

MONGO_CONNECTION

Specifies the connection string for the Mongo Shell from Altas.

mongodb+srv://mongo-cluster-1.jonig.mongodb.net

MONGO_USER_NAME

Specifies the Mongo database user name that you created earlier.

mongodbuser

MONGO_PASSWORD

Specifies the Mongo database password that you provided while creating the mongodb user.

Root@123

MONGODB_DBNAME

Specifies the preferred database name.

marketingcatalogdb

MONGODB_CONNECTIONSTR

Specifies the Mongo DB connection string, which can be formed by using the following string:

mongodb://<MONGO_USER_NAME>:<MONGO_PASSWORD>@<cluster-shard-0>:<port-number>,
<cluster-shard-1>:<port-number>,
<cluster-shard-2>:<port-number>/
<MONGODB_DBNAME>?ssl=true&replicaSet=<value>
&authSource=admin
&retryWrites=true
&w=majority

NOTE: Ensure that you provide URL encoded username and password values if they contain special characters such as *, @, :, or ?.

mongodb://mongodbuser:Root%12345@
mongo-cluster-1-shard-00-01.jonig.mongodb.net:27017,
mongo-cluster-1-shard-00-02.jonig.mongodb.net:27017,
mongo-cluster-1-shard-00-00.jonig.mongodb.net:27017/
marketingcatalogdb?ssl=true&amp;
replicaSet=atlas-qxcm8s-shard-0&amp;
authSource=admin&amp;
retryWrites=true&amp;
w=majority

EVENT_HUB_NAME_SPACE

Specifies the preferred Event hub namespace.

marketingcatalogkafkaapp

CAMPAIGN_MS

Specifies whether the Campaign Microservice is enabled.

The supported values are true and false.

false

CAMPAIGN_RESOURCE_GROUP

Specifies the name of the resource group in which the Campaign Microservice resources are created.

nas-ssl-campaign

CAMPAIGN_DB_SERVER_NAME

Specifies the server name of the MySQL Database.

sqlcampaigndb

CAMPAIGN_DB_USER_NAME

Specifies the database user name.

campaign

CAMPAIGN_DB_PASSWORD

Specifies the database password, which must be a String containing a minimum of 8 characters and combination of alpha-numeric and non-alpha-numeric characters.

root@123

ARRAY_TO_WHITELIST_IPS_TO_ACCESS_CAMPAIGN_DB

Specifies the outbound public IP address of the machine on which the installation script must run. You can specify multiple IP addresses by separating them with spaces. For example, ("w1.x1.y1.z1" "w2.x2.y2.z2" "w3.x3.y3.z3").

("103.140.124.130")

New Relic Monitoring details:

New Relic Monitoring for AKS Cluster. Enable New Relic monitoring for Infrastructure monitoring. Make sure a proper new relic subscription is available before enabling this feature.

 

NEW_RELIC_INFRA_MONITORING_ENABLED

Specifies whether node level performance metrics (such as CPU and memory) are monitored.

Set this value to true if you have a new relic license key and if new relic infra monitoring must be enabled.

The supported values are true and false.

true

NEW_RELIC_APP_PERF_MONITORING_ENABLED

Specifies whether pod level metrics are monitored.

Set this value to true if you have a new relic license and if pod level monitoring must be enabled.

The supported values are true and false.

true

NEW_RELIC_LICENSE_KEY

Specifies the new relic license key.

ab1cd2112ef34g123a45c678ab0cd1ef234

AKS_NODE_COUNT

Specifies the number of worker nodes in the cluster.

This is the minimum number of nodes that must be created in the Shared AKS agent pool.

2

AKS_MAX_NODE_COUNT

Specifies the maximum number of worker nodes that can be provisioned by Autoscaling.

This is the maximum number of nodes that the Shared AKS can create in case the load increases.

6

AKS_NODE_SIZE_NON_PROD

Specifies the type of Azure instance that is created for the Shared cluster in which the Fabric components Console, Identity, Engagement pods are created. For information about the instance sizes and codes, refer to the Azure documentation.

This property is only applicable for Non-Production instances.

Standard_D4_v3

AKS_NODE_SIZE_PROD

Specifies the type of Azure instance that is created for the Shared cluster in which the Fabric components Console, Identity, Engagement pods are created. For information about the instance sizes and codes, refer to the Azure documentation.

This property is only applicable for Production instances.

Standard_D4_v3

INTEGRATION_NODE_SIZE

Specifies the type of the Azure instance that is created for the Integration Components.

Standard_B2MS

AKS_MASTER_NODE_COUNT

Specifies the AKS Master Node Count, which is the number of Master nodes that must be created.

1

INTEGRATION_AKS_NODE_COUNT

Specifies the minimum number of nodes that must be created in the Integration AKS agent/node pool.

2

INTEGRATION_AKS_MAX_NODE_COUNT

Specifies the maximum number of nodes that must be created in the Integration AKS agent/node pool.

6

User Defined Properties

Azure Subscription ID, Azure Service Principal ID Name, Azure Service Principal ID Secret, Service Principal Object ID, and Tenant ID - Azure Subscription ID is a GUID that uniquely identifies your subscription to use Azure services. The Application needs the Service Principal to access or configure resources through the Azure Resource Manager (ARM) in the Azure Stack.

You must have an Azure account with the permissions of a Global Administrator and the role of a User. Without these privileges, it is not possible to create the AKS clusters (or other resources).

The following sections describe fetching Azure Subscription ID, generating Azure Service Principal ID Name, Azure Service Principal ID Secret, Service Principal Object ID, and Tenant ID.

  1. From the left menu of the Azure Portal, select Browse.
  2. In the search box that appears, type subscription.
  3. Select Subscriptions from the search results.
  4. For the appropriate subscription, check the Azure subscription GUID.
  1. On the Azure Portal, click the Cloud Shell icon.
  2. Execute the following command:
    
$ az ad sp create-for-rbac --role="Contributor" --scopes="/subscriptions/<subscription_id>"

    3. After you execute the command, a JSON response is displayed on the command prompt.

    {
    "appId": "APP_ID",
    "displayName": "ServicePrincipalName",
    "name": "http://ServicePrincipalName",
    "password": ...,
    "tenant": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }

  3. In the properties file of the conf directory, configure the following properties:
    • For the SERVICE_PRINCIPAL_CLIENT_ID property, enter the value of the appId.
    • For the SERVICE_PRINCIPAL_CLIENT_SECRET property, enter the value of the password.
    4. NOTE: The values of the SERVICE_PRINCIPAL_CLIENT_ID and SERVICE_PRINCIPAL_CLIENT_SECRET properties must not contain any quotation marks. For example:
    • SERVICE_PRINCIPAL_CLIENT_ID = abcd1234ef-22ab-33cd-444f-xyz7890p1q2r3
    • SERVICE_PRINCIPAL_CLIENT_SECRET = efg1234-ab22-cd33-444f-xyz7890p1q2r3
  1. On the Azure Portal, click the Cloud Shell icon.
  2. In the PowerShell window, execute the following command: 
    
$(Get-AzureADServicePrincipal -Filter "AppId eq '<SERVICE_PRINCIPAL_CLIENT_ID>'").ObjectId

  1. From the Azure Portal, navigate to the Azure Active Directory.
  2. In the Overview section, find the Tenant ID.