[UTILS] Fix and resolve remote references in standard defined domain 75/124875/1
authorKrzysztof Kuzmicki <krzysztof.kuzmicki@nokia.com>
Wed, 13 Oct 2021 09:06:20 +0000 (11:06 +0200)
committerKrzysztof Kuzmicki <krzysztof.kuzmicki@nokia.com>
Wed, 13 Oct 2021 09:06:20 +0000 (11:06 +0200)
Update of README.md file. According to changes applied in
https://gerrit.onap.org/r/c/oom/utils/+/1237941

Signed-off-by: Krzysztof Kuzmicki <krzysztof.kuzmicki@nokia.com>
Issue-ID: DCAEGEN2-2893 DCAEGEN2-2894 DCAEGEN2-2895
Change-Id: I05176572d4b58eb5176bfec7db9b47c7a3663b07

external-schema-repo-generator/README.md
external-schema-repo-generator/generator/environment.config

index 8e959ce..d8a56dd 100644 (file)
@@ -32,6 +32,7 @@ environments. Generator tool files that are required are located in `generator`
 - utils.sh
 - clean.sh
 - environment.config
+- bin_packing.awk
 
 ## Instruction
 
@@ -44,11 +45,14 @@ the configurable properties is below.
 - **EXTERNAL_REPO_CONFIGMAP_DIRECTORY** - Directory inside *GENERATION_DIRECTORY*, in which generated specs will be located.
 - **EXTERNAL_REPO_CONFIGMAP_NAME_PREFIX** - Prefix for Kubernetes name of ConfigMap, that will be generated and installed.
 - **SNIPPET_FILENAME** - Filename of snippet with autogenerated content that should be added to VES deployment.
-
 - **REPOSITORY_URL_HTTPS** - URL to remote Git repository which lets cloning repository via HTTPS.
-- **REPOSITORY_BRANCH** - Valid branch from selected Git repository which contains schemas desired to mount. Script
+- **REPOSITORY_BRANCH** - Valid OPEN API branch from selected Git repository which contains schemas desired to mount. Script
 accepts an array of branches from which schemas will be collected. To pass an array split branch names with space and
-cover list in quotation marks.
+cover list in quotation marks. User can put here 5G_API specific repository tag name related to OPEN API schema branch after colon
+for example: Rel-16-SA-91:TSG91-Rel16. Having such information script will clone this specific 5G API branch and merge it 
+with OPEN API schema. If 5G_API specific repository branch after colon will not be set by user, then script will parse 
+OPEN API if any reference to 5G_API specific repository is present and get branch name for 5G_API from this reference. 
+Next clone parsed 5G API branch and merge it with OPEN API schema
 - **SCHEMAS_LOCATION** - Path to schemas directory on selected Git repo. All YAML files from this repository will be
 considered as schema and added to ConfigMap.
 
index 86f70ad..60ad503 100644 (file)
@@ -18,7 +18,7 @@ REPOSITORY_URL_HTTPS=https\://forge.3gpp.org/rep/sa5/MnS.git
 # for example: Rel-16-SA-91:TSG91-Rel16
 # Having such information script will clone this specific 5G API branch and merge it with OPEN API schema
 # If 5G_API specific repository branch after colon will not be set by user, then script will parse OPEN API if any
-# reference to 5G_API specific repository is present and parse 5G_API branch from this reference.
+# reference to 5G_API specific repository is present and get branch name for 5G_API from this reference.
 # Next clone parsed 5G API branch and merge it with OPEN API schema
 REPOSITORY_BRANCH="SA88-Rel16 Rel-16-SA-91:TSG91-Rel16 Rel-17-SA-91"
 SCHEMAS_LOCATION=OpenAPI