repo clean-up

- update documentations

Issue-ID: OAM-346
Change-Id: Id592de70163978d34747ca20ac88ad3b3b4a1d0d
Signed-off-by: demx8as6 <martin.skorupski@highstreet-technologies.com>

diff --git a/docs/deployment.rst b/docs/deployment.rst
index e2f2d0e..550e311 100644 (file)
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -158,14 +158,14 @@ docker-compose file and its configurations.::
    ├── network
    │   ├── .env
    │   ├── config.py
-   │   ├── docker-compose.yml
+   │   ├── docker-compose.yaml
    │   │
    │   ├── ntsim-ng-o-du
    │   └── ntsim-ng-o-ru
    └── smo
       ├── common
       │   ├── .env
-      │   ├── docker-compose.yml
+      │   ├── docker-compose.yaml
       │   │
       │   ├── dmaap
       │   ├── docker
@@ -174,7 +174,7 @@ docker-compose file and its configurations.::
       │   └── zookeeper
       └── oam
          ├── .env
-         ├── docker-compose.yml
+         ├── docker-compose.yaml
          │
          ├── web
          ├── controller
@@ -201,11 +201,11 @@ The tested configuration uses the following external https ports:
 Please note that it is necessary to configure first the identity service,
 before starting further docker images.
 
-The several docker-compose yml files must be started in the right order as listed below:
+The several docker-compose yaml files must be started in the right order as listed below:
 
 First the SMO common services must be started::
 
-   docker-compose -f smo/common/docker-compose.yml up -d
+   docker-compose -f smo/common/docker-compose.yaml up -d
    python smo/common/identity/config.py
 
 The python script configure the users within the identity service (keycloak).
@@ -214,7 +214,7 @@ The identity service implemented by Keycloak is configured in a way that the use
 
 In a second step the OAM specific service can be started: ::
 
-   docker-compose -f smo/oam/docker-compose.yml up -d
+   docker-compose -f smo/oam/docker-compose.yaml up -d
 
 Looking into the ONAP SDN-R logs will give you the startup procedure.::
 
