aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorFiete Ostkamp <Fiete.Ostkamp@telekom.de>2023-12-04 13:51:17 +0100
committerAndreas Geissler <andreas-geissler@telekom.de>2023-12-07 08:43:24 +0100
commit71c8b84a44c57daba13ec4e8a19989658e8abcbc (patch)
tree4a876379fb342a9f1650f5ffe531ff5370da1807 /CONTRIBUTING.md
parent2ad6c16c56c038178c8001a242e8c3243e21e9ba (diff)
[PORTAL-NG] Publish ui and bff charts in OOM
- upload ui and bff - preferences and history services will be added later - added portal-ng to ONAP chart and overrides Issue-ID: PORTALNG-66 Change-Id: I9182234be3afbdcdc95b23f0799a11d41384184e Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md37
1 files changed, 21 insertions, 16 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e16772ddc1..f736f079e4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,36 +19,41 @@ limitations under the License.
Thanks for taking the time to contribute to OOM!
Please see some information on how to do it.
-## How to become a contributor and submit your own code
+## Local setup
-### Environment setup
-In order to be able to check on your side before submitting, you'll need to install some binaries:
+### Install helm-push plugin
-* helm (satisfying the targeted version as seen in [setup guide](
-docs/oom_cloud_setup_guide.rst#software-requirements)).
-* chartmuseum (in order to push dependency charts)
-* helm push (version 0.10.1 as of today)
-* make
+In order to push locally built charts to chartmuseum, the `helm-push` plugin must be installed. You can do that with:
-### Linting and testing
-OOM uses helm linting in order to check that the template rendering is correct with default values.
+```sh
+$ helm plugin install https://github.com/chartmuseum/helm-push
+Downloading and installing helm-push v0.10.4 ...
+https://github.com/chartmuseum/helm-push/releases/download/v0.10.3/helm-push_0.10.4_linux_amd64.tar.gz
+Installed plugin: cm-push
+```
-The first step is to start chartmuseum:
+### Run chartmuseum
``` shell
-nohup chartmuseum --storage="local" --storage-local-rootdir="/tmp/chartstorage" \
- --port 6464 &
+mkdir -p charts && docker-compose up
```
or
``` shell
-docker-compose up
+nohup chartmuseum --storage="local" --storage-local-rootdir="/tmp/chartstorage" \
+ --port 6464 &
```
-then you add a `local` repository to helm:
+### Add a `local` chart repository
+
+OOM contains `make` files that build the charts and push them to the local chartmuseum.
+For that to work, helm needs to know about the `local` helm repository.
```shell
-helm repo remove local || helm repo add local http://localhost:6464
+helm repo remove local; helm repo add local http://localhost:6464
```
+### Linting and testing
+OOM uses helm linting in order to check that the template rendering is correct with default values.
+
As full rendering may be extremely long (~9h), you may only want to lint the common part and the component you're working on.
Here's an example with AAI:
```shell