README: updated the readme with the new repo content
Signed-off-by: Marc Mattmüller <marc.mattmueller@netmodule.com>
This commit is contained in:
parent
091f8f8e0d
commit
319a755428
53
README.md
53
README.md
|
|
@ -4,35 +4,34 @@ NetModule Wireless Linux (NWL).
|
|||
|
||||
|
||||
## Content
|
||||
This repository holds the documentation for the CI environment and the jobs for
|
||||
the NWL as declarative pipelines (multibranch):
|
||||
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
|
||||
|
||||
* jobs
|
||||
|
||||
- Jenkinsfile_Build
|
||||
|
||||
+ a pipeline building a NWL yocto target
|
||||
|
||||
- Jenkinsfile_Common
|
||||
|
||||
+ a collection of commonly used functions, so that duplicated code can be
|
||||
avoided
|
||||
|
||||
* inventory
|
||||
|
||||
- Ansible inventory with all managed hosts/devices
|
||||
|
||||
* playbooks
|
||||
|
||||
- Ansible playbooks
|
||||
|
||||
|
||||
## Marginal Notes
|
||||
This repository does NOT cover the setup of the Jenkins instance.
|
||||
- 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
|
||||
|
|
|
|||
Loading…
Reference in New Issue