Installation Parameters¶
The parameters order¶
The installer is strictly command line based and all configuration and parameters are passed in values files or as single arguments to the installer script.
If the same parameter is passed to the installer several times the last in order will override the previous ones.
If a values yaml file that can hold many parameters structured in the yaml standard with the values:
**example-values.yaml
global:
namespace: exampleprod
customerCode: example
environmentType: prod
solutionSetName: My Groovy Solution!!
replicas: 2
ifsappproxy:
accessLog: enabled
If above ifscloud-values.yaml is passed to the installer, and the parameter is also passed to the installer like this:
.\installer.cmd --values ifscloud-values.yaml --set ifsappproxy.accessLog=enabled --set global.replicas=1
the installer will use the "enabled" value of the parameter ifsappproxy.accessLog and "1" of the global.replicas since that was passed as a "--set" in the command line. So "--set" wins over "values" and if the same parameter is "--set" several times the last will win.
.\installer.cmd --values ifscloud-values.yaml --values solutionset.yaml
in this example the "solutionSetName: My Groovy Solution!!" will be overwritten by the solutionSetName that is always defined parameter in a solutionset.yaml files.
IFS cloud values file¶
All configuration files and certificates should be placed in the config folder according to the folder structure in Windows Management Server.
There is a template file in the ifsinstaller folder named custom-values.tem, which will show which parameters that should and can be set in the release. When upgrading an environment to a new release this file could be compared to the used one, to see which parameters might have been added to the new release.
Here is an example of how a filled in ifscloud-values.yaml can look like. Note - always use the latest ifsinstaller\custom-values.tem from your build_home when configuring your own ifscloud-values.yaml file. Use the parameter guidance in the sections below to fill in the values in the customized file.
Password limitations¶
As IFS Cloud has many underlying password dependencies and locales, we restict the passwords to fulfil all limitations. The following restrictions and recommendations apply:
-
Must start with an alphanumerical character [a-z] [A-Z]
-
Passwords should have least 15 characters (recommended)
-
These special characters are not allowed: \ / @ ' " | - * $ & # § (and other language specific characters )
General Parameters¶
Bold parameters are mandatory others are optional
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| chart | specifies which master-chart to be used | Default: ifscloud/ifs-cloud can be a path to a local master-chart as well (only used by RnD). To use the local master-chart set e.g. " chart: .\master-chart " |
| chartVersion | if chart is set to ifscloud/ifs-cloud this parameter will specifiy the version of the master chart to use. Read more Deploying a container hotfix | if this parameter is not set or is referencing an old service update/release, the installer will read chartVersion from the version file in the delivery/build_home |
| certificateFile | Location of the pfx file that holds the certificate and private key. See Certificate Handling for more certificate requirements and info. If the certificateFile is omitted or the file can not be found, a new selfsigned certificate will be automatically generated and used. |
e.g. /path/to/yourcert.pfx or c:\path\to\yourcert.pfx |
| certificatePassword | password for the pfx file. | Note the pwd need to be a string. e.g. ifs123 or "12345" |
| helmRepo | The url of the Helm Chart repository. | Use - https://ifscloud.jfrog.io/artifactory/helm |
| helmUser | The service principal user name. This username should be provided per customer by IFS. | |
| helmPwd | The service principal password. This password should be provided per customer by IFS. | |
| global.namespace | Sets the namespace in the k8s cluster norally you would set is as a concatination of the customerCode and environmentType | none, but the parameter is mandatory and must consist of only lowercase alphanumeric characters or '-' volvobnt |
| global.customerCode | This is a label of the system. All monitoring metrics will be tagged with this label. Typically the label would be an abriviation of the company name. | none, but the parameter is mandatory volvo |
| global.environmentType | This is a label of the system. All monitoring metrics will be tagged with this label. Typical values prod/test/bnt/dev | none, but the parameter is mandatory bnt |
| global.customerId | Used in the License report. The id should come from IFSBiz and should be supplied by the IFS contact person | The parameter is mandatory |
| global.customerName | Used in the License report. The Name should come from IFSBiz and should be supplied by the IFS contact person | The parameter is mandatory |
| global.installationId | Used in the License report. Just an environment identifier that is unique per customerId e.g. TEST/PROD/DEV/MIG/TRAIN/CFG | The parameter is mandatory |
| global.systemUrl | The FQDN of the primary url where the system is accessed. Note: the https:// is not part of the FQDN |
e.g. ifscloud.corpnet.ifs.com |
| global.secondarySystemUrl | The FQDN of the secondary url where the system is accessed. This could be an internet facing external proxy that only allows b2b and mobile client requests. This FQDN could have a different domain than the normal systemUrl. If the entire system is exposed to internet, the secondarySystemUrl is not needed. |
e.g. ifscloud.ifs.com |
| global.containerRegistry | The url of the docker container registry, where all containers will be fetched from. Note: Always append a trailing slash. Note: the https:// is not part of the FQDN |
Use - ifscloud.jfrog.io/docker/ |
| global.imageCredentials.username | The service principal user name. This username should be provided per customer by IFS. | |
| global.imageCredentials.password | The service principal password. This password should be provided per customer by IFS. | |
| global.scale | Defines the scaling of cpu/memory compared to the production mode 100%. | Default: 100 A scale of 10-20 is a small development environment. A scale of aprox 50 is a small test environment. Scale should be set to 100 in all production like environments. |
| global.replicas | Sets how many containers should be started by default | The default number of replicas to be started of each type of container. Can be overridden by the containers local replicas parameter. |
| global.cpuRatio | This will set the k8s CPU request/limit ratio on all containers. | Default: 50 This will set the CPU request to 50% of the CPU limit on the containers. Read more on k8s CPU request & limits on k8s user documentation for more infomation. |
| global.httpConnectTimeout | This will set the timeout of http connection to the ingress proxy and the ifsapp-proxy | Default: 60 |
| global.httpSendTimeout | This will set the Send timeout of http connection to the ingress proxy and the ifsapp-proxy | Default: 600 |
| global.httpReadTimeout | This will set the Read timeout of http connection to the ingress proxy and the ifsapp-proxy | Default: 600 |
| global.demandPort | Demand Server Port number | Default: 5010 |
| global.crystalPort | Crystal Server Port number | Default: 80 |
| ifscore.secrets.jdbcUrl.name | ifs-jdbc-url | |
| ifscore.secrets.jdbcUrl.data | A hostname that can be resolved from within the k8s cluster. Oracle db service name or sid. Oracle db listener port. Advanced jdbc strings to support failover/RAC or TCPS can be defined here. |
jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=10.241.0.4)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=CLOUD))) Note: If passing the jdbcUrl as a command line argument it needs to be quoted and escaped. set ifscore.secrets.jdbcUrl.data= \" jdbc:or......D)) \" |
| ifscore.networkpolicy.enabled | Set to true to activate network policy | default: false |
| ifscore.networkpolicy.internetAccess ExceptionList |
Mandatory if network policy is enabled. A list of subnets that should be blocked for access from containers |
ifscore: networkpolicy: enabled: true demandcrystalhost: 10.0.2.4 internetAccessExceptionList: - ip: 10.0.0.0/16 - ip: 193.41.170.171/32 |
| ifscore.networkpolicy.demandcrystalhost | Can only be set if network policy is enabled. The IP of a server that can have Crystal Services and Demand Server. This IP will be opened even if behind a restricted subnet (internetAccessExceptionList) Note: the DB server will allways be automatically opened on port 1521 even if behind internetAccessExceptionList subnet. |
ifscore: networkpolicy: enabled: true demandcrystalhost: 10.0.2.4 internetAccessExceptionList: - ip: 10.0.0.0/16 - ip: 193.41.170.171/32 |
| ifscore.passwords.ifssysPassword.name | Need to be set to ifssys-password | ifssys-password |
| ifscore.passwords.ifssysPassword.data | The db user IFSSYS password | |
| ifscore.passwords.ifsadminPassword.name | Need to be set to ifsadmin-pw | ifsadmin-pw |
| ifscore.passwords.ifsadminPassword.data | The password of the IFSADMIN initial user to be defined in IAM this user is the only user that can logon to Aurena in a fresh installed system. With this user the additional users are defined in Solution Manager | |
| ifscore.passwords.scimtextPw.name | scimtext password | scimext-pw |
| ifscore.passwords.scimtextPw.data | The password for scimtext | |
| ifscore.certificates.database.certname1 | Path to a.cer file or a key as a string The string certname1 can be named a more descriptive name |
e.g. certificates.database.dbcert: /path/to/dbcert.cer |
| ifscore.certificates.ifsapp-connect.certname2 | Path to a.cer file or a key as a string The file or string can hold many certificates to the different integration endpoints |
e.g. /path/to/cert.cer |
| ifscore.certificates.ifsapp-iam.certname3 | Path to a.cer file or a key as a string | e.g. ifsapp-iam: adcert: |
Note: The * in the Required column mean that the Mandtory/Optional is Mandatory/Optional in a combination of other parameter settings.
Parameters for DB installer and DB import¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| dbInstaller.ifsappPassword | The IFS Cloud application schema owner's password. Used when creating the application owner in prepares.sql |
|
| dbInstaller.deliveryPath | Path to DELIVERY or BUILD_HOME (this is normally passed as an argument since it should not be persisted in a ifscloud-values.yaml file.) | It default to the delivery or build home from where the installer was started. |
| ifscore.users.ifsappUser.data | If the IFS Cloud schema owner is not IFSAPP, this parameter can set a different schema owner name | defaults to IFSAPP, All new system should use IFSAPP. |
| dbInstaller.jdbcUrl | Only one of the jdbcUrl's is required. This param will win over the ifscore.secrets.jdbcUrl.data parameter. But the ifscore.secrets.jdbcUrl.data should be used if it is a simple jdbcUrl. | |
| ifscore.secrets.jdbcUrl.data | This is the default jdbcUrl used by all contaniers, it can/should also be used by the db installer. If the ifscore.secrets.jdbcUrl.data points to an Oracle RAC cluster or Oracle Dataguard the dbInstaller.jdbcUrl should be used to deploy to the DB. | |
| dbInstaller.fileName | Full path to a file to be deployed. (this is normally passed as an argument since it should not be persisted in a ifscloud-values.yaml file.) | |
| dbInstaller.sysPassword | Password for SYS user in DB. Only used when deliveryPath is set and delivery contains prepare.sql. If sysPassword not defined, prepare.sql as SYS will not be run. (this is normally passed as an argument since it should not be persisted in a ifscloud-values.yaml file.) | |
| dbInstaller.ialOwner | If the IAL schema owner is not IFSINFO, this parameter can set a different schema owner name. | defaults to IFSINFO |
| dbInstaller.extLogging | Extended logging. | defaults to N |
| dbInstaller.waitingTime | Waiting time if locked processes, | default = 3600 (one hour) |
| logFileLocation | Path to where all logs will be placed | defaults to %TEMP%/ifsinstaller_<namespace> --set logFileLocation=c:\logs |
| ifscore.passwords.ifsiamPassword.data | Password when creating the user ifsiamsys in prepares.sql | Optional values could be defined in define.tem |
| ifscore.passwords.ifssysPassword.data | Password when creating the user ifssys in prepares.sql | Optional values could be defined in define.tem |
| ifscore.passwords.ifsmonPassword.data | Password when creating the user ifsmonitoring in prepares.sql | Optional values could be defined in define.tem |
Parameters for AMM¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappamm.replicas | Sets how many containers of this type should be started | Defaults to 1 Note: this container should not have more than 1 container running. |
| ifscore.passwords.ifsmonPassword.name | ifsmon-password | ifsmon-password |
| ifscore.passwords.ifsmonPassword.data | ifsmonitoring password | |
| ifscore.passwords.ifsappmonitorPw.name | ifsappmonitor-pw | ifsappmonitor-pw |
| ifscore.passwords.ifsappmonitorPw.data | ifsappmonitor password used by AMM to do login validation tests |
Parameters for BUSMOD¶
Should only be set if component busmod is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappbusmod.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifscore.passwords.busmodAadSecret.name | busmod-aad-secret | busmod-aad-secret |
| ifscore.passwords.busmodAadSecret.data | Password for the aad | |
| ifsappbusmod.assServerName | Mandatory | The Fully qualified name of the Azure Analysis Service to connect to |
| ifsappbusmod.authService | Mandatory | The authentiction url |
| ifsappbusmod.appId | Required | The app id (client id) of the azure application registration that is linked to the service, this needs to be created before the service can be installed, this should be handled when a new customer is provisioned in azure. |
| ifsappbusmod.tenantId | Required | The Azure tenant id where the app id (client id) is created |
Parameters for Power BI Service (PBIES)¶
Should only be set if component PBIES is active
| Parameter | Required | Purpose | Examples/Defaults |
|---|---|---|---|
| ifsapppowerbisvc.replicas | Optional | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifscore.passwords.pbiesAadSecret.name | Mandatory | Name of the secret used to access Azure Active Directory (AAD) | pbies-aad-secret |
| ifscore.passwords.pbiesAadSecret.data | Mandatory | Secret to access Azure Active Directory (AAD) | |
| ifsapppowerbisvc.serviceConfigEnabled | Optional | Indicate whether the service is configured or not, if false then the readiness probe will not fail. | Default set to false |
| ifsapppowerbisvc.azureAdClientId | Required | The client id of the azure application registration that is linked to the service, this needs to be created before the service can be installed, this should be handled when a new customer is provisioned in azure. | |
| ifsapppowerbisvc.azureAdTenantId | Required | The Azure tenant id where the client id is created | |
| ifsapppowerbisvc.azureAdServicePrincipalObjectId | Required | The object id of the service principal of the Azure application registration | |
| ifsapppowerbisvc.authConfigUserNameClaim | Optional | The claim of the OpenIdConnect token to use to send in the effective identity to an SQL Server Analysis Services (SSAS) when Row Level Security (RLS) is turned on for the model | Default set to http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress |
| ifsapppowerbisvc.authConfigCustomDataClaim | Optional | The claim of the OpenIdConnect token to use to send in the effective identity to an Azure Analysis Services (AAS) when Row Level Security (RLS) is turned on for the model | Default set to http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress |
| ifsapppowerbisvc.logLevel | Optional | The minimal level of messages that needs to be logged | Default set to warn |
Parameters for SCIM¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappscim.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifscore.passwords.scimtextPw.name | scimext-pw | scimext-pw |
| ifscore.passwords.scimtextPw.data | the password |
Parameters for IAM¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappsiam.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifsappsiam.ifsadminTempPasswordEnabled | Allows the temporary flag of ifsadmin password to be disabled when setting this to false | Default: true |
| ifscore.passwords.ifsiamPassword.name | Need to be set to ifsiam-password |
predefined - should be ifsiam-password |
| ifscore.passwords.ifsiamPassword.data | This is the password for the IAM schema owner IFSIAMSYS | |
| ifscore.passwords.ifsiamAdminPw.name | Need to be set to ifsiam-admin-pw | ifsiam-admin-pw |
| ifscore.passwords.ifsiamAdminPw.data | used to logon to the iam admin portal | |
| ifscore.passwords.ifsreadonlysuppPw.data | This is the password for the readonly user. | |
| ifscore.passwords.ifsmonPassword.data | ifsmonitoring password used by AMM, but required by IAM also. | |
| ifscore.passwords.ifsappmonitorPw.data | ifsappmonitor password used by AMM to do login validation tests, but required by IAM also. |
Parameters for DOC¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappdoc.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifsappdoc.techDocUrl | URL to techdoc | Leave empty, but can be set as e.g: https://docs.ifs.com/techdocs/21r1/ |
Parameters for PROXY¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappproxy.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifsappproxy.basicAuthEnabled | true/false Allow basic authentication on integrations. |
Default: false Warning enabling basic authentication compromises system security! |
| ifsappproxy.documentationLink | Can be set to a specific Technical doc. | Leave empty, but can be set as e.g: https://docs.ifs.com/techdocs/21r1/ |
| ifsappproxy.accessLogEnabled | true/false Enable access log on proxy |
Default: true |
| ifsappproxy.logLevel | sets the proxy server error log level. | Default: warn Valid values are debug, info, notice, warn, error, crit, alert, emerg. NOTE: anything other than those above will stop proxy server starting. |
Parameters for ODATA¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappodata.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifsappodata.logLevel | sets the oData server error log level. | Default: warn Valid values are debug, info, notice, warn, error, crit, alert, emerg. NOTE: anything other than those above will stop proxy server starting. |
Parameters for APPLICATIONSVC¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappapplicationsvc.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for CLIENT¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappclient.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for CLIENT SERVICES¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappclientservices.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for CLIENT NOTIFICATION¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappclientnotification.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for NATIVEODATA¶
Should only be set if component fndmob is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappnativeodata.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for NATIVESERVER¶
Should only be set if component fndmob is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappnativeserver.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for CONNECT¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappconnect.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifsappconnect.enterpriseId | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for REM¶
Should only be set if component fndrem is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsapprem.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifsapprem.entp_id | Sets the enterprice id | Mandatory if replicas >0 |
Parameters for RMPANEL¶
Should only be set if component rmpanl is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsapprmpanel.replicas | Sets how many containers of this type should be started | Defaults to 1 Note: this container should not have more than 1 container running. |
Parameters for CRT¶
Should only be set if component fndcrt is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappcrt.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifsappcrt.realm | Set the Realm of the CRT | |
| ifscore.passwords.ifsappcrtPassword.name | Optional if component fndcrt is active If set, must be set to: ifscrt-password |
ifscrt-password |
| ifscore.passwords.ifsappcrtPassword.data | Mandatory if component fndcrt is active The CRT password |
|
| ifscore.passwords.ifsappcrtRootCaPassword.name | Optional if component fndcrt is active If set, must be set to: ifscrt-root-ca-pk-pw |
ifscrt-root-ca-pk-pw |
| ifscore.passwords.ifsappcrtRootCaPassword.data | Mandatory if component fndcrt is active The password for the root CA private key |
|
| ifscore.passwords.ifsappcrtIssueCaPassword.name | Optional if component fndcrt is active If set, must be set to: ifscrt-issue-ca-pk-pw |
ifscrt-issue-ca-pk-pw |
| ifscore.passwords.ifsappcrtIssueCaPassword.data | Mandatory if component fndcrt is active The password for the issuer CA private key |
|
| ifscore.passwords.ifsappcrtDataVaultPassword.name | Optional if component fndcrt is active If set, must be set to: ifscrt-data-vault-pw |
ifscrt-data-vault-pw |
| ifscore.passwords.ifsappcrtDataVaultPassword.data | Mandatory if component fndcrt is active The password for the CRT Data Vault |
Parameters for CRT Services¶
Should only be set if component fndcrt is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappcrt.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for REPORTING¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappreporting.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
| ifscore.generatedSecrets.symmetricKey.data | Sets a key for encrypting reporting secrets in the IFS Cloud database. If this parameter is not passed a ramdom key will be generated. Note if this key is lost the reporting passwords need to be reentered in solution manager again, since the key is the only way to decrypt the secrets. That said - the parameter is more or less Mandatory. | e.g. 2a6f434d2f0689029b7da6856ca4ad11 |
Parameters for REPORTINGBR¶
Should only be set if component brbase is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappreportingbr.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for REPORTINGCR¶
Should only be set if component crystl is active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappreportingcr.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for REPORTINGREN¶
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsappreportingren.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for IFSMAINTENIXREPORTSERVER¶
Should only be set if component MXCORE is active.
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsmaintenixreportserver.replicas | Sets how many containers of this type should be started | Always set to 1 |
| ifsmaintenixreportserver.keycloakReportSuperAdminUser | The Keycloak admin user used for Jasper report | |
| global.customContainerRegistry | A url of a custom docker container registry where Maintenix customized containers can be fetched from. Note: Always append a trailing slash. Note: the https:// is not part of the FQDN |
|
| global.customImageCredentials.username | The service principal user name. Customer project provide user. | |
| global.customImageCredentials.password | The service principal password. This password should be provided by customer project | |
| ifsmaintenixreportserver.customRegistryEnabled | Defaults to false - if true the Maintenix image will be fetched from the customContainerRegistry | |
| ifsmaintenixreportserver.imageVersion | The custom Image version |
Parameters for IFSMAINTENIXAPPSERVER¶
Should only be set if component MXCORE is active.
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsmaintenixappserver.replicas | Sets how many containers of this type should be started | Always set to 1 |
| ifscore.passwords.ifsmtxappPassword.name | Optional if component mxcore is active If set, must be set to: ifsmtxapp-password |
ifsmtxapp-password |
| ifscore.passwords.ifsmtxappPassword.data | Mandatory if component mxcore is active The password for mtx schema owner in the DB |
|
| ifscore.passwords.ifsmtxreportPassword.name | Optional if component mxcore is active If set, must be set to: ifsmtxapp-password |
ifsmtxapp-password |
| ifscore.passwords.ifsmtxreportPassword.data | Mandatory if component mxcore is active The password for mtx report schema owner in the DB |
|
| global.customContainerRegistry | A url of a custom docker container registry where Maintenix customized containers can be fetched from. Note: Always append a trailing slash. Note: the https:// is not part of the FQDN |
|
| global.customImageCredentials.username | The service principal user name. Customer project provide user. | |
| global.customImageCredentials.password | The service principal password. This password should be provided by customer project | |
| ifsmaintenixappserver.customRegistryEnabled | Defaults to false - if true the Maintenix image will be fetched from the customContainerRegistry | |
| ifsmaintenixappserver.imageVersion | The custom Image version | e.g. 2021-06-06.1234.1 |
| ifsmaintenixappserver.maintenixDbId | Optional if component mxcore is active. The distributed nature of the Maintenix for DiSCOPS component to identify different databases. |
Set Maintenix database ID of the target Database’s MIM_LOCAL_DB table’s DB_ID field |
Parameters for IFSFORECAST¶
Should only be set if component fltplnis active
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| ifsforecast.replicas | Sets how many containers of this type should be started | Default set to global.replicas parameter |
Parameters for IFS Analysis Models¶
Will only be valid if component tabmfw is active.
Note that only the names mentioned below should be used. Only data can have custom values.
| Parameter | Purpose | Examples/Defaults |
|---|---|---|
| Oracle Related Parameters | ||
| ifscore.secrets.ifsamIfsDataSource.name | IFS Cloud Database Information | am-ifs-data-src |
| ifscore.secrets.ifsamIfsDataSource.data | HOST:PORT/SID | e.g. ifsdbhost:1521/ifs |
| ifscore.secrets.ifsamIfsinfoUsername.name | IFS Cloud Information Schema Username | am-ifsinfo-un |
| ifscore.secrets.ifsamIfsinfoUsername.data | Same as dbInstaller.ialOwner | e.g. IFSINFO |
| ifscore.passwords.ifsamIfsinfoPassword.name | IFS Cloud Information Schema Password | am-ifsinfo-pwd |
| ifscore.passwords.ifsamIfsinfoPassword.data | Refer IAL_OWNER_PASSWORD from Define.tem | |
| SQL Server Related Parameters | ||
| ifscore.secrets.ifsamSqlServerType.name | Installation type of SQL Server | am-sql-srv-type |
| ifscore.secrets.ifsamSqlServerType.data | ON_PREMISE / AZURE | e.g. ON_PREMISE |
| ifscore.secrets.ifsamSqlServerName.name | SQL Server Host Name | am-sql-srv-name |
| ifscore.secrets.ifsamSqlServerName.data | ON_PREMISE : sqlhostserver.mydomain.com AZURE : sqlhostserver.db.win.net Mandatory |
e.g. sqlhostserver.mydomain.com |
| ifscore.secrets.ifsamSqlServerDbName.name | SQL Server Database for IFS Cloud DW | am-sql-db-name |
| ifscore.secrets.ifsamSqlServerDbName.data | Mandatory | |
| ifscore.secrets.ifsamSqlServerAgentJobName.name | SQL Server Agent Job Used for Running SSIS Packages | am-sql-agent-name |
| ifscore.secrets.ifsamSqlServerAgentJobName.data | Mandatory for ON_PREMISE ifsamSqlServerType installations only | |
| ifscore.secrets.ifsamSqlServerUsername.name | SQL Server Username (SQL Server Authentication) | am-sql-un |
| ifscore.secrets.ifsamSqlServerUsername.data | Mandatory | |
| ifscore.passwords.ifsamSqlServerPassword.name | SQL Server Password (SQL Server Authentication) | am-sql-pwd |
| ifscore.passwords.ifsamSqlServerPassword.data | Mandatory | |
| SSIS Related Parameters | ||
| ifscore.secrets.ifsamSqlServerSsisDbName.name | SQL Server Database for SSIS | am-sql-ssisdb-name |
| ifscore.secrets.ifsamSqlServerSsisDbName.data | Mandatory | e.g. SSIDDB |
| ifscore.secrets.ifsamSsisProjectName.name | SQL Server Integration Services Catalog Project Name | am-ssis-proj-name |
| ifscore.secrets.ifsamSsisProjectName.data | Mandatory. This is a static value. | IFSCloudAnalysisModelsSSISFramework |
| ifscore.secrets.ifsamSsisFolderName.name | SQL Server Integration Services Catalog Folder Name | am-ssis-fold-name |
| ifscore.secrets.ifsamSsisFolderName.data | Mandatory | |
| SSAS Related Parameters | ||
| ifscore.secrets.ifsamSsasServerName.name | SQL Server Analysis Services Host Name | am-ssas-srv-name |
| ifscore.secrets.ifsamSsasServerName.data | ON_PREMISE : sqlhostserver.mydomain.com AZURE : asazure://region.asazure.win.net Mandatory |
e.g. sqlhostserver.mydomain.com |
| ifscore.secrets.ifsamSsasUsername.name | SQL Server Analysis Services Username (Windows Integrated Authentication based user for SQL Server Analysis Services on-prem / Azure AD user for Azure Analysis Services) |
am-ssas-un |
| ifscore.secrets.ifsamSsasUsername.data | Mandatory | |
| ifscore.passwords.ifsamSsasPassword.name | SQL Server Analysis Services Password | am-ssas-pwd |
| ifscore.passwords.ifsamSsasPassword.data | Mandatory |