diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0e9c68f..989e060 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -117,35 +117,6 @@ rubocop: script: # Alternative value to consider: `${CI_JOB_NAME}` - 'bin/kitchen verify "${DOCKER_ENV_CI_JOB_NAME}"' -# ############################################################################### # `test` stage: each instance below uses the `test` template above @@ -153,20 +124,6 @@ rubocop: ## Define the rest of the matrix based on Kitchen testing # Make sure the instances listed below match up with # the `platforms` defined in `kitchen.yml` -# # default-debian-10-tiamat-py3: {extends: '.test_instance'} # default-debian-9-tiamat-py3: {extends: '.test_instance'} # default-ubuntu-2004-tiamat-py3: {extends: '.test_instance'} diff --git a/.travis.yml b/.travis.yml index 10c3714..fcba58e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -169,25 +169,6 @@ jobs: # - env: INSTANCE=default-ubuntu-1804-3000-8-py2 # - env: INSTANCE=default-ubuntu-1604-3000-8-py2 # - env: INSTANCE=default-arch-base-latest-3000-8-py2 - # ## Define the release stage that runs `semantic-release` - stage: 'release' @@ -214,17 +195,3 @@ jobs: edge: true # Run `semantic-release` script: 'npx semantic-release@15.14' -# diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index 6a20fda..0000000 --- a/AUTHORS.md +++ /dev/null @@ -1,34 +0,0 @@ -# Authors - -This list is sorted by the number of commits per contributor in _descending_ order. - -Avatar|Contributor|Contributions -:-:|---|:-: -@myii|[@myii](https://github.com/myii)|316 -@baby-gnu|[@baby-gnu](https://github.com/baby-gnu)|37 -@dafyddj|[@dafyddj](https://github.com/dafyddj)|31 -@aboe76|[@aboe76](https://github.com/aboe76)|27 -@javierbertoli|[@javierbertoli](https://github.com/javierbertoli)|18 -@noelmcloughlin|[@noelmcloughlin](https://github.com/noelmcloughlin)|15 -@n-rodriguez|[@n-rodriguez](https://github.com/n-rodriguez)|8 -@daks|[@daks](https://github.com/daks)|8 -@gravyboat|[@gravyboat](https://github.com/gravyboat)|6 -@alxwr|[@alxwr](https://github.com/alxwr)|5 -@evvers|[@evvers](https://github.com/evvers)|4 -@nmadhok|[@nmadhok](https://github.com/nmadhok)|3 -@vutny|[@vutny](https://github.com/vutny)|2 -@k-hamza|[@k-hamza](https://github.com/k-hamza)|2 -@puneetk|[@puneetk](https://github.com/puneetk)|2 -@andygabby|[@andygabby](https://github.com/andygabby)|1 -@Jokipii|[@Jokipii](https://github.com/Jokipii)|1 -@johnkeates|[@johnkeates](https://github.com/johnkeates)|1 -@duk3luk3|[@duk3luk3](https://github.com/duk3luk3)|1 -@marco-m|[@marco-m](https://github.com/marco-m)|1 -@whiteinge|[@whiteinge](https://github.com/whiteinge)|1 -@sroegner|[@sroegner](https://github.com/sroegner)|1 -@babilen5|[@babilen5](https://github.com/babilen5)|1 -@GMAzrael|[@GMAzrael](https://github.com/GMAzrael)|1 - ---- - -Auto-generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2021-03-09. diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 075de10..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,1349 +0,0 @@ -# Changelog - -## [5.0.1](https://github.com/saltstack-formulas/template-formula/compare/v5.0.0...v5.0.1) (2021-03-09) - - -### Bug Fixes - -* **convert-formula:** `_mapdata` control name must use the formula one ([1f3600d](https://github.com/saltstack-formulas/template-formula/commit/1f3600d66fd710bd1a41cb937cb345369d0e3e18)) - -# [5.0.0](https://github.com/saltstack-formulas/template-formula/compare/v4.3.8...v5.0.0) (2021-03-09) - - -### Bug Fixes - -* **inspec:** validate `map.jinja` configuration ([41d222e](https://github.com/saltstack-formulas/template-formula/commit/41d222e30c0da10fabeea23a7ab2886f02ea6479)) - - -### Continuous Integration - -* **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] ([6453145](https://github.com/saltstack-formulas/template-formula/commit/6453145da16ab73c7307d14a5b864a91a5573c68)) - - -### Features - -* **map:** update to v5 `map.jinja` ([42e1932](https://github.com/saltstack-formulas/template-formula/commit/42e19322c9c4d91a6cfa1e406723b5a799f33f80)) - - -### BREAKING CHANGES - -* **map:** `map.jinja` now exports a generic `mapdata` variable -* **map:** The per grain parameter values are now under `TEMPLATE/parameters/` - -## [4.3.8](https://github.com/saltstack-formulas/template-formula/compare/v4.3.7...v4.3.8) (2021-02-21) - - -### Continuous Integration - -* **gemfile+lock:** use `ssf` customised `kitchen-docker` repo [skip ci] ([23c2bb2](https://github.com/saltstack-formulas/template-formula/commit/23c2bb2dc26f4c1600d484312a79dd0af0e232d7)) -* **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] ([00823a2](https://github.com/saltstack-formulas/template-formula/commit/00823a2d276648d184c92308f7829d0fdeefe0ba)) - - -### Tests - -* **_mapdata:** add verification files for Fedora 33 & Tumbleweed ([3347b85](https://github.com/saltstack-formulas/template-formula/commit/3347b85c928cebe8b0c376eae654e67e01730260)) - -## [4.3.7](https://github.com/saltstack-formulas/template-formula/compare/v4.3.6...v4.3.7) (2021-02-11) - - -### Continuous Integration - -* **pre-commit:** update hook for `rubocop` [skip ci] ([978a7e7](https://github.com/saltstack-formulas/template-formula/commit/978a7e7cd04c00fe6e7b5d113926683a86534094)) - - -### Styles - -* **inspec:** match current practices for file and control names ([aa8a58b](https://github.com/saltstack-formulas/template-formula/commit/aa8a58b715fec48b256ff0aa8a0b697b1ae20399)) - - -### Tests - -* **share:** standardise with latest changes [skip ci] ([dab2f34](https://github.com/saltstack-formulas/template-formula/commit/dab2f34c587ea6194351c768e9ba141744536607)) - -## [4.3.6](https://github.com/saltstack-formulas/template-formula/compare/v4.3.5...v4.3.6) (2021-01-14) - - -### Bug Fixes - -* **_mapdata:** ensure map data is directly under `values` ([bcb8e29](https://github.com/saltstack-formulas/template-formula/commit/bcb8e29b687f9804a1cfbda1253da290432cd5b0)) - - -### Tests - -* **_mapdata:** update for `_mapdata/init.sls` change ([50162ad](https://github.com/saltstack-formulas/template-formula/commit/50162adad7119285a649321b5f66710974a7983d)) - -## [4.3.5](https://github.com/saltstack-formulas/template-formula/compare/v4.3.4...v4.3.5) (2020-12-23) - - -### Code Refactoring - -* **map:** use top-level `values:` key in `map.jinja` dumps ([f8e8fcb](https://github.com/saltstack-formulas/template-formula/commit/f8e8fcb29e77d1afded74a2c92789ac8807a4768)) - -## [4.3.4](https://github.com/saltstack-formulas/template-formula/compare/v4.3.3...v4.3.4) (2020-12-22) - - -### Continuous Integration - -* **commitlint:** ensure `upstream/master` uses main repo URL [skip ci] ([e476d5a](https://github.com/saltstack-formulas/template-formula/commit/e476d5a567d90592ea32f193d2264de59d261711)) -* **gitlab-ci:** add `rubocop` linter (with `allow_failure`) [skip ci] ([4c300d0](https://github.com/saltstack-formulas/template-formula/commit/4c300d01cb909f2fbed07d39b22c06198c304cdf)) - - -### Tests - -* **_mapdata:** fix existing verification files ([6bbafed](https://github.com/saltstack-formulas/template-formula/commit/6bbafedd1f9ad6e6b659ab6ab4b1736b5c4d9a66)) -* **map:** standardise `map.jinja` verification ([4c8cf32](https://github.com/saltstack-formulas/template-formula/commit/4c8cf32db1824fb9841996d758d19c563f5414c5)) - -## [4.3.3](https://github.com/saltstack-formulas/template-formula/compare/v4.3.2...v4.3.3) (2020-12-16) - - -### Bug Fixes - -* **codeowners:** ensure `lib*` files are owned by `ssf` ([d60cc15](https://github.com/saltstack-formulas/template-formula/commit/d60cc1536637831ef76b2f2c84086b3f88f2684f)) - - -### Continuous Integration - -* **gitlab-ci:** use GitLab CI as Travis CI replacement ([0403f62](https://github.com/saltstack-formulas/template-formula/commit/0403f62c7780a8a449617003c5363118a8b6ecd6)) - -## [4.3.2](https://github.com/saltstack-formulas/template-formula/compare/v4.3.1...v4.3.2) (2020-10-31) - - -### Bug Fixes - -* **convert-formula.sh:** add -_ to allowed chars in formula name ([a999fee](https://github.com/saltstack-formulas/template-formula/commit/a999fee2145d9b0484049808c3c331943580cc3f)) -* **convert-formula.sh:** delete all existing tags ([7c33601](https://github.com/saltstack-formulas/template-formula/commit/7c33601fd455df90b1082791cdd282a507334898)), closes [#210](https://github.com/saltstack-formulas/template-formula/issues/210) - -## [4.3.1](https://github.com/saltstack-formulas/template-formula/compare/v4.3.0...v4.3.1) (2020-10-28) - - -### Tests - -* **inspec:** `system.rb` must call parent class initialisation ([1ff9ab1](https://github.com/saltstack-formulas/template-formula/commit/1ff9ab15f23ba9f3b78a1b8f9dcef7a062e2b192)) - -# [4.3.0](https://github.com/saltstack-formulas/template-formula/compare/v4.2.2...v4.3.0) (2020-10-12) - - -### Continuous Integration - -* **pre-commit:** finalise `rstcheck` configuration [skip ci] ([e78aa0c](https://github.com/saltstack-formulas/template-formula/commit/e78aa0cb784752ae699196c6309fe93bf223a306)) - - -### Features - -* add Gentoo support ([4c2f4ed](https://github.com/saltstack-formulas/template-formula/commit/4c2f4ede0223e83e1958be33288fa6b83cce7140)) - -## [4.2.2](https://github.com/saltstack-formulas/template-formula/compare/v4.2.1...v4.2.2) (2020-10-06) - - -### Bug Fixes - -* **commitlint:** fix header length at 72 chars as agreed ([a95061d](https://github.com/saltstack-formulas/template-formula/commit/a95061ddd088210c5111490234bc1588002cddd5)) - - -### Continuous Integration - -* **pre-commit:** add to formula [skip ci] ([fd89d62](https://github.com/saltstack-formulas/template-formula/commit/fd89d62ec656dc3e6f84b9834860bf51359452f5)) -* **pre-commit:** enable/disable `rstcheck` as relevant [skip ci] ([219e6b7](https://github.com/saltstack-formulas/template-formula/commit/219e6b71c85f06657564c87ba58877cfc5ebe511)) - -## [4.2.1](https://github.com/saltstack-formulas/template-formula/compare/v4.2.0...v4.2.1) (2020-09-21) - - -### Continuous Integration - -* **kitchen+travis:** use `tiamat` pre-salted images ([3a63304](https://github.com/saltstack-formulas/template-formula/commit/3a63304f13d717fc28efbb06252ffde421ab3621)) - - -### Tests - -* **oracle:** add InSpec configuration for `oraclelinux` ([c4b66d8](https://github.com/saltstack-formulas/template-formula/commit/c4b66d8f0b5666261b43ee923565cc516b7fb92f)) -* **share:** remove unnecessary hostname mangling ([194aa97](https://github.com/saltstack-formulas/template-formula/commit/194aa97dff47acd59076865489914b4148b1b76d)) - -# [4.2.0](https://github.com/saltstack-formulas/template-formula/compare/v4.1.1...v4.2.0) (2020-09-04) - - -### Continuous Integration - -* **kitchen:** execute `_madata` state ([31e1096](https://github.com/saltstack-formulas/template-formula/commit/31e1096adda4c23f77b797f35c465ba09043b3a6)) -* **kitchen+travis:** fix `centos6` suite and rename to `upstart` ([97309c6](https://github.com/saltstack-formulas/template-formula/commit/97309c6f4d6b18723ec5492564b1344155960ae0)) - - -### Features - -* **map:** generate a YAML file to validate `map.jinja` ([fc90075](https://github.com/saltstack-formulas/template-formula/commit/fc90075dd94d874eb283d96259f552812d8a8d82)) - - -### Tests - -* **inspec:** share library to access some minion informations ([64c2b6c](https://github.com/saltstack-formulas/template-formula/commit/64c2b6cdae1ad91959b5c0fe67863a529a070428)) -* **inspec:** verify `map.jinja` dump ([3dc28bf](https://github.com/saltstack-formulas/template-formula/commit/3dc28bfb3453079deca899352ecdff30daeb42f5)) -* **platform_finger:** extract from shared library ([d68ed45](https://github.com/saltstack-formulas/template-formula/commit/d68ed45109aa1274c6bf236db30758d795a3ba2a)) - -## [4.1.1](https://github.com/saltstack-formulas/template-formula/compare/v4.1.0...v4.1.1) (2020-07-28) - - -### Continuous Integration - -* **kitchen:** use `saltimages` Docker Hub where available [skip ci] ([eab21c3](https://github.com/saltstack-formulas/template-formula/commit/eab21c39fb180d3cf3be93a4ae0678b1fbe6357d)) -* **kitchen+travis:** add new platforms [skip ci] ([111a20b](https://github.com/saltstack-formulas/template-formula/commit/111a20b47d89d275ce4ff5213656d6828acb2760)) -* **kitchen+travis:** adjust matrix to add `3000.3` [skip ci] ([19ae826](https://github.com/saltstack-formulas/template-formula/commit/19ae82632ece95047b535390bd2325fb30a09af7)) -* **travis:** add notifications => zulip [skip ci] ([ac93ad8](https://github.com/saltstack-formulas/template-formula/commit/ac93ad82f143ce9348f841a263df87d717034103)) -* **travis:** run linters using `pre-commit` ([6da26cc](https://github.com/saltstack-formulas/template-formula/commit/6da26cca6a3b3ac89137d81b837633358c534396)) - - -### Documentation - -* add basic `pre-commit` usage instructions ([c78c068](https://github.com/saltstack-formulas/template-formula/commit/c78c06876eb4c117b3ab00f9da479e8a4c3f1cf5)) -* fix whitespace ([d98d98f](https://github.com/saltstack-formulas/template-formula/commit/d98d98f4da1096f4c60c5ec5c15d56d1945c9f50)) - - -### Styles - -* **libtofs.jinja:** use Black-inspired Jinja formatting [skip ci] ([55bc69a](https://github.com/saltstack-formulas/template-formula/commit/55bc69a2b194874ceb594c93c8750c320239103c)) - -# [4.1.0](https://github.com/saltstack-formulas/template-formula/compare/v4.0.9...v4.1.0) (2020-05-12) - - -### Continuous Integration - -* **kitchen+travis:** adjust matrix to add `3000.2` & remove `2018.3` [skip ci] ([efd8797](https://github.com/saltstack-formulas/template-formula/commit/efd8797e66bbe45d58a7155283b6ef47bb3fb7a4)) -* **kitchen+travis:** remove `master-py2-arch-base-latest` [skip ci] ([d693f9d](https://github.com/saltstack-formulas/template-formula/commit/d693f9dabf722946a978c64ed4fbfa03653e828c)) -* **workflows/commitlint:** add to repo [skip ci] ([574d18f](https://github.com/saltstack-formulas/template-formula/commit/574d18fc2c9628ed142a380aaff3b4c31592bb6f)) - - -### Features - -* **convert-formula.sh:** assign `@NONE` as whole-formula owner ([cceffff](https://github.com/saltstack-formulas/template-formula/commit/cceffffef5924b6c156890562e6f64f4872d6867)) - -## [4.0.9](https://github.com/saltstack-formulas/template-formula/compare/v4.0.8...v4.0.9) (2020-04-25) - - -### Continuous Integration - -* **gemfile.lock:** add to repo with updated `Gemfile` [skip ci] ([d798928](https://github.com/saltstack-formulas/template-formula/commit/d79892867549e13737a2d0f887a1388ec45704af)) - - -### Documentation - -* **readme:** show only one level in table of contents ([446b815](https://github.com/saltstack-formulas/template-formula/commit/446b81595822a54792cfbaf23fade20e652d7062)) - -## [4.0.8](https://github.com/saltstack-formulas/template-formula/compare/v4.0.7...v4.0.8) (2020-04-19) - - -### Bug Fixes - -* **libsaltcli:** update `salt-ssh` detection for `enable_ssh_minions` ([f0e7192](https://github.com/saltstack-formulas/template-formula/commit/f0e7192fb5a546cb0569f9d4257807c8592a00b6)) - -## [4.0.7](https://github.com/saltstack-formulas/template-formula/compare/v4.0.6...v4.0.7) (2020-04-15) - - -### Bug Fixes - -* **convert-formula.sh:** use portable sed function to make replacements ([41e10b5](https://github.com/saltstack-formulas/template-formula/commit/41e10b5249e0c8827844f438d1995cf7cb42d63a)), closes [#192](https://github.com/saltstack-formulas/template-formula/issues/192) - - -### Continuous Integration - -* **travis:** add quick check that `convert-formula.sh` has worked ([8312063](https://github.com/saltstack-formulas/template-formula/commit/83120632f3a2246ac640155d374634836c34965a)) - -## [4.0.6](https://github.com/saltstack-formulas/template-formula/compare/v4.0.5...v4.0.6) (2020-04-07) - - -### Bug Fixes - -* **running.sls:** use `watch` not `require` to ensure service restart ([3a1fc35](https://github.com/saltstack-formulas/template-formula/commit/3a1fc35a13f66714cd42583f13679c6f189ae48f)) - - -### Code Refactoring - -* **libsaltcli:** use the `opts` dict throughout [skip ci] ([69b632f](https://github.com/saltstack-formulas/template-formula/commit/69b632fbe613d4f99a48f59f64ec93c3897431c8)) - - -### Continuous Integration - -* **kitchen+travis:** adjust matrix to add `3000` & remove `2017.7` [skip ci] ([f81c372](https://github.com/saltstack-formulas/template-formula/commit/f81c372dfe12d42139275fc8c9e7aad1b6eec976)) -* **kitchen+travis:** adjust matrix to update `3000` to `3000.1` [skip ci] ([f48a727](https://github.com/saltstack-formulas/template-formula/commit/f48a7275644d2baef06adb0d8e74b3c19fd2d8a0)) - -## [4.0.5](https://github.com/saltstack-formulas/template-formula/compare/v4.0.4...v4.0.5) (2020-03-23) - - -### Bug Fixes - -* **libtofs:** “files_switch” mess up the variable exported by “map.jinja” [skip ci] ([241646f](https://github.com/saltstack-formulas/template-formula/commit/241646fe96447369df00f17ec1c27a53de08bec4)) - - -### Code Refactoring - -* **service:** use `systemd-journald` instead of `systemd-udevd` ([a265105](https://github.com/saltstack-formulas/template-formula/commit/a2651058be0d8b09f910aeee2f23703b6cefaa09)) - -## [4.0.4](https://github.com/saltstack-formulas/template-formula/compare/v4.0.3...v4.0.4) (2020-02-14) - - -### Bug Fixes - -* **libtofs:** “files_switch” mess up the variable defined by “map.jinja” ([ab4ce75](https://github.com/saltstack-formulas/template-formula/commit/ab4ce751a4640303af7acbf7a278aef79b530bb6)) - - -### Continuous Integration - -* **kitchen:** avoid using bootstrap for `master` instances ([6ecdb99](https://github.com/saltstack-formulas/template-formula/commit/6ecdb99f83b807b4679dc6534ae425b97eefbe54)) - -## [4.0.3](https://github.com/saltstack-formulas/template-formula/compare/v4.0.2...v4.0.3) (2020-01-27) - - -### Bug Fixes - -* fix `CentOS Linux-7` and add `os` details from current CI setup ([4be16ca](https://github.com/saltstack-formulas/template-formula/commit/4be16ca4befeddeeb8be1199cd088df7c547523f)) -* **travis:** reinstate conversion test [skip ci] ([5d47fda](https://github.com/saltstack-formulas/template-formula/commit/5d47fda1b9f52bff1a4c2cad5097cd3d8cd43521)) - - -### Continuous Integration - -* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([e9bfb71](https://github.com/saltstack-formulas/template-formula/commit/e9bfb71fdc0fa80ac63e6ce724f0e5621a4b30ca)) - -## [4.0.2](https://github.com/saltstack-formulas/template-formula/compare/v4.0.1...v4.0.2) (2019-12-19) - - -### Bug Fixes - -* **convert-formula.sh:** remove "Using this template" post-conversion ([55ab937](https://github.com/saltstack-formulas/template-formula/commit/55ab937c047374fce0548d8c18e8513bc15ead78)) -* **convert-formula.sh:** remove `rubocop` override post-conversion ([aca4e44](https://github.com/saltstack-formulas/template-formula/commit/aca4e4428964da745e7b1b7dce15d2c751f76490)) -* **convert-formula.sh:** remove CI test post-conversion ([06ec949](https://github.com/saltstack-formulas/template-formula/commit/06ec949fd17bb4b52bb230a6ad2eddfe08a4e693)) -* **convert-formula.sh:** reset version to `1.0.0` ([39889ce](https://github.com/saltstack-formulas/template-formula/commit/39889ce303cb57125ba0411ab55266ee018d40e1)) - - -### Documentation - -* **convert-formula.sh:** add usage guide ([539a335](https://github.com/saltstack-formulas/template-formula/commit/539a335f8b01ffb3944b742cc2f5852a718546dd)) - -## [4.0.1](https://github.com/saltstack-formulas/template-formula/compare/v4.0.0...v4.0.1) (2019-12-17) - - -### Bug Fixes - -* **convert-formula.sh:** apply remaining suggestions from [#180](https://github.com/saltstack-formulas/template-formula/issues/180) ([76ecd44](https://github.com/saltstack-formulas/template-formula/commit/76ecd447be66fd9b33ace56836796d3ce24537db)), closes [/github.com/saltstack-formulas/template-formula/pull/180#discussion_r357308821](https://github.com//github.com/saltstack-formulas/template-formula/pull/180/issues/discussion_r357308821) [/github.com/saltstack-formulas/template-formula/pull/180#discussion_r357318860](https://github.com//github.com/saltstack-formulas/template-formula/pull/180/issues/discussion_r357318860) [/github.com/saltstack-formulas/template-formula/pull/180#discussion_r357362707](https://github.com//github.com/saltstack-formulas/template-formula/pull/180/issues/discussion_r357362707) - -# [4.0.0](https://github.com/saltstack-formulas/template-formula/compare/v3.3.4...v4.0.0) (2019-12-16) - - -### Code Refactoring - -* improve reusability using an unique keyword TEMPLATE ([2e8ded6](https://github.com/saltstack-formulas/template-formula/commit/2e8ded6565f7bad166323792bf42979aac2980fa)) - - -### Continuous Integration - -* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([1b6164f](https://github.com/saltstack-formulas/template-formula/commit/1b6164fc4a5bda44e8cb1104039606603dab4c2e)) -* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([341f495](https://github.com/saltstack-formulas/template-formula/commit/341f495336da0e35d92b3b4acda30f9efa44ec52)) - - -### Features - -* add script to ease conversion from template to real formula ([edfa269](https://github.com/saltstack-formulas/template-formula/commit/edfa269e9655407ca26788a8d5564c759abbbb30)) - - -### Tests - -* add CI test of conversion script ([7ad85ae](https://github.com/saltstack-formulas/template-formula/commit/7ad85ae0db21888921efabbc88bcafbc65e5bd21)) - - -### BREAKING CHANGES - -* changed all state names and ids - -## [3.3.4](https://github.com/saltstack-formulas/template-formula/compare/v3.3.3...v3.3.4) (2019-11-27) - - -### Bug Fixes - -* **release.config.js:** use full commit hash in commit link [skip ci] ([4ac8d92](https://github.com/saltstack-formulas/template-formula/commit/4ac8d92778977ed63fe99e4506a2b0a2d41a2bce)) - - -### Continuous Integration - -* **kitchen:** use `debian-10-master-py3` instead of `develop` [skip ci] ([14ebf92](https://github.com/saltstack-formulas/template-formula/commit/14ebf928bc07cefa086523e63bed5df7c2879e9b)) -* **kitchen:** use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([42482d7](https://github.com/saltstack-formulas/template-formula/commit/42482d7f9b77f5d34417e25233a9f385075feace)) -* **kitchen+travis:** upgrade matrix after `2019.2.2` release [skip ci] ([d0e07b8](https://github.com/saltstack-formulas/template-formula/commit/d0e07b88834f68cc81ce4de34c14a880347fc497)) -* **travis:** apply changes from build config validation [skip ci] ([b625245](https://github.com/saltstack-formulas/template-formula/commit/b625245fc62deb6da7cb35de1280ec267718b1cd)) -* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([f1fbf7f](https://github.com/saltstack-formulas/template-formula/commit/f1fbf7f620c886827c70fb3970e3b2fac58b8db8)) -* **travis:** run `shellcheck` during lint job ([a711665](https://github.com/saltstack-formulas/template-formula/commit/a7116654d875ecb0e7e3e10fc96cbab2e91575f7)) -* **travis:** update `salt-lint` config for `v0.0.10` [skip ci] ([faea464](https://github.com/saltstack-formulas/template-formula/commit/faea464f923f552e23a83f28e3192c437f7eabfe)) -* **travis:** use build config validation (beta) [skip ci] ([66494bb](https://github.com/saltstack-formulas/template-formula/commit/66494bbc1058adc9ed6fa0074b1c4b6018c4cd48)) - - -### Performance Improvements - -* **travis:** improve `salt-lint` invocation [skip ci] ([7a96cd7](https://github.com/saltstack-formulas/template-formula/commit/7a96cd77db71eb8b022df7bd5c1014664124a022)) - -## [3.3.3](https://github.com/saltstack-formulas/template-formula/compare/v3.3.2...v3.3.3) (2019-10-16) - - -### Documentation - -* **contributing:** add recent `semantic-release` formulas [skip ci] ([](https://github.com/saltstack-formulas/template-formula/commit/e6fb519)) -* **contributing:** remove to use org-level file instead [skip ci] ([](https://github.com/saltstack-formulas/template-formula/commit/d2ebccf)) -* **readme:** update link to `CONTRIBUTING` [skip ci] ([](https://github.com/saltstack-formulas/template-formula/commit/ed61d09)) -* **reamde:** have special notes section ([](https://github.com/saltstack-formulas/template-formula/commit/c68aed5)) - -## [3.3.2](https://github.com/saltstack-formulas/template-formula/compare/v3.3.1...v3.3.2) (2019-10-08) - - -### Bug Fixes - -* **rubocop:** add fixes using `rubocop --safe-auto-correct` ([484ce24](https://github.com/saltstack-formulas/template-formula/commit/484ce24)) -* **rubocop:** fix remaining errors manually ([9566b6f](https://github.com/saltstack-formulas/template-formula/commit/9566b6f)) - - -### Code Refactoring - -* **travis:** merge `lint` stage into the `test` stage ([d3b93f8](https://github.com/saltstack-formulas/template-formula/commit/d3b93f8)) - - -### Continuous Integration - -* **kitchen:** install required packages to bootstrapped `opensuse` [skip ci] ([1cfed60](https://github.com/saltstack-formulas/template-formula/commit/1cfed60)) -* **kitchen:** use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([0467bdf](https://github.com/saltstack-formulas/template-formula/commit/0467bdf)) -* **travis:** quote `${INSTANCE}` when running `kitchen verify` ([00d56a4](https://github.com/saltstack-formulas/template-formula/commit/00d56a4)), closes [/github.com/saltstack-formulas/template-formula/pull/175#discussion_r332525964](https://github.com//github.com/saltstack-formulas/template-formula/pull/175/issues/discussion_r332525964) -* **travis:** run `rubocop` during the `Lint` job ([8d8c766](https://github.com/saltstack-formulas/template-formula/commit/8d8c766)) -* **travis:** run `salt-lint` during the `Lint` job ([2df4646](https://github.com/saltstack-formulas/template-formula/commit/2df4646)), closes [/freenode.logbot.info/saltstack-formulas/20191004#c2723464](https://github.com//freenode.logbot.info/saltstack-formulas/20191004/issues/c2723464) [/freenode.logbot.info/saltstack-formulas/20191004#c2724272](https://github.com//freenode.logbot.info/saltstack-formulas/20191004/issues/c2724272) -* **travis:** use `env` and `name` for improved display in Travis ([5f773d1](https://github.com/saltstack-formulas/template-formula/commit/5f773d1)), closes [/github.com/saltstack-formulas/template-formula/pull/175#discussion_r332613933](https://github.com//github.com/saltstack-formulas/template-formula/pull/175/issues/discussion_r332613933) - - -### Documentation - -* **bug_report:** add section requesting commit hash / release tag ([faccb6a](https://github.com/saltstack-formulas/template-formula/commit/faccb6a)) -* **bug_report:** group into sections for better logical ordering ([e9b6c2f](https://github.com/saltstack-formulas/template-formula/commit/e9b6c2f)) -* **contributing:** add recent `semantic-release` formula ([c2924b0](https://github.com/saltstack-formulas/template-formula/commit/c2924b0)) -* **contributing:** add recent `semantic-release` formula ([8d2318c](https://github.com/saltstack-formulas/template-formula/commit/8d2318c)) -* **contributing:** add recent `semantic-release` formula [skip ci] ([85118de](https://github.com/saltstack-formulas/template-formula/commit/85118de)) -* **issues:** provide `Bug report` & `Feature request` templates ([f90f1f6](https://github.com/saltstack-formulas/template-formula/commit/f90f1f6)) -* **issues:** use `Meta` instead of `Optional` as suggested ([65cadb4](https://github.com/saltstack-formulas/template-formula/commit/65cadb4)), closes [/github.com/saltstack-formulas/template-formula/pull/174#issuecomment-538999459](https://github.com//github.com/saltstack-formulas/template-formula/pull/174/issues/issuecomment-538999459) -* **issues:** use larger headings (from level 4 to level 3) ([53e7b75](https://github.com/saltstack-formulas/template-formula/commit/53e7b75)) -* **pillar.example:** fix TOFS comment to explain the default path [skip ci] ([fde5063](https://github.com/saltstack-formulas/template-formula/commit/fde5063)), closes [/github.com/saltstack-formulas/libvirt-formula/pull/60#issuecomment-537965254](https://github.com//github.com/saltstack-formulas/libvirt-formula/pull/60/issues/issuecomment-537965254) [/github.com/saltstack-formulas/libvirt-formula/pull/60#issuecomment-537988138](https://github.com//github.com/saltstack-formulas/libvirt-formula/pull/60/issues/issuecomment-537988138) -* **pillar.example:** improve TOFS comment to explain the default path [skip ci] ([27d2fe4](https://github.com/saltstack-formulas/template-formula/commit/27d2fe4)), closes [/github.com/saltstack-formulas/nginx-formula/blob/17291a0ae2c2554707b79d897bb6ddec716e8426/pillar.example#L340-L341](https://github.com//github.com/saltstack-formulas/nginx-formula/blob/17291a0ae2c2554707b79d897bb6ddec716e8426/pillar.example/issues/L340-L341) - -## [3.3.1](https://github.com/saltstack-formulas/template-formula/compare/v3.3.0...v3.3.1) (2019-09-23) - - -### Bug Fixes - -* **subcomponent:** clean referencing wrong sls ([394808e](https://github.com/saltstack-formulas/template-formula/commit/394808e)) - - -### Continuous Integration - -* use `dist: bionic` & apply `opensuse-leap-15` SCP error workaround ([330b0cb](https://github.com/saltstack-formulas/template-formula/commit/330b0cb)) -* **kitchen:** change `log_level` to `debug` instead of `info` ([1b929ff](https://github.com/saltstack-formulas/template-formula/commit/1b929ff)) -* **platform:** add `arch-base-latest` ([042e8e2](https://github.com/saltstack-formulas/template-formula/commit/042e8e2)) -* **yamllint:** add rule `empty-values` & use new `yaml-files` setting ([70ed7e2](https://github.com/saltstack-formulas/template-formula/commit/70ed7e2)), closes [#164](https://github.com/saltstack-formulas/template-formula/issues/164) - - -### Documentation - -* **contributing:** add recent `semantic-release` formulas ([7f36ae9](https://github.com/saltstack-formulas/template-formula/commit/7f36ae9)) - -# [3.3.0](https://github.com/saltstack-formulas/template-formula/compare/v3.2.1...v3.3.0) (2019-08-27) - - -### Bug Fixes - -* **libtofs:** avoid using subpath by default ([c07471d](https://github.com/saltstack-formulas/template-formula/commit/c07471d)) - - -### Code Refactoring - -* **libtofs:** remove deprecated `v1_path_prefix` argument ([ad2a965](https://github.com/saltstack-formulas/template-formula/commit/ad2a965)) - - -### Features - -* **yamllint:** include for this repo and apply rules throughout ([e76525f](https://github.com/saltstack-formulas/template-formula/commit/e76525f)) - -## [3.2.1](https://github.com/saltstack-formulas/template-formula/compare/v3.2.0...v3.2.1) (2019-08-06) - - -### Code Refactoring - -* **tofs:** move subcomponent definition to `defaults.yaml` ([c269673](https://github.com/saltstack-formulas/template-formula/commit/c269673)) -* **tofs:** move subcomponent templates to first `source` match ([70cc92d](https://github.com/saltstack-formulas/template-formula/commit/70cc92d)) - - -### Continuous Integration - -* **kitchen+travis:** replace EOL pre-salted images ([42ab22c](https://github.com/saltstack-formulas/template-formula/commit/42ab22c)) - -# [3.2.0](https://github.com/saltstack-formulas/template-formula/compare/v3.1.1...v3.2.0) (2019-08-03) - - -### Bug Fixes - -* **formula:** update to current oldest supported version of Salt ([878eca1](https://github.com/saltstack-formulas/template-formula/commit/878eca1)) - - -### Documentation - -* **libtofs:** explain usage of sub-directory for components ([42a75d9](https://github.com/saltstack-formulas/template-formula/commit/42a75d9)) -* **readme:** describe the new “template.subcomponent” states ([6b595cd](https://github.com/saltstack-formulas/template-formula/commit/6b595cd)) - - -### Features - -* **sub-component:** manage a dedicated configuration file ([c4440d7](https://github.com/saltstack-formulas/template-formula/commit/c4440d7)) -* **tofs:** lookup files directory in “tpldir” hierarchy ([5c495fb](https://github.com/saltstack-formulas/template-formula/commit/5c495fb)) - - -### Tests - -* **inspec:** verify subcomponent configuration file ([fd55e03](https://github.com/saltstack-formulas/template-formula/commit/fd55e03)) - -## [3.1.1](https://github.com/saltstack-formulas/template-formula/compare/v3.1.0...v3.1.1) (2019-07-25) - - -### Bug Fixes - -* **tofs:** prepend the config-based `source_files` to the default ([3483e76](https://github.com/saltstack-formulas/template-formula/commit/3483e76)), closes [/github.com/saltstack-formulas/nginx-formula/pull/247#issuecomment-514262549](https://github.com//github.com/saltstack-formulas/nginx-formula/pull/247/issues/issuecomment-514262549) [#151](https://github.com/saltstack-formulas/template-formula/issues/151) - - -### Documentation - -* **tofs:** ensure merged will all recent changes ([6a614d9](https://github.com/saltstack-formulas/template-formula/commit/6a614d9)) -* **tofs:** update from `nginx-formula` ([23a221e](https://github.com/saltstack-formulas/template-formula/commit/23a221e)), closes [/github.com/saltstack-formulas/nginx-formula/pull/238#discussion_r289124365](https://github.com//github.com/saltstack-formulas/nginx-formula/pull/238/issues/discussion_r289124365) - -# [3.1.0](https://github.com/saltstack-formulas/template-formula/compare/v3.0.9...v3.1.0) (2019-07-24) - - -### Bug Fixes - -* **grain:** fix grain value ([26edfa0](https://github.com/saltstack-formulas/template-formula/commit/26edfa0)) - - -### Documentation - -* **map:** update comments in `os*.yaml` after adding `osarchmap` ([d71a258](https://github.com/saltstack-formulas/template-formula/commit/d71a258)) - - -### Features - -* **mapping:** introduce osarchmap per issue [#13](https://github.com/saltstack-formulas/template-formula/issues/13) ([41ac40d](https://github.com/saltstack-formulas/template-formula/commit/41ac40d)) - - -### Tests - -* **osarch:** add unit test for osarch ([1be2052](https://github.com/saltstack-formulas/template-formula/commit/1be2052)) - -## [3.0.9](https://github.com/saltstack-formulas/template-formula/compare/v3.0.8...v3.0.9) (2019-07-24) - - -### Bug Fixes - -* **libtofs:** don't crash if “tofs.files_switch” lookup a list ([0979d35](https://github.com/saltstack-formulas/template-formula/commit/0979d35)) - - -### Documentation - -* **contributing:** add recent `semantic-release` formula ([f9def86](https://github.com/saltstack-formulas/template-formula/commit/f9def86)) -* **contributing:** add recent `semantic-release` formula ([ed8c55a](https://github.com/saltstack-formulas/template-formula/commit/ed8c55a)) -* **contributing:** add recent `semantic-release` formulas ([57d0b85](https://github.com/saltstack-formulas/template-formula/commit/57d0b85)) - - -### Tests - -* **libtofs:** “tofs.files_switch” lookup can return a list ([13f1728](https://github.com/saltstack-formulas/template-formula/commit/13f1728)) - -## [3.0.8](https://github.com/saltstack-formulas/template-formula/compare/v3.0.7...v3.0.8) (2019-07-08) - - -### Documentation - -* **contributing:** add template-formula to `semantic-release` formulas ([87e4ebc](https://github.com/saltstack-formulas/template-formula/commit/87e4ebc)) - -## [3.0.7](https://github.com/saltstack-formulas/template-formula/compare/v3.0.6...v3.0.7) (2019-07-04) - - -### Documentation - -* **contributing:** add recent `semantic-release` formula ([c679cb5](https://github.com/saltstack-formulas/template-formula/commit/c679cb5)) - -## [3.0.6](https://github.com/saltstack-formulas/template-formula/compare/v3.0.5...v3.0.6) (2019-06-28) - - -### Code Refactoring - -* **string:** remove capitalisation from 'template' string ([7062210](https://github.com/saltstack-formulas/template-formula/commit/7062210)) - -## [3.0.5](https://github.com/saltstack-formulas/template-formula/compare/v3.0.4...v3.0.5) (2019-06-28) - - -### Documentation - -* **contributing:** add recent `semantic-release` formula ([fc50a9e](https://github.com/saltstack-formulas/template-formula/commit/fc50a9e)) - -## [3.0.4](https://github.com/saltstack-formulas/template-formula/compare/v3.0.3...v3.0.4) (2019-06-27) - - -### Documentation - -* **contributing:** add recent `semantic-release` formulas ([22052fc](https://github.com/saltstack-formulas/template-formula/commit/22052fc)) - -## [3.0.3](https://github.com/saltstack-formulas/template-formula/compare/v3.0.2...v3.0.3) (2019-06-25) - - -### Documentation - -* **contributing:** add recent `semantic-release` formula ([7f56237](https://github.com/saltstack-formulas/template-formula/commit/7f56237)) - -## [3.0.2](https://github.com/saltstack-formulas/template-formula/compare/v3.0.1...v3.0.2) (2019-06-20) - - -### Documentation - -* **contributing:** add recent `semantic-release` formulas ([461c7a5](https://github.com/saltstack-formulas/template-formula/commit/461c7a5)) - -## [3.0.1](https://github.com/saltstack-formulas/template-formula/compare/v3.0.0...v3.0.1) (2019-06-16) - - -### Tests - -* **inspec:** readme for default profile & os-name depreciated ([3fa7bce](https://github.com/saltstack-formulas/template-formula/commit/3fa7bce)) - -# [3.0.0](https://github.com/saltstack-formulas/template-formula/compare/v2.2.1...v3.0.0) (2019-06-13) - - -### Code Refactoring - -* **pkgname:** reserve 'pkg' as packaging dict ([c6ae81c](https://github.com/saltstack-formulas/template-formula/commit/c6ae81c)) - - -### Continuous Integration - -* **kitchen+travis:** modify matrix to include `develop` platform ([7b5d4ff](https://github.com/saltstack-formulas/template-formula/commit/7b5d4ff)) - - -### BREAKING CHANGES - -* **pkgname:** the parameter `pkg` is now a dictionary. References - to `template.pkg` should be changed to `template.pkg.name`. - -## [2.2.1](https://github.com/saltstack-formulas/template-formula/compare/v2.2.0...v2.2.1) (2019-05-31) - - -### Code Refactoring - -* **`osfamilymap`:** avoid *BSD ambiguity with MacOS `rootgroup` ([3338605](https://github.com/saltstack-formulas/template-formula/commit/3338605)) - -# [2.2.0](https://github.com/saltstack-formulas/template-formula/compare/v2.1.18...v2.2.0) (2019-05-31) - - -### Features - -* **macos:** basic package and group handling ([8c3fe22](https://github.com/saltstack-formulas/template-formula/commit/8c3fe22)) - -## [2.1.18](https://github.com/saltstack-formulas/template-formula/compare/v2.1.17...v2.1.18) (2019-05-29) - - -### Bug Fixes - -* **`libtofs`:** use `select` to deal with empty strings in path ([afe0751](https://github.com/saltstack-formulas/template-formula/commit/afe0751)) -* **`libtofs`:** use `strip` to deal with leading/trailing slashes ([2563a46](https://github.com/saltstack-formulas/template-formula/commit/2563a46)) - -## [2.1.17](https://github.com/saltstack-formulas/template-formula/compare/v2.1.16...v2.1.17) (2019-05-27) - - -### Continuous Integration - -* **kitchen:** add Bundler binstub for Kitchen ([7bb7c53](https://github.com/saltstack-formulas/template-formula/commit/7bb7c53)) - - -### Documentation - -* **readme:** tidy headings ([d931ed1](https://github.com/saltstack-formulas/template-formula/commit/d931ed1)) - -## [2.1.16](https://github.com/saltstack-formulas/template-formula/compare/v2.1.15...v2.1.16) (2019-05-27) - - -### Documentation - -* **contributing:** add ufw formula to semantic release formulas ([18ff689](https://github.com/saltstack-formulas/template-formula/commit/18ff689)) - -## [2.1.15](https://github.com/saltstack-formulas/template-formula/compare/v2.1.14...v2.1.15) (2019-05-25) - - -### Tests - -* **`services_spec`:** remove temporary `suse` conditional ([00d4a77](https://github.com/saltstack-formulas/template-formula/commit/00d4a77)) - -## [2.1.14](https://github.com/saltstack-formulas/template-formula/compare/v2.1.13...v2.1.14) (2019-05-25) - - -### Bug Fixes - -* **`config/file`:** add missing space before Jinja `}}` ([5cd08ab](https://github.com/saltstack-formulas/template-formula/commit/5cd08ab)) - -## [2.1.13](https://github.com/saltstack-formulas/template-formula/compare/v2.1.12...v2.1.13) (2019-05-24) - - -### Documentation - -* **readme:** add testing requirements section (from `vault-formula`) ([e04413e](https://github.com/saltstack-formulas/template-formula/commit/e04413e)) - -## [2.1.12](https://github.com/saltstack-formulas/template-formula/compare/v2.1.11...v2.1.12) (2019-05-24) - - -### Continuous Integration - -* **travis:** improve recommended matrix usage comment ([b08a0fd](https://github.com/saltstack-formulas/template-formula/commit/b08a0fd)) -* **travis:** reduce matrix down to 6 instances (ref: [#118](https://github.com/saltstack-formulas/template-formula/issues/118)) ([a8834e2](https://github.com/saltstack-formulas/template-formula/commit/a8834e2)) - - -### Documentation - -* **contributing:** add `bind-formula` to `semantic-release` formulas ([3da78b0](https://github.com/saltstack-formulas/template-formula/commit/3da78b0)) - -## [2.1.11](https://github.com/saltstack-formulas/template-formula/compare/v2.1.10...v2.1.11) (2019-05-18) - - -### Documentation - -* **contributing:** add recent `semantic-release` formula ([486b393](https://github.com/saltstack-formulas/template-formula/commit/486b393)) - -## [2.1.10](https://github.com/saltstack-formulas/template-formula/compare/v2.1.9...v2.1.10) (2019-05-16) - - -### Documentation - -* **contributing:** fix link to contributing docs ([b6a33d3](https://github.com/saltstack-formulas/template-formula/commit/b6a33d3)) - -## [2.1.9](https://github.com/saltstack-formulas/template-formula/compare/v2.1.8...v2.1.9) (2019-05-16) - - -### Documentation - -* move contributing sections and links to ease adaptation ([741896d](https://github.com/saltstack-formulas/template-formula/commit/741896d)) - -## [2.1.8](https://github.com/saltstack-formulas/template-formula/compare/v2.1.7...v2.1.8) (2019-05-16) - - -### Documentation - -* **contributing:** add recent `semantic-release` formulas ([#110](https://github.com/saltstack-formulas/template-formula/issues/110)) ([ab7afd4](https://github.com/saltstack-formulas/template-formula/commit/ab7afd4)) - -## [2.1.7](https://github.com/saltstack-formulas/template-formula/compare/v2.1.6...v2.1.7) (2019-05-15) - - -### Styles - -* **indent:** fix indentation ([34d1307](https://github.com/saltstack-formulas/template-formula/commit/34d1307)) - -## [2.1.6](https://github.com/saltstack-formulas/template-formula/compare/v2.1.5...v2.1.6) (2019-05-15) - - -### Bug Fixes - -* **`map.jinja`:** _merge_ defaults and `config.get` ([91bc2f0](https://github.com/saltstack-formulas/template-formula/commit/91bc2f0)) - -## [2.1.5](https://github.com/saltstack-formulas/template-formula/compare/v2.1.4...v2.1.5) (2019-05-15) - - -### Bug Fixes - -* **`map.jinja`:** use tplroot ([b9c5e03](https://github.com/saltstack-formulas/template-formula/commit/b9c5e03)) - -## [2.1.4](https://github.com/saltstack-formulas/template-formula/compare/v2.1.3...v2.1.4) (2019-05-15) - - -### Bug Fixes - -* **`map.jinja`:** remove `merge` from `config.get` (for `salt-ssh`) ([00e474c](https://github.com/saltstack-formulas/template-formula/commit/00e474c)), closes [#95](https://github.com/saltstack-formulas/template-formula/issues/95) - -## [2.1.3](https://github.com/saltstack-formulas/template-formula/compare/v2.1.2...v2.1.3) (2019-05-13) - - -### Bug Fixes - -* **travis:** don't install gems twice ([925d8e2](https://github.com/saltstack-formulas/template-formula/commit/925d8e2)) - - -### Documentation - -* **readme:** add testing section based on `postgres-formula` ([c309d5f](https://github.com/saltstack-formulas/template-formula/commit/c309d5f)) - -## [2.1.2](https://github.com/saltstack-formulas/template-formula/compare/v2.1.1...v2.1.2) (2019-05-13) - - -### Bug Fixes - -* **gitignore:** add Gemfile.lock to .gitignore ([87fa410](https://github.com/saltstack-formulas/template-formula/commit/87fa410)) - -## [2.1.1](https://github.com/saltstack-formulas/template-formula/compare/v2.1.0...v2.1.1) (2019-05-13) - - -### Documentation - -* **semantic-release:** add list of semantic-release compatible formulas ([97b19b9](https://github.com/saltstack-formulas/template-formula/commit/97b19b9)) - -# [2.1.0](https://github.com/saltstack-formulas/template-formula/compare/v2.0.6...v2.1.0) (2019-05-12) - - -### Features - -* **centos-6:** reshape formula and tests for this platform ([a4b1608](https://github.com/saltstack-formulas/template-formula/commit/a4b1608)), closes [#104](https://github.com/saltstack-formulas/template-formula/issues/104) - -## [2.0.6](https://github.com/saltstack-formulas/template-formula/compare/v2.0.5...v2.0.6) (2019-05-02) - - -### Continuous Integration - -* **kitchen+travis:** use latest pre-salted images ([91ef13b](https://github.com/saltstack-formulas/template-formula/commit/91ef13b)) - - -### Tests - -* **inspec:** disable `service`-based tests for `opensuse-leap-15` ([848c2ad](https://github.com/saltstack-formulas/template-formula/commit/848c2ad)) - -## [2.0.5](https://github.com/saltstack-formulas/template-formula/compare/v2.0.4...v2.0.5) (2019-04-30) - - -### Documentation - -* **tofs:** remove whitespace from blank line ([0881b7d](https://github.com/saltstack-formulas/template-formula/commit/0881b7d)) - -## [2.0.4](https://github.com/saltstack-formulas/template-formula/compare/v2.0.3...v2.0.4) (2019-04-27) - - -### Code Refactoring - -* **map:** use `config.get` instead of `pillar.get` ([5dc0b86](https://github.com/saltstack-formulas/template-formula/commit/5dc0b86)) - - -### Continuous Integration - -* **gemfile:** update `kitchen-salt` version ([ad31c32](https://github.com/saltstack-formulas/template-formula/commit/ad31c32)) - -## [2.0.3](https://github.com/saltstack-formulas/template-formula/compare/v2.0.2...v2.0.3) (2019-04-24) - - -### Bug Fixes - -* **comments:** explain that at least an empty dict is required ([426f955](https://github.com/saltstack-formulas/template-formula/commit/426f955)), closes [#93](https://github.com/saltstack-formulas/template-formula/issues/93) - - -### Continuous Integration - -* **kitchen:** use pre-salted images instead ([2855ed6](https://github.com/saltstack-formulas/template-formula/commit/2855ed6)) - -## [2.0.2](https://github.com/saltstack-formulas/template-formula/compare/v2.0.1...v2.0.2) (2019-04-22) - - -### Code Refactoring - -* **config_clean:** remove unused import from `libtofs.jinja` ([b7cb585](https://github.com/saltstack-formulas/template-formula/commit/b7cb585)) - - -### Continuous Integration - -* **kitchen+travis:** implement new distro-python-salt_version matrix ([bd4792d](https://github.com/saltstack-formulas/template-formula/commit/bd4792d)) - -## [2.0.1](https://github.com/saltstack-formulas/template-formula/compare/v2.0.0...v2.0.1) (2019-03-25) - - -### Code Refactoring - -* **tofs:** ensure (v2 > v1 > default) checking for `src_files` ([3e62d7b](https://github.com/saltstack-formulas/template-formula/commit/3e62d7b)) -* **tofs:** make `files_switch` macro fully portable ([a98b777](https://github.com/saltstack-formulas/template-formula/commit/a98b777)) -* **tofs:** use `config` rather than `pillar` throughout ([5730e94](https://github.com/saltstack-formulas/template-formula/commit/5730e94)) - -# [2.0.0](https://github.com/saltstack-formulas/template-formula/compare/v1.2.6...v2.0.0) (2019-03-24) - - -### Code Refactoring - -* **tofs:** move “files_switch” macro to “libtofs.jinja” ([da7e692](https://github.com/saltstack-formulas/template-formula/commit/da7e692)) - - -### BREAKING CHANGES - -* **tofs:** every formula writer will need to change the import -to use this new version. - -* template/libtofs.jinja: provides the “files_switch” macro. - -* docs/TOFS_pattern.rst: update documentation to use the new path. - -* template/config/clean.sls: change import from “macros.jinja” to “libtofs.jinja”. - -* template/config/file.sls: ditoo. - -## [1.2.6](https://github.com/saltstack-formulas/template-formula/compare/v1.2.5...v1.2.6) (2019-03-24) - - -### Reverts - -* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([dcd141a](https://github.com/saltstack-formulas/template-formula/commit/dcd141a)), closes [/github.com/saltstack/salt-pack/issues/657#issuecomment-474954298](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-474954298) - -## [1.2.5](https://github.com/saltstack-formulas/template-formula/compare/v1.2.4...v1.2.5) (2019-03-23) - - -### Bug Fixes - -* **travis:** use version numbers in Gemfile to prevent failed builds ([35f7111](https://github.com/saltstack-formulas/template-formula/commit/35f7111)) - -## [1.2.4](https://github.com/saltstack-formulas/template-formula/compare/v1.2.3...v1.2.4) (2019-03-22) - - -### Code Refactoring - -* **tofs:** avoid using “salt['config.get']” for formula writers ([60d43e7](https://github.com/saltstack-formulas/template-formula/commit/60d43e7)) - -## [1.2.3](https://github.com/saltstack-formulas/template-formula/compare/v1.2.2...v1.2.3) (2019-03-13) - - -### Documentation - -* **tofs:** incorrect path for “source_files” lookup key ([a76f659](https://github.com/saltstack-formulas/template-formula/commit/a76f659)) - -## [1.2.2](https://github.com/saltstack-formulas/template-formula/compare/v1.2.1...v1.2.2) (2019-03-09) - - -### Bug Fixes - -* **tofs:** update use of state ID in `config` and `pillar` ([3d9a24c](https://github.com/saltstack-formulas/template-formula/commit/3d9a24c)) -* **tofs:** use `source_files` instead of `files` ([5110716](https://github.com/saltstack-formulas/template-formula/commit/5110716)), closes [/freenode.logbot.info/saltstack-formulas/20190308#c2046753](https://github.com//freenode.logbot.info/saltstack-formulas/20190308/issues/c2046753) - -## [1.2.1](https://github.com/saltstack-formulas/template-formula/compare/v1.2.0...v1.2.1) (2019-03-07) - - -### Code Refactoring - -* **kitchen:** `pillars-from-files` => `pillars_from_files` ([7c954a7](https://github.com/saltstack-formulas/template-formula/commit/7c954a7)), closes [/github.com/saltstack-formulas/packages-formula/pull/50#discussion_r262769817](https://github.com//github.com/saltstack-formulas/packages-formula/pull/50/issues/discussion_r262769817) - - -### Styles - -* **map:** use `-` for each Jinja block ([64e3834](https://github.com/saltstack-formulas/template-formula/commit/64e3834)) - -# [1.2.0](https://github.com/saltstack-formulas/template-formula/compare/v1.1.2...v1.2.0) (2019-03-03) - - -### Features - -* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([b86ddf4](https://github.com/saltstack-formulas/template-formula/commit/b86ddf4)) - -## [1.1.2](https://github.com/saltstack-formulas/template-formula/compare/v1.1.1...v1.1.2) (2019-03-03) - - -### Documentation - -* **contributing:** add documentation contribution guidelines ([dff0ee8](https://github.com/saltstack-formulas/template-formula/commit/dff0ee8)) -* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](https://github.com/saltstack-formulas/template-formula/commit/f237364)) -* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](https://github.com/saltstack-formulas/template-formula/commit/ad5a8b8)) -* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](https://github.com/saltstack-formulas/template-formula/commit/3f0071b)) - -## [1.1.1](https://github.com/saltstack-formulas/template-formula/compare/v1.1.0...v1.1.1) (2019-03-01) - - -### Continuous Integration - -* **travis:** remove obsolete `markdown-toc` process ([97fbb60](https://github.com/saltstack-formulas/template-formula/commit/97fbb60)) - - -### Documentation - -* **contributing:** add TOC to match all other pages ([7b1a2a9](https://github.com/saltstack-formulas/template-formula/commit/7b1a2a9)) -* **readme:** add Read the Docs build status badge ([f47797d](https://github.com/saltstack-formulas/template-formula/commit/f47797d)) -* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](https://github.com/saltstack-formulas/template-formula/commit/fd68168)) -* **tofs:** use table to list authorship ([2f0e20f](https://github.com/saltstack-formulas/template-formula/commit/2f0e20f)) - -# [1.1.0](https://github.com/saltstack-formulas/template-formula/compare/v1.0.1...v1.1.0) (2019-03-01) - - -### Documentation - -* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](https://github.com/saltstack-formulas/template-formula/commit/18d3924)) - - -### Features - -* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](https://github.com/saltstack-formulas/template-formula/commit/24bd338)) - -## [1.0.1](https://github.com/saltstack-formulas/template-formula/compare/v1.0.0...v1.0.1) (2019-03-01) - - -### Continuous Integration - -* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](https://github.com/saltstack-formulas/template-formula/commit/3148f0d)) - - -### Documentation - -* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](https://github.com/saltstack-formulas/template-formula/commit/474f318)) -* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](https://github.com/saltstack-formulas/template-formula/commit/0c98e67)) -* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](https://github.com/saltstack-formulas/template-formula/commit/c92f674)) -* **readme:** update heading markers for consistency ([5a2bea8](https://github.com/saltstack-formulas/template-formula/commit/5a2bea8)) -* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](https://github.com/saltstack-formulas/template-formula/commit/f02139f)) -* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](https://github.com/saltstack-formulas/template-formula/commit/da09528)) - -# [1.0.0](https://github.com/saltstack-formulas/template-formula/compare/v0.7.6...v1.0.0) (2019-02-28) - - -### Code Refactoring - -* **components:** split components into separate subdirs ([d957055](https://github.com/saltstack-formulas/template-formula/commit/d957055)), closes [/github.com/saltstack-formulas/template-formula/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312) -* **include+require:** use variable for duplicate values ([4443518](https://github.com/saltstack-formulas/template-formula/commit/4443518)) -* **pkg:** change to `package` instead ([2cd82e5](https://github.com/saltstack-formulas/template-formula/commit/2cd82e5)), closes [/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123) -* **pkg:** move `pkg` related components into separate directory ([c21f82b](https://github.com/saltstack-formulas/template-formula/commit/c21f82b)) -* **states:** set state IDs based on a dependable structure ([6690ee6](https://github.com/saltstack-formulas/template-formula/commit/6690ee6)), closes [/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996) -* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](https://github.com/saltstack-formulas/template-formula/commit/a218e91)) -* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](https://github.com/saltstack-formulas/template-formula/commit/2838bc9)) -* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](https://github.com/saltstack-formulas/template-formula/commit/b7356b0)) - - -### Continuous Integration - -* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](https://github.com/saltstack-formulas/template-formula/commit/b25fbdc)) -* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](https://github.com/saltstack-formulas/template-formula/commit/1b9d249)), closes [#50](https://github.com/saltstack-formulas/template-formula/issues/50) [/github.com/saltstack/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962) - - -### Documentation - -* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](https://github.com/saltstack-formulas/template-formula/commit/726fcab)) -* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](https://github.com/saltstack-formulas/template-formula/commit/bf1039c)) -* **readme:** fix typos ([007159a](https://github.com/saltstack-formulas/template-formula/commit/007159a)) - - -### Features - -* **pkg:** add `clean` states ([422c7ac](https://github.com/saltstack-formulas/template-formula/commit/422c7ac)) -* **pkg:** use `require` requisite between `pkg` states ([6e7141b](https://github.com/saltstack-formulas/template-formula/commit/6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086) - - -### Reverts - -* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](https://github.com/saltstack-formulas/template-formula/commit/e8f0f7e)) - - -### BREAKING CHANGES - -* **states:** Wholesale state ID changes will break implementations -that are relying on the previous state IDs for requisite purposes. -* **pkg:** Changing the `pkg` directory to `package` will break -implementations that are depending on `pkg` for `include` or `sls`-based -requisite purposes. - -## [0.7.6](https://github.com/saltstack-formulas/template-formula/compare/v0.7.5...v0.7.6) (2019-02-27) - - -### Documentation - -* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](https://github.com/saltstack-formulas/template-formula/commit/dd99750)) - -## [0.7.5](https://github.com/saltstack-formulas/template-formula/compare/v0.7.4...v0.7.5) (2019-02-27) - - -### Bug Fixes - -* **pillar:** fix `os_family` typo ([3f89c12](https://github.com/saltstack-formulas/template-formula/commit/3f89c12)) -* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](https://github.com/saltstack-formulas/template-formula/commit/3fa3640)) - - -### Code Refactoring - -* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](https://github.com/saltstack-formulas/template-formula/commit/923b459)) - - -### Documentation - -* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](https://github.com/saltstack-formulas/template-formula/commit/2c5dc21)) -* **tofs:** apply language formatting to source code blocks ([0638413](https://github.com/saltstack-formulas/template-formula/commit/0638413)) -* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](https://github.com/saltstack-formulas/template-formula/commit/2f82eb5)), closes [#44](https://github.com/saltstack-formulas/template-formula/issues/44) -* **tofs:** improve general use of language ([5105d29](https://github.com/saltstack-formulas/template-formula/commit/5105d29)) -* **tofs:** update the `files_switch` section for the updated macro ([788f732](https://github.com/saltstack-formulas/template-formula/commit/788f732)) -* **tofs:** use `{%-` for all Jinja statements ([4348df8](https://github.com/saltstack-formulas/template-formula/commit/4348df8)) - -## [0.7.4](https://github.com/saltstack-formulas/template-formula/compare/v0.7.3...v0.7.4) (2019-02-27) - - -### Continuous Integration - -* **kitchen:** check for repos updates before trying package installation ([b632383](https://github.com/saltstack-formulas/template-formula/commit/b632383)) -* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](https://github.com/saltstack-formulas/template-formula/commit/178c710)) - - -### Documentation - -* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](https://github.com/saltstack-formulas/template-formula/commit/ee053d7)) - -## [0.7.3](https://github.com/saltstack-formulas/template-formula/compare/v0.7.2...v0.7.3) (2019-02-25) - - -### Bug Fixes - -* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](https://github.com/saltstack-formulas/template-formula/commit/5e9df00)) - -## [0.7.2](https://github.com/saltstack-formulas/template-formula/compare/v0.7.1...v0.7.2) (2019-02-24) - - -### Code Refactoring - -* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](https://github.com/saltstack-formulas/template-formula/commit/52d03d8)), closes [#22](https://github.com/saltstack-formulas/template-formula/issues/22) - - -### Continuous Integration - -* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](https://github.com/saltstack-formulas/template-formula/commit/c246939)) -* **travis:** prevent `release` stage running for PRs ([3a072c7](https://github.com/saltstack-formulas/template-formula/commit/3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/template-formula/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324) - -## [0.7.1](https://github.com/saltstack-formulas/template-formula/compare/v0.7.0...v0.7.1) (2019-02-24) - - -### Continuous Integration - -* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](https://github.com/saltstack-formulas/template-formula/commit/99b073a)) - - -### Documentation - -* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](https://github.com/saltstack-formulas/template-formula/commit/be4571d)) - -# [0.7.0](https://github.com/saltstack-formulas/template-formula/compare/v0.6.0...v0.7.0) (2019-02-23) - - -### Features - -* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](https://github.com/saltstack-formulas/template-formula/commit/068a94d)) - -# [0.6.0](https://github.com/saltstack-formulas/template-formula/compare/v0.5.0...v0.6.0) (2019-02-23) - - -### Documentation - -* **contributing:** add basic introductory text before the TOC ([45ccaf6](https://github.com/saltstack-formulas/template-formula/commit/45ccaf6)) -* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](https://github.com/saltstack-formulas/template-formula/commit/abcb6ef)) -* **readme:** convert note into a heading ([5f2d789](https://github.com/saltstack-formulas/template-formula/commit/5f2d789)) - - -### Features - -* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](https://github.com/saltstack-formulas/template-formula/commit/a5bae1e)) - -# [0.5.0](https://github.com/saltstack-formulas/template-formula/compare/v0.4.0...v0.5.0) (2019-02-23) - - -### Features - -* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](https://github.com/saltstack-formulas/template-formula/commit/7614a3c)) -* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](https://github.com/saltstack-formulas/template-formula/commit/1348078)) - - -### Tests - -* **inspec:** update `supports` for all platforms added ([42f93b3](https://github.com/saltstack-formulas/template-formula/commit/42f93b3)) - -# [0.4.0](https://github.com/saltstack-formulas/template-formula/compare/v0.3.6...v0.4.0) (2019-02-23) - - -### Documentation - -* **contributing:** centre-align version bump columns in table ([a238cae](https://github.com/saltstack-formulas/template-formula/commit/a238cae)) - - -### Features - -* **authors:** update automatically alongside `semantic-release` ([8000098](https://github.com/saltstack-formulas/template-formula/commit/8000098)) - -## [0.3.6](https://github.com/saltstack-formulas/template-formula/compare/v0.3.5...v0.3.6) (2019-02-22) - - -### Continuous Integration - -* **travis:** include `commitlint` stage ([6659a69](https://github.com/saltstack-formulas/template-formula/commit/6659a69)) -* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](https://github.com/saltstack-formulas/template-formula/commit/6df9c95)) - - -### Documentation - -* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](https://github.com/saltstack-formulas/template-formula/commit/ea2c9a4)) - -## [0.3.5](https://github.com/saltstack-formulas/template-formula/compare/v0.3.4...v0.3.5) (2019-02-21) - - -### Code Refactoring - -* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](https://github.com/saltstack-formulas/template-formula/commit/3860bf9)) - -## [0.3.4](https://github.com/saltstack-formulas/template-formula/compare/v0.3.3...v0.3.4) (2019-02-21) - - -### Documentation - -* **contributing:** add commit message formatting instructions ([fb3d173](https://github.com/saltstack-formulas/template-formula/commit/fb3d173)) - -## [0.3.3](https://github.com/saltstack-formulas/template-formula/compare/v0.3.2...v0.3.3) (2019-02-20) - - -### Documentation - -* **changelog:** add missing entry under `v0.3.2` ([50352b5](https://github.com/saltstack-formulas/template-formula/commit/50352b5)) - -## [0.3.2](https://github.com/saltstack-formulas/template-formula/compare/v0.3.1...v0.3.2) (2019-02-20) - - -### Documentation - -* **README:** remove gitchangelog ([2fc85fc](https://github.com/saltstack-formulas/template-formula/commit/2fc85fc)) -* **contributing:** create blank template ([3633e8f](https://github.com/saltstack-formulas/template-formula/commit/3633e8f)) - -## [0.3.1](https://github.com/saltstack-formulas/template-formula/compare/v0.3.0...v0.3.1) (2019-02-20) - - -### Documentation - -* **changelog:** merge previous `rst` into new `md` format ([2b4e485](https://github.com/saltstack-formulas/template-formula/commit/2b4e485)) - -# [0.3.0](https://github.com/saltstack-formulas/template-formula/compare/v0.2.0...v0.3.0) (2019-02-20) - - -### Features - -* **semantic-release:** configure for this formula ([cbcfd75](https://github.com/saltstack-formulas/template-formula/commit/cbcfd75)) - -# [0.2.0](https://github.com/saltstack-formulas/template-formula/compare/v0.1.7...v0.2.0) (2019-02-17) - -* Added a working testing scaffold and travis support. [Javier Bértoli] - -## [0.1.7](https://github.com/saltstack-formulas/template-formula/compare/v0.1.6...v0.1.7) (2019-02-16) - -### Fix - -* Typo in the installation instructions. [Niels Abspoel] - -### Other - -* Update the changelog. [Niels Abspoel] -* Update README with link to install gitchangelog [Imran Iqbal] - -## [0.1.6](https://github.com/saltstack-formulas/template-formula/compare/v0.1.5...v0.1.6) (2019-02-16) - -* Add changelog generator. [Niels Abspoel] - -## [0.1.5](https://github.com/saltstack-formulas/template-formula/compare/v0.1.4...v0.1.5) (2019-02-15) - -* Prepare v0.1.5 [Imran Iqbal] -* Fix missing ')' [gmazrael] - -## [0.1.4](https://github.com/saltstack-formulas/template-formula/compare/v0.1.3...v0.1.4) (2019-02-15) - -* Replace obsolete VERSION file and replace with FORMULA file. [Imran Iqbal] - -## [0.1.3](https://github.com/saltstack-formulas/template-formula/compare/v0.1.2...v0.1.3) (2019-02-12) - -* Updated changelog and version. [Alexander Weidinger] -* Map.jinja: use grains.filter\_by instead of defaults.merge. [Alexander Weidinger] - - because defaults.merge does not work with salt-ssh. - - Added osfingermap.yaml. - -## [0.1.2](https://github.com/saltstack-formulas/template-formula/compare/v0.1.1...v0.1.2) (2019-02-12) - -* Improve comments and examples in osfamilymap & osmap [Imran Iqbal] -* Fix map.jinja and add more OSes. [Imran Iqbal] - -## [0.1.1](https://github.com/saltstack-formulas/template-formula/compare/v0.1.0...v0.1.1) (2019-02-10) - -* Update. [Niels Abspoel] -* Update formula with map.jinja and style guide references, improve README and VERSION. [Niels Abspoel] - -# [0.1.0](https://github.com/saltstack-formulas/template-formula/compare/v0.0.9...v0.1.0) (2019-02-10) - -* Examples must be consistent. [Daniel Dehennin] - - The “template” is kept during rendering. - - * TOFS\_pattern.md: add “template” to rendered state. - * template/macros.jinja: ditoo. - -* Remove double slash in generated salt URL. [Daniel Dehennin] - - When the files are “full path” with leading slash “/”, the generated URL contain a double slash because of the join. - - * template/macros.jinja: remove leading slash before joining parts. - * TOFS\_pattern.md: mirror changes of “macros.jinja”. - -* Add an example for “ntp” of the use of “files\_switch” [Daniel Dehennin] -* Accept pillar separator in “files\_switch” prefix. [Daniel Dehennin] - - The prefix was used for 2 purposes: - - * define the pillar prefix where to lookup “:files\_switch”. It supports the colon “:” separator to lookup in pillar subtree like “foo:bar” - * define the path prefix where to look for “files/”, It did not support separator to lookup inside directory tree. - - This patch only replace any colon “:” with “/” when looking up “files/” directory, with the “foo:bar” prefix: - - * lookup “foo:bar:files\_switch” pillar to get list of grains to match - * lookup files under “salt://foo/bar/files/” - * TOFS\_pattern.md: document the new use of “prefix” supporting colon “:”. - * template/macros.jinja: transform any colon “:” in “prefix” by slash - “/” to lookup files. - -* Make TOFS pattern example usable. [Daniel Dehennin] - - The example could not be used as-is. This commit improve conformity to formula conventions. - - * TOFS\_pattern.md: add missing commas “,” in “map.jinja” and extra one - to ease the addition of new entries. Import “map.jinja” in “init.sls” and “conf.sls”. Declare descriptive state IDs. Use the “module.function” notation. Use the “name” parameter. - -* Cosmetics modification of TOFS pattern documentation. [Daniel Dehennin] - * TOFS\_pattern.md: add myself as modifier. - Trim trailing whitespaces. Separate titles from first paragraph. - -* Switch template.config to TOFS pattern. [Daniel Dehennin] -* Import TOFS pattern from Zabbix formula. [Daniel Dehennin] - -## [0.0.9](https://github.com/saltstack-formulas/template-formula/compare/v0.0.8...v0.0.9) (2019-02-10) - -* Add VERSION file. [Karim Hamza] -* Add note about formula versioning. [Karim Hamza] - -## [0.0.8](https://github.com/saltstack-formulas/template-formula/compare/v0.0.7...v0.0.8) (2019-02-10) - -* Align with SaltStack official formulas doc page. [Denys Havrysh] -* Use https in the link to SaltStack documentation. [Denys Havrysh] - -## [0.0.7](https://github.com/saltstack-formulas/template-formula/compare/v0.0.6...v0.0.7) (2019-02-10) - -* Map.ninja: fix typos and leftover comments. [Marco Molteni] -* Remove whitespace in map.jinja comment. [Andrew Gabbitas] - -## [0.0.6](https://github.com/saltstack-formulas/template-formula/compare/v0.0.5...v0.0.6) (2019-02-10) - -* Improve style and jinja too match salt-formula. [Niels Abspoel] -* Propose new-ish formula style - defaults live in defaults.yml - map jinja overrides by grain + merges pillar:lookup - split all contextually similar states in their own files. [puneet kandhari] - -## [0.0.5](https://github.com/saltstack-formulas/template-formula/compare/v0.0.4...v0.0.5) (2019-02-10) - -* Change states to use short-dec style. [Seth House] -* Update CHANGELOG.rst. [Nitin Madhok] -* Update README.rst. [Nitin Madhok] - - Fix broken link -* Fixing pillar to match the map file. [Forrest] - - Map file and pillar didn't match. - -## [0.0.4](https://github.com/saltstack-formulas/template-formula/compare/v0.0.3...v0.0.4) (2019-02-10) - -* Add change log. [Antti Jokipii] - -## [0.0.3](https://github.com/saltstack-formulas/template-formula/compare/v0.0.2...v0.0.3) (2019-02-10) - -* Updated the license and readme to match our standards. [Forrest Alvarez] -* Use map.jinja content in init.sls. [Eugene Vereschagin] -* Add map.jinja. [Eugene Vereschagin] - -## [0.0.2](https://github.com/saltstack-formulas/template-formula/compare/v0.0.1...v0.0.2) (2019-02-10) - -* Add link to Salt Formula documentation. [Eugene Vereschagin] -* Change extension from .md to .rst. [Eugene Vereschagin] - -## [0.0.1](https://github.com/saltstack-formulas/template-formula/releases/tag/v0.0.1) (2019-02-10) - -* Initial commit. [Lukas Erlacher] diff --git a/CODEOWNERS b/CODEOWNERS index f0221bf..d200ad9 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -2,7 +2,7 @@ # SECTION: Owner(s) for everything in the repo, unless a later match takes precedence # FILE PATTERN OWNER(S) -* @saltstack-formulas/wg +* @NONE # SECTION: Owner(s) for specific directories # FILE PATTERN OWNER(S) diff --git a/FORMULA b/FORMULA index 9254783..a07b52a 100644 --- a/FORMULA +++ b/FORMULA @@ -1,9 +1,9 @@ -name: TEMPLATE +name: nsd os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Amazon, Oracle, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, Solaris, SmartOS, Windows, MacOS os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD, Solaris, Windows, MacOS -version: 5.0.1 +version: 1.0.0 release: 1 minimum_version: 2019.2 -summary: TEMPLATE formula +summary: nsd formula description: Formula to use as a template for other formulas -top_level_dir: TEMPLATE +top_level_dir: nsd diff --git a/TEMPLATE/package/install.sls b/TEMPLATE/package/install.sls deleted file mode 100644 index 631e189..0000000 --- a/TEMPLATE/package/install.sls +++ /dev/null @@ -1,10 +0,0 @@ -# -*- coding: utf-8 -*- -# vim: ft=sls - -{#- Get the `tplroot` from `tpldir` #} -{%- set tplroot = tpldir.split('/')[0] %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} - -TEMPLATE-package-install-pkg-installed: - pkg.installed: - - name: {{ TEMPLATE.pkg.name }} diff --git a/bin/convert-formula.sh b/bin/convert-formula.sh deleted file mode 100755 index e1858b8..0000000 --- a/bin/convert-formula.sh +++ /dev/null @@ -1,114 +0,0 @@ -#!/usr/bin/env sh -set -o nounset # Treat unset variables as an error and immediately exit -set -o errexit # If a command fails exit the whole script - -if [ "${DEBUG:-false}" = "true" ]; then - set -x # Run the entire script in debug mode -fi - -usage() { - echo "usage: $(basename "$0") " 1>&2 - echo 1>&2 - echo "Convert template-formula to -formula." 1>&2 - echo " should be a string of lowercase characters, numbers or '-',\ -'_' only." 1>&2 - echo " should not be any of 'bin' 'docs' 'test'." 1>&2 -} - -sedi() { - # Run different sed -i arguments based on GNU vs BSD sed - # See https://stackoverflow.com/a/38595160 - if sed --version >/dev/null 2>&1 ; then - sed -i"" "$@" - else - sed -i "" "$@" - fi -} - -args() { - if [ $# -ne 1 ]; then - usage - exit 1 - fi - NEW_NAME=$1 - NEW_NAME_PYSAFE=$(echo "$NEW_NAME" | sed 's/-/__/g') - if echo "$NEW_NAME" | grep -E --quiet --invert-match '^[a-z0-9_-]+$'; then - usage - exit 1 - fi - if echo bin docs test | grep --quiet --word-regexp "$NEW_NAME"; then - usage - exit 1 - fi -} - -convert_formula() { - # Empty history and make commit message `semantic-release`-compliant - # Works for forks of `template-formula` as well as GitHub "Use this template" - # See https://stackoverflow.com/a/15572071/5009408 - git reset \ - "$(echo 'feat: initial commit' \ - | git commit-tree 'HEAD^{tree}')" - git rm --quiet bin/convert-formula.sh AUTHORS.md CHANGELOG.md \ - docs/_static/css/custom.css docs/AUTHORS.rst docs/CHANGELOG.rst \ - docs/conf.py docs/CONTRIBUTING_DOCS.rst docs/index.rst - tag_out=$(git tag --list | xargs git tag --delete) - if [ "${DEBUG:-false}" = "true" ]; then - echo "$tag_out" - fi - - git mv TEMPLATE "$NEW_NAME" - - # Replace TEMPLATE within sls and jinja files with py-safe formula name - # due to python limitations on identifier names (no hyphen) - # including when specifying jinja context variables - git ls-files -- '*.sls' '*.jinja' \ - | while read -r filename; do - sedi "s/\({[{%#].*\)TEMPLATE/\1${NEW_NAME_PYSAFE}/" "$filename" - sedi "s/\([[:space:]]\{1,\}\)TEMPLATE:/\1${NEW_NAME_PYSAFE}:/" "$filename" - done - - # Temporarily, until the v5 `map.jinja` is implemented for this formula, this - # specific py-safe replacement is also required (`map.jinja` import variable) - sedi "s/TEMPLATE/${NEW_NAME_PYSAFE}/g" "${NEW_NAME}/_mapdata/init.sls" - # However, this section will probably be needed even for the v5 `map.jinja` - # All of the YAML comparison files need the py-safe `map.jinja` import variable - git ls-files -- 'test/integration/*.yaml' \ - | while read -r filename; do - sedi "/^\( \)TEMPLATE\(:\)$/s//\1${NEW_NAME_PYSAFE}\2/" "$filename" - done - - # Replace all other instances of TEMPLATE with the regular new formula name - grep --recursive --files-with-matches --exclude-dir=.git TEMPLATE . \ - | while read -r filename; do - sedi "s/TEMPLATE/${NEW_NAME}/g" "$filename" - done - - # Miscellaneous other replacements - sedi 's/^\(version:\).*/\1 1.0.0/' FORMULA - sedi 's/^\(*[[:space:]]\{1,\}\)@saltstack-formulas\/wg/\1@NONE/' CODEOWNERS - - # Deleting lines between two patterns - git ls-files -- '.gitlab-ci.yml' '.travis.yml' '.rubocop.yml' '*/map.jinja' \ - | while read -r filename; do - sedi '//d' "$filename" - done - # shellcheck disable=SC1004 # This backslash+linefeed is literal (sed: replace text) - sedi '//c \ -None -' docs/README.rst - - # Produce a commitlint-safe commit message (line length) - if [ "${#NEW_NAME}" -gt 25 ]; then - NEW_NAME_SHORT=$(echo "$NEW_NAME" | cut -c 1-23)'..' - else - NEW_NAME_SHORT="$NEW_NAME" - fi - # shellcheck disable=SC2016 # Expressions don't expand in single quotes - git commit --quiet --all \ - --message 'feat: convert `template-formula` to `'"$NEW_NAME_SHORT"'-formula`' \ - --message 'BREAKING CHANGE: changed all state names and ids' -} - -args "$@" -convert_formula diff --git a/docs/AUTHORS.rst b/docs/AUTHORS.rst deleted file mode 100644 index 4dbf615..0000000 --- a/docs/AUTHORS.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. role:: raw-html-m2r(raw) - :format: html - - -Authors -======= - -This list is sorted by the number of commits per contributor in *descending* order. - -.. list-table:: - :header-rows: 1 - - * - Avatar - - Contributor - - Contributions - * - :raw-html-m2r:`@myii` - - `@myii `_ - - 316 - * - :raw-html-m2r:`@baby-gnu` - - `@baby-gnu `_ - - 37 - * - :raw-html-m2r:`@dafyddj` - - `@dafyddj `_ - - 31 - * - :raw-html-m2r:`@aboe76` - - `@aboe76 `_ - - 27 - * - :raw-html-m2r:`@javierbertoli` - - `@javierbertoli `_ - - 18 - * - :raw-html-m2r:`@noelmcloughlin` - - `@noelmcloughlin `_ - - 15 - * - :raw-html-m2r:`@n-rodriguez` - - `@n-rodriguez `_ - - 8 - * - :raw-html-m2r:`@daks` - - `@daks `_ - - 8 - * - :raw-html-m2r:`@gravyboat` - - `@gravyboat `_ - - 6 - * - :raw-html-m2r:`@alxwr` - - `@alxwr `_ - - 5 - * - :raw-html-m2r:`@evvers` - - `@evvers `_ - - 4 - * - :raw-html-m2r:`@nmadhok` - - `@nmadhok `_ - - 3 - * - :raw-html-m2r:`@vutny` - - `@vutny `_ - - 2 - * - :raw-html-m2r:`@k-hamza` - - `@k-hamza `_ - - 2 - * - :raw-html-m2r:`@puneetk` - - `@puneetk `_ - - 2 - * - :raw-html-m2r:`@andygabby` - - `@andygabby `_ - - 1 - * - :raw-html-m2r:`@Jokipii` - - `@Jokipii `_ - - 1 - * - :raw-html-m2r:`@johnkeates` - - `@johnkeates `_ - - 1 - * - :raw-html-m2r:`@duk3luk3` - - `@duk3luk3 `_ - - 1 - * - :raw-html-m2r:`@marco-m` - - `@marco-m `_ - - 1 - * - :raw-html-m2r:`@whiteinge` - - `@whiteinge `_ - - 1 - * - :raw-html-m2r:`@sroegner` - - `@sroegner `_ - - 1 - * - :raw-html-m2r:`@babilen5` - - `@babilen5 `_ - - 1 - * - :raw-html-m2r:`@GMAzrael` - - `@GMAzrael `_ - - 1 - - ----- - -Auto-generated by a `forked version `_ of `gaocegege/maintainer `_ on 2021-03-09. diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst deleted file mode 100644 index 37c0de0..0000000 --- a/docs/CHANGELOG.rst +++ /dev/null @@ -1,1697 +0,0 @@ - -Changelog -========= - -`5.0.1 `_ (2021-03-09) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **convert-formula:** ``_mapdata`` control name must use the formula one (\ `1f3600d `_\ ) - -`5.0.0 `_ (2021-03-09) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **inspec:** validate ``map.jinja`` configuration (\ `41d222e `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] (\ `6453145 `_\ ) - -Features -^^^^^^^^ - - -* **map:** update to v5 ``map.jinja`` (\ `42e1932 `_\ ) - -BREAKING CHANGES -^^^^^^^^^^^^^^^^ - - -* **map:** ``map.jinja`` now exports a generic ``mapdata`` variable -* **map:** The per grain parameter values are now under ``TEMPLATE/parameters/`` - -`4.3.8 `_ (2021-02-21) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **gemfile+lock:** use ``ssf`` customised ``kitchen-docker`` repo [skip ci] (\ `23c2bb2 `_\ ) -* **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] (\ `00823a2 `_\ ) - -Tests -^^^^^ - - -* **_mapdata:** add verification files for Fedora 33 & Tumbleweed (\ `3347b85 `_\ ) - -`4.3.7 `_ (2021-02-11) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **pre-commit:** update hook for ``rubocop`` [skip ci] (\ `978a7e7 `_\ ) - -Styles -^^^^^^ - - -* **inspec:** match current practices for file and control names (\ `aa8a58b `_\ ) - -Tests -^^^^^ - - -* **share:** standardise with latest changes [skip ci] (\ `dab2f34 `_\ ) - -`4.3.6 `_ (2021-01-14) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **_mapdata:** ensure map data is directly under ``values`` (\ `bcb8e29 `_\ ) - -Tests -^^^^^ - - -* **_mapdata:** update for ``_mapdata/init.sls`` change (\ `50162ad `_\ ) - -`4.3.5 `_ (2020-12-23) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **map:** use top-level ``values:`` key in ``map.jinja`` dumps (\ `f8e8fcb `_\ ) - -`4.3.4 `_ (2020-12-22) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **commitlint:** ensure ``upstream/master`` uses main repo URL [skip ci] (\ `e476d5a `_\ ) -* **gitlab-ci:** add ``rubocop`` linter (with ``allow_failure``\ ) [skip ci] (\ `4c300d0 `_\ ) - -Tests -^^^^^ - - -* **_mapdata:** fix existing verification files (\ `6bbafed `_\ ) -* **map:** standardise ``map.jinja`` verification (\ `4c8cf32 `_\ ) - -`4.3.3 `_ (2020-12-16) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **codeowners:** ensure ``lib*`` files are owned by ``ssf`` (\ `d60cc15 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **gitlab-ci:** use GitLab CI as Travis CI replacement (\ `0403f62 `_\ ) - -`4.3.2 `_ (2020-10-31) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **convert-formula.sh:** add -_ to allowed chars in formula name (\ `a999fee `_\ ) -* **convert-formula.sh:** delete all existing tags (\ `7c33601 `_\ ), closes `#210 `_ - -`4.3.1 `_ (2020-10-28) ----------------------------------------------------------------------------------------------------------- - -Tests -^^^^^ - - -* **inspec:** ``system.rb`` must call parent class initialisation (\ `1ff9ab1 `_\ ) - -`4.3.0 `_ (2020-10-12) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **pre-commit:** finalise ``rstcheck`` configuration [skip ci] (\ `e78aa0c `_\ ) - -Features -^^^^^^^^ - - -* add Gentoo support (\ `4c2f4ed `_\ ) - -`4.2.2 `_ (2020-10-06) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **commitlint:** fix header length at 72 chars as agreed (\ `a95061d `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **pre-commit:** add to formula [skip ci] (\ `fd89d62 `_\ ) -* **pre-commit:** enable/disable ``rstcheck`` as relevant [skip ci] (\ `219e6b7 `_\ ) - -`4.2.1 `_ (2020-09-21) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+travis:** use ``tiamat`` pre-salted images (\ `3a63304 `_\ ) - -Tests -^^^^^ - - -* **oracle:** add InSpec configuration for ``oraclelinux`` (\ `c4b66d8 `_\ ) -* **share:** remove unnecessary hostname mangling (\ `194aa97 `_\ ) - -`4.2.0 `_ (2020-09-04) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** execute ``_madata`` state (\ `31e1096 `_\ ) -* **kitchen+travis:** fix ``centos6`` suite and rename to ``upstart`` (\ `97309c6 `_\ ) - -Features -^^^^^^^^ - - -* **map:** generate a YAML file to validate ``map.jinja`` (\ `fc90075 `_\ ) - -Tests -^^^^^ - - -* **inspec:** share library to access some minion informations (\ `64c2b6c `_\ ) -* **inspec:** verify ``map.jinja`` dump (\ `3dc28bf `_\ ) -* **platform_finger:** extract from shared library (\ `d68ed45 `_\ ) - -`4.1.1 `_ (2020-07-28) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** use ``saltimages`` Docker Hub where available [skip ci] (\ `eab21c3 `_\ ) -* **kitchen+travis:** add new platforms [skip ci] (\ `111a20b `_\ ) -* **kitchen+travis:** adjust matrix to add ``3000.3`` [skip ci] (\ `19ae826 `_\ ) -* **travis:** add notifications => zulip [skip ci] (\ `ac93ad8 `_\ ) -* **travis:** run linters using ``pre-commit`` (\ `6da26cc `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* add basic ``pre-commit`` usage instructions (\ `c78c068 `_\ ) -* fix whitespace (\ `d98d98f `_\ ) - -Styles -^^^^^^ - - -* **libtofs.jinja:** use Black-inspired Jinja formatting [skip ci] (\ `55bc69a `_\ ) - -`4.1.0 `_ (2020-05-12) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+travis:** adjust matrix to add ``3000.2`` & remove ``2018.3`` [skip ci] (\ `efd8797 `_\ ) -* **kitchen+travis:** remove ``master-py2-arch-base-latest`` [skip ci] (\ `d693f9d `_\ ) -* **workflows/commitlint:** add to repo [skip ci] (\ `574d18f `_\ ) - -Features -^^^^^^^^ - - -* **convert-formula.sh:** assign ``@NONE`` as whole-formula owner (\ `cceffff `_\ ) - -`4.0.9 `_ (2020-04-25) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **gemfile.lock:** add to repo with updated ``Gemfile`` [skip ci] (\ `d798928 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **readme:** show only one level in table of contents (\ `446b815 `_\ ) - -`4.0.8 `_ (2020-04-19) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **libsaltcli:** update ``salt-ssh`` detection for ``enable_ssh_minions`` (\ `f0e7192 `_\ ) - -`4.0.7 `_ (2020-04-15) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **convert-formula.sh:** use portable sed function to make replacements (\ `41e10b5 `_\ ), closes `#192 `_ - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **travis:** add quick check that ``convert-formula.sh`` has worked (\ `8312063 `_\ ) - -`4.0.6 `_ (2020-04-07) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **running.sls:** use ``watch`` not ``require`` to ensure service restart (\ `3a1fc35 `_\ ) - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **libsaltcli:** use the ``opts`` dict throughout [skip ci] (\ `69b632f `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+travis:** adjust matrix to add ``3000`` & remove ``2017.7`` [skip ci] (\ `f81c372 `_\ ) -* **kitchen+travis:** adjust matrix to update ``3000`` to ``3000.1`` [skip ci] (\ `f48a727 `_\ ) - -`4.0.5 `_ (2020-03-23) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **libtofs:** “files_switch” mess up the variable exported by “map.jinja” [skip ci] (\ `241646f `_\ ) - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **service:** use ``systemd-journald`` instead of ``systemd-udevd`` (\ `a265105 `_\ ) - -`4.0.4 `_ (2020-02-14) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **libtofs:** “files_switch” mess up the variable defined by “map.jinja” (\ `ab4ce75 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** avoid using bootstrap for ``master`` instances (\ `6ecdb99 `_\ ) - -`4.0.3 `_ (2020-01-27) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* fix ``CentOS Linux-7`` and add ``os`` details from current CI setup (\ `4be16ca `_\ ) -* **travis:** reinstate conversion test [skip ci] (\ `5d47fda `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **travis:** use ``major.minor`` for ``semantic-release`` version [skip ci] (\ `e9bfb71 `_\ ) - -`4.0.2 `_ (2019-12-19) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **convert-formula.sh:** remove "Using this template" post-conversion (\ `55ab937 `_\ ) -* **convert-formula.sh:** remove ``rubocop`` override post-conversion (\ `aca4e44 `_\ ) -* **convert-formula.sh:** remove CI test post-conversion (\ `06ec949 `_\ ) -* **convert-formula.sh:** reset version to ``1.0.0`` (\ `39889ce `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **convert-formula.sh:** add usage guide (\ `539a335 `_\ ) - -`4.0.1 `_ (2019-12-17) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **convert-formula.sh:** apply remaining suggestions from `#180 `_ (\ `76ecd44 `_\ ), closes `/github.com/saltstack-formulas/template-formula/pull/180#discussion_r357308821 `_ `/github.com/saltstack-formulas/template-formula/pull/180#discussion_r357318860 `_ `/github.com/saltstack-formulas/template-formula/pull/180#discussion_r357362707 `_ - -`4.0.0 `_ (2019-12-16) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* improve reusability using an unique keyword TEMPLATE (\ `2e8ded6 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **gemfile:** restrict ``train`` gem version until upstream fix [skip ci] (\ `1b6164f `_\ ) -* **travis:** quote pathspecs used with ``git ls-files`` [skip ci] (\ `341f495 `_\ ) - -Features -^^^^^^^^ - - -* add script to ease conversion from template to real formula (\ `edfa269 `_\ ) - -Tests -^^^^^ - - -* add CI test of conversion script (\ `7ad85ae `_\ ) - -BREAKING CHANGES -^^^^^^^^^^^^^^^^ - - -* changed all state names and ids - -`3.3.4 `_ (2019-11-27) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **release.config.js:** use full commit hash in commit link [skip ci] (\ `4ac8d92 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** use ``debian-10-master-py3`` instead of ``develop`` [skip ci] (\ `14ebf92 `_\ ) -* **kitchen:** use ``develop`` image until ``master`` is ready (\ ``amazonlinux``\ ) [skip ci] (\ `42482d7 `_\ ) -* **kitchen+travis:** upgrade matrix after ``2019.2.2`` release [skip ci] (\ `d0e07b8 `_\ ) -* **travis:** apply changes from build config validation [skip ci] (\ `b625245 `_\ ) -* **travis:** opt-in to ``dpl v2`` to complete build config validation [skip ci] (\ `f1fbf7f `_\ ) -* **travis:** run ``shellcheck`` during lint job (\ `a711665 `_\ ) -* **travis:** update ``salt-lint`` config for ``v0.0.10`` [skip ci] (\ `faea464 `_\ ) -* **travis:** use build config validation (beta) [skip ci] (\ `66494bb `_\ ) - -Performance Improvements -^^^^^^^^^^^^^^^^^^^^^^^^ - - -* **travis:** improve ``salt-lint`` invocation [skip ci] (\ `7a96cd7 `_\ ) - -`3.3.3 `_ (2019-10-16) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formulas [skip ci] (\ ` `_\ ) -* **contributing:** remove to use org-level file instead [skip ci] (\ ` `_\ ) -* **readme:** update link to ``CONTRIBUTING`` [skip ci] (\ ` `_\ ) -* **reamde:** have special notes section (\ ` `_\ ) - -`3.3.2 `_ (2019-10-08) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **rubocop:** add fixes using ``rubocop --safe-auto-correct`` (\ `484ce24 `_\ ) -* **rubocop:** fix remaining errors manually (\ `9566b6f `_\ ) - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **travis:** merge ``lint`` stage into the ``test`` stage (\ `d3b93f8 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** install required packages to bootstrapped ``opensuse`` [skip ci] (\ `1cfed60 `_\ ) -* **kitchen:** use bootstrapped ``opensuse`` images until ``2019.2.2`` [skip ci] (\ `0467bdf `_\ ) -* **travis:** quote ``${INSTANCE}`` when running ``kitchen verify`` (\ `00d56a4 `_\ ), closes `/github.com/saltstack-formulas/template-formula/pull/175#discussion_r332525964 `_ -* **travis:** run ``rubocop`` during the ``Lint`` job (\ `8d8c766 `_\ ) -* **travis:** run ``salt-lint`` during the ``Lint`` job (\ `2df4646 `_\ ), closes `/freenode.logbot.info/saltstack-formulas/20191004#c2723464 `_ `/freenode.logbot.info/saltstack-formulas/20191004#c2724272 `_ -* **travis:** use ``env`` and ``name`` for improved display in Travis (\ `5f773d1 `_\ ), closes `/github.com/saltstack-formulas/template-formula/pull/175#discussion_r332613933 `_ - -Documentation -^^^^^^^^^^^^^ - - -* **bug_report:** add section requesting commit hash / release tag (\ `faccb6a `_\ ) -* **bug_report:** group into sections for better logical ordering (\ `e9b6c2f `_\ ) -* **contributing:** add recent ``semantic-release`` formula (\ `c2924b0 `_\ ) -* **contributing:** add recent ``semantic-release`` formula (\ `8d2318c `_\ ) -* **contributing:** add recent ``semantic-release`` formula [skip ci] (\ `85118de `_\ ) -* **issues:** provide ``Bug report`` & ``Feature request`` templates (\ `f90f1f6 `_\ ) -* **issues:** use ``Meta`` instead of ``Optional`` as suggested (\ `65cadb4 `_\ ), closes `/github.com/saltstack-formulas/template-formula/pull/174#issuecomment-538999459 `_ -* **issues:** use larger headings (from level 4 to level 3) (\ `53e7b75 `_\ ) -* **pillar.example:** fix TOFS comment to explain the default path [skip ci] (\ `fde5063 `_\ ), closes `/github.com/saltstack-formulas/libvirt-formula/pull/60#issuecomment-537965254 `_ `/github.com/saltstack-formulas/libvirt-formula/pull/60#issuecomment-537988138 `_ -* **pillar.example:** improve TOFS comment to explain the default path [skip ci] (\ `27d2fe4 `_\ ), closes `/github.com/saltstack-formulas/nginx-formula/blob/17291a0ae2c2554707b79d897bb6ddec716e8426/pillar.example#L340-L341 `_ - -`3.3.1 `_ (2019-09-23) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **subcomponent:** clean referencing wrong sls (\ `394808e `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* use ``dist: bionic`` & apply ``opensuse-leap-15`` SCP error workaround (\ `330b0cb `_\ ) -* **kitchen:** change ``log_level`` to ``debug`` instead of ``info`` (\ `1b929ff `_\ ) -* **platform:** add ``arch-base-latest`` (\ `042e8e2 `_\ ) -* **yamllint:** add rule ``empty-values`` & use new ``yaml-files`` setting (\ `70ed7e2 `_\ ), closes `#164 `_ - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formulas (\ `7f36ae9 `_\ ) - -`3.3.0 `_ (2019-08-27) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **libtofs:** avoid using subpath by default (\ `c07471d `_\ ) - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **libtofs:** remove deprecated ``v1_path_prefix`` argument (\ `ad2a965 `_\ ) - -Features -^^^^^^^^ - - -* **yamllint:** include for this repo and apply rules throughout (\ `e76525f `_\ ) - -`3.2.1 `_ (2019-08-06) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **tofs:** move subcomponent definition to ``defaults.yaml`` (\ `c269673 `_\ ) -* **tofs:** move subcomponent templates to first ``source`` match (\ `70cc92d `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+travis:** replace EOL pre-salted images (\ `42ab22c `_\ ) - -`3.2.0 `_ (2019-08-03) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **formula:** update to current oldest supported version of Salt (\ `878eca1 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **libtofs:** explain usage of sub-directory for components (\ `42a75d9 `_\ ) -* **readme:** describe the new “template.subcomponent” states (\ `6b595cd `_\ ) - -Features -^^^^^^^^ - - -* **sub-component:** manage a dedicated configuration file (\ `c4440d7 `_\ ) -* **tofs:** lookup files directory in “tpldir” hierarchy (\ `5c495fb `_\ ) - -Tests -^^^^^ - - -* **inspec:** verify subcomponent configuration file (\ `fd55e03 `_\ ) - -`3.1.1 `_ (2019-07-25) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **tofs:** prepend the config-based ``source_files`` to the default (\ `3483e76 `_\ ), closes `/github.com/saltstack-formulas/nginx-formula/pull/247#issuecomment-514262549 `_ `#151 `_ - -Documentation -^^^^^^^^^^^^^ - - -* **tofs:** ensure merged will all recent changes (\ `6a614d9 `_\ ) -* **tofs:** update from ``nginx-formula`` (\ `23a221e `_\ ), closes `/github.com/saltstack-formulas/nginx-formula/pull/238#discussion_r289124365 `_ - -`3.1.0 `_ (2019-07-24) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **grain:** fix grain value (\ `26edfa0 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **map:** update comments in ``os*.yaml`` after adding ``osarchmap`` (\ `d71a258 `_\ ) - -Features -^^^^^^^^ - - -* **mapping:** introduce osarchmap per issue `#13 `_ (\ `41ac40d `_\ ) - -Tests -^^^^^ - - -* **osarch:** add unit test for osarch (\ `1be2052 `_\ ) - -`3.0.9 `_ (2019-07-24) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **libtofs:** don't crash if “tofs.files_switch” lookup a list (\ `0979d35 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formula (\ `f9def86 `_\ ) -* **contributing:** add recent ``semantic-release`` formula (\ `ed8c55a `_\ ) -* **contributing:** add recent ``semantic-release`` formulas (\ `57d0b85 `_\ ) - -Tests -^^^^^ - - -* **libtofs:** “tofs.files_switch” lookup can return a list (\ `13f1728 `_\ ) - -`3.0.8 `_ (2019-07-08) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add template-formula to ``semantic-release`` formulas (\ `87e4ebc `_\ ) - -`3.0.7 `_ (2019-07-04) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formula (\ `c679cb5 `_\ ) - -`3.0.6 `_ (2019-06-28) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **string:** remove capitalisation from 'template' string (\ `7062210 `_\ ) - -`3.0.5 `_ (2019-06-28) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formula (\ `fc50a9e `_\ ) - -`3.0.4 `_ (2019-06-27) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formulas (\ `22052fc `_\ ) - -`3.0.3 `_ (2019-06-25) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formula (\ `7f56237 `_\ ) - -`3.0.2 `_ (2019-06-20) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formulas (\ `461c7a5 `_\ ) - -`3.0.1 `_ (2019-06-16) ----------------------------------------------------------------------------------------------------------- - -Tests -^^^^^ - - -* **inspec:** readme for default profile & os-name depreciated (\ `3fa7bce `_\ ) - -`3.0.0 `_ (2019-06-13) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **pkgname:** reserve 'pkg' as packaging dict (\ `c6ae81c `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+travis:** modify matrix to include ``develop`` platform (\ `7b5d4ff `_\ ) - -BREAKING CHANGES -^^^^^^^^^^^^^^^^ - - -* **pkgname:** the parameter ``pkg`` is now a dictionary. References - to ``template.pkg`` should be changed to ``template.pkg.name``. - -`2.2.1 `_ (2019-05-31) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **\ ``osfamilymap``\ :** avoid *BSD ambiguity with MacOS ``rootgroup`` (\ `3338605 `_\ ) - -`2.2.0 `_ (2019-05-31) ------------------------------------------------------------------------------------------------------------ - -Features -^^^^^^^^ - - -* **macos:** basic package and group handling (\ `8c3fe22 `_\ ) - -`2.1.18 `_ (2019-05-29) -------------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **\ ``libtofs``\ :** use ``select`` to deal with empty strings in path (\ `afe0751 `_\ ) -* **\ ``libtofs``\ :** use ``strip`` to deal with leading/trailing slashes (\ `2563a46 `_\ ) - -`2.1.17 `_ (2019-05-27) -------------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** add Bundler binstub for Kitchen (\ `7bb7c53 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **readme:** tidy headings (\ `d931ed1 `_\ ) - -`2.1.16 `_ (2019-05-27) -------------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add ufw formula to semantic release formulas (\ `18ff689 `_\ ) - -`2.1.15 `_ (2019-05-25) -------------------------------------------------------------------------------------------------------------- - -Tests -^^^^^ - - -* **\ ``services_spec``\ :** remove temporary ``suse`` conditional (\ `00d4a77 `_\ ) - -`2.1.14 `_ (2019-05-25) -------------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **\ ``config/file``\ :** add missing space before Jinja ``}}`` (\ `5cd08ab `_\ ) - -`2.1.13 `_ (2019-05-24) -------------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **readme:** add testing requirements section (from ``vault-formula``\ ) (\ `e04413e `_\ ) - -`2.1.12 `_ (2019-05-24) -------------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **travis:** improve recommended matrix usage comment (\ `b08a0fd `_\ ) -* **travis:** reduce matrix down to 6 instances (ref: `#118 `_\ ) (\ `a8834e2 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add ``bind-formula`` to ``semantic-release`` formulas (\ `3da78b0 `_\ ) - -`2.1.11 `_ (2019-05-18) -------------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formula (\ `486b393 `_\ ) - -`2.1.10 `_ (2019-05-16) ------------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** fix link to contributing docs (\ `b6a33d3 `_\ ) - -`2.1.9 `_ (2019-05-16) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* move contributing sections and links to ease adaptation (\ `741896d `_\ ) - -`2.1.8 `_ (2019-05-16) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add recent ``semantic-release`` formulas (\ `#110 `_\ ) (\ `ab7afd4 `_\ ) - -`2.1.7 `_ (2019-05-15) ----------------------------------------------------------------------------------------------------------- - -Styles -^^^^^^ - - -* **indent:** fix indentation (\ `34d1307 `_\ ) - -`2.1.6 `_ (2019-05-15) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **\ ``map.jinja``\ :** *merge* defaults and ``config.get`` (\ `91bc2f0 `_\ ) - -`2.1.5 `_ (2019-05-15) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **\ ``map.jinja``\ :** use tplroot (\ `b9c5e03 `_\ ) - -`2.1.4 `_ (2019-05-15) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **\ ``map.jinja``\ :** remove ``merge`` from ``config.get`` (for ``salt-ssh``\ ) (\ `00e474c `_\ ), closes `#95 `_ - -`2.1.3 `_ (2019-05-13) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **travis:** don't install gems twice (\ `925d8e2 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **readme:** add testing section based on ``postgres-formula`` (\ `c309d5f `_\ ) - -`2.1.2 `_ (2019-05-13) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **gitignore:** add Gemfile.lock to .gitignore (\ `87fa410 `_\ ) - -`2.1.1 `_ (2019-05-13) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **semantic-release:** add list of semantic-release compatible formulas (\ `97b19b9 `_\ ) - -`2.1.0 `_ (2019-05-12) ----------------------------------------------------------------------------------------------------------- - -Features -^^^^^^^^ - - -* **centos-6:** reshape formula and tests for this platform (\ `a4b1608 `_\ ), closes `#104 `_ - -`2.0.6 `_ (2019-05-02) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+travis:** use latest pre-salted images (\ `91ef13b `_\ ) - -Tests -^^^^^ - - -* **inspec:** disable ``service``\ -based tests for ``opensuse-leap-15`` (\ `848c2ad `_\ ) - -`2.0.5 `_ (2019-04-30) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **tofs:** remove whitespace from blank line (\ `0881b7d `_\ ) - -`2.0.4 `_ (2019-04-27) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **map:** use ``config.get`` instead of ``pillar.get`` (\ `5dc0b86 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **gemfile:** update ``kitchen-salt`` version (\ `ad31c32 `_\ ) - -`2.0.3 `_ (2019-04-24) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **comments:** explain that at least an empty dict is required (\ `426f955 `_\ ), closes `#93 `_ - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** use pre-salted images instead (\ `2855ed6 `_\ ) - -`2.0.2 `_ (2019-04-22) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **config_clean:** remove unused import from ``libtofs.jinja`` (\ `b7cb585 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen+travis:** implement new distro-python-salt_version matrix (\ `bd4792d `_\ ) - -`2.0.1 `_ (2019-03-25) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **tofs:** ensure (v2 > v1 > default) checking for ``src_files`` (\ `3e62d7b `_\ ) -* **tofs:** make ``files_switch`` macro fully portable (\ `a98b777 `_\ ) -* **tofs:** use ``config`` rather than ``pillar`` throughout (\ `5730e94 `_\ ) - -`2.0.0 `_ (2019-03-24) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **tofs:** move “files_switch” macro to “libtofs.jinja” (\ `da7e692 `_\ ) - -BREAKING CHANGES -^^^^^^^^^^^^^^^^ - - -* - **tofs:** every formula writer will need to change the import - to use this new version. - -* - template/libtofs.jinja: provides the “files_switch” macro. - -* - docs/TOFS_pattern.rst: update documentation to use the new path. - -* - template/config/clean.sls: change import from “macros.jinja” to “libtofs.jinja”. - -* - template/config/file.sls: ditoo. - -`1.2.6 `_ (2019-03-24) ----------------------------------------------------------------------------------------------------------- - -Reverts -^^^^^^^ - - -* **kitchen+travis:** use ``debian:jessie-backports`` as ``debian-8`` (\ `dcd141a `_\ ), closes `/github.com/saltstack/salt-pack/issues/657#issuecomment-474954298 `_ - -`1.2.5 `_ (2019-03-23) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **travis:** use version numbers in Gemfile to prevent failed builds (\ `35f7111 `_\ ) - -`1.2.4 `_ (2019-03-22) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **tofs:** avoid using “salt['config.get']” for formula writers (\ `60d43e7 `_\ ) - -`1.2.3 `_ (2019-03-13) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **tofs:** incorrect path for “source_files” lookup key (\ `a76f659 `_\ ) - -`1.2.2 `_ (2019-03-09) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **tofs:** update use of state ID in ``config`` and ``pillar`` (\ `3d9a24c `_\ ) -* **tofs:** use ``source_files`` instead of ``files`` (\ `5110716 `_\ ), closes `/freenode.logbot.info/saltstack-formulas/20190308#c2046753 `_ - -`1.2.1 `_ (2019-03-07) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **kitchen:** ``pillars-from-files`` => ``pillars_from_files`` (\ `7c954a7 `_\ ), closes `/github.com/saltstack-formulas/packages-formula/pull/50#discussion_r262769817 `_ - -Styles -^^^^^^ - - -* **map:** use ``-`` for each Jinja block (\ `64e3834 `_\ ) - -`1.2.0 `_ (2019-03-03) ----------------------------------------------------------------------------------------------------------- - -Features -^^^^^^^^ - - -* **m2r:** use ``m2r`` to convert automatic ``.md`` files to ``.rst`` (\ `b86ddf4 `_\ ) - -`1.1.2 `_ (2019-03-03) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add documentation contribution guidelines (\ `dff0ee8 `_\ ) -* **rtd:** add comment to CSS file for overriding in-use Sphinx theme (\ `f237364 `_\ ) -* **rtd:** clean up numerous issues and inconsistencies (\ `ad5a8b8 `_\ ) -* **tofs:** use ``literalinclude`` of ``macros.jinja`` instead of code dupe (\ `3f0071b `_\ ) - -`1.1.1 `_ (2019-03-01) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **travis:** remove obsolete ``markdown-toc`` process (\ `97fbb60 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add TOC to match all other pages (\ `7b1a2a9 `_\ ) -* **readme:** add Read the Docs build status badge (\ `f47797d `_\ ) -* **tofs:** replace existing ``.md`` with ``.rst`` and add to RTD (\ `fd68168 `_\ ) -* **tofs:** use table to list authorship (\ `2f0e20f `_\ ) - -`1.1.0 `_ (2019-03-01) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **rtd:** add basic ``docs/conf.py`` to allow additional customisation (\ `18d3924 `_\ ) - -Features -^^^^^^^^ - - -* **rtd:** provide custom CSS file for overriding in-use Sphinx theme (\ `24bd338 `_\ ) - -`1.0.1 `_ (2019-03-01) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **travis:** remove unavailable files from ``markdown-toc`` process (\ `3148f0d `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** convert to ``.rst`` and move to ``docs`` subdir (\ `474f318 `_\ ) -* **index:** add ``CONTRIBUTING`` to the ``toctree`` (\ `0c98e67 `_\ ) -* **readme:** move under ``docs`` subdir to access in both GitHub and RTD (\ `c92f674 `_\ ) -* **readme:** update heading markers for consistency (\ `5a2bea8 `_\ ) -* **rtd:** add basic ``index.rst`` to allow RTD to produce docs (\ `f02139f `_\ ) -* **rtd:** use internal link targets at the top of each ``.rst`` file (\ `da09528 `_\ ) - -`1.0.0 `_ (2019-02-28) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **components:** split components into separate subdirs (\ `d957055 `_\ ), closes `/github.com/saltstack-formulas/template-formula/pull/48#pullrequestreview-207182085 `_ `/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259805312 `_ -* **include+require:** use variable for duplicate values (\ `4443518 `_\ ) -* **pkg:** change to ``package`` instead (\ `2cd82e5 `_\ ), closes `/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259951123 `_ -* **pkg:** move ``pkg`` related components into separate directory (\ `c21f82b `_\ ) -* **states:** set state IDs based on a dependable structure (\ `6690ee6 `_\ ), closes `/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259953473 `_ `/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259956996 `_ -* **topdir:** use for ``include`` and ``require`` except ``init.sls`` (\ `a218e91 `_\ ) -* **tpldir:** use ``topdir`` globally in place of ``tpldir`` (\ `2838bc9 `_\ ) -* **tplroot:** use ``tplroot`` instead of ``topdir`` to match ``tpldata`` (\ `b7356b0 `_\ ) - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** specify ``image`` explicitly for each platform (\ `b25fbdc `_\ ) -* **kitchen+travis:** use ``debian:jessie-backports`` as ``debian-8`` (\ `1b9d249 `_\ ), closes `#50 `_ `/github.com/saltstack/salt-pack/issues/657#issuecomment-467932962 `_ - -Documentation -^^^^^^^^^^^^^ - - -* **components:** update for separation of ``pkg``\ , ``config`` & ``service`` (\ `726fcab `_\ ) -* **readme:** add suggested improvement to ``template.service.clean`` (\ `bf1039c `_\ ) -* **readme:** fix typos (\ `007159a `_\ ) - -Features -^^^^^^^^ - - -* **pkg:** add ``clean`` states (\ `422c7ac `_\ ) -* **pkg:** use ``require`` requisite between ``pkg`` states (\ `6e7141b `_\ ), closes `/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120 `_ `/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145 `_ `/github.com/saltstack/salt/issues/10838#issuecomment-391718086 `_ - -Reverts -^^^^^^^ - - -* **kitchen+travis:** disable ``debian-8`` due to ``2019.2`` bug (\ `e8f0f7e `_\ ) - -BREAKING CHANGES -^^^^^^^^^^^^^^^^ - - -* **states:** Wholesale state ID changes will break implementations - that are relying on the previous state IDs for requisite purposes. -* **pkg:** Changing the ``pkg`` directory to ``package`` will break - implementations that are depending on ``pkg`` for ``include`` or ``sls``\ -based - requisite purposes. - -`0.7.6 `_ (2019-02-27) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **yaml:** os*.yaml map files needs at least an empty dict (\ `dd99750 `_\ ) - -`0.7.5 `_ (2019-02-27) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **pillar:** fix ``os_family`` typo (\ `3f89c12 `_\ ) -* **tofs:** update comments in ``files_switch`` macro for new method (\ `3fa3640 `_\ ) - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **macros:** use ``tplroot`` instead of ``topdir`` to match ``tpldata`` (\ `923b459 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **tofs:** add more sub-headings to ease document navigation (\ `2c5dc21 `_\ ) -* **tofs:** apply language formatting to source code blocks (\ `0638413 `_\ ) -* **tofs:** explain how all parts of the ``source`` can be customised (\ `2f82eb5 `_\ ), closes `#44 `_ -* **tofs:** improve general use of language (\ `5105d29 `_\ ) -* **tofs:** update the ``files_switch`` section for the updated macro (\ `788f732 `_\ ) -* **tofs:** use ``{%-`` for all Jinja statements (\ `4348df8 `_\ ) - -`0.7.4 `_ (2019-02-27) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** check for repos updates before trying package installation (\ `b632383 `_\ ) -* **kitchen+travis:** disable ``debian-8`` due to ``2019.2`` installation bug (\ `178c710 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** separate ``BREAKING CHANGE`` under its own heading (\ `ee053d7 `_\ ) - -`0.7.3 `_ (2019-02-25) ----------------------------------------------------------------------------------------------------------- - -Bug Fixes -^^^^^^^^^ - - -* **tofs:** use ``tpldir`` derivative ``topdir`` for pillar (config) paths (\ `5e9df00 `_\ ) - -`0.7.2 `_ (2019-02-24) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **tpldir:** use ``tpldir`` or derivatives to make formula portable (\ `52d03d8 `_\ ), closes `#22 `_ - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** improve comments about ``opensuse`` problems encountered (\ `c246939 `_\ ) -* **travis:** prevent ``release`` stage running for PRs (\ `3a072c7 `_\ ), closes `/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466 `_ `/github.com/saltstack-formulas/template-formula/pull/42#issuecomment-466446324 `_ - -`0.7.1 `_ (2019-02-24) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **kitchen:** use ``salt-minion`` version of ``opensuse`` to ensure tests run (\ `99b073a `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **changelog:** remove erroneous "closes" used by ``semantic-release`` (\ `be4571d `_\ ) - -`0.7.0 `_ (2019-02-23) ----------------------------------------------------------------------------------------------------------- - -Features -^^^^^^^^ - - -* **tofs:** implement backwards-compatible TOFSv2 for configurability (\ `068a94d `_\ ) - -`0.6.0 `_ (2019-02-23) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add basic introductory text before the TOC (\ `45ccaf6 `_\ ) -* **contributing:** modify quoted heading to prevent TOC inclusion (\ `abcb6ef `_\ ) -* **readme:** convert note into a heading (\ `5f2d789 `_\ ) - -Features -^^^^^^^^ - - -* **toc:** use ``markdown-toc`` directly to update inline (\ `a5bae1e `_\ ) - -`0.5.0 `_ (2019-02-23) ----------------------------------------------------------------------------------------------------------- - -Features -^^^^^^^^ - - -* **kitchen+travis:** add ``opensuse-leap`` after resolving issues (\ `7614a3c `_\ ) -* **kitchen+travis:** conduct tests on a wider range of platforms (\ `1348078 `_\ ) - -Tests -^^^^^ - - -* **inspec:** update ``supports`` for all platforms added (\ `42f93b3 `_\ ) - -`0.4.0 `_ (2019-02-23) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** centre-align version bump columns in table (\ `a238cae `_\ ) - -Features -^^^^^^^^ - - -* **authors:** update automatically alongside ``semantic-release`` (\ `8000098 `_\ ) - -`0.3.6 `_ (2019-02-22) ----------------------------------------------------------------------------------------------------------- - -Continuous Integration -^^^^^^^^^^^^^^^^^^^^^^ - - -* **travis:** include ``commitlint`` stage (\ `6659a69 `_\ ) -* **travis:** remove obsolete check based on ``$TRAVIS_TEST_RESULT`` (\ `6df9c95 `_\ ) - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** update with sub-headings and ``commitlint`` details (\ `ea2c9a4 `_\ ) - -`0.3.5 `_ (2019-02-21) ----------------------------------------------------------------------------------------------------------- - -Code Refactoring -^^^^^^^^^^^^^^^^ - - -* **kitchen:** prefer ``kitchen.yml`` to ``.kitchen.yml`` (\ `3860bf9 `_\ ) - -`0.3.4 `_ (2019-02-21) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **contributing:** add commit message formatting instructions (\ `fb3d173 `_\ ) - -`0.3.3 `_ (2019-02-20) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **changelog:** add missing entry under ``v0.3.2`` (\ `50352b5 `_\ ) - -`0.3.2 `_ (2019-02-20) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **README:** remove gitchangelog (\ `2fc85fc `_\ ) -* **contributing:** create blank template (\ `3633e8f `_\ ) - -`0.3.1 `_ (2019-02-20) ----------------------------------------------------------------------------------------------------------- - -Documentation -^^^^^^^^^^^^^ - - -* **changelog:** merge previous ``rst`` into new ``md`` format (\ `2b4e485 `_\ ) - -`0.3.0 `_ (2019-02-20) ----------------------------------------------------------------------------------------------------------- - -Features -^^^^^^^^ - - -* **semantic-release:** configure for this formula (\ `cbcfd75 `_\ ) - -`0.2.0 `_ (2019-02-17) ----------------------------------------------------------------------------------------------------------- - - -* Added a working testing scaffold and travis support. [Javier Bértoli] - -`0.1.7 `_ (2019-02-16) ----------------------------------------------------------------------------------------------------------- - -Fix -^^^ - - -* Typo in the installation instructions. [Niels Abspoel] - -Other -^^^^^ - - -* Update the changelog. [Niels Abspoel] -* Update README with link to install gitchangelog [Imran Iqbal] - -`0.1.6 `_ (2019-02-16) ----------------------------------------------------------------------------------------------------------- - - -* Add changelog generator. [Niels Abspoel] - -`0.1.5 `_ (2019-02-15) ----------------------------------------------------------------------------------------------------------- - - -* Prepare v0.1.5 [Imran Iqbal] -* Fix missing ')' [gmazrael] - -`0.1.4 `_ (2019-02-15) ----------------------------------------------------------------------------------------------------------- - - -* Replace obsolete VERSION file and replace with FORMULA file. [Imran Iqbal] - -`0.1.3 `_ (2019-02-12) ----------------------------------------------------------------------------------------------------------- - - -* Updated changelog and version. [Alexander Weidinger] -* - Map.jinja: use grains.filter_by instead of defaults.merge. [Alexander Weidinger] - - because defaults.merge does not work with salt-ssh. https://github.com/saltstack/salt/issues/51605 - - Added osfingermap.yaml. - -`0.1.2 `_ (2019-02-12) ----------------------------------------------------------------------------------------------------------- - - -* Improve comments and examples in osfamilymap & osmap [Imran Iqbal] -* Fix map.jinja and add more OSes. [Imran Iqbal] - -`0.1.1 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Update. [Niels Abspoel] -* Update formula with map.jinja and style guide references, improve README and VERSION. [Niels Abspoel] - -`0.1.0 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* - Examples must be consistent. [Daniel Dehennin] - - The “template” is kept during rendering. - - - * TOFS_pattern.md: add “template” to rendered state. - * template/macros.jinja: ditoo. - -* - Remove double slash in generated salt URL. [Daniel Dehennin] - - When the files are “full path” with leading slash “/”, the generated URL contain a double slash because of the join. - - - * template/macros.jinja: remove leading slash before joining parts. - * TOFS_pattern.md: mirror changes of “macros.jinja”. - -* - Add an example for “ntp” of the use of “files_switch” [Daniel Dehennin] - -* - Accept pillar separator in “files_switch” prefix. [Daniel Dehennin] - - The prefix was used for 2 purposes: - - - * define the pillar prefix where to lookup “:files_switch”. It supports the colon “:” separator to lookup in pillar subtree like “foo:bar” - * - define the path prefix where to look for “files/”, It did not support separator to lookup inside directory tree. - - This patch only replace any colon “:” with “/” when looking up “files/” directory, with the “foo:bar” prefix: - - * - lookup “foo:bar:files_switch” pillar to get list of grains to match - - * lookup files under “salt://foo/bar/files/” - * TOFS_pattern.md: document the new use of “prefix” supporting colon “:”. - * template/macros.jinja: transform any colon “:” in “prefix” by slash - “/” to lookup files. - -* - Make TOFS pattern example usable. [Daniel Dehennin] - - The example could not be used as-is. This commit improve conformity to formula conventions. - - - * TOFS_pattern.md: add missing commas “,” in “map.jinja” and extra one - to ease the addition of new entries. Import “map.jinja” in “init.sls” and “conf.sls”. Declare descriptive state IDs. Use the “module.function” notation. Use the “name” parameter. - -* - Cosmetics modification of TOFS pattern documentation. [Daniel Dehennin] - - - * TOFS_pattern.md: add myself as modifier. - Trim trailing whitespaces. Separate titles from first paragraph. - -* - Switch template.config to TOFS pattern. [Daniel Dehennin] - -* Import TOFS pattern from Zabbix formula. [Daniel Dehennin] - -`0.0.9 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Add VERSION file. [Karim Hamza] -* Add note about formula versioning. [Karim Hamza] - -`0.0.8 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Align with SaltStack official formulas doc page. [Denys Havrysh] -* Use https in the link to SaltStack documentation. [Denys Havrysh] - -`0.0.7 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Map.ninja: fix typos and leftover comments. [Marco Molteni] -* Remove whitespace in map.jinja comment. [Andrew Gabbitas] - -`0.0.6 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Improve style and jinja too match salt-formula. [Niels Abspoel] -* Propose new-ish formula style - defaults live in defaults.yml - map jinja overrides by grain + merges pillar:lookup - split all contextually similar states in their own files. [puneet kandhari] - -`0.0.5 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Change states to use short-dec style. [Seth House] -* Update CHANGELOG.rst. [Nitin Madhok] -* - Update README.rst. [Nitin Madhok] - - Fix broken link - -* - Fixing pillar to match the map file. [Forrest] - - Map file and pillar didn't match. - -`0.0.4 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Add change log. [Antti Jokipii] - -`0.0.3 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Updated the license and readme to match our standards. [Forrest Alvarez] -* Use map.jinja content in init.sls. [Eugene Vereschagin] -* Add map.jinja. [Eugene Vereschagin] - -`0.0.2 `_ (2019-02-10) ----------------------------------------------------------------------------------------------------------- - - -* Add link to Salt Formula documentation. [Eugene Vereschagin] -* Change extension from .md to .rst. [Eugene Vereschagin] - -`0.0.1 `_ (2019-02-10) ------------------------------------------------------------------------------------------------------- - - -* Initial commit. [Lukas Erlacher] diff --git a/docs/CONTRIBUTING_DOCS.rst b/docs/CONTRIBUTING_DOCS.rst deleted file mode 100644 index b68bb77..0000000 --- a/docs/CONTRIBUTING_DOCS.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. _contributing_docs: - -Contributing documentation -========================== - -|docs| - -.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest - :alt: Documentation Status - :scale: 100% - :target: https://TEMPLATE-formula.readthedocs.io/en/latest/?badge=latest - -Toolchain -^^^^^^^^^ - -The documentation for this formula is written in -`reStructuredText `_ -(also known as RST, ReST, or reST). -It is built by -`Sphinx `_ -and hosted on -`Read the Docs `_. - -Adding a new page -^^^^^^^^^^^^^^^^^ - -Adding a new page involves two steps: - -#. Use the - :ref:`provided page template ` - to create a new page. -#. Add the page name under the ``toctree`` list in ``index.rst``. - - a. Do not just append it to the list. - #. Select the best place where it fits within the overall documentation. - -.. _saltstack_formulas_rst_page_template: - -SaltStack-Formulas' RST page template -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Use the following template when creating a new page. -This ensures consistency across the documentation for this formula. -The heading symbols have been selected in accordance to the output rendered by the -`Markdown to reStructuredText converter `_ -we are using for some of the pages of this documentation. - -.. code-block:: rst - - .. _template: - - [Page title] - ============ - - [Introductory paragraph] - - .. contents:: **Table of Contents** - - [Heading 2] - ----------- - - [Heading 3] - ^^^^^^^^^^^ - - [Heading 4] - ~~~~~~~~~~~ - - [Heading 5] - """"""""""" - - [Heading 6] - ########### - -#. The first line is an anchor that can be used to link back to (the top of) - this file. - - a. Change this to be the lowercase version of the file name. - #. Do not include the ``.rst`` file extension. - #. Use hyphens (``-``) instead of spaces or non-letter characters. - -#. Change the ``[Page title]`` accordingly, matching the same number of equals - signs (``=``) underneath. -#. Change the ``[Introductory paragraph]`` to be a short summary of the page - content. - Use no more than three paragraphs for this. -#. Leave the ``..contents:: **Table of Contents**`` line as it is. -#. Use the remaining headings as required to break up the page content. - - a. You will rarely need to use beyond ``[Heading 4]``. - #. Again, no single heading should have more than about three paragraphs of - content before the next heading or sub-heading is used. - -Obviously, it is not necessary to follow the steps in the order above. -For example, it is usually easier to write the ``[Introductory paragraph]`` -at the end. diff --git a/docs/README.rst b/docs/README.rst index 2b7f575..1183c65 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,14 +1,14 @@ .. _readme: -TEMPLATE-formula +nsd-formula ================ |img_travis| |img_sr| |img_pc| -.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/TEMPLATE-formula.svg?branch=master +.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/nsd-formula.svg?branch=master :alt: Travis CI Build Status :scale: 100% - :target: https://travis-ci.com/saltstack-formulas/TEMPLATE-formula + :target: https://travis-ci.com/saltstack-formulas/nsd-formula .. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg :alt: Semantic Release :scale: 100% @@ -68,35 +68,7 @@ now ``pre-commit`` will run automatically on each ``git commit``. :: Special notes ------------- -.. -formula``, where ```` consists of lower-case alphabetic characters, numbers, '-' or '_'. - -In the rest of this example we'll use ``example`` as the ````. - -Follow these steps to complete the conversion from ``template-formula`` to ``example-formula``. :: - - $ git clone git@github.com:YOUR-USERNAME/example-formula.git - $ cd example-formula/ - $ bin/convert-formula.sh example - $ git push --force - -Alternatively, it's possible to clone ``template-formula`` into a new repository and perform the conversion there. For example:: - - $ git clone https://github.com/saltstack-formulas/template-formula example-formula - $ cd example-formula/ - $ bin/convert-formula.sh example - -To take advantage of `semantic-release `_ for automated changelog generation and release tagging, you will need a GitHub `Personal Access Token `_ with at least the **public_repo** scope. - -In the Travis repository settings for your new repository, create an `environment variable `_ named ``GH_TOKEN`` with the personal access token as value, restricted to the ``master`` branch for security. - -Note that this repository uses a `CODEOWNERS `_ file to assign ownership to various parts of the formula. The conversion process removes overall ownership, but you should consider assigning ownership to yourself or your organisation when contributing your new formula to the ``saltstack-formulas`` organisation. - -.. REMOVEME> +None Available states ---------------- @@ -104,79 +76,79 @@ Available states .. contents:: :local: -``TEMPLATE`` +``nsd`` ^^^^^^^^^^^^ *Meta-state (This is a state that includes other states)*. -This installs the TEMPLATE package, -manages the TEMPLATE configuration file and then -starts the associated TEMPLATE service. +This installs the nsd package, +manages the nsd configuration file and then +starts the associated nsd service. -``TEMPLATE.package`` +``nsd.package`` ^^^^^^^^^^^^^^^^^^^^ -This state will install the TEMPLATE package only. +This state will install the nsd package only. -``TEMPLATE.config`` +``nsd.config`` ^^^^^^^^^^^^^^^^^^^ -This state will configure the TEMPLATE service and has a dependency on ``TEMPLATE.install`` +This state will configure the nsd service and has a dependency on ``nsd.install`` via include list. -``TEMPLATE.service`` +``nsd.service`` ^^^^^^^^^^^^^^^^^^^^ -This state will start the TEMPLATE service and has a dependency on ``TEMPLATE.config`` +This state will start the nsd service and has a dependency on ``nsd.config`` via include list. -``TEMPLATE.clean`` +``nsd.clean`` ^^^^^^^^^^^^^^^^^^ *Meta-state (This is a state that includes other states)*. -this state will undo everything performed in the ``TEMPLATE`` meta-state in reverse order, i.e. +this state will undo everything performed in the ``nsd`` meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package. -``TEMPLATE.service.clean`` +``nsd.service.clean`` ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This state will stop the TEMPLATE service and disable it at boot time. +This state will stop the nsd service and disable it at boot time. -``TEMPLATE.config.clean`` +``nsd.config.clean`` ^^^^^^^^^^^^^^^^^^^^^^^^^ -This state will remove the configuration of the TEMPLATE service and has a -dependency on ``TEMPLATE.service.clean`` via include list. +This state will remove the configuration of the nsd service and has a +dependency on ``nsd.service.clean`` via include list. -``TEMPLATE.package.clean`` +``nsd.package.clean`` ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This state will remove the TEMPLATE package and has a depency on -``TEMPLATE.config.clean`` via include list. +This state will remove the nsd package and has a depency on +``nsd.config.clean`` via include list. -``TEMPLATE.subcomponent`` +``nsd.subcomponent`` ^^^^^^^^^^^^^^^^^^^^^^^^^ *Meta-state (This is a state that includes other states)*. This state installs a subcomponent configuration file before -configuring and starting the TEMPLATE service. +configuring and starting the nsd service. -``TEMPLATE.subcomponent.config`` +``nsd.subcomponent.config`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This state will configure the TEMPLATE subcomponent and has a -dependency on ``TEMPLATE.config`` via include list. +This state will configure the nsd subcomponent and has a +dependency on ``nsd.config`` via include list. -``TEMPLATE.subcomponent.config.clean`` +``nsd.subcomponent.config.clean`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This state will remove the configuration of the TEMPLATE subcomponent -and reload the TEMPLATE service by a dependency on -``TEMPLATE.service.running`` via include list and ``watch_in`` +This state will remove the configuration of the nsd subcomponent +and reload the nsd service by a dependency on +``nsd.service.running`` via include list and ``watch_in`` requisite. Testing @@ -202,7 +174,7 @@ e.g. ``debian-9-2019-2-py3``. ``bin/kitchen converge`` ^^^^^^^^^^^^^^^^^^^^^^^^ -Creates the docker instance and runs the ``TEMPLATE`` main state, ready for testing. +Creates the docker instance and runs the ``nsd`` main state, ready for testing. ``bin/kitchen verify`` ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css deleted file mode 100644 index e6cc1de..0000000 --- a/docs/_static/css/custom.css +++ /dev/null @@ -1,20 +0,0 @@ -/* - Override styles for in-use Sphinx theme -*/ - -/* The next two `.wy`-based rules are specifically needed for the dealing with */ -/* the `sphinx_rtd_theme` bug where long lines do not wrap in tables */ - -/* override table width restrictions */ -.wy-table-responsive table th -, .wy-table-responsive table td -{ - /* !important prevents the common CSS stylesheets from - overriding this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; -} - -.wy-table-responsive -{ - overflow: visible !important; -} diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index afc8bd3..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,173 +0,0 @@ -# -*- coding: utf-8 -*- -"""Configuration file for the Sphinx documentation builder. - -This file does only contain a selection of the most common options. For a -full list see the documentation: - -* http://www.sphinx-doc.org/en/stable/config - -""" - -from __future__ import division, print_function, unicode_literals - -# from datetime import datetime - -from recommonmark.parser import CommonMarkParser - -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . -__author__ = 'Imran Iqbal' # noqa: E221 -__copyright__ = 'Copyright (C) 2019, MYII' # noqa: E221 -__license__ = 'Apache-2.0' # noqa: E221 -__version__ = 'latest' # noqa: E221 -__maintainer__ = 'Imran Iqbal' # noqa: E221 - - -# -- Project information ----------------------------------------------------- - -project = 'template-formula' -copyright = __copyright__.replace('Copyright (C) ', '') # noqa: A001 -author = __author__ -version = __version__ -release = __version__ - - -# -- General configuration --------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['templates', '_templates', '.templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -source_suffix = ['.rst', '.md'] - -# The master toctree document. -master_doc = 'index' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path . -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - - -# -- Options for the reStructuredText parser --------------------------------- - -file_insertion_enabled = False - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'template-formula' - - -# -- Options for Markdown output --------------------------------------------- - -source_parsers = { - '.md': CommonMarkParser, -} - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - 'index', - 'template-formula.tex', - u'template-formula Documentation', - u'', - 'manual', - ), -] - - -# -- Functions: `setup`, docstring preprocessing, etc. ----------------------- - -def setup(app): - """Prepare the Sphinx application object. - - Used for providing a custom CSS file for override styles. - - Parameters - ---------- - app : object - The Sphinx application object. - - Returns - ------- - app : object - The Sphinx application object. - - """ - app.add_stylesheet('css/custom.css') - return app diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index a49c0c3..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _index: - -.. ``template-formula`` documentation master file. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to template-formula's documentation! -============================================ - -.. toctree:: - :maxdepth: 2 - :caption: Contents - :numbered: - :glob: - - README - CONTRIBUTING - TOFS_pattern - AUTHORS - CHANGELOG diff --git a/docs/map.jinja.rst b/docs/map.jinja.rst index bfd3326..7e1f678 100644 --- a/docs/map.jinja.rst +++ b/docs/map.jinja.rst @@ -28,7 +28,7 @@ For formula users Quick start: configure per role and per DNS domain name values ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -We will see a quick setup to configure the ``TEMPLATE`` formula for different DNS domain names and several roles. +We will see a quick setup to configure the ``nsd`` formula for different DNS domain names and several roles. For this example, I'll define 2 kinds of `fileserver`_ sources: @@ -72,19 +72,19 @@ Create the file ``/etc/salt/master.d/fileserver.conf`` and restart the ``master` ... -Create per DNS configuration for ``TEMPLATE`` formula +Create per DNS configuration for ``nsd`` formula ````````````````````````````````````````````````````` -Now, we can provides the per DNS domain name configuration files for the ``TEMPLATE`` formulas under ``/srv/salt/TEMPLATE/parameters/``. +Now, we can provides the per DNS domain name configuration files for the ``nsd`` formulas under ``/srv/salt/nsd/parameters/``. We create the directory for ``dns:domain`` grain and we add a symlink for the ``domain`` grain which is extracted from the minion ``id``: .. code-block:: console - mkdir -p /srv/salt/TEMPLATE/parameters/dns:domain/ - ln -s dns:domain /srv/salt/TEMPLATE/parameters/domain + mkdir -p /srv/salt/nsd/parameters/dns:domain/ + ln -s dns:domain /srv/salt/nsd/parameters/domain -We create a configuration for the DNS domain ``example.net`` in ``/srv/salt/TEMPLATE/parameters/dns:domain/example.net.yaml``: +We create a configuration for the DNS domain ``example.net`` in ``/srv/salt/nsd/parameters/dns:domain/example.net.yaml``: .. code-block:: yaml @@ -93,7 +93,7 @@ We create a configuration for the DNS domain ``example.net`` in ``/srv/salt/TEMP config: /etc/template-formula-example-net.conf ... -We create another configuration for the DNS domain ``example.com`` in the Jinja YAML template ``/srv/salt/TEMPLATE/parameters/dns:domain/example.com.yaml.jinja``: +We create another configuration for the DNS domain ``example.com`` in the Jinja YAML template ``/srv/salt/nsd/parameters/dns:domain/example.com.yaml.jinja``: .. code-block:: yaml @@ -103,23 +103,23 @@ We create another configuration for the DNS domain ``example.com`` in the Jinja ... -Create per role configuration for ``TEMPLATE`` formula +Create per role configuration for ``nsd`` formula `````````````````````````````````````````````````````` -Now, we can provides the per role configuration files for the ``TEMPLATE`` formulas under ``/srv/salt/TEMPLATE/parameters/``. +Now, we can provides the per role configuration files for the ``nsd`` formulas under ``/srv/salt/nsd/parameters/``. We create the directory for roles: .. code-block:: console - mkdir -p /srv/salt/TEMPLATE/parameters/roles + mkdir -p /srv/salt/nsd/parameters/roles We will define 2 roles: -- ``TEMPLATE/server`` -- ``TEMPLATE/client`` +- ``nsd/server`` +- ``nsd/client`` -We create a configuration for the role ``TEMPLATE/server`` in ``/srv/salt/TEMPLATE/parameters/roles/TEMPLATE/server.yaml``: +We create a configuration for the role ``nsd/server`` in ``/srv/salt/nsd/parameters/roles/nsd/server.yaml``: .. code-block:: yaml @@ -128,7 +128,7 @@ We create a configuration for the role ``TEMPLATE/server`` in ``/srv/salt/TEMPLA config: /etc/template-formula-server.conf ... -We create another configuration for the role ``TEMPLATE/client`` in ``/srv/salt/TEMPLATE/parameters/roles/TEMPLATE/client.yaml``: +We create another configuration for the role ``nsd/client`` in ``/srv/salt/nsd/parameters/roles/nsd/client.yaml``: .. code-block:: yaml @@ -185,13 +185,13 @@ For the servers: .. code-block:: console - salt 'server-*' grains.append roles TEMPLATE/server + salt 'server-*' grains.append roles nsd/server For the clients: .. code-block:: console - salt 'client-*' grains.append roles TEMPLATE/client + salt 'client-*' grains.append roles nsd/client .. note:: @@ -236,7 +236,7 @@ And then, rename the directory: .. code-block:: console - mv /srv/salt/TEMPLATE/parameters/dns:domain/ '/srv/salt/TEMPLATE/parameters/dns!domain/' + mv /srv/salt/nsd/parameters/dns:domain/ '/srv/salt/nsd/parameters/dns!domain/' Format of configuration YAML files @@ -458,11 +458,11 @@ Here is the best way to use it in an ``sls`` file: {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split("/")[0] %} - {%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} + {%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} - test-does-nothing-but-display-TEMPLATE-as-json: + test-does-nothing-but-display-nsd-as-json: test.nop: - - name: {{ TEMPLATE | json }} + - name: {{ nsd | json }} Use formula configuration values in templates @@ -470,7 +470,7 @@ Use formula configuration values in templates When you need to process salt templates, you should avoid calling `salt['config.get']`_ (or `salt['pillar.get']`_ and `salt['grains.get']`_) directly from the template. All the needed values should be available within the ``mapdata`` variable exported by ``map.jinja``. -Here is an example based on `template-formula/TEMPLATE/config/file.sls`_: +Here is an example based on `template-formula/nsd/config/file.sls`_: .. code-block:: sls @@ -480,30 +480,30 @@ Here is an example based on `template-formula/TEMPLATE/config/file.sls`_: {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} {%- set sls_package_install = tplroot ~ '.package.install' %} - {%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} + {%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} {%- from tplroot ~ "/libtofs.jinja" import files_switch with context %} include: - {{ sls_package_install }} - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: file.managed: - - name: {{ TEMPLATE.config }} + - name: {{ nsd.config }} - source: {{ files_switch(['example.tmpl'], - lookup='TEMPLATE-config-file-file-managed' + lookup='nsd-config-file-file-managed' ) }} - mode: 644 - user: root - - group: {{ TEMPLATE.rootgroup }} + - group: {{ nsd.rootgroup }} - makedirs: True - template: jinja - require: - sls: {{ sls_package_install }} - context: - TEMPLATE: {{ TEMPLATE | json }} + nsd: {{ nsd | json }} -This ``sls`` file expose a ``TEMPLATE`` context variable to the jinja template which could be used like this: +This ``sls`` file expose a ``nsd`` context variable to the jinja template which could be used like this: .. code-block:: jinja @@ -515,9 +515,9 @@ This ``sls`` file expose a ``TEMPLATE`` context variable to the jinja template w This is another example file from SaltStack template-formula. # This is here for testing purposes - {{ TEMPLATE | json }} + {{ nsd | json }} - winner of the merge: {{ TEMPLATE['winner'] }} + winner of the merge: {{ nsd['winner'] }} .. _documentation: https://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html#writing-formulas @@ -538,5 +538,5 @@ This ``sls`` file expose a ``TEMPLATE`` context variable to the jinja template w .. _salt.slsutil.merge: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.slsutil.html#salt.modules.slsutil.merge .. _traverse: https://docs.saltproject.io/en/latest/topics/jinja/index.html#traverse .. _salt-ssh: https://docs.saltproject.io/en/latest/topics/ssh/ -.. _template-formula/TEMPLATE/config/file.sls: https://github.com/saltstack-formulas/template-formula/blob/master/TEMPLATE/config/file.sls +.. _template-formula/nsd/config/file.sls: https://github.com/saltstack-formulas/template-formula/blob/master/nsd/config/file.sls .. _bug 58726: https://github.com/saltstack/salt/issues/58726 diff --git a/kitchen.yml b/kitchen.yml index 468cf72..803a642 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -293,7 +293,7 @@ provisioner: log_level: debug salt_install: none require_chef: false - formula: TEMPLATE + formula: nsd salt_copy_filter: - .kitchen - .git @@ -321,16 +321,16 @@ suites: state_top: base: '*': - - TEMPLATE._mapdata - - TEMPLATE + - nsd._mapdata + - nsd pillars: top.sls: base: '*': - - TEMPLATE + - nsd - define_roles pillars_from_files: - TEMPLATE.sls: pillar.example + nsd.sls: pillar.example define_roles.sls: test/salt/pillar/define_roles.sls verifier: inspec_tests: @@ -349,17 +349,17 @@ suites: state_top: base: '*': - - TEMPLATE._mapdata - - TEMPLATE + - nsd._mapdata + - nsd pillars: top.sls: base: '*': - - TEMPLATE + - nsd - gentoo - define_roles pillars_from_files: - TEMPLATE.sls: pillar.example + nsd.sls: pillar.example gentoo.sls: test/salt/pillar/gentoo.sls define_roles.sls: test/salt/pillar/define_roles.sls verifier: diff --git a/TEMPLATE/_mapdata/_mapdata.jinja b/nsd/_mapdata/_mapdata.jinja similarity index 100% rename from TEMPLATE/_mapdata/_mapdata.jinja rename to nsd/_mapdata/_mapdata.jinja diff --git a/TEMPLATE/_mapdata/init.sls b/nsd/_mapdata/init.sls similarity index 100% rename from TEMPLATE/_mapdata/init.sls rename to nsd/_mapdata/init.sls diff --git a/TEMPLATE/clean.sls b/nsd/clean.sls similarity index 100% rename from TEMPLATE/clean.sls rename to nsd/clean.sls diff --git a/TEMPLATE/config/clean.sls b/nsd/config/clean.sls similarity index 66% rename from TEMPLATE/config/clean.sls rename to nsd/config/clean.sls index 19b3f99..848c49e 100644 --- a/TEMPLATE/config/clean.sls +++ b/nsd/config/clean.sls @@ -4,13 +4,13 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} {%- set sls_service_clean = tplroot ~ '.service.clean' %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} include: - {{ sls_service_clean }} -TEMPLATE-config-clean-file-absent: +nsd-config-clean-file-absent: file.absent: - - name: {{ TEMPLATE.config }} + - name: {{ nsd.config }} - require: - sls: {{ sls_service_clean }} diff --git a/TEMPLATE/config/file.sls b/nsd/config/file.sls similarity index 64% rename from TEMPLATE/config/file.sls rename to nsd/config/file.sls index 661d813..1c7a510 100644 --- a/TEMPLATE/config/file.sls +++ b/nsd/config/file.sls @@ -4,25 +4,25 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} {%- set sls_package_install = tplroot ~ '.package.install' %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} {%- from tplroot ~ "/libtofs.jinja" import files_switch with context %} include: - {{ sls_package_install }} -TEMPLATE-config-file-file-managed: +nsd-config-file-file-managed: file.managed: - - name: {{ TEMPLATE.config }} + - name: {{ nsd.config }} - source: {{ files_switch(['example.tmpl'], - lookup='TEMPLATE-config-file-file-managed' + lookup='nsd-config-file-file-managed' ) }} - mode: 644 - user: root - - group: {{ TEMPLATE.rootgroup }} + - group: {{ nsd.rootgroup }} - makedirs: True - template: jinja - require: - sls: {{ sls_package_install }} - context: - TEMPLATE: {{ TEMPLATE | json }} + nsd: {{ nsd | json }} diff --git a/TEMPLATE/config/init.sls b/nsd/config/init.sls similarity index 100% rename from TEMPLATE/config/init.sls rename to nsd/config/init.sls diff --git a/TEMPLATE/files/default/example.tmpl b/nsd/files/default/example.tmpl similarity index 100% rename from TEMPLATE/files/default/example.tmpl rename to nsd/files/default/example.tmpl diff --git a/TEMPLATE/files/default/example.tmpl.jinja b/nsd/files/default/example.tmpl.jinja similarity index 82% rename from TEMPLATE/files/default/example.tmpl.jinja rename to nsd/files/default/example.tmpl.jinja index b8999ab..60ea013 100644 --- a/TEMPLATE/files/default/example.tmpl.jinja +++ b/nsd/files/default/example.tmpl.jinja @@ -6,6 +6,6 @@ This is another example file from SaltStack template-formula. # This is here for testing purposes -{{ TEMPLATE | json }} +{{ nsd | json }} -winner of the merge: {{ TEMPLATE['winner'] }} +winner of the merge: {{ nsd['winner'] }} diff --git a/TEMPLATE/init.sls b/nsd/init.sls similarity index 100% rename from TEMPLATE/init.sls rename to nsd/init.sls diff --git a/TEMPLATE/libmapstack.jinja b/nsd/libmapstack.jinja similarity index 100% rename from TEMPLATE/libmapstack.jinja rename to nsd/libmapstack.jinja diff --git a/TEMPLATE/libmatchers.jinja b/nsd/libmatchers.jinja similarity index 100% rename from TEMPLATE/libmatchers.jinja rename to nsd/libmatchers.jinja diff --git a/TEMPLATE/libsaltcli.jinja b/nsd/libsaltcli.jinja similarity index 100% rename from TEMPLATE/libsaltcli.jinja rename to nsd/libsaltcli.jinja diff --git a/TEMPLATE/libtofs.jinja b/nsd/libtofs.jinja similarity index 100% rename from TEMPLATE/libtofs.jinja rename to nsd/libtofs.jinja diff --git a/TEMPLATE/map.jinja b/nsd/map.jinja similarity index 100% rename from TEMPLATE/map.jinja rename to nsd/map.jinja diff --git a/TEMPLATE/package/clean.sls b/nsd/package/clean.sls similarity index 65% rename from TEMPLATE/package/clean.sls rename to nsd/package/clean.sls index 883b37d..afb1bf7 100644 --- a/TEMPLATE/package/clean.sls +++ b/nsd/package/clean.sls @@ -4,13 +4,13 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} {%- set sls_config_clean = tplroot ~ '.config.clean' %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} include: - {{ sls_config_clean }} -TEMPLATE-package-clean-pkg-removed: +nsd-package-clean-pkg-removed: pkg.removed: - - name: {{ TEMPLATE.pkg.name }} + - name: {{ nsd.pkg.name }} - require: - sls: {{ sls_config_clean }} diff --git a/TEMPLATE/package/init.sls b/nsd/package/init.sls similarity index 100% rename from TEMPLATE/package/init.sls rename to nsd/package/init.sls diff --git a/nsd/package/install.sls b/nsd/package/install.sls new file mode 100644 index 0000000..4082332 --- /dev/null +++ b/nsd/package/install.sls @@ -0,0 +1,10 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} + +nsd-package-install-pkg-installed: + pkg.installed: + - name: {{ nsd.pkg.name }} diff --git a/TEMPLATE/parameters/defaults.yaml b/nsd/parameters/defaults.yaml similarity index 64% rename from TEMPLATE/parameters/defaults.yaml rename to nsd/parameters/defaults.yaml index dc693d1..4b45194 100644 --- a/TEMPLATE/parameters/defaults.yaml +++ b/nsd/parameters/defaults.yaml @@ -5,13 +5,13 @@ --- values: pkg: - name: TEMPLATE + name: nsd rootgroup: root - config: '/etc/TEMPLATE' + config: '/etc/nsd' service: - name: TEMPLATE + name: nsd subcomponent: - config: '/etc/TEMPLATE-subcomponent-formula.conf' + config: '/etc/nsd-subcomponent-formula.conf' # Just here for testing added_in_defaults: defaults_value winner: defaults diff --git a/TEMPLATE/parameters/os/Fedora.yaml b/nsd/parameters/os/Fedora.yaml similarity index 94% rename from TEMPLATE/parameters/os/Fedora.yaml rename to nsd/parameters/os/Fedora.yaml index 98d2a96..857e3eb 100644 --- a/TEMPLATE/parameters/os/Fedora.yaml +++ b/nsd/parameters/os/Fedora.yaml @@ -13,7 +13,7 @@ --- values: pkg: - name: TEMPLATE-fedora + name: nsd-fedora service: name: service-fedora ... diff --git a/TEMPLATE/parameters/os/MacOS.yaml.jinja b/nsd/parameters/os/MacOS.yaml.jinja similarity index 100% rename from TEMPLATE/parameters/os/MacOS.yaml.jinja rename to nsd/parameters/os/MacOS.yaml.jinja diff --git a/TEMPLATE/parameters/os/Ubuntu.yaml b/nsd/parameters/os/Ubuntu.yaml similarity index 85% rename from TEMPLATE/parameters/os/Ubuntu.yaml rename to nsd/parameters/os/Ubuntu.yaml index 88748c1..358f87a 100644 --- a/TEMPLATE/parameters/os/Ubuntu.yaml +++ b/nsd/parameters/os/Ubuntu.yaml @@ -13,6 +13,6 @@ --- values: pkg: - name: TEMPLATE-ubuntu - config: /etc/TEMPLATE.d/custom-ubuntu.conf + name: nsd-ubuntu + config: /etc/nsd.d/custom-ubuntu.conf ... diff --git a/TEMPLATE/parameters/os_family/Arch.yaml b/nsd/parameters/os_family/Arch.yaml similarity index 94% rename from TEMPLATE/parameters/os_family/Arch.yaml rename to nsd/parameters/os_family/Arch.yaml index f490854..2a645c7 100644 --- a/TEMPLATE/parameters/os_family/Arch.yaml +++ b/nsd/parameters/os_family/Arch.yaml @@ -13,7 +13,7 @@ --- values: pkg: - name: TEMPLATE-arch + name: nsd-arch service: name: service-arch ... diff --git a/TEMPLATE/parameters/os_family/Debian.yaml b/nsd/parameters/os_family/Debian.yaml similarity index 86% rename from TEMPLATE/parameters/os_family/Debian.yaml rename to nsd/parameters/os_family/Debian.yaml index 5fd86ed..30cb664 100644 --- a/TEMPLATE/parameters/os_family/Debian.yaml +++ b/nsd/parameters/os_family/Debian.yaml @@ -13,6 +13,6 @@ --- values: pkg: - name: TEMPLATE-debian - config: /etc/TEMPLATE.d/custom.conf + name: nsd-debian + config: /etc/nsd.d/custom.conf ... diff --git a/TEMPLATE/parameters/os_family/FreeBSD.yaml b/nsd/parameters/os_family/FreeBSD.yaml similarity index 100% rename from TEMPLATE/parameters/os_family/FreeBSD.yaml rename to nsd/parameters/os_family/FreeBSD.yaml diff --git a/TEMPLATE/parameters/os_family/Gentoo.yaml b/nsd/parameters/os_family/Gentoo.yaml similarity index 93% rename from TEMPLATE/parameters/os_family/Gentoo.yaml rename to nsd/parameters/os_family/Gentoo.yaml index ec91b18..bc9ed37 100644 --- a/TEMPLATE/parameters/os_family/Gentoo.yaml +++ b/nsd/parameters/os_family/Gentoo.yaml @@ -13,5 +13,5 @@ --- values: pkg: - name: TEMPLATE-gentoo + name: nsd-gentoo ... diff --git a/TEMPLATE/parameters/os_family/OpenBSD.yaml b/nsd/parameters/os_family/OpenBSD.yaml similarity index 100% rename from TEMPLATE/parameters/os_family/OpenBSD.yaml rename to nsd/parameters/os_family/OpenBSD.yaml diff --git a/TEMPLATE/parameters/os_family/RedHat.yaml b/nsd/parameters/os_family/RedHat.yaml similarity index 87% rename from TEMPLATE/parameters/os_family/RedHat.yaml rename to nsd/parameters/os_family/RedHat.yaml index 43b0280..7aa8cf0 100644 --- a/TEMPLATE/parameters/os_family/RedHat.yaml +++ b/nsd/parameters/os_family/RedHat.yaml @@ -13,6 +13,6 @@ --- values: pkg: - name: TEMPLATE-redhat - config: /etc/TEMPLATE.conf + name: nsd-redhat + config: /etc/nsd.conf ... diff --git a/TEMPLATE/parameters/os_family/Suse.yaml b/nsd/parameters/os_family/Suse.yaml similarity index 94% rename from TEMPLATE/parameters/os_family/Suse.yaml rename to nsd/parameters/os_family/Suse.yaml index 567f12c..cae0a90 100644 --- a/TEMPLATE/parameters/os_family/Suse.yaml +++ b/nsd/parameters/os_family/Suse.yaml @@ -13,5 +13,5 @@ --- values: pkg: - name: TEMPLATE-suse + name: nsd-suse ... diff --git a/TEMPLATE/parameters/osarch/386.yaml b/nsd/parameters/osarch/386.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/386.yaml rename to nsd/parameters/osarch/386.yaml diff --git a/TEMPLATE/parameters/osarch/amd64.yaml b/nsd/parameters/osarch/amd64.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/amd64.yaml rename to nsd/parameters/osarch/amd64.yaml diff --git a/TEMPLATE/parameters/osarch/arm64.yaml b/nsd/parameters/osarch/arm64.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/arm64.yaml rename to nsd/parameters/osarch/arm64.yaml diff --git a/TEMPLATE/parameters/osarch/armv6l.yaml b/nsd/parameters/osarch/armv6l.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/armv6l.yaml rename to nsd/parameters/osarch/armv6l.yaml diff --git a/TEMPLATE/parameters/osarch/armv7l.yaml b/nsd/parameters/osarch/armv7l.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/armv7l.yaml rename to nsd/parameters/osarch/armv7l.yaml diff --git a/TEMPLATE/parameters/osarch/ppc64le.yaml b/nsd/parameters/osarch/ppc64le.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/ppc64le.yaml rename to nsd/parameters/osarch/ppc64le.yaml diff --git a/TEMPLATE/parameters/osarch/s390x.yaml b/nsd/parameters/osarch/s390x.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/s390x.yaml rename to nsd/parameters/osarch/s390x.yaml diff --git a/TEMPLATE/parameters/osarch/x86_64.yaml b/nsd/parameters/osarch/x86_64.yaml similarity index 100% rename from TEMPLATE/parameters/osarch/x86_64.yaml rename to nsd/parameters/osarch/x86_64.yaml diff --git a/TEMPLATE/parameters/osfinger/CentOS-6.yaml b/nsd/parameters/osfinger/CentOS-6.yaml similarity index 83% rename from TEMPLATE/parameters/osfinger/CentOS-6.yaml rename to nsd/parameters/osfinger/CentOS-6.yaml index ff82087..2886880 100644 --- a/TEMPLATE/parameters/osfinger/CentOS-6.yaml +++ b/nsd/parameters/osfinger/CentOS-6.yaml @@ -13,6 +13,6 @@ --- values: pkg: - name: TEMPLATE-centos-6 - config: /etc/TEMPLATE.d/custom-centos-6.conf + name: nsd-centos-6 + config: /etc/nsd.d/custom-centos-6.conf ... diff --git a/TEMPLATE/parameters/osfinger/Ubuntu-18.04.yaml b/nsd/parameters/osfinger/Ubuntu-18.04.yaml similarity index 88% rename from TEMPLATE/parameters/osfinger/Ubuntu-18.04.yaml rename to nsd/parameters/osfinger/Ubuntu-18.04.yaml index 4a2bbb4..8b5ee2b 100644 --- a/TEMPLATE/parameters/osfinger/Ubuntu-18.04.yaml +++ b/nsd/parameters/osfinger/Ubuntu-18.04.yaml @@ -12,5 +12,5 @@ # values: {} --- values: - config: /etc/TEMPLATE.d/custom-ubuntu-18.04.conf + config: /etc/nsd.d/custom-ubuntu-18.04.conf ... diff --git a/TEMPLATE/service/clean.sls b/nsd/service/clean.sls similarity index 50% rename from TEMPLATE/service/clean.sls rename to nsd/service/clean.sls index 5616703..e438718 100644 --- a/TEMPLATE/service/clean.sls +++ b/nsd/service/clean.sls @@ -3,9 +3,9 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} -TEMPLATE-service-clean-service-dead: +nsd-service-clean-service-dead: service.dead: - - name: {{ TEMPLATE.service.name }} + - name: {{ nsd.service.name }} - enable: False diff --git a/TEMPLATE/service/init.sls b/nsd/service/init.sls similarity index 100% rename from TEMPLATE/service/init.sls rename to nsd/service/init.sls diff --git a/TEMPLATE/service/running.sls b/nsd/service/running.sls similarity index 65% rename from TEMPLATE/service/running.sls rename to nsd/service/running.sls index 9c9a625..0a5ec44 100644 --- a/TEMPLATE/service/running.sls +++ b/nsd/service/running.sls @@ -4,14 +4,14 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} {%- set sls_config_file = tplroot ~ '.config.file' %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} include: - {{ sls_config_file }} -TEMPLATE-service-running-service-running: +nsd-service-running-service-running: service.running: - - name: {{ TEMPLATE.service.name }} + - name: {{ nsd.service.name }} - enable: True - watch: - sls: {{ sls_config_file }} diff --git a/TEMPLATE/subcomponent/clean.sls b/nsd/subcomponent/clean.sls similarity index 100% rename from TEMPLATE/subcomponent/clean.sls rename to nsd/subcomponent/clean.sls diff --git a/TEMPLATE/subcomponent/config/clean.sls b/nsd/subcomponent/config/clean.sls similarity index 62% rename from TEMPLATE/subcomponent/config/clean.sls rename to nsd/subcomponent/config/clean.sls index 7cbe308..aa81bbf 100644 --- a/TEMPLATE/subcomponent/config/clean.sls +++ b/nsd/subcomponent/config/clean.sls @@ -4,13 +4,13 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} {%- set sls_service_clean = tplroot ~ '.service.clean' %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} include: - {{ sls_service_clean }} -TEMPLATE-subcomponent-config-clean-file-absent: +nsd-subcomponent-config-clean-file-absent: file.absent: - - name: {{ TEMPLATE.subcomponent.config }} + - name: {{ nsd.subcomponent.config }} - watch_in: - sls: {{ sls_service_clean }} diff --git a/TEMPLATE/subcomponent/config/file.sls b/nsd/subcomponent/config/file.sls similarity index 65% rename from TEMPLATE/subcomponent/config/file.sls rename to nsd/subcomponent/config/file.sls index dc3404f..4cf0041 100644 --- a/TEMPLATE/subcomponent/config/file.sls +++ b/nsd/subcomponent/config/file.sls @@ -4,23 +4,23 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} {%- set sls_config_file = tplroot ~ '.config.file' %} -{%- from tplroot ~ "/map.jinja" import mapdata as TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %} {%- from tplroot ~ "/libtofs.jinja" import files_switch with context %} include: - {{ sls_config_file }} -TEMPLATE-subcomponent-config-file-file-managed: +nsd-subcomponent-config-file-file-managed: file.managed: - - name: {{ TEMPLATE.subcomponent.config }} + - name: {{ nsd.subcomponent.config }} - source: {{ files_switch(['subcomponent-example.tmpl'], - lookup='TEMPLATE-subcomponent-config-file-file-managed', + lookup='nsd-subcomponent-config-file-file-managed', use_subpath=True ) }} - mode: 644 - user: root - - group: {{ TEMPLATE.rootgroup }} + - group: {{ nsd.rootgroup }} - makedirs: True - template: jinja - require_in: diff --git a/TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl b/nsd/subcomponent/config/files/default/subcomponent-example.tmpl similarity index 100% rename from TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl rename to nsd/subcomponent/config/files/default/subcomponent-example.tmpl diff --git a/TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl.jinja b/nsd/subcomponent/config/files/default/subcomponent-example.tmpl.jinja similarity index 100% rename from TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl.jinja rename to nsd/subcomponent/config/files/default/subcomponent-example.tmpl.jinja diff --git a/TEMPLATE/subcomponent/config/init.sls b/nsd/subcomponent/config/init.sls similarity index 100% rename from TEMPLATE/subcomponent/config/init.sls rename to nsd/subcomponent/config/init.sls diff --git a/TEMPLATE/subcomponent/init.sls b/nsd/subcomponent/init.sls similarity index 100% rename from TEMPLATE/subcomponent/init.sls rename to nsd/subcomponent/init.sls diff --git a/pillar.example b/pillar.example index 995d8f7..91f2070 100644 --- a/pillar.example +++ b/pillar.example @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=yaml --- -TEMPLATE: +nsd: lookup: master: template-master # Just for testing purposes @@ -33,7 +33,7 @@ TEMPLATE: # All aspects of path/file resolution are customisable using the options below. # This is unnecessary in most cases; there are sensible defaults. # Default path: salt://< path_prefix >/< dirs.files >/< dirs.default > - # I.e.: salt://TEMPLATE/files/default + # I.e.: salt://nsd/files/default # path_prefix: template_alt # dirs: # files: files_alt @@ -41,15 +41,15 @@ TEMPLATE: # The entries under `source_files` are prepended to the default source files # given for the state # source_files: - # TEMPLATE-config-file-file-managed: + # nsd-config-file-file-managed: # - 'example_alt.tmpl' # - 'example_alt.tmpl.jinja' # For testing purposes source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - 'example.tmpl.jinja' - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - 'subcomponent-example.tmpl.jinja' # Just for testing purposes diff --git a/test/integration/default/controls/_mapdata.rb b/test/integration/default/controls/_mapdata.rb index c424138..526a786 100644 --- a/test/integration/default/controls/_mapdata.rb +++ b/test/integration/default/controls/_mapdata.rb @@ -2,7 +2,7 @@ require 'yaml' -control 'TEMPLATE._mapdata' do +control 'nsd._mapdata' do title '`map.jinja` should match the reference file' ### Method diff --git a/test/integration/default/controls/config.rb b/test/integration/default/controls/config.rb index d501ee3..5f8b566 100644 --- a/test/integration/default/controls/config.rb +++ b/test/integration/default/controls/config.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -control 'TEMPLATE.config.file' do +control 'nsd.config.file' do title 'Verify the configuration file' describe file('/etc/template-formula.conf') do @@ -26,8 +26,8 @@ control 'TEMPLATE.config.file' do should include( '"tofs": {"files_switch": ["any/path/can/be/used/here", "id", '\ '"roles", "osfinger", "os", "os_family"], "source_files": '\ - '{"TEMPLATE-config-file-file-managed": ["example.tmpl.jinja"], '\ - '"TEMPLATE-subcomponent-config-file-file-managed": '\ + '{"nsd-config-file-file-managed": ["example.tmpl.jinja"], '\ + '"nsd-subcomponent-config-file-file-managed": '\ '["subcomponent-example.tmpl.jinja"]}' ) # rubocop:enable Layout/LineLength diff --git a/test/integration/default/controls/packages.rb b/test/integration/default/controls/packages.rb index 9e68437..fb51681 100644 --- a/test/integration/default/controls/packages.rb +++ b/test/integration/default/controls/packages.rb @@ -3,7 +3,7 @@ # Prepare platform "finger" platform_finger = system.platform[:finger].split('.').first.to_s -control 'TEMPLATE.package.install' do +control 'nsd.package.install' do title 'The required package should be installed' # Overide by `platform_finger` diff --git a/test/integration/default/controls/services.rb b/test/integration/default/controls/services.rb index 44fcab1..0bf6cc6 100644 --- a/test/integration/default/controls/services.rb +++ b/test/integration/default/controls/services.rb @@ -3,7 +3,7 @@ # Prepare platform "finger" platform_finger = system.platform[:finger].split('.').first.to_s -control 'TEMPLATE.service.running' do +control 'nsd.service.running' do title 'The service should be installed, enabled and running' # Overide by `platform_finger` diff --git a/test/integration/default/controls/subcomponent_config.rb b/test/integration/default/controls/subcomponent_config.rb index 5501f92..eef0281 100644 --- a/test/integration/default/controls/subcomponent_config.rb +++ b/test/integration/default/controls/subcomponent_config.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -control 'TEMPLATE.subcomponent.config.file' do +control 'nsd.subcomponent.config.file' do title 'Verify the subcomponent configuration file' - describe file('/etc/TEMPLATE-subcomponent-formula.conf') do + describe file('/etc/nsd-subcomponent-formula.conf') do it { should be_file } it { should be_owned_by 'root' } it { should be_grouped_into 'root' } @@ -11,7 +11,7 @@ control 'TEMPLATE.subcomponent.config.file' do its('content') do should include( '# File managed by Salt at '\ - '.' ) end diff --git a/test/integration/default/files/_mapdata/amazonlinux-1.yaml b/test/integration/default/files/_mapdata/amazonlinux-1.yaml index 5e9a51d..2bd13f8 100644 --- a/test/integration/default/files/_mapdata/amazonlinux-1.yaml +++ b/test/integration/default/files/_mapdata/amazonlinux-1.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: crond subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/amazonlinux-2.yaml b/test/integration/default/files/_mapdata/amazonlinux-2.yaml index 72cc079..df4fd6e 100644 --- a/test/integration/default/files/_mapdata/amazonlinux-2.yaml +++ b/test/integration/default/files/_mapdata/amazonlinux-2.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/arch-base-latest.yaml b/test/integration/default/files/_mapdata/arch-base-latest.yaml index f229d77..84bdd41 100644 --- a/test/integration/default/files/_mapdata/arch-base-latest.yaml +++ b/test/integration/default/files/_mapdata/arch-base-latest.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/centos-6.yaml b/test/integration/default/files/_mapdata/centos-6.yaml index e483d0d..699ead8 100644 --- a/test/integration/default/files/_mapdata/centos-6.yaml +++ b/test/integration/default/files/_mapdata/centos-6.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: crond subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/centos-7.yaml b/test/integration/default/files/_mapdata/centos-7.yaml index cbb0b4f..0f8ccc8 100644 --- a/test/integration/default/files/_mapdata/centos-7.yaml +++ b/test/integration/default/files/_mapdata/centos-7.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/centos-8.yaml b/test/integration/default/files/_mapdata/centos-8.yaml index b964150..d40f5ec 100644 --- a/test/integration/default/files/_mapdata/centos-8.yaml +++ b/test/integration/default/files/_mapdata/centos-8.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/debian-10.yaml b/test/integration/default/files/_mapdata/debian-10.yaml index cde0770..2f27c32 100644 --- a/test/integration/default/files/_mapdata/debian-10.yaml +++ b/test/integration/default/files/_mapdata/debian-10.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/debian-9.yaml b/test/integration/default/files/_mapdata/debian-9.yaml index bf5aae9..f005cf8 100644 --- a/test/integration/default/files/_mapdata/debian-9.yaml +++ b/test/integration/default/files/_mapdata/debian-9.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/fedora-31.yaml b/test/integration/default/files/_mapdata/fedora-31.yaml index a36a2fa..30bd031 100644 --- a/test/integration/default/files/_mapdata/fedora-31.yaml +++ b/test/integration/default/files/_mapdata/fedora-31.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/fedora-32.yaml b/test/integration/default/files/_mapdata/fedora-32.yaml index 4aac6c1..7445036 100644 --- a/test/integration/default/files/_mapdata/fedora-32.yaml +++ b/test/integration/default/files/_mapdata/fedora-32.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/fedora-33.yaml b/test/integration/default/files/_mapdata/fedora-33.yaml index 9508dd3..6ecc6fa 100644 --- a/test/integration/default/files/_mapdata/fedora-33.yaml +++ b/test/integration/default/files/_mapdata/fedora-33.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/gentoo-2-sysd.yaml b/test/integration/default/files/_mapdata/gentoo-2-sysd.yaml index 05e6ed5..8e5caf9 100644 --- a/test/integration/default/files/_mapdata/gentoo-2-sysd.yaml +++ b/test/integration/default/files/_mapdata/gentoo-2-sysd.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/gentoo-2-sysv.yaml b/test/integration/default/files/_mapdata/gentoo-2-sysv.yaml index 84b4fb9..d92e975 100644 --- a/test/integration/default/files/_mapdata/gentoo-2-sysv.yaml +++ b/test/integration/default/files/_mapdata/gentoo-2-sysv.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: mtab subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/opensuse-15.yaml b/test/integration/default/files/_mapdata/opensuse-15.yaml index 7a52c39..1bb2479 100644 --- a/test/integration/default/files/_mapdata/opensuse-15.yaml +++ b/test/integration/default/files/_mapdata/opensuse-15.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/opensuse-tumbleweed.yaml b/test/integration/default/files/_mapdata/opensuse-tumbleweed.yaml index dffde67..552331a 100644 --- a/test/integration/default/files/_mapdata/opensuse-tumbleweed.yaml +++ b/test/integration/default/files/_mapdata/opensuse-tumbleweed.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/oraclelinux-7.yaml b/test/integration/default/files/_mapdata/oraclelinux-7.yaml index 4eae50d..2b9e68f 100644 --- a/test/integration/default/files/_mapdata/oraclelinux-7.yaml +++ b/test/integration/default/files/_mapdata/oraclelinux-7.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/oraclelinux-8.yaml b/test/integration/default/files/_mapdata/oraclelinux-8.yaml index 40f09bb..a04c318 100644 --- a/test/integration/default/files/_mapdata/oraclelinux-8.yaml +++ b/test/integration/default/files/_mapdata/oraclelinux-8.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/ubuntu-16.yaml b/test/integration/default/files/_mapdata/ubuntu-16.yaml index 83c9f8b..9e14f8f 100644 --- a/test/integration/default/files/_mapdata/ubuntu-16.yaml +++ b/test/integration/default/files/_mapdata/ubuntu-16.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/ubuntu-18.yaml b/test/integration/default/files/_mapdata/ubuntu-18.yaml index 86a231b..602414f 100644 --- a/test/integration/default/files/_mapdata/ubuntu-18.yaml +++ b/test/integration/default/files/_mapdata/ubuntu-18.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/files/_mapdata/ubuntu-20.yaml b/test/integration/default/files/_mapdata/ubuntu-20.yaml index cc56582..700ee66 100644 --- a/test/integration/default/files/_mapdata/ubuntu-20.yaml +++ b/test/integration/default/files/_mapdata/ubuntu-20.yaml @@ -17,8 +17,8 @@ values: - Y:G@os_family - Y:G@os - Y:G@osfinger - - C@TEMPLATE:lookup - - C@TEMPLATE + - C@nsd:lookup + - C@nsd - Y:G@id master: template-master pkg: @@ -27,7 +27,7 @@ values: service: name: systemd-journald subcomponent: - config: /etc/TEMPLATE-subcomponent-formula.conf + config: /etc/nsd-subcomponent-formula.conf tofs: files_switch: - any/path/can/be/used/here @@ -37,8 +37,8 @@ values: - os - os_family source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - example.tmpl.jinja - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - subcomponent-example.tmpl.jinja winner: pillar diff --git a/test/integration/default/inspec.yml b/test/integration/default/inspec.yml index e9ccc54..9d3ecfb 100644 --- a/test/integration/default/inspec.yml +++ b/test/integration/default/inspec.yml @@ -2,11 +2,11 @@ # vim: ft=yaml --- name: default -title: TEMPLATE formula +title: nsd formula maintainer: SaltStack Formulas license: Apache-2.0 # yamllint disable-line rule:line-length -summary: Verify that the TEMPLATE formula is setup and configured correctly +summary: Verify that the nsd formula is setup and configured correctly depends: - name: share path: test/integration/share diff --git a/test/salt/pillar/gentoo.sls b/test/salt/pillar/gentoo.sls index bf2914a..356d6a9 100644 --- a/test/salt/pillar/gentoo.sls +++ b/test/salt/pillar/gentoo.sls @@ -3,7 +3,7 @@ --- portage: sync_wait_one_day: true -TEMPLATE: +nsd: pkg: name: 'app-shells/bash' service: diff --git a/test/salt/pillar/upstart.sls b/test/salt/pillar/upstart.sls index 7c5a4cf..d7530c7 100644 --- a/test/salt/pillar/upstart.sls +++ b/test/salt/pillar/upstart.sls @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=yaml --- -TEMPLATE: +nsd: lookup: master: template-master # Just for testing purposes @@ -45,9 +45,9 @@ TEMPLATE: # For testing purposes source_files: - TEMPLATE-config-file-file-managed: + nsd-config-file-file-managed: - 'example.tmpl.jinja' - TEMPLATE-subcomponent-config-file-file-managed: + nsd-subcomponent-config-file-file-managed: - 'subcomponent-example.tmpl.jinja' # Just for testing purposes