Salt: Add module/function and top.sls syntax to check for sls existence

[ryan-lane]

Currently, if I want to conditionally include an sls file, if the file exists, I need to do some ugly jinja magic:

base:
  # For each directory that can have pillar files
  {% for root in opts['pillar_roots']['base'] -%}
  # Set a variable to the path to check
  {% set service_group_sls = '{0}/{1}.sls'.format(root, grains['service_group']) -%}
  # Check to see if the file exists, if so, include that pillar file.
  {% if salt['file.file_exists'](service_group_sls) %}
  'service_group:{{ grains["service_group"] }}':
    - match: grain
    - {{ grains['service_group'] }}
  {% endif %}
  {% endfor -%}

What I really want to do is:

base:
  'service_group:{{ grains["service_group"] }}':
    - match: grain
    - ignore_missing: True
    - {{ grains['service_group'] }}

I also want to see if a pillar or state sls file exists from the cli, or from inside of a state, for conditional include:

salt-call state.sls_exists mystatssls
salt-call pillar.sls_exists mypillarsls

This way I can call individual states, but only if they actually exist.

[cachedout]

Hi @ryan-lane. I think this is a tremendous idea. I really like it. If possible, I'd really like to see this feature included in Lithium. I plan to push for it. :]

[ryan-lane]

Fixed for pillars in #19429

[syphernl]

I'm working on something that requires a similar approach and running into an issue that Salt doesn't ignore it if I try to include a state that does not exist.

It looks like for states the cp.show_states could come in handy.
The proposed sls_exists can most likely be a wrapper around that probably?

[invsblduck]

Too bad this was only implemented for Pillar! Generic support for SLS inclusion in top.sls (as the title states!) or SLS inclusion from within another SLS would have been epic. But that is no small patch, I'm sure. Thanks @ryan-lane for getting the Pillar part done! :+1:

[ryan-lane]

Yeah... The code for pillar and state top files are separate for some reason, even though they do the exact same thing. I was hoping to do both at the same time, but I only needed pillar and the state top file code looked more difficult to modify. I'm still hoping someone from SaltStackInc will finish this work up :)

[hartloosli]

Bumping this, as it would really clean up a tedious top.sls in our code.

[dgorissen]

Linking this to duplicate #20010

[ksoviero]

39186 is a duplicate as well.

[zerthimon]

+1
I really need this functionality:

include:
  - ignore_missing: True
  - {{ "servers/%s" % grains.id.replace('.', '_') }}

[frleb]

+1

[konstest]

+1

[ksoviero]

I tried adding support for it myself a while back, but SaltStack's code is... We'll, let's just say I still have nightmares about it.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

[ksoviero]

Oh no you don't mr.stale-bot. This is still very much needed.

[stale[bot]]

Thank you for updating this issue. It is no longer marked as stale.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

[OrangeDog]

This feature is still wanted.

[stale[bot]]

Thank you for updating this issue. It is no longer marked as stale.

[solomongumbie]

I could really make use of this feature as well.

[dth202]

I would also like this feature