docs/sections/guides/deployment_guides/oom_dev_testing_local_deploy.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright (C) 2022 Nordix Foundation
   5
   6 .. Links
   7
   8 .. _oom_dev_testing_local_deploy:
   9
  10 OOM Developer Testing Deployment
  11 ================================
  12
  13 Developing and testing changes to the existing OOM project can be done locally by setting up some additional
  14 tools to host the updated helm charts.
  15
  16 **Step 1.** Clone the OOM repository from ONAP gerrit::
  17
  18   > git clone http://gerrit.onap.org/r/oom
  19
  20   > cd oom/kubernetes
  21
  22
  23 **Step 2.** Install Helm Plugin required to push helm charts to local repo::
  24
  25   > helm plugin install https://github.com/chartmuseum/helm-push.git --version 0.9.0
  26
  27 .. note::
  28   The ``--version 0.9.0`` is required as new version of helm (3.7.0 and up) is
  29   now using ``push`` directly and helm-push is using ``cm-push`` starting
  30   version ``0.10.0`` and up.
  31
  32 **Step 3.** Install Chartmuseum
  33
  34 Chart museum is required to host the helm charts locally when deploying in a development environment::
  35
  36   > curl https://raw.githubusercontent.com/helm/chartmuseum/main/scripts/get-chartmuseum | bash
  37
  38 **Step 4.** To setup a local Helm server to store the ONAP charts::
  39
  40   > mkdir -p ~/helm3-storage
  41
  42   > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 &
  43
  44 Note the port number that is listed and use it in the Helm repo add as follows::
  45
  46   > helm repo add local http://127.0.0.1:8879
  47
  48 **Step 5.** Verify your Helm repository setup with::
  49
  50   > helm repo list
  51   NAME   URL
  52   local  http://127.0.0.1:8879
  53
  54 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
  55
  56   > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all
  57
  58 `HELM_BIN`
  59   Sets the helm binary to be used. The default value use helm from PATH
  60
  61
  62 **Step 7.** Display the onap charts that are available to be deployed::
  63
  64   > helm repo update
  65
  66   > helm search repo local
  67
  68
  69 .. collapse:: Helm search repo output
  70
  71     .. include:: ../../resources/helm/helm-search.txt
  72        :code: yaml
  73
  74 |
  75
  76 .. note::
  77   The setup of the Helm repository is a one time activity. If you make changes
  78   to your deployment charts or values be sure to use ``make`` to update your
  79   local Helm repository.
  80
  81
  82
  83