WIP: Issue 61 - Rename pillar.example to pillar-example.sls

[getSurreal]

Proper extension for pillar files is .sls. Not using pillar.example.sls because the extra period is bad form for Salt.

[myii]

Closes #61.

---

As an introduction to this PR, please consider the following comments captured on the issue behind this PR:

• Add extension .sls or .yml to pillar.example #61 (comment)
• Add extension .sls or .yml to pillar.example #61 (comment)
• Add extension .sls or .yml to pillar.example #61 (comment)

[daks]

Good to me

[noelmcloughlin]

Could it be named pillar-example.yaml instead? It does not & should not contain SLS code I guess

[myii]

Could it be named pillar-example.yaml instead? It does not & should not contain SLS code I guess

@noelmcloughlin The issue with this is that the convention with actual pillar files is to use .sls.

[noelmcloughlin]

Could it be named pillar-example.yaml instead? It does not & should not contain SLS code I guess

@noelmcloughlin The issue with this is that the convention with actual pillar files is to use .sls.

Okay, SLS then. I see pillar.example has qualifying comment: # vim: ft=yaml

[myii]

Yes, it's not ideal that the file extension and content format diverge. But even changing from pillar.example => pillar-example.sls may be a step too far, due to existing conventions. Changing the extension of all pillar files to .yml may end up in mass rejection!

Out of interest, has anyone even tried accessing a pillar using .yml...?

[myii]

As expected, it doesn't work for anything other than the .sls extension:

    Data failed to compile:
----------
    Pillar failed to render with the following messages:
----------
    Specified SLS 'template' in environment 'base' is not available on the salt master

[noelmcloughlin]

i will consider raising bug. On salt i guess? YAML is also data exchange technology. So i should be able to migrate my yaml models between various technology consumers ideally.

…

On Thu 28 Feb 2019, 14:44 Imran Iqbal ***@***.***> wrote: As expected, it doesn't work for anything other than the .sls extension: Data failed to compile:---------- Pillar failed to render with the following messages:---------- Specified SLS 'template' in environment 'base' is not available on the salt master — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#62 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AMtKQuNBaXymx4ok_SQrufbKN06-wPRwks5vR-svgaJpZM4bV-sb> .

[myii]

@noelmcloughlin Here's the code in salt/pillar/__init__.py, which calls salt/fileclient.py. Somehow, I don't think this is going to be changed any time soon...

[aboe76]

@myii , @getSurreal doesn't spm use the name pillar.example?

https://docs.saltstack.com/en/latest/topics/spm/dev.html#package-files

[aboe76]

I see an issue with spm when we change this...
see: https://docs.saltstack.com/en/latest/topics/spm/dev.html#package-files

[myii]

@aboe76 Yes, referenced literally in three places in [salt/spm/pkgfiles/local.py]:

1. L82
2. L120
3. L148

Even if there was a PR to fix this, it wouldn't be available for a long time.

[noelmcloughlin]

Its officially a bug now: saltstack/salt#51910

[noelmcloughlin]

Approving Thanks @getSurreal

[waynew]

Okay, SLS then. I see pillar.example has qualifying comment: # vim: ft=yaml

That's a hint for Vim to use yaml formatting, since sls isn't a known Vim filetype. If you have a problem with the discrepancy the correct place to file a bug is wherever Vim filetypes are implemented.

sls files are a superset of yaml. If you have a .yaml file that you just really want to trade between systems then you can simply do ln -s yourfile.yaml somefile.sls (at least I'm pretty sure Salt reads symlinks - if not you just have to swap those things around).