How to import config templates?

[chuegel]

For a specific device role we have a base config template with macros (onboarding_macros.j2)
We would like to import this template into a second one for that device role

{% import 'onboarding_macros.j2' as macro %}
hostname {{ device.name }}
!
logging buffered 40960
---snip---

How can we achieve this? Is this only possible when using a local data source as file?
According to this discussion it should be possible
Thanks

[abhi1693]

#11559 (comment)

[chuegel]

Thanks for you reply.
Well, yes I came across that discussion but in that example it assumes the templates reside locally in the common folder.
My config templates are not sourced from a external data source.

[kkthxbye-code]

Is this only possible when using a local data source as file?

Yes.

[chuegel]

OK, so how is this suppose to work? I've mounted a ConfigMap with the template inside netbox-worker pod under /opt/netbox/netbox/config-templates/base_macros.j2

Note: I later found out that local is referring to the netbox-worker pod and not netbox

In Netbox I created a local data source to see if netbox can access the local file:

• Name: base
• Type: local
• Path: file:///opt/netbox/netbox/config-templates/

After sync I could see the data file base_macros.j2
But when importing from within a template:

{% import '/opt/netbox/netbox/config-templates/base_macros.j2' as macro %}

it throws an error:

Traceback (most recent call last):
  File "/opt/netbox/netbox/dcim/views.py", line 2100, in get_extra_context
    rendered_config = config_template.render(context=context_data)
  File "/opt/netbox/netbox/extras/models/configs.py", line 252, in render
    output = template.render(**context)
  File "/opt/netbox/venv/lib/python3.10/site-packages/jinja2/environment.py", line 1301, in render
    self.environment.handle_exception()
  File "/opt/netbox/venv/lib/python3.10/site-packages/jinja2/environment.py", line 936, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "<template>", line 1, in top-level template code
  File "/opt/netbox/venv/lib/python3.10/site-packages/jinja2/loaders.py", line 99, in get_source
    raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: /opt/netbox/netbox/config-templates/base_macros.j2

[chuegel]

Any hints how to include locally stored templates into Config Templates?
Does NetBox require a specific path?

[chuegel]

Got it..thanks

[eviboo]

So, what was the correct path?

[chuegel]

Since we couldn't use ignore rules on the git repo (#13611) we endet up creating a new repo only for templates.
As such, we created a git Data Source in NB and referenced the templates that way. For complete reference here is a config template:

{% import 'sites/MUC01/roles/xl_edge/macros/base_macros.j2' as macro %}
hostname {{ device.name }}
ip domain-name vrf Mgmt-vrf {{ domain_name }}
netconf-yang
netconf-yang feature candidate-datastore
ip http secure-server
ip http authentication aaa
restconf
ip scp server enable
!
logging buffered 40960
username rescue privilege 15 secret 9 ****
username ansible privilege 15 secret 9 ****
no ip domain lookup
lldp run
!
{# set DNS server -#}
ip name-server vrf Mgmt-vrf {{ name_server | join(" ") }}
!
!
{# Configure NTP server or peers -#}
{%- if ntp_server is defined -%}
{%- for server in ntp_server -%}
ntp server vrf Mgmt-vrf {{ server }}
{% endfor -%}
{% elif ntp_peer is defined %}
{% for server in ntp_peer %}
ntp peer vrf Mgmt-vrf {{ server }}
{% endfor -%}
{%- endif -%}
!
!
{#- aaa configuration -#}
{{ macro.aaa() }}
!
!
{#- configure some service settings -#}
{{ macro.service() }}
{#- set timezone -#}
!
{{ macro.timezone(time_zone) }}
{#- set banner for login -#}
banner exec $
HOSTNAME            {{ device.name }}
ROLE                {{ device.device_role }}
SITE                {{ device.site }}
LOCATION            {{ device.location }}
RACK                {{ device.rack }}
MANUFACTURER        {{ device.device_type.manufacturer }}
MODEL               {{ device.device_type }}
SERIAL              {{ device.serial }}
TAGS                {{ device.tags.names() | join(", ") }}

$
!
banner login $

Unauthorized access prohibited!

$
!
!
{%- for vl in device.site.vlans.filter(group__name="EDGE_VLANS") %}
vlan {{vl.vid }} 
name {{ vl.name }} 
{%- endfor %}
!
{% for interface in device.interfaces.all() -%}
{% if interface.mgmt_only == false %}
!
interface {{ interface.name }}
  {%- if interface.description != None %}
description {{ interface.description }}
  {%- endif %}
  {%- if interface.enabled == false %}
shutdown
  {%- elif interface.enabled == true %}
no shutdown
  {%- endif %}
  {%- if "no_cdp_lldp" in interface.tags.names() %}
no cdp enable
no lldp transmit
no lldp receive
  {%- endif %}
  {%- if interface.mode == "access" %}
switchport mode access
switchport access vlan {{ interface.untagged_vlan.vid }}
  {%- elif interface.mode == "tagged" %}
switchport mode trunk
    {%- for vlan in interface.tagged_vlans.all() %}
switchport trunk allowed vlan add {{ vlan.vid }}
    {%- endfor %}
  {%- elif "tagged-all" in interface.mode %}
switchport mode trunk
switchport trunk allowed vlan all
  {%- else %} 
    {%- if interface.lag != None %}
channel-group {% for char in interface.lag.name %} {%- if char.isdigit() %}{{ char }}{%- endif %}{%-endfor %} mode active 
    {%- endif %} 
  {%- endif %} 
{%- else -%}
interface {{ interface.name }} 
description Management VLAN
vrf forwarding Mgmt-vrf
negotiation auto
  {%- if interface.enabled== false %}
shutdown
  {%- elif interface.enabled == true %}
no shutdown 
  {%- endif %}
ip address {{ device.primary_ip.address.ip }} {{device.primary_ip.address.netmask }}
{%- endif %}
{%- endfor %}

base_macros.j2

{%- macro timezone(time_zone) -%}
{%  if time_zone == "CET" -%}
clock timezone CET +1
clock summer-time CEST recurring last Sun Mar 2:00 last Sun Oct 3:00

{%-  endif -%}
{%- endmacro -%}
!
{% macro aaa() %}
tacacs server OVH31-AAA-01
  address ipv4 10.10.10.10
  key 7 *****
!
aaa group server tacacs+ AUTHENTICATOR
  server name OVH31-AAA-01
  ip vrf forwarding Mgmt-vrf
!
aaa new-model
aaa group server radius AUTHENTICATOR
aaa authentication login default group AUTHENTICATOR local-case
aaa authorization console
aaa authorization exec default group AUTHENTICATOR local if-authenticated
aaa accounting exec default start-stop group AUTHENTICATOR
aaa accounting commands 14 default start-stop group AUTHENTICATOR
aaa accounting commands 15 default start-stop group AUTHENTICATOR
aaa session-id common
{%- endmacro -%}
!
{% macro service() %}
no service pad
service timestamps debug datetime msec localtime
service timestamps log datetime msec localtime
service password-encryption
service sequence-numbers
{%- endmacro -%}
!
{%- macro lines() %}
line con 0
  logging synchronous
line vty 0 4
  logging synchronous
  transport input ssh
{% endmacro -%}
!
{% macro global() %}
ip arp proxy disable
{% endmacro -%}
!
{% macro logging () %}
logging discriminator NOLOG msg-body drops SW_MATM-4-MACFLAP_NOTIF
logging buffered discriminator NOLOG
logging console discriminator NOLOG
logging monitor discriminator NOLOG
logging history size 500
logging history informational
logging origin-id hostname
{% endmacro -%}

Hope it helps,

Cheers