Skip to content

Jinja Filters

Jinja Helm

base64_encode 

base64_encode(string: str) -> str

Returns base64-encoded string

The given UTF-8 string is encoded to base64 using base64.b64encode.

PARAMETER DESCRIPTION

string

UTF-8 string to be encoded.

TYPE: str

RETURNS DESCRIPTION
str

Base64-encoded string.

TYPE: str

Source code in src/adeploy/common/jinja/filters.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
def base64_encode(string: str) -> str:
    """Returns base64-encoded string

    The given UTF-8 string is encoded to base64 using [base64.b64encode](https://docs.python.org/3/library/base64.html).

    Args:
        string: UTF-8 string to be encoded.

    Returns:
        str: Base64-encoded string.

    """
    return str(base64.b64encode(string.encode("utf-8")), "utf-8")

basename 

basename(path: str) -> str

Returns the basename of the given path using pathlib.Path.

PARAMETER DESCRIPTION

path

The path to get the basename from.

TYPE: str

RETURNS DESCRIPTION
str

The basename from the path.

TYPE: str

Source code in src/adeploy/common/jinja/filters.py 
105
106
107
108
109
110
111
112
113
114
def basename(path: str) -> str:
    """Returns the basename of the given path using [pathlib.Path](https://docs.python.org/3/library/pathlib.html#basic-use).

    Args:
        path: The path to get the basename from.

    Returns:
        str: The basename from the path.
    """
    return Path(path).name

quote 

quote(string: str) -> str

Quotes the given string

This filter add quotations "..." around the given string and escapes any quotations inside the string.

PARAMETER DESCRIPTION

string

The string to be quoted.

TYPE: str

RETURNS DESCRIPTION
str

String with quotations.

TYPE: str

Example: Quote a property value

templates/deployment.yml
metadata:
  name: my-deployment
  namespace: playground
  labels:
    app.kubernetes.io/instance: prod
    app.kubernetes.io/component: nginx
    app.kubernetes.io/version: {{ version('nginx') | quote }}
Source code in src/adeploy/common/jinja/filters.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def quote(string: str) -> str:
    """Quotes the given string

    This filter add quotations `"..."` around the given string and escapes any quotations inside the string.

    Args:
        string: The string to be quoted.

    Returns:
        str: String with quotations.

    !!!example "Example: Quote a property value"

        ```{.yaml title="templates/deployment.yml" hl_lines="7"}
        metadata:
          name: my-deployment
          namespace: playground
          labels:
            app.kubernetes.io/instance: prod
            app.kubernetes.io/component: nginx
            app.kubernetes.io/version: {{ version('nginx') | quote }}
        ```

    """
    return '"' + str(string).replace('"', '\\"') + '"'

sha256sum 

sha256sum(string: str) -> str

Creates a SHA256 hash

Creates a SHA256 hash from the given string using hashlib.sha256.

PARAMETER DESCRIPTION

string

UTF-8 string to be hashed.

TYPE: str

RETURNS DESCRIPTION
str

Hex representation of SHA265 as string.

TYPE: str

Example: Use a SHA265 hash of a config map to trigger a re-creation of k8s API objects on changes

template/nginx/deployment.yml
  template:
    metadata:
      labels:
        app.kubernetes.io/part-of: {{ name }}
        app.kubernetes.io/instance: {{ release }}
        app.kubernetes.io/component: nginx
      annotations:
        checksum/config: |
          {{ include_file("common/configmap.yml") | sha256sum }}
Source code in src/adeploy/common/jinja/filters.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def sha256sum(string: str) -> str:
    """Creates a SHA256 hash

    Creates a SHA256 hash from the given string using [hashlib.sha256](https://docs.python.org/3/library/hashlib.html#hashlib.sha256).

    Args:
        string: UTF-8 string to be hashed.

    Returns:
        str: Hex representation of SHA265 as string.

    !!!example "Example: Use a SHA265 hash of a config map to trigger a re-creation of k8s API objects on changes"
        ```{.yaml title="template/nginx/deployment.yml" hl_lines="7-9"}
        --8<-- "examples/jinja/003-include/templates/nginx/deployment.yml:example-sha256"
        ```
    """
    hash = hashlib.sha256()
    hash.update(string.encode("utf-8"))
    return hash.hexdigest()

yaml 

yaml(obj: Union[JinjaDict, dict], flow_style: bool) -> str

Converts given object into YAML formatted string

This filter is using PyYAML to convert the given object into a YAML formatted string.

PARAMETER DESCRIPTION

obj

The object to convert into the YAML formatted string.

TYPE: Union[JinjaDict, dict]

flow_style

By default, PyYAML chooses the style of a collection depending on whether it has nested collections. If a collection has nested collections, it will be assigned the block style. Otherwise it will have the flow style. Set True or False to explicitly define the flow style to use.

TYPE: bool

RETURNS DESCRIPTION
str

YAML representation of the given data.

TYPE: str

Example: Using the yaml() filter with flow_style=False

templates/ingress.yml
spec:
  ingressClassName: {{ ingress.className }}
  {% if ingress.get('tls', False) %}
  tls:
    {{ ingress.get('tls') | yaml(false) | indent(4) }}
  {% endif %}

Will result in the following:

build/jinja/playground/002-secrets-ingress/prod/ingress.yml
spec:
  ingressClassName: external

  tls:
  - hosts:
    - mydomain.com
    secretName: secret-6e1adb2c4c075e35335e851dd6ebc5f0f7397a80
Source code in src/adeploy/common/jinja/filters.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def yaml(obj: Union[jinja_dict.JinjaDict, dict], flow_style: bool) -> str:
    """Converts given object into YAML formatted string

    This filter is using [PyYAML](https://pyyaml.org/wiki/PyYAMLDocumentation) to convert the given object into a
    YAML formatted string.

    Args:
        obj: The object to convert into the YAML formatted string.
        flow_style: By default, PyYAML chooses the style of a collection depending on whether it has nested collections.
            If a collection has nested collections, it will be assigned the block style. Otherwise it will have the flow
            style. Set `True` or `False` to explicitly define the flow style to use.

    Returns:
        str: YAML representation of the given data.

    !!!example "Example: Using the `yaml()` filter with `flow_style=False`"

        ```{.yaml title="templates/ingress.yml" hl_lines="5"}
        --8<-- "examples/jinja/002-secrets-ingress/templates/ingress.yml:example-filter-yaml"
        ```

        Will result in the following:

        ```{.yaml title="build/jinja/playground/002-secrets-ingress/prod/ingress.yml" hl_lines="5-7"}
        --8<-- "examples/jinja/002-secrets-ingress/build/jinja/playground/002-secrets-ingress/prod/ingress.yml:example-filter-yaml"
        ```
    """
    if isinstance(obj, jinja_dict.JinjaDict):
        obj = obj.get_dict()
    return _yaml.safe_dump(obj, default_flow_style=flow_style, sort_keys=False)