Installing and configuring the TRIRIGA Application Suite GIS Operator

• Ensure that you have the following environment:

  Any 64-bit Intel or AMD x86 Red Hat OpenShift Container Platform 4.12 or higher cluster, included, but not limited to:

  • Any customer-managed cluster

  • Any IBM Cloud® managed cluster (ROKS and satellite)

• The maximum number of the memory map areas (vm.max_map_count) of the nodes of the Red Hat OpenShift Container Platform cluster must be at least 262144.

• The Red Hat OpenShift Container Platform cluster must be equipped with at least one StorageClass able to grant read/write permission to the Linux® root group and to support Kubernetes ReadWriteMany or ReadWriteOnce access mode. Review the following considerations about the StorageClasses to be adopted:

  • Set the reclaimPolicy field to Delete to simplify administration. This option cleans up the associated PV when a PVC is deleted (for example, when you undeploy the software).

  • Use a separate StorageClass for the hosted backup store configuration with its reclaimPolicy field set to Retain so that the PV persists when you undeploy and redeploy.

  • Set the allowVolumeExpansion field on the StorageClass to true if your storage provider supports the expansion of PVs.

  • For clusters that span multiple availability zones, set the volumeBindingMode to WaitForFirstConsumer for the associated storage class to avoid node-volume affinity conflicts.

• The cert-manager Operator for Red Hat OpenShift must be deployed on the target cluster, managing the certificates.cert-manager.io/v1 and issuers.cert-manager.io/v1 custom resource definitions. For more information, see cert-manager Operator for Red Hat OpenShift. The cert-manager Operator for Red Hat OpenShift is available in the Red Hat OpenShift-provided Operators catalog (registry.redhat.io/redhat/redhat-operator-index), see https://docs.openshift.com/container-platform/4.16/operators/understanding/olm-rh-catalogs.html.

• An IBM Entitled Registry key.

• An IBM TRIRIGA Application Suite Location Service for Esri authorization file, which you can download from your IBM Passport Advantage®

Complete the following steps to install the TRIRIGA Application Suite GIS Operator.

1. Create a Red Hat OpenShift Container Platform project, assuming a name ibm-tas-gis.

   oc new-project ibm-tas-gis

2. Create the tas-gis-operatorgroup by entering the following command:

   cat <<EOF | oc create -f -
   apiVersion: operators.coreos.com/v1alpha2
   kind: OperatorGroup
   metadata:
     name: tas-gis-operator-group
     namespace: ibm-tas-gis
   spec:
     targetNamespaces:
       - ibm-tas-gis
   EOF    

3. Create an image pull secret called ibm-entitlement-key, or ibm-entitlement, to access the IBM Entitled registry.

   oc create secret docker-registry ibm-entitlement-key --docker-server=cp.icr.io --docker-username=cp --docker-password=<apikey> --docker-email=<email address> -n ibm-tas-gis

4. Install the TRIRIGA Application Suite GIS Operator. You can use the OperatorHub UI or create a subscription by using the oc CLI as shown.

   cat <<EOF | oc create -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: ibm-tas-gis-subscription
     namespace: ibm-tas-gis
   spec:
     channel: v11.6
     installPlanApproval: Automatic
     name: ibm-tas-gis-operator
     source: ibm-operator-catalog
     sourceNamespace: openshift-marketplace
     startingCSV: ibm-tas-gis-operator.v11.6.0
   EOF  

   Where installPlanApproval can be set as follows:

   • You can decide on the approval strategy by setting the subscription installPlanApproval to either Automatic or Manual.

     By default, the installPlanApproval is set to Automatic when working with the OperatorHub UI or if you don't specify a value in the Subscription spec. If the approval strategy is set to Automatic, the operator is automatically installed or upgraded when a new version is available.

     If you set the installPlanApproval parameter to Manual, the operator is not automatically installed or upgraded. Instead, you get an installation plan that needs to be manually approved. With Manual approval, you can plan for any activity that you need to complete before the installation or upgrade of the operator.

   • If you install the TRIRIGA Application Suite GIS Operator in a namespace where another operator is installed with installPlanApproval: Manual in its subscription, then the operator inherits this setting. The approval plan is set to Manual and the GIS operator is not automatically installed or upgraded.

   • If you install the TRIRIGA Application Suite GIS Operator operator with installPlanApproval set to Manual, this setting is applied to all installed operators, or operators installed in the future, in the same namespace.

   • You can initially set installPlanApproval to Automatic and switch to Manual when the TRIRIGA Application Suite GIS Operator installation completes. Then you can control when updates are applied and plan for any activity that you need to complete before the operator upgrade.

Complete the following basic configuration to get up and running.

1. Create a secret to hold the TRIRIGA Application Suite Location Service for Esri authorization file, which you can download from your IBM Passport Advantage account. Enter the following commands, assuming a tas-gis-authorization-secret name.

   cat <<EOF | oc apply -f - 
   kind: Secret
   apiVersion: v1
   metadata:
     namespace: ibm-tas-gis
     name: tas-gis-authorization-secret
   stringData:
     authorization.json: |
       ...
       Authorization file in json format
       ...
   EOF        

2. Create a Locservice instance.

   Note: Only one Locservice instance can be created in a namespace and it must be named arcgis.

   You can use the OperatorHub UI or create an instance by using the oc CLI as shown.

   cat <<EOF | oc create -f -
   apiVersion: gis.tas.ibm.com/v1
   kind: Locservice
   metadata:
     name: arcgis
     namespace: ibm-tas-gis
   spec:
     license:
       accept: true
     version: 11.6.0
     settings:    
       profile: standard-availability
       admin:
         security_question: 
           question: 'What city were you born in?'
           answer: my-city
         email: my-emailv@my-domain.com
         first_name: my-first-name
         last_name: my-first-name
         username: my-username
       authorization_secret: tas-gis-authorization-secret
       k8s_availability_topology_key: kubernetes.io/hostname
       storage:
         indexer:
           class: my-storage-class
           size: 16
         memory:
           class: my-storage-class
           size: 16
         object:
           class: my-storage-class
           size: 32
         prometheus:
           class: my-storage-class
           size: 30
         queue:
           class: my-storage-class
           size: 16
         relational:
           class: my-storage-class
           size: 20
         sharing:
           class: my-storage-class
           size: 16
       logging:
         level: warning
         retention_days: 60
   EOF  

Complete the following advanced configuration steps.