Rename the symlink AUX to RICAUX 87/15287/4
authoraravind.est <aravindhan.a@est.tech>
Mon, 17 Nov 2025 16:00:38 +0000 (16:00 +0000)
committeraravind.est <aravindhan.a@est.tech>
Mon, 17 Nov 2025 16:58:00 +0000 (16:58 +0000)
AUX is a reserved keyword in windows platform.
This prevents the repository from cloning in windows environment.

Issue-ID: NONRTRIC-1096
Change-Id: I1ba379e7562df4efa7c9a436ecbf5a16634c0eac
Signed-off-by: aravind.est <aravindhan.a@est.tech>
README.md
RECIPE_EXAMPLE/RICAUX [moved from RECIPE_EXAMPLE/AUX with 100% similarity]
docs/requirements-docs.txt
docs/ric/installation-aux.rst
tools/onap/install
tox.ini

index e3b69e1..76642db 100644 (file)
--- a/README.md
+++ b/README.md
@@ -81,7 +81,7 @@ $ . ./undeploy-ric-platform
 ```
 
 ### To deploy RIC Auxiliary functions
-Choose a deployment recipe (e.g, ./RECIPE_EXAMPLE/AUX/amber_example_recipe.yaml)
+Choose a deployment recipe (e.g, ./RECIPE_EXAMPLE/RICAUX/amber_example_recipe.yaml)
 Make a copy of the recipe and edit the key:value pairs in it according to your needs
 Set the values of extsvcaux/ricip and extsvcaux/auxip to be the external IP addresses of VM hosting RIC cluster and VM hosting AUX cluster, respectively.
 ```sh
similarity index 100%
rename from RECIPE_EXAMPLE/AUX
rename to RECIPE_EXAMPLE/RICAUX
index 09a0c1c..eec5fa1 100644 (file)
@@ -3,3 +3,4 @@ sphinx-rtd-theme
 sphinxcontrib-httpdomain
 recommonmark
 lfdocs-conf
+urllib3~=1.26.15
\ No newline at end of file
index 0d24c3f..2ea2f09 100644 (file)
@@ -2,6 +2,7 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 .. ===============LICENSE_START=======================================================
 .. Copyright (C) 2019-2020 AT&T Intellectual Property
+.. Modifications Copyright (C) 2025 OpenInfra Foundation Europe
 .. ===================================================================================
 .. This documentation file is distributed under the Creative Commons Attribution
 .. 4.0 International License (the "License"); you may not use this file except in
@@ -34,7 +35,7 @@ Run the following commands in a root shell:
 
 **Modify the deployment recipe**
 
-Edit the recipe file ./RECIPE_EXAMPLE/AUX/example_recipe.yaml.
+Edit the recipe file ./RECIPE_EXAMPLE/RICAUX/example_recipe.yaml.
 
 - Specify the IP addresses used by the RIC and AUX cluster ingress controller (e.g., the main interface IP) in the following section.
   If you are only testing the AUX cluster, you can put down any private IPs (e.g., 10.0.2.1 and 10.0.2.2).
@@ -71,7 +72,7 @@ After the recipes are edited, the AUX group is ready to be deployed.
 .. code:: bash
 
   cd dep/bin
-  ./deploy-ric-aux ../RECIPE_EXAMPLE/AUX/example_recipe.yaml
+  ./deploy-ric-aux ../RECIPE_EXAMPLE/RICAUX/example_recipe.yaml
 
 
 **Checking the Deployment Status**
index f710dd7..db25387 100755 (executable)
@@ -1,6 +1,7 @@
 #!/bin/bash
 ################################################################################
 #   Copyright (c) 2020 AT&T Intellectual Property.                             #
+#   Modifications Copyright (c) 2025 OpenInfra Foundation Europe.              #
 #                                                                              #
 #   Licensed under the Apache License, Version 2.0 (the "License");            #
 #   you may not use this file except in compliance with the License.           #
@@ -237,18 +238,18 @@ done
 #cd ${REPOROOTDIR}/ric-aux/helm/infrastructure
 #helm dep update
 #cd ..
-#helm install -f ${REPOROOTDIR}/RECIPE_EXAMPLE/AUX/example_recipe.yaml --name bronze-infra --namespace ricaux ./infrastructure
+#helm install -f ${REPOROOTDIR}/RECIPE_EXAMPLE/RICAUX/example_recipe.yaml --name bronze-infra --namespace ricaux ./infrastructure
 #
 #cd ${REPOROOTDIR}/ric-aux/helm/ves
 #helm dep update
 #cd ..
-#helm install -f ${REPOROOTDIR}/RECIPE_EXAMPLE/AUX/example_recipe.yaml --name bronze-ves --namespace ricaux ./ves
+#helm install -f ${REPOROOTDIR}/RECIPE_EXAMPLE/RICAUX/example_recipe.yaml --name bronze-ves --namespace ricaux ./ves
 #
 #
-## edit RECIPE_EXAMPLE/AUX/example_recipe.yaml file
+## edit RECIPE_EXAMPLE/RICAUX/example_recipe.yaml file
 ##./bin/prepare-common-templates
 ##cd ric-aux/bin
-##./install -f ${REPOROOTDIR}/RECIPE_EXAMPLE/AUX/example_recipe.yaml -c "ves"
+##./install -f ${REPOROOTDIR}/RECIPE_EXAMPLE/RICAUX/example_recipe.yaml -c "ves"
 #
 #cd $STARTDIR
 #kubectl get pods --all-namespaces
diff --git a/tox.ini b/tox.ini
index c86cfdf..1246bb7 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -14,11 +14,12 @@ deps =
     sphinxcontrib-httpdomain
     recommonmark
     lfdocs-conf
+    urllib3~=1.26.15
 
 commands =
     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
     echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals = echo
+allowlist_externals = echo
 
 [testenv:docs-linkcheck]
 basepython = python3
@@ -27,4 +28,5 @@ deps = sphinx
        sphinxcontrib-httpdomain
        recommonmark
        lfdocs-conf
+       urllib3~=1.26.15
 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck