diff --git a/.gitignore b/.gitignore index 5ed72a7..40b9b02 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # ---> Ansible *.retry +*.tar.gz # ---> Linux *~ @@ -83,4 +84,3 @@ $RECYCLE.BIN/ # Built Visual Studio Code Extensions *.vsix - diff --git a/README.md b/README.md index a92c72b..91cfcd6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,64 @@ -# ansible-collection-dnd +# rakestraw.dnd -An Ansible collection to install the applications needed for a full D&D transcript processing pipeline. \ No newline at end of file +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. + +Initial import: + +```sh +pipeline_commit=$(git -C ../ansible-role-dnd-pipeline rev-parse HEAD) +git subtree add --prefix=roles/pipeline \ + https://gitea.maximumdirect.net/eric/ansible-role-dnd-pipeline.git \ + "$pipeline_commit" --squash +``` + +Subsequent update: + +```sh +pipeline_commit=$(git -C ../ansible-role-dnd-pipeline rev-parse HEAD) +git subtree pull --prefix=roles/pipeline \ + https://gitea.maximumdirect.net/eric/ansible-role-dnd-pipeline.git \ + "$pipeline_commit" --squash +``` diff --git a/galaxy.yml b/galaxy.yml new file mode 100644 index 0000000..24f51f9 --- /dev/null +++ b/galaxy.yml @@ -0,0 +1,28 @@ +--- +namespace: rakestraw +name: dnd +version: 0.1.0 +readme: README.md +authors: + - Eric Rakestraw +description: Install and configure the D&D transcript-processing pipeline. +license: + - CC0-1.0 +tags: + - dnd + - pipeline + - transcript + - processing +repository: https://gitea.maximumdirect.net/eric/ansible-collection-dnd.git +issues: https://gitea.maximumdirect.net/eric/ansible-collection-dnd/issues +dependencies: + ansible.posix: 2.2.0 + community.general: 13.3.0 +build_ignore: + - tests + - .gitignore + - roles/pipeline/.gitignore + - roles/pipeline/ansible.cfg + - roles/pipeline/collections + - roles/pipeline/requirements.yml + - roles/pipeline/tests diff --git a/meta/runtime.yml b/meta/runtime.yml new file mode 100644 index 0000000..114725c --- /dev/null +++ b/meta/runtime.yml @@ -0,0 +1,2 @@ +--- +requires_ansible: ">=2.18.0" diff --git a/requirements.yml b/requirements.yml new file mode 100644 index 0000000..115808d --- /dev/null +++ b/requirements.yml @@ -0,0 +1,27 @@ +--- +roles: + - name: rakestraw.seriatim + src: https://gitea.maximumdirect.net/eric/ansible-role-seriatim.git + scm: git + version: e08c63c0b078658bdfa2d10a2e6e1e4f9372a075 + - name: rakestraw.audita + src: https://gitea.maximumdirect.net/eric/ansible-role-audita.git + scm: git + version: 66ebea9a47ce82bfdbdc5e2855f3dfaaff8e2a16 + - name: rakestraw.notarius + src: https://gitea.maximumdirect.net/eric/ansible-role-notarius.git + scm: git + version: 14a38e04e35ef524d6a97fa7fb5a04981a0a2161 + - name: rakestraw.scriptorium + src: https://gitea.maximumdirect.net/eric/ansible-role-scriptorium.git + scm: git + version: 8b4c86e48e7d8655e479b26dc510bf01683a0c8f + - name: rakestraw.narratio + src: https://gitea.maximumdirect.net/eric/ansible-role-narratio.git + scm: git + version: 292d8669e7aad5cfe80b0c469d22b6177e8cf0f1 +collections: + - name: ansible.posix + version: 2.2.0 + - name: community.general + version: 13.3.0