diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0a3dc9 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Osmocom CI and infrastructure files + +## ansible +Ansible rules for setting up machines of the Osmocom infrastructure. +See `ansible/README.md`. + +## contrib +Scripts and files that did not fit into other directories. + +## coverity +Scripts used to submit the osmocom sources for coverity scan. This depends on a +`tokens.txt`, see `coverity/get_token.sh`. + +### how to upgrade +* Download the latest version from [here](https://scan.coverity.com/download) +* Find the "upgrade considerations" [here](https://sig-product-docs.synopsys.com/bundle/coverity-docs/page/upgrade-guide/topics/important_upgrade_considerations.html) +* Place the resulting `cov-analysis-linux64-$VERSION.tar.gz` in `ansible/files` +* Adjust `coverity_version` in `ansible/roles/install-coverity/defaults/main.yml` +* Deploy the ansible playbook: +``` +$ cd ansible +$ ansible-playbook -v -i hosts setup-jenkins-slave.yml -l coverity_slaves -t coverity +``` +* On success, only one task should be skipped (the "Please download..." task): +``` +PLAY RECAP ******************************************************************************************************************** +build2-deb11build-ansible : ok=8 changed=4 unreachable=0 failed=0 skipped=1 rescued=0 ignored=0 +build3-deb11build-ansible : ok=9 changed=4 unreachable=0 failed=0 skipped=1 rescued=0 ignored=0 +build4-deb12build-ansible : ok=9 changed=4 unreachable=0 failed=0 skipped=1 rescued=0 ignored=0 +``` + +## jobs +Jenkins Job Builder YAML files defining jenkins jobs. Read `jobs/README.adoc` +for more information about deployment. + +## lint +The linter running on patches submitted via gerrit. See the wiki page +[Linting](https://osmocom.org/projects/cellular-infrastructure/wiki/Linting) +for more information. + +## qemu-kvm +A script to create a virtual machine with kernel gtp ggsn for qemu-kvm. + +## scripts +Scripts used by jenkins jobs. Various `osmo*/contrib/jenkins.sh` scripts assume +osmo-ci to be checked out in the build slave user's home, i.e. using a PATH of +`$HOME/osmo-ci/scripts`. + +## _docker_playground +A clone of +[docker-playground](https://gitea.osmocom.org/osmocom/docker-playground), +so the scripts can build required docker images. This dir gets created on +demand by scripts/common.sh, and automatically fetched and reset to +"origin/master" (override with `$OSMO_BRANCH_DOCKER_PLAYGROUND`). The fetch and +reset gets skipped if _docker_playground is a symlink. For development, set it +up as follows: + +``` +$ git clone https://gitea.osmocom.org/osmocom/docker-playground +$ git clone https://gitea.osmocom.org/osmocom/osmo-ci +$ cd osmo-ci +$ ln -s ../docker-playground _docker_playground +``` |