Migration of Activities to Huddo Boards (with Component Pack)¶
Tip
If you are not using Component Pack please follow this guide
As part of the installation process for Huddo Boards (Activities Plus) you must run the migration service to move the existing Activities into Huddo Boards.
Info
Please review the Roles page for details on how Community Activity membership is interpreted & presented by Boards
Process Overview¶
This service will:
- access Activities data in the existing Connections SQL database
- process the Activity into a Board
- get file attachments and long descriptions via mounting the Connections shared drive
- write Boards data into the Component Pack mongo database
- write file attachments into S3 storage
Ensure you have updated the following variables as applicable in your boards-cp.yaml
file downloaded previously
Example | Description | |
---|---|---|
sharedDrive.server |
192.168.10.1 or websphereNode1 |
IP or Hostname of the server with the Connections shared drive mount |
sharedDrive.path |
/opt/HCL/Connections/data/shared or /nfs/data/shared |
Path on the mount to the Connections shared drive |
sharedDrive.mountOptions |
-nfsvers=4.1 (optional) |
Any additional sharedDrive mountOptions. All yaml is passed through drive |
sharedDrive.storage |
10Gi (optional) |
The capacity of the PV and PVC |
sharedDrive.accessMode |
ReadOnlyMany (optional) |
The accessMode of the PV and PVC |
sharedDrive.volumeMode |
Filesystem (optional) |
The volumeMode of the PV and PVC |
sharedDrive.persistentVolumeReclaimPolicy |
Retain (optional) |
The persistentVolumeReclaimPolicy of the PV and PVC |
sharedDrive.storageClassName |
manual (optional) |
The storageClassName of the PV and PVC - useful for custom spec (e.g. hostPath) |
sharedDrive.spec |
See below | Using a fully custom spec - e.g. FlexVolume or hostPath |
env.FILE_PATH_ACTIVITIES_CONTENT_STORE |
/data/activities/content |
Path of the Activities content store relative to the Connections shared drive.Must start with /data as the Connections shared drive is mounted at /dataEnsure you set the IP and path for the NFS volume mount. |
env.API_GATEWAY |
https://[CONNECTIONS_URL]/api-boards |
URL of the Boards API.Used by files attached to a board. URL. |
env.TZ |
Europe/London or Australia/Hobart etc |
'Local' TimezoneUsed for date interpretation. See full list of supported timezones |
env.CONNECTIONS_ACTIVITIES_ADMIN_USERNAME |
connectionsadmin |
Credentials for user with admin role on the Activities application.See ISC => Applications => Activities => Security role to user mapping |
env.CONNECTIONS_ACTIVITIES_ADMIN_PASSWORD |
adminpassword |
Password for the Activities administrator |
env.CONNECTIONS_DB_TYPE |
db2 or mssql or oracle |
SQL database type hosting Activities. |
env.CONNECTIONS_DB_HOST |
dbserver.company.com |
SQL Server hostname |
env.CONNECTIONS_DB_PORT |
50000 or 1433 or 1531 |
SQL Server connection port |
env.CONNECTIONS_DB_USER |
dbuser |
SQL Server user name |
env.CONNECTIONS_DB_PASSWORD |
dbpassword |
SQL Server user password |
env.CONNECTIONS_DB_SID |
DATABASE |
SQL Server SIDNote: applicable to Oracle |
env.CONNECTIONS_DB_DOMAIN |
domain |
SQL Server connection stringNote: applicable to Microsoft SQL |
env.CONNECTIONS_DB_CONNECT_STRING |
HOSTNAME=<host>;PROTOCOL=... or <host>:<port>/<sid> |
SQL Server connection stringNote: OptionalDefault is built from other values.Only applicable to DB2 and Oracle |
env.PROCESSING_PAGE_SIZE |
10 (default) |
Number of Activities to process simultaneously. Value must not exceed the connection pool size supported by the SQL database |
env.PROCESSING_LOG_EVERY |
50 (default) |
The migration process logs every 50 Activities completed |
env.IMMEDIATELY_PROCESS_ALL |
false (default) |
Process ALL Activities on service startup. |
env.COMPLETE_ACTIVITY_AFTER_MIGRATED |
false |
Mark the old Activity data as complete |
env.CREATE_LINK_IN_ACTIVITY_AFTER_MIGRATED |
false |
Create link to new Board in old Activity |
Custom Persistent Volume¶
The default chart values use an NFS mount. Below are examples custom configuration of the persisent volume definition for access to the Shared Drive using other methods.
Note
We recommend running the helm chart with --dry-run --debug
to confirm the yaml output
-
Host path
Tip
This can be used in conjunction with existing linux methods (e.g.
cifs-utils
,smbclient
etc) to mount a Windows Samba share directly onto the Kubernetes Node(s).Please read the Kubernetes documentation.
migration: sharedDrive: storageClassName: manual spec: hostPath: path: /data/shared
-
Kubernetes CIFS Volume Driver (for Samba shares).
Please read the CIFS documentation
migration: sharedDrive: spec: flexVolume: driver: juliohm/cifs options: opts: sec=ntlm,uid=1000 server: my-cifs-host share: /MySharedDirectory secretRef: name: my-secret
Additional for Windows
This migration is designed to be a once-off operation. If you are using Windows SMB shares and neither option above is appropriate for your environment, we would recommend:
- Temporarily copy the Activity Store content directory at
<SHARED_DRIVE>/activities/content
(e.g./opt/HCL/connections/data/shared/activities/content
) to an existing Linux accessible drive (e.g./pv-connections/activitystore
). - Set the standard
sharedDrive.server
&sharedDrive.path
to mount this path at/data
in the containers - Set
migration.env.FILE_PATH_ACTIVITIES_CONTENT_STORE: "/data"
Deploy Helm Chart¶
Please deploy the following chart with the same configuration boards-cp.yaml
file used to deploy the huddo-boards-cp chart
helm upgrade huddo-boards-cp-activity-migration https://docs.huddo.com/assets/config/kubernetes/huddo-boards-cp-activity-migration-1.0.0.tgz -i -f ./boards-cp.yaml --namespace connections --recreate-pods
Note: the configuration file has changed as of the v3 chart. Please add the new
sharedDrive
parameters described above
Migrate Activities¶
The migration interface is accessible at https://[CONNECTIONS_URL]/boards/admin/migration
to select which Activities to migrate (ie ignore completed/deleted). For some explanation of the interface, see Activity Migration User Interface.
You can also set the env.IMMEDIATELY_PROCESS_ALL
if you wish to migrate every Activity without the UI.
Logs¶
You can check the pod logs for the activity-migration to see progress of the running migration
For example
After Migration Complete¶
-
The Migration service can be removed. Please use the following command
helm delete huddo-boards-cp-activity-migration --purge
-
Turn off the Activities application in WebSphere ISC