Merge "Add missing licences"
authorJohn Keeney <John.Keeney@est.tech>
Mon, 25 May 2020 17:35:54 +0000 (17:35 +0000)
committerGerrit Code Review <gerrit@o-ran-sc.org>
Mon, 25 May 2020 17:35:54 +0000 (17:35 +0000)
1  2 
test/mrstub/README.md

diff --combined test/mrstub/README.md
@@@ -65,24 -65,7 +65,24 @@@ There are a number of counters that ca
  ```docker run -it -p 3905:3905 mrstub```
  
  >Start the image on http and https<br>
 +By default, this image has default certificates under /usr/src/app/cert
 +file "cert.crt" is the certificate file
 +file "key.crt" is the key file
 +file "generate_cert_and_key.sh" is a shell script to generate certificate and key
 +file "pass" stores the password when you run the shell script
 +
 +Start the a1-interface container without specifing external certificates:
 +```docker run -it -p 3905:3905 -p 3906:3906 mrstub```
 +
 +It will listen to http 3905 port and https 3906 port(using default certificates) at the same time.
 +
 +This certificates/key can be overriden by mounting a volume when using "docker run" or "docker-compose"
 +In 'docker run', use field:
 +--volume "$PWD/certificate:/usr/src/app/cert" a1test
  ```docker run -it -p 3905:3905 -p 3906:3906 -v "/PATH_TO_CERT/cert:/usr/src/app/cert" mrstub```
 +In 'docker-compose.yml', use field:
 +volumes:
 +      - ./certificate:/usr/src/app/cert:ro
  
  The script ```mrstub-build-start.sh``` do the build and docker run in one go. This starts the stub container in stand-alone mode for basic test.<br>If the mrstub should be executed manually with the agent, replace docker run with this command to connect to the docker network with the correct service name (--name shall be the same as configured in consul for the read and write streams).
  ```docker run -it -p 3905:3905 --network nonrtric-docker-net --name message-router mrstub```
  
  ### Basic test ###
  
- Basic test is made with the script ```basic_test.sh nonsecure|secure``` which tests all the available urls with a subset of the possible operations. Choose nonsecure for http and secure for https. Use the script ```mrstub-build-start.sh``` to start the mrstub in a container first.
+ Basic test is made with the script ```basic_test.sh nonsecure|secure``` which tests all the available urls with a subset of the possible operations. Choose nonsecure for http and secure for https. Use the script ```mrstub-build-start.sh``` to start the mrstub in a container first.
+ ## License
+ Copyright (C) 2020 Nordix Foundation. All rights reserved.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.