Kudos Boards for HCL Connections CP¶
Deploying Kudos Boards into HCL Connections Component Pack (Kubernetes)
Prerequisites¶
- HCL Component Pack is installed and running
- WebSphere environment with Web Server (or another reverse proxy)
- kubectl is installed
- helm is installed
- SMTP gateway setup for email notifications if required
SSL / Network setup¶
Kudos Boards in Connections Component Pack (CP) uses the existing CP infrastructure.
The UI and API each require a unique route:
- UI for Boards:
[CONNECTIONS_URL]/boards. We will refer to this asBOARDS_URL - API Gateway:
[CONNECTIONS_URL]/api-boards. We will refer to this asAPI_URL
For more details on configuring an IBM HTTP WebServer as reverse proxy, please see here
Setup OAuth¶
You will need to setup an OAuth application with one (or more) of these providers for Kudos Boards to function. please refer to the following documentation:
| Provider | Registration / Documentation | Callback URL |
|---|---|---|
| HCL Connections (on premise) |
Kudos instructions | https://[CONNECTIONS_URL]/boards/auth/connections/callback |
| Microsoft Office 365 | Kudos instructions | https://[CONNECTIONS_URL]/boards/auth/msgraph/callback |
Configure kubectl¶
| Instructions | |
|---|---|
| Kubernetes | copy ~/kube/.config from the Kubernetes master server to the same location locally(backup any existing local config) |
Storage¶
S3¶
Kudos Boards for Component Pack deploys a Minio service. Please follow S3 storage details here to configure the NFS mount.
Mongo¶
Kudos Boards uses the Mongo database already deployed inside the Component Pack. There is no configuration required.
Licence Key¶
Kudos Boards / Activities Plus is a free entitlement however it requires a licence key from https://store.kudosapps.com. For more details see here.
Update Config file¶
Download our config file and update all the values inside. Descriptions as below.
Kubernetes variables:
| Key | Description |
|---|---|
global.env.APP_URI |
https://[BOARDS_URL] (e.g. https://connections.example.com/boards) |
webfront.ingress.hosts |
[CONNECTIONS_URL] (no protocol, e.g. connections.example.com) |
core.ingress.hosts |
[API_URL] (no protocol, e.g. connections.example.com/api-boards) |
minio.nfs.server |
IP address of the NFS Server file mount (e.g. 192.168.10.20) |
Boards variables:
Are detailed here.
Activity migration variables:
The Activity migration chart will be deployed separately but use the same config file. The variables are described here.
Deploy Boards Helm Chart¶
Install the Boards services via our Helm chart
Note:
--recreate-podsensures all images are up to date. This will cause downtime.
helm upgrade kudos-boards-cp [PATH_TO_HELM_CHARTS]/kudos-boards-cp-1.0.0.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods
Where [PATH_TO_HELM_CHARTS] is the file path to the helm charts, ie
[extractedFolder]/microservices_connections/hybridcloud/helmbuilds/
For example:
helm upgrade kudos-boards-cp ./microservices_connections/hybridcloud/helmbuilds/kudos-boards-cp-1.0.0.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods
Add Proxy Config¶
Connections On Premise - update WAS config¶
in the linked document you should use the IP of your kubernetes manager and the http port for your ingress (32080 for default component pack installs)
Please follow these instructions
Integrations¶
HCL Connections¶
Microsoft Teams¶
Migrate Activities data¶
Please follow the instructions here