YAML(YAML 不是標記語言)是一種對人友好的跨語言數據序列化語言,通常用於配置文件,並將數據表示為映射、序列和標量。版本 1.2 使 YAML 成為 JSON 的嚴格超集。在代理和抓取工作中,YAML 出現在配置文件中。例如,Envoy 代理的靜態配置是用 YAML 編寫的,定義了流量流經的監聽器和集群。

YAML 語法基礎

  • 映射: key: value 對,類似於字典或哈希。
  • 序列: 列表,每個項目單獨一行,開頭以 - 開始。
  • 縮排: 在區塊樣式中,縮排決定結構,因此錯位的空格會改變數據的含義。
  • 不使用制表符: 縮排時不得使用制表符字符。
  • 註釋: # 開始一個註釋。

在抓取器和代理配置中安全使用 YAML

YAML 解析器能做的不僅僅是讀取普通數據。PyYAML 文檔警告說,對來自不受信任來源的數據調用 yaml.load 是不安全的,因為它可以構造任意的 Python 對象。它的 yaml.safe_load 函數僅識別標準 YAML 標籤,這使其成為不受信任輸入的文檔選擇。

多行字符串、錨點和多個文檔

  • 字面區塊 (|): 在多行字符串中保留每個換行符。
  • 折疊區塊 (>): 將每個換行符轉換為空格,除了在空行或更多縮排的行之前。
  • 錨點和別名: &name 標記一個節點,*name 之後重用它,而不是重複它。
  • 多個文檔: --- 標記文檔內容的開始,因此一個流可以包含多個文檔。... 結束一個文檔而不開始一個新文檔。

相關術語