https://github.com/nsls2/n3xtware-abcd-config-demo
ABCD Config for Demonstration Only
https://github.com/nsls2/n3xtware-abcd-config-demo
Last synced: 6 months ago
JSON representation
ABCD Config for Demonstration Only
- Host: GitHub
- URL: https://github.com/nsls2/n3xtware-abcd-config-demo
- Owner: NSLS2
- License: bsd-3-clause
- Created: 2024-12-13T16:24:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-13T18:14:43.000Z (over 1 year ago)
- Last Synced: 2024-12-13T19:25:16.759Z (over 1 year ago)
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Demo Configuration For N3XTware Ansible Based Configuration and Deployment (ABCD)
A tutorial for the N3XTware SDAT can be found in [docs/tutorial-mvp-1.md](https://github.com/NSLS2/n3xtware-abcd-config-demo/blob/main/docs/tutorial-mvp-1.md).
Configuration is currently accomplished on a per-host basis. The files herein are a substitute to the `host_vars` directories in Ansible.
The directories are named after the hosts that they are intended for, with YAML configuration according to the [ioc-deploy-roles n3xtware branch](https://github.com/nsls2/ioc-deploy-roles/tree/n3xtware).
## IOC Configuration Conventions
When deploying the IOCs for a host, the ansible role `DeployIOC` will iterate over the `iocs` list in the `ioc.yml` file in the host configuration directory.
Each IOC in the list should have a corresponsing configuration file in the directory with a dictionary with a single key of the IOC name (e.g., `xspress3.yml` should have a single dictionary with the key `xspress3`).
The value of that key should be a dictionary with keys specific to the IOC; for more information consult the [ioc-deploy-roles n3xtware branch](https://github.com/nsls2/ioc-deploy-roles/tree/n3xtware).
The `host.yml` file should contain the following keys, with examples below:
```yaml
beamline: TLA
hostname: DIRNAME
softioc_user: softioc-TLA
softioc_group: n2sn-instadmin
```
These variables will be loaded in place of `host_vars` in the `DeployIOC` role (e.g., through a combination of git clone and [`ansible.builtin.include_vars`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/include_vars_module.html)).