Document standalone and collection pipeline usage
This commit is contained in:
23
README.md
23
README.md
@@ -18,8 +18,7 @@ ansible-galaxy collection install -r collections/requirements.yml
|
||||
The dependency manifest installs the roles under their canonical names:
|
||||
`rakestraw.seriatim`, `rakestraw.audita`, `rakestraw.notarius`,
|
||||
`rakestraw.scriptorium`, and `rakestraw.narratio`. This standalone role is
|
||||
named `rakestraw.dnd_pipeline`; a later collection release will expose it as
|
||||
`rakestraw.dnd.pipeline`.
|
||||
named `rakestraw.dnd_pipeline`.
|
||||
|
||||
```yaml
|
||||
---
|
||||
@@ -32,6 +31,26 @@ named `rakestraw.dnd_pipeline`; a later collection release will expose it as
|
||||
dnd_pipeline_whisperx_transcribe_url: https://whisperx.example/transcribe
|
||||
```
|
||||
|
||||
The collection source exposes a reviewed snapshot of this role as
|
||||
`rakestraw.dnd.pipeline`:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Install the D&D pipeline from the collection
|
||||
hosts: pipeline_hosts
|
||||
gather_facts: true
|
||||
roles:
|
||||
- role: rakestraw.dnd.pipeline
|
||||
vars:
|
||||
dnd_pipeline_whisperx_transcribe_url: https://whisperx.example/transcribe
|
||||
```
|
||||
|
||||
Collection consumers should follow the unified bootstrap instructions in the
|
||||
[`rakestraw.dnd` collection repository](https://gitea.maximumdirect.net/eric/ansible-collection-dnd).
|
||||
This standalone repository remains authoritative for role changes; collection
|
||||
maintainers import a reviewed commit as a snapshot. This does not imply that a
|
||||
collection release has been published or tagged.
|
||||
|
||||
## Variables
|
||||
|
||||
`dnd_pipeline_whisperx_transcribe_url` is required and is passed to Narratio.
|
||||
|
||||
Reference in New Issue
Block a user