Move service-versions.yaml to repo root and add cross-references
Quartz may not handle YAML files in docs/, so move the tracking file to the repo root. Add version tracking checklist items to deploy-k8s-service, add-ansible-role, and adding-a-service guides. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
74ceb742bd
commit
518abac9f4
6 changed files with 14 additions and 3 deletions
|
|
@ -136,8 +136,17 @@ For metrics collection, create a companion `<role>_metrics` role that:
|
|||
|
||||
See [[alloy]] for how metrics are collected from textfiles.
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Role created in `ansible/roles/<role>/`
|
||||
- [ ] Role added to `ansible/playbooks/indri.yml` with tag
|
||||
- [ ] Secrets wired via pre_tasks (if needed)
|
||||
- [ ] Dry run passes: `mise run provision-indri -- --tags <role> --check --diff`
|
||||
- [ ] Service added to `service-versions.yaml` for version tracking
|
||||
|
||||
## Related
|
||||
|
||||
- [[ansible]] - Available roles reference
|
||||
- [[indri]] - Target host
|
||||
- [[observability]] - Metrics collection
|
||||
- [[review-services]] - Periodic service version review
|
||||
|
|
|
|||
|
|
@ -131,6 +131,7 @@ argocd app sync <service>
|
|||
- [ ] Tested on feature branch
|
||||
- [ ] PR reviewed and merged
|
||||
- [ ] Reset to main branch
|
||||
- [ ] Service added to `service-versions.yaml` for version tracking
|
||||
|
||||
## Related
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Show services sorted by when they were last reviewed (most stale first):
|
|||
mise run service-review
|
||||
```
|
||||
|
||||
This reads the tracking file at `docs/reference/services/service-versions.yaml` and sorts by the `last-reviewed` field. Services without a review date float to the top. The script shows a staleness table and then displays the most stale service with a review checklist.
|
||||
This reads the tracking file at `service-versions.yaml` (repo root) and sorts by the `last-reviewed` field. Services without a review date float to the top. The script shows a staleness table and then displays the most stale service with a review checklist.
|
||||
|
||||
To show more entries in the table:
|
||||
|
||||
|
|
@ -64,7 +64,7 @@ Same as ArgoCD, but also check for new chart versions in the mirrored chart repo
|
|||
|
||||
## Marking a Service as Reviewed
|
||||
|
||||
After reviewing, edit `docs/reference/services/service-versions.yaml` and update the service entry:
|
||||
After reviewing, edit `service-versions.yaml` (repo root) and update the service entry:
|
||||
|
||||
```yaml
|
||||
- name: prometheus
|
||||
|
|
|
|||
|
|
@ -246,6 +246,7 @@ See [[grafana]] for dashboard provisioning details.
|
|||
- [ ] Metrics/dashboard configured (if applicable)
|
||||
- [ ] PR created and reviewed
|
||||
- [ ] Reset to main after merge
|
||||
- [ ] Service added to `service-versions.yaml` for version tracking
|
||||
|
||||
## Related
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ from rich.console import Console
|
|||
from rich.panel import Panel
|
||||
from rich.table import Table
|
||||
|
||||
VERSIONS_FILE = Path(__file__).parent.parent / "docs" / "reference" / "services" / "service-versions.yaml"
|
||||
VERSIONS_FILE = Path(__file__).parent.parent / "service-versions.yaml"
|
||||
|
||||
|
||||
def load_services(path: Path) -> list[dict]:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue