Commit d161c2b0 authored by Lucas Nussbaum's avatar Lucas Nussbaum

[dev] update doc

parent 3161652c
Pipeline #50056 passed with stages
in 1 minute and 28 seconds
'''reference-repository''' is Grid'5000's ''single source of truth'' about sites, clusters, nodes, and network topology.
reference-repository
====================
**reference-repository** is Grid'5000's *single source of truth* about sites, clusters, nodes, and network topology.
There are several important parts:
* data/ is the set of JSON files that describe Grid'5000. They are exposed by the ''reference API'' (for example: `curl -k https://api.grid5000.fr/sid/sites/nancy/clusters/graoully/nodes/graoully-1.json?pretty`
* data/ is the set of JSON files that describe Grid'5000. They are exposed by the **reference API** (for example: `curl -k https://api.grid5000.fr/sid/sites/nancy/clusters/graoully/nodes/graoully-1.json?pretty` )
* input/ is the set of YAML files used to generate data/. The files in input/ are either:
+ manually created and edited by admins
+ generated by g5k-checks (this is the case of the nodes descriptions, in the nodes/ directory of each cluster)
......@@ -10,13 +13,13 @@ There are several important parts:
+ to check input/ data for consistency
+ to generate the configuration of various services (and the list of OAR properties)
All tasks are executed using '''rake'''. To see the list of tasks, use '''rake -T'''.
All tasks are executed using **rake**. To see the list of tasks, use `rake -T`.
See also:
* https://www.grid5000.fr/mediawiki/index.php/Reference_Repository
* .gitlab-ci.yml, that automates various checks and the deployment of data files after each commit
* README.generators.md
* doc/README.generators.md
# Credentials
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment