Updating the Activities Plus configuration file

This topic guides as you replace variables in the boards-cp.yaml file with appropriate values.

Before you begin

Activities Plus (Kudos Boards) is a free entitlement. However, it requires a licence key, which you can obtain at the Kudos Apps Store.

Activities Plus uses the Mongo database already deployed inside the Component Pack. There is no configuration required.

About this task

Important: Make sure that you check every variable in the file.

Procedure

  1. Locate the file boards-cp.yaml in - [extractedFolder]/microservices_connections/hybridcloud/support/kudosboards
  2. Update Kubernetes variables as follows.
    Table 1. Kubernetes variables and value descriptions
    Key Value description
    global.repository <name_of_your_Docker_Registry:port>/connections
    global.imageTag 20191120-214007
    Important: Do not change this value.
    imagePullSecret myregkey
    Important: Do not change this value.
    global.env.APP_URI

    https://[BOARDS_URL] (for example, connections.example.com/boards)
    webfront.ingress.hosts

    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 this command: 
    kubectl get ingresses --all-namespaces
    core.ingress.hosts

    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 this command: 
    kubectl get ingresses --all-namespaces
    useDockerHub true
    Important: Set this value only if you have internet access. If set to true, useDockerHub attempts to get Docker images from an external Docker Registry.

    If there is no internet access, remove the useDockerHub variable, so that the image is pulled from the local Docker Registry. For more information, see the article Update Activities Plus helm chart to latest on the HCL Customer Support site.
    minio.nfs.server

    IP address of the NFS Server file mount (for example, 192.168.10.20)
  3. Update Activities Plus variables as follows:
    Table 2. Activities Plus variables and value descriptions
    Key Value description
    webfront.env.API_GATEWAY https://[CONNECTIONS_URL]/api-boards
    core.env.NOTIFIER_EMAIL_HOST MTP gateway hostname (smtp.ethereal.com)
    core.env.NOTIFIER_EMAIL_USERNAME Optional: SMTP gateway authentication. Setting a value will enable authentication and the default port to 587.
    core.env.NOTIFIER_EMAIL_PASSWORD Optional: SMTP gateway authentication password
    core.env.NOTIFIER_EMAIL_PORT Optional: SMTP gateway port.
    core.env.NOTIFIER_EMAIL_FROM_NAME

    Optional: Emails are sent from this name.

    Default: Kudos Boards
    core.env.NOTIFIER_EMAIL_FROM_EMAIL

    Optional: Emails are sent from this email address.

    Default: no-reply@kudosboards.com
    core.env.NOTIFIER_EMAIL_SUPPORT_EMAIL

    Optional: Support link shown in emails.

    Default: support@kudosboards.com
    core.env.NOTIFIER_EMAIL_HELP_URL

    Optional: Help link shown in new user welcome email.

    Default: https://docs.kudosapps.com/boards/howto/knowledgebase/
    provider.env.WIDGET_ID Optional: ID of the Community widget configured in this step
    user.env.CONNECTIONS_NAME Optional: If you refer to Connections by another name, set it here.
    user.env.CONNECTIONS_CLIENT_ID oAuth client-id, usually kudosboards
    user.env.CONNECTIONS_CLIENT_SECRET oAuth client-secret as configured in Registering an OAuth application with a provider
    user.env.CONNECTIONS_URL Connections URL, for example, https://connections.example.com
  4. If you are migrating Connections Activities data to Activities Plus, you must also update the migration variables. For information on migration variables and descriptions, see the table in Migration of Activities in the Kudos Docs help.