search

tektoncd / results

Long term storage of execution results.
Apache License 2.0
78 stars 74 forks source link

Document how to add another config overlay #427

Closed adambkaplan closed 1 year ago

adambkaplan commented 1 year ago

Feature request

Add a README that describes how to add an overlay configuration for Tekton Results.

Use case

In https://github.com/tektoncd/results/commit/39b0981e668a7731481dcd9e79457b3e2bb84b3d I reorganized how the yaml manifests for Results are organized. Contributors and end users can't use the current base directory by itself without losing some important information - they must create an overlay or use the default-local-db overlay. We need to describe how to create an overlay, and which components must be included.

enarha commented 1 year ago

I agree we should document that. But shouldn't we also add another overlay (to the existing one) which does not include the local DB (basically base + metadata). I'm sure more use cases/overlays will emerge, but at least cover that other basic scenario. We can use the process of adding that to actually document the process.

tekton-robot commented 1 year ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale with a justification. Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with /close with a justification. If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

enarha commented 1 year ago

Covered by https://github.com/tektoncd/results/pull/447 /close