Versions Compared

Old Version 42

changes.mady.by.user Raparthi Kalyan

Saved on

compared with

New Version 43

changes.mady.by.user Raparthi Kalyan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The docker-compose.yaml which you downloaded requires some environmental variables to function .

please update the Environmental Variable mentioned for various containers.

All conatiners containers marked in RED are mandatory, rest are optional and needed only if respective tools are in use.

KnowHOW Specific Variables

MongoDB service

NOTE: NO need to update if you are upgrading the Knowhow

  • MONGO_INITDB_ROOT_USERNAME=<DB ROOT USER> (used for DDL comands within the application.)

  • MONGO_INITDB_ROOT_PASSWORD=<DB ROOT PASSWORD>(password for admin user)

  • MONGODB_APPLICATION_USER=<DB READ/Write User>

  • MONGODB_APPLICATION_PASS=<DB READ/WRITE PASSWORD>

CustomAPI

  • forgotPassword.uiHost=<DNS > (DNS of the Knowhow server)

  • corsFilterValidOrigin=<DNS> (DNS of the Knowhow server)

  • versionnumber=<Current version installed>

  • spring.data.mongodb.uri=<pass mongo db connection url in this format mongodb://<DB USER NAME>:<DB PASSWORD>@mongodb:27017/kpidashboard> Special char need to converted eg “@" is %40

  • aesEncryptionKey=<aesEncryptionKey>(this is the passphrase for generating AES key, this can not be changed during lifetime of application)
    (min lenght - 8, sample value - 7DLHllMii14pId0FSSwGWwtga5dckGHW)

  • auth.secret=<auth secret>(this the passphrase used to generate sign jwt token)
    (min length -4, sample value - C0GNAIDS8upDNnkE)

  • isRepoToolEnable= <true for repotool(developer tab) enable or false for repotool disable>

  • JAVA_OPTS= <configuring Java runtime settings>

  • auth.subDomainCookie= <true for Auth service enable and false for Auth service disable>

  • auth.domain= <auth service is on then added to parent domain(required only when auth.subDomainCookie=true)>

  • auth.centralAuthBaseURL= <central Auth Backend DNS(required only when auth.subDomainCookie=true)>

  • exposed_api_key= < api key for the exposed kpi like repo tool, sample value:UvcP8HOTwcJVFR4DYVZZwwSh5p6dVue7DExY6m0nblPSIYGCl1K/c89oQMVD2nVqN1N443vkDofkROBFiHjDxw==> (required only when isRepoToolEnable=true)

  • auth.resourceAPIKey= <resource api key for the Auth Service API used in Knowhow BE> You have to generate API Key - follow mention Steps Sample Value - BKQI07DExY6m0nblPSIYGCentral AUTH Service (required only when running central auth)

  • mongock.start-system-version=<current version> in case of upgrade
    mongock.end-system-version=9.x.x in case of upgrade
    mongock.migration-scan-package=com.publicissapient.kpidashboard.apis.mongock.upgrade in case u are upgrading

  • mongock.migration-scan-package=com.publicissapient.kpidashboard.apis.mongock.installation in case of fresh installation

  • mongock.end-system-version=9.x.x in case of fresh installation

...

  • spring.data.mongodb.uri=<pass mongo db connection url in this format “mongodb://<DB USER NAME>:<DB PASSWORD>@mongodb:27017/kpidashboard“>

  • aesEncryptionKey=<aesEncryptionKey>(same Key as defined in CustomAPI)

AuthnAuth Specific Variables: Use Only When Deploying Knowhow with Auth Application

Authdb:

  • POSTGRES_USER=<DB ROOT USER>(Specify the Postgres user name)

  • POSTGRES_PASSWORD=<DB ROOT PASSWORD>(Specify the Postgres user password)

  • POSTGRES_DB=authNauth

  • HOST=<Host IP> Pass the host IP when running as docker

authnauth:

  • auth.baseUrl=https://<Central auth UI DNS url>

  • auth.baseUiUrl=<Knowhow UI https://<Central auth UI DNS url>

  • auth.secret=<auth secret>(this the should be same passphrase used to generate sign jwt token )
    (min length -4, sample value - C0GNAIDS8upDNnkEin customapi)

  • forgotPassword.uiHost=https://<Central auth UI DNS > url>

  • auth.corsFilterValidOrigin=https://<Central auth UI DNS> DNS url>

  • spring.datasource.url=jdbc:postgresql://<Auth DB service/container name>:<Port>/authNauth

  • spring.datasource.username=authdb

  • spring.datasource.password= < postgres db passowrd>

  • spring.kafka.producer.bootstrap-servers= <kafka service/container name>

  • spring.kafka.consumer.bootstrap-servers= <kafka end point>service/container name:port>

  • KAFKA_CFG_ZOOKEEPER_CONNECT= <zookeeper service/container name:port>

  • ZOO_SERVERS=<zookeeper service/container name:port>

  • flag.mailWithoutKafka= <true for the smtp or false for the kafka>

  • auth.domain= <auth service is on then added <Add to parent domain> example: tools.publicis.sapient.com

  • For SAML Integration SAML Integration Flow As per flow Update flow SAML details

  • auth.holdingEntityId= <SAML Entity ID>

  • auth.assertingEntityId = <SAML Url of the tenent ID>

  • auth.alias = <alias of the saml>

  • auth.samlLoginUrl= <login url saml>

authnauth-ui:

  • REACT_APP_DNS=https://<Central Auth UI Url>

  • DNS_SSL=<Kowhow UI DNS >https://<Central Auth UI Url>

  • REACT_APP_PSKnowHOW=https://< Knowhow UI Url>

SCM tool:

PostgreSQL config:

POSTGRES_USER=<Postgres user name>
POSTGRES_PASSWORD= <postgres db password>
POSTGRES_DB=debbie

...