install/README.md

   1
   2
   3 ## Prerequisites
   4
   5 The ranpm setup works on linux/MacOS or on windows via WSL using a local or remote kubernetes cluster.
   6
   7 - local kubectl
   8 - kubernetes cluster
   9 - local docker for building images
  10
  11 It is recommended to run the ranpm on a kubernetes cluster instead of local docker-desktop etc as the setup requires a fair amount of computer resouces.
  12
  13 # Requirement on kubernetes
  14
  15 The demo set can be run on local or remote kubernetes.
  16 Kubectl must be configured to point to the applicable kubernetes instance.
  17 Nodeports exposed by the kubernetes instance must be accessible by the local machine - basically the kubernetes control plane IP needs to be accessible from the local machine.
  18
  19 - Latest version of istio installed
  20
  21 # Other requirements
  22 - helm3
  23 - bash
  24 - cmd 'envsubst' must be installed (check by cmd: 'type envsubst' )
  25 - cmd 'jq' must be installed (check by cmd: 'type jq' )
  26 - keytool
  27 - openssl
  28
  29
  30 ## Before installation
  31 The following images need to be built manually. If remote or multi node cluster is used, then an image repo needs to be available to push the built images to.
  32 If external repo is used, use the same repo for all built images and configure the reponame in `helm/global-values.yaml` (the parameter value of extimagerepo shall have a trailing `/`)
  33
  34 Build the following images (build instruction in each dir)
  35 - ranpm/https-server
  36 - ranpm/pm-file-converter
  37 - pm-rapp
  38
  39
  40 ## Installation
  41
  42 The installation is made by a few scripts.
  43 The main part of the ranpm is installed by a single script. Then, additional parts can be added on top. All installations in kubernetes is made by helm charts.
  44
  45 The following scripts are provided for installing (install-nrt.sh mush be installed first):
  46
  47 - install-nrt.sh : Installs the main parts of the ranpm setup
  48 - install-pm-log.sh : Installs the producer for influx db
  49 - install-pm-influx-job.sh : Sets up an alternative job to produce data stored in influx db.
  50 - install-pm-rapp.sh : Installs a rapp that subscribe and print out received data
  51
  52 ## Unstallation
  53
  54 There is a corresponding uninstall script for each install script. However, it is enough to just run `uninstall-nrt.sh` and `uninstall-pm-rapp.sh´.
  55
  56 ## Exposed ports to APIs
  57 All exposed APIs on individual port numbers (nodeporta) on the address of the kubernetes control plane.
  58
  59 ### Keycloak API
  60 Keycloak API accessed via proxy (proxy is needed to make keycloak issue token with the internal address of keycloak).
  61 - nodeport: 31784
  62
  63 ### OPA rules bundle server
  64 Server for posting updated OPA rules.
  65 - nodeport: 32201
  66
  67 ### Information coordinator Service
  68 Direct access to ICS API.
  69 -nodeports (http and https): 31823, 31824
  70
  71 ### Ves-Collector
  72 Direct access to the Ves-Collector
  73 - nodeports (http and https): 31760, 31761
  74
  75 ## Exposed ports to admin tools
  76 As part of the ranpm installation, a number of admin tools are installed.
  77 The tools are accessed via a browser on individual port numbers (nodeports) on the address of the kubernetes control plane.
  78
  79 ### Keycload admin console
  80 Admin tool for keycloak.
  81 - nodeport : 31788
  82 - user: admin
  83 - password: admin
  84
  85 ### Redpanda consule
  86 With this tool the topics, consumer etc can be viewed.
  87 - nodeport: 31767
  88
  89 ### Minio web
  90 Browser for minio filestore.
  91 - nodeport: 31768
  92 - user: admin
  93 - password: adminadmin
  94
  95 ### Influx db
  96 Browser for influx db.
  97 - nodeport: 31812
  98 - user: admin
  99 - password: mySuP3rS3cr3tT0keN
 100
 101
 102 ## License
 103
 104 Copyright (C) 2023 Nordix Foundation. All rights reserved.
 105 Licensed under the Apache License, Version 2.0 (the "License");
 106 you may not use this file except in compliance with the License.
 107 You may obtain a copy of the License at
 108
 109      http://www.apache.org/licenses/LICENSE-2.0
 110
 111 Unless required by applicable law or agreed to in writing, software
 112 distributed under the License is distributed on an "AS IS" BASIS,
 113 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 114 See the License for the specific language governing permissions and
 115 limitations under the License.