Installing Component Pack services
Prepare the installation of the Component Pack for HCL Connections™ by determining which Helm charts you need for the deployment.
Before you begin
Before you start the installation, verify that the following requirements have been satisfied:
-
All Prerequisites for Component Pack are in place.
- An ImagePullSecret called
myregkey
must be created if you are using a private Docker registry (see Prerequisites for Component Pack); otherwise pods will fail to start with the error: ErrImagePull -
All persistent volumes are configured.
-
Your Connections deployment is running.
-
All Component Pack servers can reach the Connections servers.
About this task
Component Pack for Connections consists of four offerings: Orient Me, Elasticsearch, Customizer, and Activities Plus. Each offering is delivered as a set of Docker images and the Helm charts for installing them; these are all included in the Component Pack installation package. Table 1 shows which Helm charts are required for each offering (a check mark indicates a required Helm chart).
Helm chart |
Customizer | Elasticsearch | Orient Me | Activities Plus |
---|---|---|---|---|
connections-env |
||||
bootstrap |
||||
infrastructure |
||||
mw-proxy |
||||
elasticsearch |
Recommended* | |||
orientme |
||||
cnx-ingress |
||||
kudos-boards-cp |
||||
*It is best to use Elasticsearch as the storage and retrieval service for Orient Me Top Updates. Otherwise, Solr is used by default. |
Table 2 describes the optional Helm charts that are also included in the Component Pack
installation package.
Helm chart | Description |
---|---|
k8s-psp | Set the Pod Security Policies that are required for Component Pack pods to run. Only required if the PodSecurityPolicy admission plugin is enabled in your cluster. See Pod Security Policies |
sanity |
Sanity provides a dashboard where you can monitor the health of all applications running within the Component Pack. For more information, see Using Sanity to monitor Component Pack. |
sanity-watcher |
Monitors the helm list of installed releases and upgrades sanity with the latest list of services to monitor when it detects that any helm release has been added or removed. |
connections-persistent-storage-nfs |
Helm chart to set up and configure the required persistent volumes using NFS. |
esbackuprestore |
Helm chart to backup or restore data for Elasticsearch-based components. |
elasticstack |
Helm chart that deploys Filebeat, Logstash and Kibana,which integrate with the Component Pack Elasticsearch offering to provide a centralized logging solution. (Requires Elasticsearch helm chart to be deployed). |
Procedure
- Download the Component Pack installation kit from HCL FlexNet portal.
-
Complete the following tasks to install Component Pack services.
Note: For Activities Plus, see Installing Activities Plus services in the section on third-party applications in Component Pack.