Merge "Add a note about MongoDB requirements to README.md"
authorCedric Ollivier <cedric.ollivier@orange.com>
Thu, 16 Nov 2023 15:38:19 +0000 (15:38 +0000)
committerGerrit Code Review <gerrit@opnfv.org>
Thu, 16 Nov 2023 15:38:19 +0000 (15:38 +0000)
1  2 
README.md

diff --combined README.md
+++ b/README.md
@@@ -18,6 -18,18 +18,18 @@@ to try Xtesting. You will love them
  
  ## [Write your own Xtesting driver](https://www.katacoda.com/ollivier/courses/xtestingci/firstdriver)
  
+ Note that [running MongoDB 5.0+ requires _avx_ CPU instruction set](https://www.mongodb.com/docs/manual/administration/production-notes/#x86_64)
+ that is usually shipped in all recent _x86_ hardware processors.
+ Though, it may not be available in your virtualized environments.
+ For example, Qemu _avx_ support is only available [since version 7.2](https://github.com/nodkz/mongodb-memory-server/issues/710#issuecomment-1297462935)
+ and must be explicitly enabled (e.g. with the argument _-cpu max_).
+ You can check the presence of the _avx_ CPU instruction set on your processor
+ with the following command.
+ ```bash
+ grep '^processor\|^flags.* avx' /proc/cpuinfo
+ ```
  ### dump all the following files in an empty dir
  
  weather.py
@@@ -174,38 -186,16 +186,38 @@@ COPY testcases.yaml /usr/lib/python3.8/
  CMD ["run_tests", "-t", "all"]
  ```
  
 +site.yml
 +
 +```yaml
 +---
 +- hosts:
 +    - 127.0.0.1
 +  roles:
 +    - role: collivier.xtesting
 +      project: weather
 +      registry_deploy: true
 +      repo: 127.0.0.1
 +      dport: 5000
 +      suites:
 +        - container: weather
 +          tests:
 +            - humidity
 +            - pressure
 +            - temp
 +            - half
 +```
 +
  ### make world
  
  Deploy your own Xtesting toolchain
  
  ```bash
 -virtualenv xtesting
 +virtualenv xtesting -p python3 --system-site-packages
  . xtesting/bin/activate
  pip install ansible
  ansible-galaxy install collivier.xtesting
 -ansible-galaxy collection install ansible.posix community.general community.grafana community.kubernetes
 +ansible-galaxy collection install ansible.posix community.general community.grafana \
 +    community.kubernetes community.docker community.postgresql
  ansible-playbook site.yml
  deactivate
  rm -r xtesting
@@@ -217,7 -207,7 +229,7 @@@ Build your containe
  sudo docker build -t 127.0.0.1:5000/weather .
  ```
  
 -Publish your container on your local repository
 +Publish your container on your local registry
  
  ```bash
  sudo docker push 127.0.0.1:5000/weather