如何通过Ansible Inventory将竖线|作为文本传递至Helm Values.yml并保留Grafana Ingress注解格式

Let's break down how to solve the issue where Ansible's to_nice_yaml collapses your multi-line Nginx server snippet into a single line, plus how to pass the YAML block style (|) directly from your inventory.

1. Why Your Current Setup Isn't Working #

When you use to_nice_yaml, Ansible automatically flattens strings without explicit line breaks into a single quoted string. If you’ve been defining the server snippet as a one-liner in your Ansible vars, that’s why the output loses the block format. To retain the | marker and multi-line structure, you need to ensure the variable contains actual line breaks and is treated as a multi-line string.

2. Solution 1: Define Multi-Line Strings in Ansible Vars #

The simplest fix is to build your ingress annotations with proper YAML block syntax directly in your Ansible variables. This guarantees to_nice_yaml preserves the format you want.

Step 1: Set Up Your Ansible Variables #

# In playbook vars, group_vars, or host_vars
grafana_helm_values:
  grafana:
    ingress:
      annotations:
        nginx.ingress.kubernetes.io/server-snippet: |
          http2_max_header_size 16k;
          http2_max_field_size 16k;
      enabled: true
      hosts:
        - grafana.XXXX

Step 2: Generate the Values.yml File #

Use the copy module with to_nice_yaml to write the config, ensuring correct indentation:

- name: Generate Grafana Helm values file
  copy:
    dest: ./grafana-values.yml
    content: "{{ grafana_helm_values | to_nice_yaml(indent=2) }}"

This will output the exact block-style YAML you need, since the variable already includes the multi-line string with the | marker.

3. Solution 2: Pass Block Style from Inventory #

If you need to pull the server snippet (including the | block marker) from your Ansible inventory, use one of these options based on your inventory format:

Option A: YAML Inventory #

Define the multi-line variable directly with block syntax in your YAML inventory:

# inventory.yml
all:
  hosts:
    grafana-server:
      ansible_host: 192.168.1.100
      grafana_server_snippet: |
        http2_max_header_size 16k;
        http2_max_field_size 16k;

Option B: INI Inventory #

For INI inventories, wrap the multi-line string in quotes and include line breaks:

# inventory.ini
[grafana]
grafana-server ansible_host=192.168.1.100 grafana_server_snippet="|
http2_max_header_size 16k;
http2_max_field_size 16k;"

Step 3: Use the Inventory Variable in Your Playbook #

Reference the inventory variable to build your Helm config:

grafana_helm_values:
  grafana:
    ingress:
      annotations:
        nginx.ingress.kubernetes.io/server-snippet: "{{ grafana_server_snippet }}"
      enabled: true
      hosts:
        - grafana.XXXX

Then generate the values file as shown in Solution 1.

4. Alternative: Use blockinfile for Precise Control #

If to_nice_yaml still causes issues, use Ansible's blockinfile module to directly insert the annotated block into your values file. This bypasses any YAML filtering quirks:

- name: Create base Grafana values file
  copy:
    dest: ./grafana-values.yml
    content: |
      grafana:
        ingress:
          enabled: true
          hosts:
            - grafana.XXXX

- name: Insert multi-line ingress annotation
  blockinfile:
    path: ./grafana-values.yml
    marker: "# {mark} ANSIBLE MANAGED INGRESS ANNOTATIONS"
    block: |
          annotations:
            nginx.ingress.kubernetes.io/server-snippet: |
              http2_max_header_size 16k;
              http2_max_field_size 16k;
    insertafter: "grafana:\n  ingress:"

This ensures the block style is preserved exactly as written.

内容的提问来源于stack exchange，提问作者shirab