one-click/README

   1 **NOTE:
   2 ** Database must be initialized before the cores and VTHs are installed, docker images have to be build, and individual charts have to be updated to pull the correct image.
   3 ** If using one-click, you need to build or update the helm dependencies after updating the individual charts that should now point to correct docker images. Oneclick uses
   4 **    anchors and pointers in its yaml, so values need to be updated in the file, do not pass values in the command line as it will ignore those values.
   5
   6 Prerequisites:
   7 - Kubernetes
   8 - Helm 3.0
   9 - Docker Images
  10
  11 Useful k8 commands:
  12   view ports: kubectl get svc -n [namespace]
  13   view secrets: kubectl get secrets -n [namespace]
  14   view pvc: kubectl get pvc -n [namespace]
  15
  16 usefule helm commands:
  17   dependency build: helm depenency build
  18   dependency update: helm depenency udpate
  19   install charts: helm install [chart_name] [path_to_chart] -n [namespace]
  20   uninstall charts: helm uninstall [chart_name] -n [namespace]
  21   view charts: helm ls -n [namespace]
  22
  23
  24 1. This step is to install otf databases: mysql and mongodb
  25
  26         NOTE: each install of dbs requires dbs to not have pvcs set, if they exist delete them on every install. If primary starts failing, uninstall and remove pvc and reinstall
  27         a) helm install one-click-dbs -n [namespace] . (dir: otf-oran/one-click/one-click-dbs)
  28
  29 2. This step is to install otf-core componenets: otf-service-api,otf-camunda, and otf-frontend
  30
  31         a) modify one-click-core values.yaml (otf-oran/one-click/one-click-core/values.yaml) with correct secret name and ip from the previous step. Fill in otf-service-api and otf-camunda ip adresses.
  32         NOTE:  format is-> mongo-ip=X.X.X.X:27017 mysql-ip=X.X.X.X:3306/otf_camunda ips are the cluster ports
  33   NOTE: format is-> otf-url: http://X.X.X.X:80
  34                     camunda-url: http://X.X.X.X:8443/
  35                     service-api-url: http://X.X.X.X:8443/otf/api/
  36                     camunda-url-no-port: http://X.X.X.X
  37
  38         b) fill in the rest of the values.yaml accordingly (ie, camunda-url,&svc-url,etc)
  39
  40         c) helm install otf-core -n [namespace] . (dir: otf-oran/one-click/one-click-core)
  41
  42 3. This step is to run otf-vths if desired (dir: otf-oran/one-click/one-click-vths). This step will deploy ALL of OTF's VTHS so if you are only deploying specfic ones, you should skip this step.
  43
  44         a) robot vths needs a mongo connections so you will have to update the values.yaml (otf-oran/one-click/one-click-vths/values.yaml) with the approiate IP and mongo secret name from step one. format is mongo-ip=X.X.X.X:27017/
  45
  46         b) helm install otf-vths -n [namespace] . (dir: otf-oran/one-click/one-click-vths)
  47
  48
  49 SELF-CHECK **MORE UPDATES COMING**
  50         1) kubectl get pods -n [namespace] *make sure all pods are running with no errors*
  51
  52 **COMMONLY KNOWN ERRORS/WORKAROUNDS**
  53 1) Later verisons of chrome might have an issue where users might get stuck on the login page when trying to login.
  54   WORKAROUND:
  55     - use firefox
  56     - if you have to use chrome, go to your chrome brower and paste chrome://flags/#cookies-without-same-site-must-be-secure on the URL section and disable cookies must be secure flag.
  57
  58
  59   ***NOTES***
  60   - defaut username and password-> otfuser@email.com:password (use this account to managed other users via user managment tab. You can change password via the mongo database)
  61   - You have to be in a group before you can execute any workflows or add anything VTHs.(Test def, instance, execution are saved to the group that executed it)
  62   - In values.