hashicorp/consul

Allow more parameters in topology view `dashboard_url_templates.service`

Open

#12,401 opened on 2022年2月20日

GitHub で見る
 (4 comments) (2 reactions) (0 assignees)Go (29,891 stars) (4,588 forks)batch import
good first issuetheme/uitype/enhancement

説明

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

コントリビューターガイド

技術スタック
go
領域
backend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Go programming languageknowledge of Go templatesunderstanding of Consul configuration
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
Investigate the regression that prevented `{{Service.Meta.xxx}}` from working in `dashboard url templates.service`. The feature worked in Consul 1.9.x. Look at the configuration parsing for `ui config.dashboard url templates.service` in the Go codebase, likely in the agent or UI config files. Check the changes between versions to identify where template parameter support was restricted. The issue mentions using `unsafe` YAML tag, so also examine how template strings are processed.