From 021ba8a52974c616fea42881cffb64b0a58cd396 Mon Sep 17 00:00:00 2001 From: Sebastian-RG Date: Mon, 18 Sep 2023 17:46:55 -0500 Subject: [PATCH] Adds kdu documentation for helm v3 Signed-off-by: Sebastian-RG --- 05-quickstarts.md | 7 +++++-- 07-knfwalkthrough.md | 1 + 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/05-quickstarts.md b/05-quickstarts.md index d002df3..0171371 100644 --- a/05-quickstarts.md +++ b/05-quickstarts.md @@ -620,11 +620,11 @@ git clone --recursive https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages First, explore the folder `openldap_knf`, in particular, the file `openldap_vnfd.yaml`. This is the CNF descriptor, which models a single KDU (Kubernetes Deployment Unit) with the specified helm chart (`stable/openldap` here), a single connection point (`mgmt-ext`) where all Kubernetes services of this helm-chart will be exposed, and certain k8s-cluster requirements (in this case, it must have at least one network to expose services). -In most of the cases, adapting your package would be as simple as changing the helm chart. where all the Kubernetes services of this helm chart will be exposed). +In most of the cases, adapting your package would be as simple as changing the helm chart. It must be noted that the descriptor follows a format defined in OSM, augmenting SOL006, because the modeling of CNF or any Kubernetes applications has not yet been included in ETSI NFV SOL006. -By default, it is assumed that the helm version for the helm charts is `v3`. If the helm chart is based on `v2`, the descriptor should add the line `helm-version: v2` in the kdu section. +By default, it is assumed that the helm version for the helm charts is `v3`. If the helm chart is based on `v2`, the descriptor should add the line `helm-version: v2` in the kdu section. This setting also sets the name for the folder where the helm charts are expected to be if you are using a local helm chart instead of a repo. For `v2`, `helm-charts` is expected. For `v3`, `helm-chart-v3s` is expected. #### Step 3: Upload the packages to the catalogue @@ -766,6 +766,9 @@ helm fetch stable/openldap helm fetch stable/openldap --version 1.2.6 ``` +You must save the helm charts under a folder called `helm-charts` if you are using helm version 2, or under a folder called `helm-chart-v3s` if you are using helm version 3. +Helm version 3 is the default if not specified in the kdu. + You could even modify a downloaded helm chart, for instance to add new parameters (called values). This [guide](https://helm.sh/docs/chart_template_guide/getting_started/) will help you. #### Using different instantiation parameters, derived from the helm values file diff --git a/07-knfwalkthrough.md b/07-knfwalkthrough.md index e38849b..61fcc5f 100644 --- a/07-knfwalkthrough.md +++ b/07-knfwalkthrough.md @@ -45,6 +45,7 @@ vnfd-catalog: kdu: - helm-chart: magma/orc8r name: orc8r + helm-version: v3 mgmt-interface: cp: mgmt name: fb_magma_knf -- GitLab