hashicorp/consul

Allow more parameters in topology view `dashboard_url_templates.service`

Open

#12,401 创建于 2022年2月20日

在 GitHub 查看
 (4 评论) (2 反应) (0 负责人)Go (29,891 star) (4,588 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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.