How to use include in locations block

[tibz7]

I'm trying to make a generic location that i want to be able to include in multiple domains, something like:

location /endpoint {
    internal true;
}

And I want to include that in each server block where i need it.

The problem is that the role forces you to use the "hierarchy" so i end up writting:

- deployment_location: /etc/nginx/includes/common_locations.conf
  config:
    servers:
      - core:
        locations:
          - location: ^~ /endpoint
            internal: true

which renders as

server {
location /endpoint {
   internal true; 
}
location /endpoint2 {
...
}
}

but that cannot be included in the server bloc. If I include it one level above, it does not work...

[alessfg]

The internal directive is only allowed within location blocks. Check https://nginx.org/en/docs/http/ngx_http_core_module.html#internal for more details 🙂

[tibz7]

yes this is exactly my problem 😄

I cannot make an include of a file containing only locations inside a server block . according to the documentation this is actually possible, but the role does not let me do that.
the best I could do is an include of a server block containing my location within a host configuration. but then it does not work

[oxpa]

@tibz7 could you please add some details: why do you need it in an include? To be more specific, I don't quite get why would you need an include for a configuration managed by ansible.
If you have a repeating snippet you may reuse yaml nodes within a file. Would this suffice?

[oxpa]

I looked through templates and I'm not sure if it is even possible to include anything into a server block.
So you will have to use custom directives to include the file into a server or a location block.

And it's not trivial to make include work everywhere, sadly.

[tibz7]

yes thats what I was affrayed of... It seems that using it with ansible is not very useful.

[oxpa]

¯\(ツ)/¯

[alessfg]

You should be able to include files/snippets/conf files in both the server and location block by doing something like:

servers:
  - core:
      include: /path/to/server/snippet
    locations:
      - location: /
        core:
          include: /path/to/location/snippet

In so far as creating snippets/conf files that directly create a location block (sans the wrapping server block) -- that's definitely not possible at this time. It's definitely worth investigating how feasible it'd be to implement!

[tibz7]

yeah i wrote someting like that initially

server:
 server_name: blabla
  include: /path/to/snippet

and snippet

servers:
server:
   locations:
       location:  /myendpoint
       core:
         .....