hashicorp/consul

Allow more parameters in topology view `dashboard_url_templates.service`

Open

#12.401 geöffnet am 20. Feb. 2022

Auf GitHub ansehen
 (4 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Go (4.588 Forks)batch import
good first issuetheme/uitype/enhancement

Repository-Metriken

Stars
 (29.891 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 8h) (73 gemergte PRs in 30 T)

Beschreibung

Feature Description

Allow more parameters in ui_config.dashboard_url_templates.service. Parameters like {{Service.Meta.xxx}}.

This was actually allowed and worked back in version 1.9.x

Use Case(s)

Using Consul meta to provide links in topology visualization. For example, when registering service with:

meta {
        dashboard = "G7Z29GzMGz"
        alloc_id = NOMAD_ALLOC_ID
      }

and

  ui_config:
     dashboard_url_templates:
      service: !unsafe "https://grafana.service.consul/d/{{Service.Meta.dashboard}}"

resulting link in the UI should be https://grafana.service.consul/d/G7Z29GzMGz

Contributor Guide

Research-Richtung
Untersuche den Regression, der verhindert hat, dass `{{Service.Meta.xxx}}` in `dashboard url templates.service` funktioniert. Die Funktion hat in Consul 1.9.x funktioniert. Sieh dir die Konfigurationsverarbeitung für `ui config.dashboard url templates.service` in der Go Codebasis an, wahrscheinlich in den Agent oder UI Konfigurationsdateien. Überprüfe die Änderungen zwischen den Versionen, um zu identifizieren, wo die Unterstützung für Template Parameter eingeschränkt wurde. Das Problem erwähnt die Verwendung des `unsafe` YAML Tags, untersuche daher auch, wie Template Strings verarbeitet werden.
Tech Stack
go
Domain
infrastructure
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Go
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50