Installation and upgrade

Experienced customers can download a package to do an automated installation or upgrade of Component Pack for HCL Connections. It is best for new customers to read this introduction and at least initially to do the manual steps in this section to gain a better understanding of Component Pack.

Ansible automation option provided by HCL

Starting with version 7, HCL Software is providing Ansible automation tested in house as a preferred way of setting up Component Pack and its dependencies. If you don't have any experience with managing Kubernetes and its dependencies, or you simply want to see what the automation experience looks like, you can use the Ansible package to create your first single-node or distributed Component Pack cluster. This automation will, from Component Pack point of view, set up Kubernetes, kubectl, Helm, Docker Registry, and execute all the needed steps.

For more specifics on how to use the automation, see HCL's open-source GitHub for the documents Quickstart for Setting Up HCL Connections and Component Pack Using Ansible Automation and HCL Connections and Component Pack Automation Scripts.

Replacing Component Pack

Component Pack runs on top of the Kubernetes, and for important data uses persistent storage. That storage lives, in a supported way, on NFS or Amazon EFS, if you are running stuff on Amazon, so your data should be already safe.

It is possible to simply recreate Kubernetes cluster and reinstall Component Pack and simply continue using it with the data as where you left it before you did it. Removing Component Pack and/or Kubernetes doesn't affect your data at all. Just don't remove the data.

In theory, you can have multiple Kubernetes clusters with multiiple installations of Component Pack, and on Connections side, by manipulating httpd.conf in your IHS, you can decide to which one to point to. Just don't try to have multiple clusters using same PVs at the same time for the sake of data consistency and reliability.

Installation and upgrade general approch

You will notice that we are going to use the same commands to install or upgrade Component Pack. The approach and syntax are Helm v2 compatible, but it is still best to use Helm v3. See the link at the end of this page for details.

Order of installation

Here is a high-level checklist of the tasks involved installing Component Pack in a logical order:

  • First, install or upgrade HCL Connections.
  • Ensure that you have NFS up and running. Ensure that you have a proper set of folders there with specific permissions. Ensure that is also exported and mountable from all Kubernetes nodes
  • Download your Component Pack installation package into a folder. Ensure that on the machine from which you want to execute the installation you also have kubectl and helm configured and working properly.
    Note: For the Component Pack refresh that is part of the Connections post-7.0 update, download Component Pack 7.0.0.1 from the HCL License & Delivery Portal.
  • Go to component_pack_installation_folder/hybridcloud/support and from there run your setupImages.sh, which will push all the images from the component_pack_installation_folder/hybridcloud/images to your Docker Registry
  • Create the credentials for your Docker Registry so that your Kubernetes workers can authenticate to it and pull the images when needed.
  • Set up pod security policies
  • Set up persistent volumes and persistent volume claims for Component Pack
  • Run bootstrap, which will create the secrets and certificates needed to proceed with Component Pack installation
  • Set up connections-env config map
  • Install infrastructure charts
  • Install Customizer charts
  • Install Elasticsearch
  • Set up Nginx ingress controller and rules
  • Set up Microsoft Teams integration
  • Install community creation wizard and templates (Tailored Experience) charts
  • Set up Orient Me and run user migration from the Connections database to MongoDB
  • Set up Activities Plus
  • Set up Microsoft Outlook Add-in
  • Enable Metrics with Elasticsearch
  • Enable Microsoft Teams integration