LibreCloud/Upclapi
1
1
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

chore: add yaml attributes comments

Browse Source
This commit is contained in:
Jesús Pérez Lorenzo 2021-08-31 12:21:23 +01:00
parent 795e34363f
commit a8b8152d98
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -28,6 +28,7 @@ It clearly does not try to replace tools like [Terraform](https://www.terraform.
- create [Ansible inventories](https://docs.ansible.com/ansible/latest/index.html)
- resources lists in **json**
- prototyping
- resources costs
...
- As a provider tool for other **LibreClouds** [Klouds](https://rlung.librecloud.online/LibreCloud/Klouds#klouds) tools: [CloudMandala](https://rlung.librecloud.online/LibreCloud/CloudMandala#cloudmandala) and [Zteron](https://rlung.librecloud.online/LibreCloud/CloudMandala#cloudmandala)
@ -283,6 +284,12 @@ servers:
```
Attributes and values are declared in [main.go](https://rlung.librecloud.online/LibreCloud/Upclapi/src/branch/master/main.go) and *yaml parsed*.
A lot of definitions (__apps, tsksrvcs, cntrllrs, etc.__) are used mainly for other **LibreClouds** [Klouds](https://rlung.librecloud.online/LibreCloud/Klouds#klouds) tools: [CloudMandala](https://rlung.librecloud.online/LibreCloud/CloudMandala#cloudmandala) and [Zteron](https://rlung.librecloud.online/LibreCloud/CloudMandala#cloudmandala). These [Klouds](https://rlung.librecloud.online/LibreCloud/Klouds#klouds) tools developed in [Rust](https://www.rust-lang.org/) declare attributes and values with [Dhall language](https://dhall-lang.org/) and then converted to formats like yaml and json (so types are consistent and grouped accordly).
[{...}UpClapi](https://rlung.librecloud.online/LibreCloud/Upclapi#upclapi) consumes <u>ONLY yaml</u> config/declaration files, and can be used for standalone proposal with yaml resources declaration files (in such case set empty definitions for: __apps, tsksrvcs, cntrllrs__)
## Environment
Main vars: