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 install
  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
  27 ## Before installation
  28 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.
  29 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 `/`)
  30
  31 Build the following images (build instruction in each dir)
  32 - ranpm/https-server
  33 - ranpm/pm-file-converter
  34 - pm-rapp
  35
  36
  37 ## Installation
  38
  39 The installation is made by a few scripts.
  40 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.
  41
  42 The following scripts are provided for installing (install-nrt.sh mush be installed first):
  43
  44 - install-nrt.sh : Installs the main parts of the ranpm setup
  45 - install-pm-log.sh : Installs the producer for influx db
  46 - install-pm-influx-job.sh : Sets up an alternative job to produce data stored in influx db.
  47 - install-pm-rapp.sh : Installs a rapp that subscribe and print out received data
  48
  49 ## Unstallation
  50
  51 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´.
  52
  53 ## Exposed ports to APIs
  54 All exposed APIs on individual port numbers (nodeporta) on the address of the kubernetes control plane.
  55
  56 ### Keycloak API
  57 Keycloak API accessed via proxy (proxy is needed to make keycloak issue token with the internal address of keycloak).
  58 - nodeport: 31784
  59
  60 ### OPA rules bundle server
  61 Server for posting updated OPA rules.
  62 - nodeport: 32201
  63
  64 ### Information coordinator Service
  65 Direct access to ICS API.
  66 -nodeports (http and https): 31823, 31824
  67
  68 ### Ves-Collector
  69 Direct access to the Ves-Collector
  70 - nodeports (http and https): 31760, 31761
  71
  72 ## Exposed ports to admin tools
  73 As part of the ranpm installation, a number of admin tools are installed.
  74 The tools are accessed via a browser on individual port numbers (nodeports) on the address of the kubernetes control plane.
  75
  76 ### Keycload admin console
  77 Admin tool for keycloak.
  78 - nodeport : 31788
  79 - user: admin
  80 - password: admin
  81
  82 ### Redpanda consule
  83 With this tool the topics, consumer etc can be viewed.
  84 - nodeport: 31767
  85
  86 ### Minio web
  87 Browser for minio filestore.
  88 - nodeport: 31768
  89 - user: admin
  90 - password: adminadmin
  91
  92 ### Influx db
  93 Browser for influx db.
  94 - nodeport: 31812
  95 - user: admin
  96 - password: mySuP3rS3cr3tT0keN
  97
  98
  99 ## License
 100
 101 Copyright (C) 2023 Nordix Foundation. All rights reserved.
 102 Licensed under the Apache License, Version 2.0 (the "License");
 103 you may not use this file except in compliance with the License.
 104 You may obtain a copy of the License at
 105
 106      http://www.apache.org/licenses/LICENSE-2.0
 107
 108 Unless required by applicable law or agreed to in writing, software
 109 distributed under the License is distributed on an "AS IS" BASIS,
 110 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 111 See the License for the specific language governing permissions and
 112 limitations under the License.