kargo-loki-gateway/knowledge.yaml at main · corewire/kargo-loki-gateway · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# Auto-generated by make docs-gen — do not edit manually.
project:
  name: kargo-loki-gateway
  description: "HTTP gateway that bridges Kargo's log viewer and Loki"
  module: github.com/corewire/kargo-loki-gateway
  go_version: "1.26.6"
  license: MIT
  namespace: kargo
config:
  - env: LOKI_URL
    default: "http://loki-gateway.loki.svc.cluster.local"
    meaning: "Loki base URL"
  - env: LISTEN_ADDR
    default: ":8080"
    meaning: "Listen address"
  - env: LOG_WINDOW
    default: "30m"
    meaning: "Window after AnalysisRun.startedAt"
  - env: FALLBACK_WINDOW
    default: "24h"
    meaning: "Window when AnalysisRun is missing or GC'd"
  - env: LIMIT
    default: "5000"
    meaning: "Loki result line limit"
  - env: LOKI_TIMEOUT
    default: "15s"
    meaning: "Per-request Loki timeout"
  - env: K8S_TIMEOUT
    default: "5s"
    meaning: "k8s API lookup timeout (separate from Loki)"
  - env: K8S_API
    default: "https://kubernetes.default.svc"
    meaning: "k8s API server (in-cluster default)"
  - env: LOKI_USERNAME
    default: ""
    meaning: "Basic auth username (e.g. Grafana Cloud user ID)"
  - env: LOKI_PASSWORD
    default: ""
    meaning: "Basic auth password / API key"
  - env: LOKI_BEARER_TOKEN
    default: ""
    meaning: "Bearer token (e.g. Loki behind an auth proxy)"
  - env: LOKI_TENANT_ID
    default: ""
    meaning: "X-Scope-OrgID header for multi-tenant Loki"
tests:
  - name: TestBuildQuery
    meaning: ""
  - name: TestPodNamePrefix
    meaning: ""
  - name: TestNameValidation
    meaning: ""
  - name: TestQueryLokiSorted
    meaning: ""
  - name: TestQueryLokiEmpty
    meaning: ""
  - name: TestQueryLokiUpstreamError
    meaning: ""
  - name: TestAnalysisRunStartedAt
    meaning: ""
  - name: TestAnalysisRunStartedAtMissing
    meaning: ""
  - name: TestHandleLogsNoNamespace
    meaning: ""
  - name: TestHandleLogsInvalidParam
    meaning: ""
  - name: TestHandleLogsLokiDown
    meaning: ""
  - name: TestHandleLogsEmptyResult
    meaning: ""
  - name: TestHealthz
    meaning: ""
  - name: TestQueryLokiBasicAuth
    meaning: ""
  - name: TestQueryLokiBearerToken
    meaning: ""
  - name: TestQueryLokiTenantID
    meaning: ""
  - name: TestQueryLokiBearerAndTenant
    meaning: ""
  - name: TestQueryLokiBasicAuthTakesPrecedenceOverBearer
    meaning: ""
make_targets:
  - name: docs-gen:
    meaning: "Regenerate llms.txt, llms-full.txt, AGENTS.md, knowledge.yaml from source annotations."
  - name: docs-diff:
    meaning: "Show what docs-gen would change without writing files (exits 1 if stale)."
  - name: devenv:
    meaning: "Start local dev environment via Tilt (creates kind cluster if needed)."
conventions:
  - "stdlib-only Go — never add external dependencies"
  - "pod name is Alloy structured metadata — use \"| pod=~\\\"...\\\"\" after the selector, never inside {}"
  - "do not put business logic in main.go — it wires only"
  - "LOKI_USERNAME/LOKI_PASSWORD (basic) or LOKI_BEARER_TOKEN (bearer); LOKI_TENANT_ID is independent"
  - "do not manually edit llms.txt, llms-full.txt, AGENTS.md — run make docs-gen"