grafana-util docs

grafana-util access team

這頁在說什麼

列出或瀏覽 live 與本機的 Grafana 團隊,以及建立、修改、匯出、匯入、比對或刪除 Grafana 團隊。

什麼時候看這頁

  • 檢視團隊清單與團隊成員關係。
  • 從 live Grafana 或本機匯出套件中檢視團隊。
  • 建立或更新團隊成員與管理員指派。
  • 匯出或匯入團隊套件。
  • 以 id 或精確名稱刪除團隊。

適合誰

適合要管理 org、使用者、team、service account 與 token 生命週期的管理者。

目的

列出或瀏覽 live 與本機的 Grafana 團隊,以及建立、修改、匯出、匯入、比對或刪除 Grafana 團隊。

使用時機

  • 檢視團隊清單與團隊成員關係。
  • 從 live Grafana 或本機匯出套件中檢視團隊。
  • 建立或更新團隊成員與管理員指派。
  • 匯出或匯入團隊套件。
  • 以 id 或精確名稱刪除團隊。

採用前後對照

  • 採用前:團隊成員關係常常散在 UI 側邊選單或零碎腳本裡。
  • 採用後:同一個命名空間就能處理 inventory、成員更新、匯出/匯入與刪除,而且認證方式一致。

成功判準

  • 團隊成員變更都綁定到精確的 team id 或名稱
  • 在新增或移除成員前,可以先看出管理員指派
  • 匯出的套件可以在另一個環境重複使用,不必手動重建團隊

失敗時先檢查

  • 如果 list、add、modify 或 delete 失敗,先確認這個 team 在選到的 org 裡存在,而且認證範圍正確
  • 如果成員看起來不完整,先核對精確的 member 名稱,以及是否有加上 --with-members
  • 如果匯入結果不如預期,先確認來源套件與目標環境,再重試

主要旗標

  • list: --input-dir, --query, --name, --with-members, --page, --per-page, --table, --csv, --json, --yaml, --output-format
  • browse: --input-dir, --query, --name, --with-members, --page, --per-page
  • add: --name, --email, --member, --admin, --json
  • modify: --team-id, --name, --add-member, --remove-member, --add-admin, --remove-admin, --json
  • exportdiff: --output-dir--diff-dir, --overwrite, --dry-run, --with-members
  • import: --input-dir, --replace-existing, --dry-run, --table, --json, --output-format, --yes
  • delete: --team-id, --name, --yes, --json

範例

# 用途:在新增或移除成員前,先確認 team membership。
grafana-util access team list --profile prod --output-format text
# 用途:先看本機存好的 team 套件。
grafana-util access team list --input-dir ./access-teams --output-format table
# 用途:直接互動式瀏覽本機 team 套件,不碰 live Grafana。
grafana-util access team browse --input-dir ./access-teams --name platform-team
# 用途:建立一個有明確成員與管理員指派的 team。
grafana-util access team add --url http://localhost:3000 --token "$GRAFANA_API_TOKEN" --name platform-team --email platform@example.com --member alice --admin alice --json

相關命令