Install the Orient Me offering of the Component Pack for HCL
Connections™.
Before you begin
Before attempting to install Orient Me, verify that the following tasks were successfully
completed.
About this task
The following components are deployed as part of the Orient Me offering:
- community-suggestions
- orient-indexing-service
- itm-services
- mail-service
- middleware-graphql
- orient-web-client
- people-datamigration
- people-idmapping
- people-relationship
- people-scoring
- orient-retrieval-service
- solr-basic
- userprefs-service
- zookeeper
Note: If you're using Elasticsearch, you won't need Solr.
Procedure
-
Install the Orient Me Helm chart by running the following command:
In the command, replace extractedFolder with the location of the directory
where you extracted the Component Pack installation package. Replace the value of
global.image.repository
with the name of your Docker registry.
- If you do not use ISAM:
If you do not use IBM®
Security Access Manager, run the following command to install the Helm
chart.
helm install \
--name=orientme extractedFolder/microservices_connections/hybridcloud/helmbuilds/orientme-0.1.0-20200321-174037.tgz \
--set \
global.onPrem=true,\
global.image.repository=Docker_registry/connections,\
orient-web-client.service.nodePort=30001,\
itm-services.service.nodePort=31100,\
mail-service.service.nodePort=32721,\
community-suggestions.service.nodePort=32200
Include
the following settings if you're using
Elasticsearch.
orient-indexing-service.indexing.solr=false,\
orient-indexing-service.indexing.elasticsearch=true,\
orient-retrieval-service.retrieval.elasticsearch=true
(Optional)
Add one more Elasticsearch setting if you want to change the default
value of 3000. The setting controls how many pages of content can be
displayed in Top Updates, and the default reflects a balance between
content and performance. A higher value allows more pages to be
displayed; a lower value improves performance. The formula for how many
stacks are retrieved is (Page #) X (Stacks per page) = (# of stacks).
orient-retrieval-service.retrieval.esStacksSizeLimit=<your value>
- If you use ISAM:
If your deployment uses IBM
Security Access Manager (formerly Tivoli® Access Manager), the installation command includes some
additional
settings.
helm install \
--name=orientme extractedFolder/microservices_connections/hybridcloud/helmbuilds/orientme-0.1.0-20200321-174037.tgz \
--set \
global.onPrem=true,\
global.image.repository=Docker_registry/connections,\
orient-web-client.service.nodePort=30001,\
itm-services.service.nodePort=31100,\
mail-service.service.nodePort=32721,\
community-suggestions.service.nodePort=32200,\
orient-web-client.env.validateTokenMatch=false,\
middleware-graphql.env.validateTokenMatch=false,\
community-suggestions.env.validateTokenMatch=false,\
itm-services.env.validateTokenMatch=false,\
mail-service.env.validateTokenMatch=false
Include
the following settings if you're using
Elasticsearch:
orient-indexing-service.indexing.solr=false,\
orient-indexing-service.indexing.elasticsearch=true,\
orient-retrieval-service.retrieval.elasticsearch=true
(Optional)
Add one more Elasticsearch setting if you want to change the default
value of 3000. The setting controls how many pages of content can be
displayed in Top Updates, and the default reflects a balance between
content and performance. A higher value allows more pages to be
displayed; a lower value improves performance. The formula for how many
stacks are retrieved is (Page #) X (Stacks per page) = (# of stacks).
orient-retrieval-service.retrieval.esStacksSizeLimit=<your value>
Note: By default, deployment is done to the
connections
namespace. If you created a
namespace with a different name and would like to deploy there, the following extra values must be
included in the helm install
command:
community-suggestions.namespace=namespace,\
orient-indexing-service.namespace=namespace,\
itm-services.namespace=namespace,\
mail-service.namespace=namespace,\
middleware-graphql.namespace=namespace,\
orient-web-client.namespace=namespace,\
people-datamigration.namespace=namespace,\
people-idmapping.namespace=namespace,\
people-relationship.namespace=namespace,\
people-scoring.namespace=namespace,\
orient-retrieval-service.namespace=namespace,\
solr-basic.namespace=namespace,\
userprefs-service.namespace=namespace,\
zookeeper.namespace=namespace
-
Verify that Orient Me was successfully deployed.
-
Verify that the installation completed by running the
helm list
command.
When the installation completes, the chart's status shows as
DEPLOYED.
-
Then run the following command to check the status of all of the pods.
In the following example,
connections
is the name of the
namespace:
kubectl get pods -n connections
It can take up to 10 minutes for
all pods to start.