@@ -227,12 +227,12 @@ The startup was successful when you see the following line: ::
 
 If you see the login page (https://sdnc-web:8453) you are good to go and can start the (simulated) network.::
 
-   docker-compose -f network/docker-compose.yml up -d
+   docker-compose -f network/docker-compose.yaml up -d
 
 
 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.::
 
-   docker-compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
+   docker-compose -f network/docker-compose.yaml restart ntsim-ng-o-du-1122
    python network/config.py
 
 
@@ -272,9 +272,9 @@ Terminate solution
 
 To stop all container please respect the following order::
 
-   docker-compose -f network/docker-compose.yml down
-   docker-compose -f smo/oam/docker-compose.yml down
-   docker-compose -f smo/common/docker-compose.yml down
+   docker-compose -f network/docker-compose.yaml down
+   docker-compose -f smo/oam/docker-compose.yaml down
+   docker-compose -f smo/common/docker-compose.yaml down
 
 Cleanup
 ^^^^^^^

diff --git a/solution/README.md b/solution/README.md
index 273e707..036b803 100644 (file)
--- a/solution/README.md
+++ b/solution/README.md
@@ -137,16 +137,16 @@ The following commands should be invoked. More detailed can be found in the
 next chapters.
 
 ```
-docker compose -f smo/common/docker-compose.yml up -d
+docker compose -f smo/common/docker-compose.yaml up -d
 python smo/common/identity/config.py
 
-docker compose -f smo/oam/docker-compose.yml up -d
-docker compose -f smo/apps/docker-compose.yml up -d
+docker compose -f smo/oam/docker-compose.yaml up -d
+docker compose -f smo/apps/docker-compose.yaml up -d
 
 # wait until the cpu load is low again
 
-docker compose -f network/docker-compose.yml up -d
-docker compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122 ntsim-ng-o-du-1123
+docker compose -f network/docker-compose.yaml up -d
+docker compose -f network/docker-compose.yaml restart ntsim-ng-o-du-1122 ntsim-ng-o-du-1123
 python network/config.py
 ```
 
@@ -163,10 +163,10 @@ nano network/.env
 Please note that it is necessary to configure first the identity service,
 before starting further docker images.
 
-The several docker-compose yml files must be started in the right order as listed below:
+The several docker-compose yaml files must be started in the right order as listed below:
 
 ```
-docker compose -f smo/common/docker-compose.yml up -d
+docker compose -f smo/common/docker-compose.yaml up -d
 python smo/common/identity/config.py
 ```
 
@@ -175,7 +175,7 @@ A system user (%USER) is also created with administration rights.
 
 
 ```
-docker compose -f smo/oam/docker-compose.yml up -d
+docker compose -f smo/oam/docker-compose.yaml up -d
 ```
 
 Looking into the ONAP SDN-R logs will give you the startup procedure.
@@ -187,13 +187,13 @@ docker logs -f controller
 If you see the login page (https://odlux.oam.smo.o-ran-sc.org) you are good to go and can start the (simulated) network.
 
 ```
-docker compose -f network/docker-compose.yml up -d
+docker compose -f network/docker-compose.yaml up -d
 ```
 
 Usually the first ves:event gets lost. Please restart the O-DU docker container(s) to send a second ves:pnfRegistration.
 
 ```
-docker compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122
+docker compose -f network/docker-compose.yaml restart ntsim-ng-o-du-1122
 python network/config.py
 ```
 
@@ -258,10 +258,10 @@ In case of trouble, please update the commands with your customized '.env' file.
 To stop all container please respect the following order
 
 ```
-docker compose -f network/docker-compose.yml down
-docker compose -f smo/apps/docker-compose.yml down
-docker compose -f smo/oam/docker-compose.yml down
-docker compose -f smo/common/docker-compose.yml down
+docker compose -f network/docker-compose.yaml down
+docker compose -f smo/apps/docker-compose.yaml down
+docker compose -f smo/oam/docker-compose.yaml down
+docker compose -f smo/common/docker-compose.yaml down
 ```
 
 ### Cleanup
@@ -288,7 +288,7 @@ docker rm -f $(docker ps -aq)
 ```
 $ docker ps -a --format "table {{.Names}}\t{{.Image}}\t{{.Status}}" 
 NAMES     IMAGE     STATUS
-$ docker compose -f smo/common/docker-compose.yml up -d
+$ docker compose -f smo/common/docker-compose.yaml up -d
 [+] Running 9/9
  ✔ Network smo            Created                                                                                                                                                                  0.1s 
  ✔ Network dmz            Created                                                                                                                                                                  0.1s 
@@ -309,17 +309,17 @@ User role jargo.fett supervision created!
 User role leia.organa administration created!
 User role luke.skywalker provision created!
 User role r2.d2 administration created!
-$ docker compose -f smo/oam/docker-compose.yml up -d
+$ docker compose -f smo/oam/docker-compose.yaml up -d
 [+] Running 4/4
  ✔ Network oam              Created                                                                                                                                                                0.1s 
  ✔ Container controller     Healthy                                                                                                                                                               83.4s 
  ✔ Container ves-collector  Started                                                                                                                                                                1.2s 
  ✔ Container odlux          Started                                                                                                                                                               84.0s 
-$ docker compose -f smo/apps/docker-compose.yml up -d
+$ docker compose -f smo/apps/docker-compose.yaml up -d
 WARN[0000] Found orphan containers ([odlux controller ves-collector]) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up. 
 [+] Running 1/1
  ✔ Container flows  Started                                                                                                                                                                        0.9s 
-$ docker compose -f network/docker-compose.yml up -d
+$ docker compose -f network/docker-compose.yaml up -d
 WARN[0000] Found orphan containers ([flows odlux controller ves-collector]) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up. 
 [+] Running 6/6
  ✔ Container ntsim-ng-o-du-1123   Started                                                                                                                                                          2.6s 
@@ -328,7 +328,7 @@ WARN[0000] Found orphan containers ([flows odlux controller ves-collector]) for
  ✔ Container ntsim-ng-o-ru-11224  Started                                                                                                                                                          1.9s 
  ✔ Container ntsim-ng-o-du-1122   Started                                                                                                                                                          2.4s 
  ✔ Container ntsim-ng-o-ru-11222  Started                                                                                                                                                          2.3s 
-$ docker compose -f network/docker-compose.yml restart ntsim-ng-o-du-1122 ntsim-ng-o-du-1123
+$ docker compose -f network/docker-compose.yaml restart ntsim-ng-o-du-1122 ntsim-ng-o-du-1123
 [+] Running 2/2
  ✔ Container ntsim-ng-o-du-1122  Started                                                                                                                                                           2.8s 
  ✔ Container ntsim-ng-o-du-1123  Started                                                                                                                                                           2.9s