Page MenuHomeDevCentral

Adopt Salt Tower to merge pillar files
AbandonedPublic

Authored by dereckson on Mar 9 2023, 20:43.
Tags
None
Referenced Files
F3715534: D2870.id7314.diff
Tue, Nov 5, 07:42
Unknown Object (File)
Thu, Oct 31, 17:30
Unknown Object (File)
Thu, Oct 31, 02:15
Unknown Object (File)
Wed, Oct 30, 23:08
Unknown Object (File)
Mon, Oct 28, 11:47
Unknown Object (File)
Fri, Oct 25, 19:33
Unknown Object (File)
Fri, Oct 25, 16:25
Unknown Object (File)
Fri, Oct 25, 03:59
Subscribers
None

Details

Reviewers
None
Summary

Pillar represents structured data and is intended to be easy to iterate.

For several entries, a pillar dictionary is subdivised by node. If it's rather
straightforward to use, this situation has some drawbacks:

  • it doesn't follow the principle of less surprise: Salt documents the pillar to be node-specific: "targeted data to be securely sent only to the relevant minion"
  • it asks to add programmation constructs in templates or modules to browse data, for example through the node.filter_by_name added in 1609054d, or through expressions like pillar["key" + grains["id"]].
  • a pillar can be loooooong, e.g. for docker_containers

Why Salt Tower?

In the Puppet world, hiera is a solution for this configuration problem,
allowing to define configuration at several level, globally, by group, by node.

While SaltStack offers hiera compatibility, it doesn't seem well documented or
maintained.

T1758 offers to use PillarStack to create a pillar stack by node/role/grain.
This solves most of our needs, excepted:

  • there is no top-file, so the list of the stack files should be in the external pillar configuration
  • even if the external pillar configuration is a pillar is a symlink to a file in this repository, paths must be relative to the stack configuration directory (ie to /usr/local/etc/master.d/) or absolute

A well-maintained and active external pillar is Salt Tower, which allows
to define a "tower" top file, with references to the relevant files.
It also allows to target by node or grain. This solution is adopted here.

Salt Tower in action

One most relevant section of the pillar is the PaaS Docker configuration:
instead of 597 lines of data about everything about Docker, minus some values
defined instead in pillar/saas, the data is now organized by Docker node,
and furthermore, is split under several files, to separate service definitions.

That creates a more legible and easier to maintain configuration.

Fixes T1768.

Diff Detail

Repository
rOPS Nasqueron Operations
Lint
Lint Passed
Unit
No Test Coverage
Branch
refactor-pillar
Build Status
Buildable 4531
Build 4798: arc lint + arc unit