85 lines
2.6 KiB
Markdown
85 lines
2.6 KiB
Markdown
# rakestraw.dnd
|
|
|
|
An Ansible collection for installing and configuring the D&D
|
|
transcript-processing pipeline on Ubuntu 26.04. The assembled pipeline role is
|
|
available as `rakestraw.dnd.pipeline` and supports Ansible Core 2.18 or newer.
|
|
|
|
Release `0.1.0` contains the reviewed `rakestraw.dnd_pipeline` `v0.1.0`
|
|
snapshot and pins the Seriatim, Audita, Notarius, Scriptorium, and Narratio
|
|
roles to their respective `v0.1.0` releases.
|
|
|
|
The current development snapshot advances Narratio and Notarius through public
|
|
commit pins and includes the suite's separate Notarius testing overlay. This
|
|
does not replace or modify the published `0.1.0` release artifact.
|
|
|
|
## Install release 0.1.0
|
|
|
|
Download the tagged compatibility manifest and install its exact standalone
|
|
role and collection dependencies:
|
|
|
|
```sh
|
|
curl -fLO \
|
|
https://gitea.maximumdirect.net/eric/ansible-collection-dnd/raw/tag/v0.1.0/requirements.yml
|
|
ansible-galaxy install -r requirements.yml
|
|
```
|
|
|
|
Then install the published collection artifact without resolving dependencies
|
|
a second time:
|
|
|
|
```sh
|
|
ansible-galaxy collection install \
|
|
https://gitea.maximumdirect.net/eric/ansible-collection-dnd/releases/download/v0.1.0/rakestraw-dnd-0.1.0.tar.gz \
|
|
--no-deps
|
|
```
|
|
|
|
## Build from source
|
|
|
|
Maintainers can build the collection into a temporary directory after
|
|
installing `requirements.yml`:
|
|
|
|
```sh
|
|
build_dir=$(mktemp -d)
|
|
ansible-galaxy collection build --output-path "$build_dir"
|
|
ansible-galaxy collection install \
|
|
"$build_dir/rakestraw-dnd-0.1.0.tar.gz" --no-deps
|
|
```
|
|
|
|
## Use
|
|
|
|
```yaml
|
|
---
|
|
- name: Install the D&D transcript-processing pipeline
|
|
hosts: pipeline_hosts
|
|
gather_facts: true
|
|
roles:
|
|
- role: rakestraw.dnd.pipeline
|
|
vars:
|
|
dnd_pipeline_whisperx_transcribe_url: https://whisperx.example/transcribe
|
|
```
|
|
|
|
## Maintain the pipeline snapshot
|
|
|
|
[`ansible-role-dnd-pipeline`](https://gitea.maximumdirect.net/eric/ansible-role-dnd-pipeline)
|
|
is authoritative. Make and review role changes there, then import the reviewed
|
|
commit; do not edit `roles/pipeline` directly. The selected commit or immutable
|
|
tag must be pushed to the authoritative repository before collection assembly.
|
|
Replace `PUSHED_COMMIT_OR_TAG` below with that remote revision.
|
|
|
|
Initial import:
|
|
|
|
```sh
|
|
pipeline_revision=PUSHED_COMMIT_OR_TAG
|
|
git subtree add --prefix=roles/pipeline \
|
|
https://gitea.maximumdirect.net/eric/ansible-role-dnd-pipeline.git \
|
|
"$pipeline_revision" --squash
|
|
```
|
|
|
|
Subsequent update:
|
|
|
|
```sh
|
|
pipeline_revision=PUSHED_COMMIT_OR_TAG
|
|
git subtree pull --prefix=roles/pipeline \
|
|
https://gitea.maximumdirect.net/eric/ansible-role-dnd-pipeline.git \
|
|
"$pipeline_revision" --squash
|
|
```
|