Files
ansible-collection-dnd/README.md

67 lines
2.0 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.
## Install from source
Bootstrap the collection's exact standalone-role and collection dependencies:
```sh
ansible-galaxy install -r requirements.yml
```
Build the collection into a temporary directory, then install the artifact
without resolving dependencies a second time:
```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
```
The development manifest uses immutable role commit pins. A future released
collection may instead consume reviewed role tags; this repository does not
claim that version `0.1.0` has been published or tagged.
## 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
```