From: garciadeblas <gerardo.garciadeblas@telefonica.com>
Date: Fri, 18 Jul 2025 09:10:03 +0000 (+0200)
Subject: Minor changes and typos in README
X-Git-Tag: v18.0.0~7
X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=8c29cef0489c257ae27154a7fc21f7c6b08631f3;p=osm%2Ftests.git

Minor changes and typos in README

Change-Id: If873befbd51f08406faffb0229e5f325f48c9bdd
Signed-off-by: garciadeblas <gerardo.garciadeblas@telefonica.com>
---

diff --git a/README.md b/README.md
index 751c71c..d84c328 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,7 @@ This repository contains tools and configuration files for testing and automatio
 
 Create a file `envconfig.rc` copying from `envconfig-local.rc` and set the required variables.
 
-```
+```bash
 OSM_HOSTNAME=<OSM_IP_ADDRESS>
 VIM_TARGET=<VIM_REGISTERED_AT_OSM>
 VIM_MGMT_NET=<NAME_OF_THE_MGMT_NETWORK_IN_THE_VIM>
@@ -62,7 +62,7 @@ You can use a different robot tag instead of `sanity`. The whole list of tags ar
 docker build -f docker/Dockerfile -t osmtests .
 ```
 
-### Run the tests
+### Run the tests using the built image
 
 ```bash
 export CLOUDS_YAML_FILE="${HOME}/.config/openstack/clouds.yaml"
@@ -95,10 +95,11 @@ docker run --rm=true --name tests -t --env-file envconfig.rc \
 
 Relevant volumes to be mounted are:
 
-- <path_to_reports> [OPTIONAL]: the absolute path to reports location in the host
-- <path_to_clouds.yaml> [OPTIONAL]: the absolute path to the clouds.yaml file in the host
-- <path_to_sdncs.yaml> [OPTIONAL]: the absolute path to the sdncs.yaml file in the host
-- <path_to_kubeconfig> [OPTIONAL]: the kubeconfig file to be used for k8s clusters
+- `-v <path_to_reports>:/robot-systest/reports` [OPTIONAL]: the absolute path to reports location in the host.
+- `-v <path_to_clouds.yaml>:/etc/openstack/clouds.yaml` [OPTIONAL]: the absolute path to the clouds.yaml file in the host
+- `-v <path_to_sdncs.yaml>:/root/port-mapping.yaml` [OPTIONAL]: the absolute path to the sdncs.yaml file in the host
+- `-v <path_to_kubeconfig>:/root/.kube/config`: [OPTIONAL]: the kubeconfig file to be used for testing CNF deployment with the imperative framework (`k8s_xx` tests)
+- `-v <path_to_kubeconfig>:/robot-systest/cluster-kubeconfig.yaml` [OPTIONAL]: the kubeconfig file to be used for testing the declarative framework (cluster registration/de-registration, OKA, KSU) (`gitops_xx` tests)
 
 Other relevant options to run tests are:
 
@@ -129,7 +130,7 @@ git clone https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages.git
 
 Create a file `envconfig.rc` copying from `envconfig-local.rc` and set the required variables (in this case, the use of `export` is mandatory).
 
-```
+```bash
 export OSM_HOSTNAME=<OSM_IP_ADDRESS>
 export VIM_TARGET=<VIM_REGISTERED_AT_OSM>
 export VIM_MGMT_NET=<NAME_OF_THE_MGMT_NETWORK_IN_THE_VIM>
@@ -224,7 +225,7 @@ to destroy the deployments immediately, the following tags are used:
   So, for instance, you could first deploy a number of network services executing
   the tests with "prepare" tag, migrate to another OSM version, and then
   check the behavior executing with the "verify" tag. Finally, use the "cleanup"
-  tag. 
+  tag.
 
 ## Post-processing Robot output files
 
@@ -234,7 +235,7 @@ The output files of Robot include tyipically three files:
 - `log.html`: details about the executed test cases in HTML format
 - `output.xml`: all the test execution results in machine readable XML format
 
-More information about these files [here](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#output-file).
+More information about these files can be found in the [Robot Framework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#output-file).
 
 It is possible to use the tool `rebot`, included as part of the Robot Framework, to post-process the output file `output.xml`.
 
@@ -252,7 +253,7 @@ rebot [-d <output_folder>] -e <tag1> -e <tag2> ... -e <tagN> [-o <new_output_xml
 rebot [-d <output_folder>] --merge output1.xml output2.xml ... outputN.xml
 ```
 
-More information about post-processing Robot output files [here](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#post-processing-outputs)
+More information about post-processing Robot output files [Robot Framework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#post-processing-outputs)
 
 ## Autogeneration of tests
 
@@ -312,8 +313,8 @@ cd robot-systest/autogeneration/
 
 ## Built With
 
-* [Python](www.python.org/) - The language used
-* [Robot Framework](robotframework.org) - The testing framework
+- [Python](www.python.org/) - The language used
+- [Robot Framework](robotframework.org) - The testing framework
 
 ## Contributing
 
@@ -326,4 +327,3 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
 ## License
 
 This project is licensed under the Apache2 License - see the [LICENSE](LICENSE) file for details
-