{"id":26404487,"url":"https://github.com/nsls2/n3xtware-abcd-config-demo","last_synced_at":"2026-01-03T18:03:10.596Z","repository":{"id":268008197,"uuid":"902963033","full_name":"NSLS2/n3xtware-abcd-config-demo","owner":"NSLS2","description":"ABCD Config for Demonstration Only","archived":false,"fork":false,"pushed_at":"2024-12-13T18:14:43.000Z","size":2,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-13T19:25:16.759Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NSLS2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-13T16:24:23.000Z","updated_at":"2024-12-13T18:14:47.000Z","dependencies_parsed_at":"2024-12-13T19:25:18.772Z","dependency_job_id":"dab6c6b1-5426-44b6-859d-2642dbfc7864","html_url":"https://github.com/NSLS2/n3xtware-abcd-config-demo","commit_stats":null,"previous_names":["nsls2/n3xtware-abcd-config-demo"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSLS2%2Fn3xtware-abcd-config-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSLS2%2Fn3xtware-abcd-config-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSLS2%2Fn3xtware-abcd-config-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NSLS2%2Fn3xtware-abcd-config-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NSLS2","download_url":"https://codeload.github.com/NSLS2/n3xtware-abcd-config-demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244069599,"owners_count":20393053,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-17T16:36:07.541Z","updated_at":"2026-01-03T18:03:10.539Z","avatar_url":"https://github.com/NSLS2.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Demo Configuration For N3XTware Ansible Based Configuration and Deployment (ABCD)\n\nA 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).\n\nConfiguration is currently accomplished on a per-host basis. The files herein are a substitute to the `host_vars` directories in Ansible.\nThe 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).\n\n## IOC Configuration Conventions\n\nWhen 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.\nEach 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`).\nThe 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).\n\nThe `host.yml` file should contain the following keys, with examples below:\n\n```yaml\n    beamline: TLA\n    hostname: DIRNAME\n    softioc_user: softioc-TLA\n    softioc_group: n2sn-instadmin\n```\n\nThese 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)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnsls2%2Fn3xtware-abcd-config-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnsls2%2Fn3xtware-abcd-config-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnsls2%2Fn3xtware-abcd-config-demo/lists"}