Go to file

Marc Mattmüller be603724d2 jobs/common: refactored gitCheckout() for using more flexible the function gitCheckout() holds the following steps: - git clone unless done - checking out a branch/tag/commit including rebase and updating submodules - launching the update source revision script - printing the submodule status - printing the last 3 commits of the git history But so far you could not use the steps separately. Thus, this function was refactored by extracting some steps into own functions so that they can be used easily. Example: the job workspace is the cloned git repository and you want to update the source revision hashes ;-P Signed-off-by: Marc Mattmüller <marc.mattmueller@netmodule.com>		2023-08-29 14:40:31 +02:00
collections	playbooks,collections: renamed to .yml and added collection requirements	2023-05-02 13:14:31 +02:00
doc	doc/nwl-ci: updated sections about integrating seed job in NWL HAC instance	2023-08-28 18:22:42 +02:00
docker	docker/nwl-cicd.yaml: added wipeWorkspace to seed job	2023-08-28 16:32:40 +02:00
inventory	inventory: added netmodule-01 as host to inventory	2023-07-18 10:43:14 +02:00
jobs	jobs/common: refactored gitCheckout() for using more flexible	2023-08-29 14:40:31 +02:00
playbooks/getting_started	playbooks: updated hosts with target variable	2023-08-21 16:34:44 +02:00
.gitignore	README,doc: added next-level-CI and NWL-CI documentation	2023-04-18 16:05:34 +02:00
README.md	README: updated the readme with the new repo content	2023-06-21 12:52:57 +02:00
ansible.cfg	ansible.cfg,os-rls.yml: added configuration for files and fixed var	2023-05-09 15:19:43 +02:00
docker-compose.yaml	docker, playbooks: adaption for integrating root CA	2023-07-11 15:15:43 +02:00

README.md

NetModule Wireless Linux CI/CD Repository

This repository contains all necessary jobs for the CI/CD environment of the NetModule Wireless Linux (NWL).

Content

This repository holds the automation files for ansible, the CI environment for the NWL and its documentation:

doc
- the documentation of the work for the NWL CI environment
ansible automation:
- ansible.cfg
  - the paths of inventory, collections, etc for AWX
- inventory
  - the ansible inventory with all managed hosts/devices
- playbooks
  - ansible playbooks
jenkins environment:
- jobs
  - Jenkinsfile_Common
    - a collection of commonly used functions, so that duplicated code can be avoided
  - Jenkinsfile_Build / Jenkinsfile_Build_awx
    - a pipeline building a NWL yocto target (postfix awx is for the instance set up with AWX)
  - Jenkinsfile_Documentation_awx
    - a pipeline building the CI documentation (for the instance set up with AWX)
- docker
  - Dockerfile
  - nwl-cicd.yaml
  - plugins.txt
- docker-compose.yaml

Building the Documentation

The documentation bases on sphinx and is written in reStructuredText format. To build the documenation you need to install sphinx first:

sudo apt install python3-sphinx
sudo pip3 install cloud-sptheme

Within the directory doc you can use make as follows:

# entering doc:
cd doc

# clean and build the documentation:
make clean
make html

# open the generated documentation in the browser:
xdg-open out/html/index.html

cd ..