Updating the Activities Plus configuration file
This topic guides as you replace variables in the boards-cp.yaml file with values appopriate for Activities Plus in the Component Pack environment.
Before you begin
Locate the file boards-cp.yaml in - [extractedFolder]/microservices_connections/hybridcloud/support/kudosboards
About this task
The following is the default network configuration (SSL/Network setup):
- BOARDS_URL:
connections_url/boards
For example, connections.example.com/boards
- API_GATEWAY:
connections_url/api-boards
For example, connections.example.com/api-boards
These values will be used throughout this documentation on integrating Activities Plus with Component Pack.
Note: Activities Plus uses the Mongo database already deployed inside the Component Pack.
There is no configuration required for Mongo.
Procedure
Edit the setttings in your boards-cp.yaml so that the values match
those in the following sample file. Remove any settings not included here.
Note: Activities Plus (Kudos Boards) is a free entitlement. However, it requires a licence
key; instructions for obtaining it are included (as a comment) in the sample.
# Please read every variable and replace with appropriate value # For details of variable meanings, please see https://docs.kudosapps.com/boards/cp/ global: repository: <name_of_your_Docker_Registry:port>/connections # Do not Change this value for 6.5 CR1 imageTag: 20200306-180701 # Do not Change this value for 6.5 CR1ß imagePullSecret: myregkey env: APP_URI: https://[BOARDS_URL] minio: # useDockerHub: true - gets the docker minio image from DockerHub (needs internet access) # useDockerHub: false - default, gets the docker minio image from Component Pack zip (local) # useDockerHub: true/false nfs: server: <your_NFS_server_ip> webfront: env: API_GATEWAY: https://[CONNECTIONS_URL]/api-boards ingress: # This hostname must match other Ingresses defined in your CP environment # If all ingresses start with * you must match the pattern, or all traffic will be routed to Boards and everything will break # Run: kubectl get ingresses --all-namespaces (check the HOSTS column and use the value below for hosts:) hosts: - "*.example.com" core: env: # SMTP gateway setup (uncomment) for email notifications if required # NOTIFIER_EMAIL_HOST: <smtp.example.com> # NOTIFIER_EMAIL_USERNAME: <username> # NOTIFIER_EMAIL_PASSWORD: <password> # APP_NAME: Kudos Boards (Used for all notifications, e.g. Orient Me) # NOTIFIER_EMAIL_FROM_NAME: Kudos Boards # NOTIFIER_EMAIL_FROM_EMAIL: <boards@connections.example.com> ingress: # This hostname must match other Ingresses defined in your CP environment # If all ingresses start with * you must match the pattern, or all traffic will be routed to Boards and everything will break # Run: kubectl get ingresses --all-namespaces (check the HOSTS column and use the value below for hosts:) hosts: - "*.example.com" licence: env: # Register your Organisation and download your Free 'Activities Plus' licence key from store.kudosapps.com LICENCE: https://docs.kudosapps.com/boards/cp/store/ # https://docs.kudosapps.com/boards/msgraph/teams-on-prem/ # Uncomment/configure the following 3 lines if you are using this Kudos Boards deployment from Microsoft Teams # provider: # env: # MSGRAPH_TEAMS_APP_ID: app-id-shown-in-teams-url user: env: # CONNECTIONS_NAME: HCL Connections CONNECTIONS_CLIENT_ID: kudosboards CONNECTIONS_URL: https://[CONNECTIONS_URL] # setup an OAuth application with HCL Connctions (provider)) for Kudos Boards CONNECTIONS_CLIENT_SECRET: [CLIENT_SECRET] CONNECTIONS_ADMINS: "[\"<ADMIN_EMAIL>\"]" # set following parameters if you're migrating existing activities migration: env: API_GATEWAY: https://[CONNECTIONS_URL]/api-boards CONNECTIONS_ACTIVITIES_ADMIN_USERNAME: [ADMIN_USER] CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD: [ADMIN_PASSWORD] CONNECTIONS_DB_HOST: [DB_SERVER] CONNECTIONS_DB_USER: db2inst1 CONNECTIONS_DB_PASSWORD: [DB_PASSWORD] # -------- DB2 variables ------------ CONNECTIONS_DB_TYPE: db2 CONNECTIONS_DB_PORT: 50000 # Connection string is built from other variables: # CONNECTIONS_DB_CONNECT_STRING: HOSTNAME=${host};PORT=${port};PROTOCOL=TCPIP;UID=${user};PWD=${password};CHARSET=UTF8; # -------- Microsoft variables ------- # CONNECTIONS_DB_TYPE: mssql # CONNECTIONS_DB_PORT: 1433 # CONNECTIONS_DB_DOMAIN: domain # -------- Oracle variables ---------- # CONNECTIONS_DB_TYPE: oracle # CONNECTIONS_DB_PORT: 1531 # CONNECTIONS_DB_SID: DATABASE # Connection string is built from other variables: # CONNECTIONS_DB_CONNECT_STRING: ${host}:${port}/${sid} # -------- Other options ------------- # PROCESSING_PAGE_SIZE: 10 # PROCESSING_LOG_EVERY: 50 # IMMEDIATELY_PROCESS_ALL: false # COMPLETE_ACTIVITY_AFTER_MIGRATED: false # CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED: false