Make Audita configuration field-specific
This commit is contained in:
48
README.md
48
README.md
@@ -16,8 +16,36 @@ audita_manage_build_dependencies: true
|
||||
audita_go_snap_channel: 1.26/stable
|
||||
audita_go_binary: /snap/bin/go
|
||||
audita_config_path: /usr/local/etc/audita/config.yml
|
||||
audita_config:
|
||||
version: 1
|
||||
audita_config_version: 1
|
||||
audita_pipeline_modules: null
|
||||
audita_output_schema: null
|
||||
audita_llm_proposal_base_url: null
|
||||
audita_llm_proposal_model: null
|
||||
audita_llm_proposal_api_key_env: null
|
||||
audita_llm_proposal_timeout: null
|
||||
audita_llm_proposal_max_retries: null
|
||||
audita_llm_validation_base_url: null
|
||||
audita_llm_validation_model: null
|
||||
audita_llm_validation_api_key_env: null
|
||||
audita_llm_validation_timeout: null
|
||||
audita_llm_validation_max_retries: null
|
||||
audita_concurrency_total_llm: null
|
||||
audita_concurrency_proposal_llm: null
|
||||
audita_concurrency_validation_llm: null
|
||||
audita_chunking_target_sections: null
|
||||
audita_chunking_max_section_tokens: null
|
||||
audita_chunking_min_section_tokens: null
|
||||
audita_normalization_max_segment_gap: null
|
||||
audita_normalization_ellipsis_gap: null
|
||||
audita_normalization_max_segment_duration: null
|
||||
audita_normalization_max_segment_tokens: null
|
||||
audita_thresholds_glossary: null
|
||||
audita_thresholds_homophones: null
|
||||
audita_thresholds_spoken_word: null
|
||||
audita_thresholds_grammar: null
|
||||
audita_context_description: null
|
||||
audita_diagnostics_work_dir: null
|
||||
audita_diagnostics_retention: null
|
||||
```
|
||||
|
||||
When `audita_manage_build_dependencies` is `false`, Git and the executable
|
||||
@@ -31,10 +59,18 @@ selecting `audita_version`. The role builds Audita directly to
|
||||
the checkout changes or the binary is absent. The source tree is recursively
|
||||
owned by `root:root`; the binary is `root:root` mode `0755`.
|
||||
|
||||
`audita_config` is the complete versioned YAML document, not an overlay on
|
||||
hidden defaults. The role writes it to `audita_config_path` as `root:root` mode
|
||||
`0644`. The repository-local integration suite validates it with Audita rather
|
||||
than executing the CLI during production convergence.
|
||||
The configuration variables map directly to Audita's versioned YAML fields.
|
||||
Every optional variable defaults to `null`; null values and their empty parent
|
||||
sections are omitted, allowing Audita to retain ownership of its built-in
|
||||
defaults. `audita_config_version` always renders as `version` and defaults to
|
||||
`1`. The role writes the resulting file to `audita_config_path` as `root:root`
|
||||
mode `0644`.
|
||||
|
||||
LLM API-key settings name environment variables through
|
||||
`audita_llm_proposal_api_key_env` and `audita_llm_validation_api_key_env`; they
|
||||
must never contain secret values. The repository-local integration suite
|
||||
validates the rendered file with Audita rather than executing the CLI during
|
||||
production convergence.
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user