From cbabd4188c1200866ef7ac01e1ab57a58b8775bc Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20B=C3=A9rtoli?= Date: Wed, 15 Apr 2020 13:40:59 -0300 Subject: [PATCH] feat: convert `template-formula` to `arvados-formula` BREAKING CHANGE: changed all state names and ids --- .rubocop.yml | 5 +- .travis.yml | 13 - AUTHORS.md | 34 - CHANGELOG.md | 1104 ------------- FORMULA | 8 +- TEMPLATE/package/install.sls | 10 - {TEMPLATE => arvados}/clean.sls | 0 {TEMPLATE => arvados}/config/clean.sls | 6 +- {TEMPLATE => arvados}/config/file.sls | 12 +- {TEMPLATE => arvados}/config/init.sls | 0 {TEMPLATE => arvados}/defaults.yaml | 10 +- .../files/default/example.tmpl | 0 .../files/default/example.tmpl.jinja | 4 +- {TEMPLATE => arvados}/init.sls | 0 {TEMPLATE => arvados}/libsaltcli.jinja | 0 {TEMPLATE => arvados}/libtofs.jinja | 0 {TEMPLATE => arvados}/map.jinja | 6 +- {TEMPLATE => arvados}/osarchmap.yaml | 0 {TEMPLATE => arvados}/osfamilymap.yaml | 12 +- {TEMPLATE => arvados}/osfingermap.yaml | 6 +- {TEMPLATE => arvados}/osmap.yaml | 6 +- {TEMPLATE => arvados}/package/clean.sls | 6 +- {TEMPLATE => arvados}/package/init.sls | 0 arvados/package/install.sls | 10 + {TEMPLATE => arvados}/service/clean.sls | 6 +- {TEMPLATE => arvados}/service/init.sls | 0 {TEMPLATE => arvados}/service/running.sls | 6 +- {TEMPLATE => arvados}/subcomponent/clean.sls | 0 .../subcomponent/config/clean.sls | 6 +- .../subcomponent/config/file.sls | 10 +- .../files/default/subcomponent-example.tmpl | 0 .../default/subcomponent-example.tmpl.jinja | 0 .../subcomponent/config/init.sls | 0 {TEMPLATE => arvados}/subcomponent/init.sls | 0 bin/convert-formula.sh | 59 - docs/AUTHORS.rst | 92 -- docs/CHANGELOG.rst | 1395 ----------------- docs/CONTRIBUTING_DOCS.rst | 96 -- docs/README.rst | 94 +- docs/_static/css/custom.css | 21 - docs/conf.py | 173 -- docs/index.rst | 20 - kitchen.yml | 14 +- pillar.example | 10 +- .../default/controls/config_spec.rb | 6 +- .../default/controls/packages_spec.rb | 2 +- .../default/controls/services_spec.rb | 2 +- .../controls/subcomponent_config_spec.rb | 6 +- test/integration/default/inspec.yml | 4 +- test/salt/pillar/centos6.sls | 6 +- 50 files changed, 122 insertions(+), 3158 deletions(-) delete mode 100644 AUTHORS.md delete mode 100644 CHANGELOG.md delete mode 100644 TEMPLATE/package/install.sls rename {TEMPLATE => arvados}/clean.sls (100%) rename {TEMPLATE => arvados}/config/clean.sls (68%) rename {TEMPLATE => arvados}/config/file.sls (65%) rename {TEMPLATE => arvados}/config/init.sls (100%) rename {TEMPLATE => arvados}/defaults.yaml (57%) rename {TEMPLATE => arvados}/files/default/example.tmpl (100%) rename {TEMPLATE => arvados}/files/default/example.tmpl.jinja (82%) rename {TEMPLATE => arvados}/init.sls (100%) rename {TEMPLATE => arvados}/libsaltcli.jinja (100%) rename {TEMPLATE => arvados}/libtofs.jinja (100%) rename {TEMPLATE => arvados}/map.jinja (89%) rename {TEMPLATE => arvados}/osarchmap.yaml (100%) rename {TEMPLATE => arvados}/osfamilymap.yaml (79%) rename {TEMPLATE => arvados}/osfingermap.yaml (87%) rename {TEMPLATE => arvados}/osmap.yaml (87%) rename {TEMPLATE => arvados}/package/clean.sls (67%) rename {TEMPLATE => arvados}/package/init.sls (100%) create mode 100644 arvados/package/install.sls rename {TEMPLATE => arvados}/service/clean.sls (52%) rename {TEMPLATE => arvados}/service/init.sls (100%) rename {TEMPLATE => arvados}/service/running.sls (67%) rename {TEMPLATE => arvados}/subcomponent/clean.sls (100%) rename {TEMPLATE => arvados}/subcomponent/config/clean.sls (64%) rename {TEMPLATE => arvados}/subcomponent/config/file.sls (66%) rename {TEMPLATE => arvados}/subcomponent/config/files/default/subcomponent-example.tmpl (100%) rename {TEMPLATE => arvados}/subcomponent/config/files/default/subcomponent-example.tmpl.jinja (100%) rename {TEMPLATE => arvados}/subcomponent/config/init.sls (100%) rename {TEMPLATE => arvados}/subcomponent/init.sls (100%) delete mode 100755 bin/convert-formula.sh delete mode 100644 docs/AUTHORS.rst delete mode 100644 docs/CHANGELOG.rst delete mode 100644 docs/CONTRIBUTING_DOCS.rst delete mode 100644 docs/_static/css/custom.css delete mode 100644 docs/conf.py delete mode 100644 docs/index.rst diff --git a/.rubocop.yml b/.rubocop.yml index 3b6c0b8..7c701f5 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -8,7 +8,4 @@ Layout/LineLength: Max: 88 # Any offenses that should be fixed, e.g. collected via. `rubocop --auto-gen-config` -# + diff --git a/.travis.yml b/.travis.yml index 78b60d9..1c23398 100644 --- a/.travis.yml +++ b/.travis.yml @@ -105,19 +105,6 @@ jobs: # - env: INSTANCE=default-opensuse-leap-151-2018-3-py2 # - env: INSTANCE=default-amazonlinux-1-2018-3-py2 # - env: INSTANCE=default-arch-base-latest-2018-3-py2 - # ## Define the release stage that runs `semantic-release` - stage: 'release' diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index 68b9353..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)|255 -@aboe76|[@aboe76](https://github.com/aboe76)|27 -@javierbertoli|[@javierbertoli](https://github.com/javierbertoli)|18 -@noelmcloughlin|[@noelmcloughlin](https://github.com/noelmcloughlin)|11 -@dafyddj|[@dafyddj](https://github.com/dafyddj)|10 -@n-rodriguez|[@n-rodriguez](https://github.com/n-rodriguez)|8 -@daks|[@daks](https://github.com/daks)|7 -@gravyboat|[@gravyboat](https://github.com/gravyboat)|6 -@alxwr|[@alxwr](https://github.com/alxwr)|5 -@baby-gnu|[@baby-gnu](https://github.com/baby-gnu)|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 2020-04-07. diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 5147d53..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,1104 +0,0 @@ -# Changelog - -## [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/FORMULA b/FORMULA index f97022c..91a416c 100644 --- a/FORMULA +++ b/FORMULA @@ -1,9 +1,9 @@ -name: TEMPLATE +name: arvados os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Amazon, 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: 4.0.6 +version: 1.0.0 release: 1 minimum_version: 2017.7 -summary: TEMPLATE formula +summary: arvados formula description: Formula to use as a template for other formulas -top_level_dir: TEMPLATE +top_level_dir: arvados diff --git a/TEMPLATE/package/install.sls b/TEMPLATE/package/install.sls deleted file mode 100644 index 4533b4c..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 TEMPLATE with context %} - -TEMPLATE-package-install-pkg-installed: - pkg.installed: - - name: {{ TEMPLATE.pkg.name }} diff --git a/TEMPLATE/clean.sls b/arvados/clean.sls similarity index 100% rename from TEMPLATE/clean.sls rename to arvados/clean.sls diff --git a/TEMPLATE/config/clean.sls b/arvados/config/clean.sls similarity index 68% rename from TEMPLATE/config/clean.sls rename to arvados/config/clean.sls index 330029e..9ed5b8a 100644 --- a/TEMPLATE/config/clean.sls +++ b/arvados/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 TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import arvados with context %} include: - {{ sls_service_clean }} -TEMPLATE-config-clean-file-absent: +arvados-config-clean-file-absent: file.absent: - - name: {{ TEMPLATE.config }} + - name: {{ arvados.config }} - require: - sls: {{ sls_service_clean }} diff --git a/TEMPLATE/config/file.sls b/arvados/config/file.sls similarity index 65% rename from TEMPLATE/config/file.sls rename to arvados/config/file.sls index 985c1c8..463d5b3 100644 --- a/TEMPLATE/config/file.sls +++ b/arvados/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 TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import arvados with context %} {%- from tplroot ~ "/libtofs.jinja" import files_switch with context %} include: - {{ sls_package_install }} -TEMPLATE-config-file-file-managed: +arvados-config-file-file-managed: file.managed: - - name: {{ TEMPLATE.config }} + - name: {{ arvados.config }} - source: {{ files_switch(['example.tmpl'], - lookup='TEMPLATE-config-file-file-managed' + lookup='arvados-config-file-file-managed' ) }} - mode: 644 - user: root - - group: {{ TEMPLATE.rootgroup }} + - group: {{ arvados.rootgroup }} - makedirs: True - template: jinja - require: - sls: {{ sls_package_install }} - context: - TEMPLATE: {{ TEMPLATE | json }} + arvados: {{ arvados | json }} diff --git a/TEMPLATE/config/init.sls b/arvados/config/init.sls similarity index 100% rename from TEMPLATE/config/init.sls rename to arvados/config/init.sls diff --git a/TEMPLATE/defaults.yaml b/arvados/defaults.yaml similarity index 57% rename from TEMPLATE/defaults.yaml rename to arvados/defaults.yaml index a5c495e..03e860c 100644 --- a/TEMPLATE/defaults.yaml +++ b/arvados/defaults.yaml @@ -1,15 +1,15 @@ # -*- coding: utf-8 -*- # vim: ft=yaml --- -TEMPLATE: +arvados: pkg: - name: TEMPLATE + name: arvados rootgroup: root - config: '/etc/TEMPLATE' + config: '/etc/arvados' service: - name: TEMPLATE + name: arvados subcomponent: - config: '/etc/TEMPLATE-subcomponent-formula.conf' + config: '/etc/arvados-subcomponent-formula.conf' # Just here for testing added_in_defaults: defaults_value winner: defaults diff --git a/TEMPLATE/files/default/example.tmpl b/arvados/files/default/example.tmpl similarity index 100% rename from TEMPLATE/files/default/example.tmpl rename to arvados/files/default/example.tmpl diff --git a/TEMPLATE/files/default/example.tmpl.jinja b/arvados/files/default/example.tmpl.jinja similarity index 82% rename from TEMPLATE/files/default/example.tmpl.jinja rename to arvados/files/default/example.tmpl.jinja index b8999ab..a071658 100644 --- a/TEMPLATE/files/default/example.tmpl.jinja +++ b/arvados/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 }} +{{ arvados | json }} -winner of the merge: {{ TEMPLATE['winner'] }} +winner of the merge: {{ arvados['winner'] }} diff --git a/TEMPLATE/init.sls b/arvados/init.sls similarity index 100% rename from TEMPLATE/init.sls rename to arvados/init.sls diff --git a/TEMPLATE/libsaltcli.jinja b/arvados/libsaltcli.jinja similarity index 100% rename from TEMPLATE/libsaltcli.jinja rename to arvados/libsaltcli.jinja diff --git a/TEMPLATE/libtofs.jinja b/arvados/libtofs.jinja similarity index 100% rename from TEMPLATE/libtofs.jinja rename to arvados/libtofs.jinja diff --git a/TEMPLATE/map.jinja b/arvados/map.jinja similarity index 89% rename from TEMPLATE/map.jinja rename to arvados/map.jinja index 1b8b1c6..1479309 100644 --- a/TEMPLATE/map.jinja +++ b/arvados/map.jinja @@ -46,11 +46,11 @@ ) %} -{#- Change **TEMPLATE** to match with your formula's name and then remove this line #} -{%- set TEMPLATE = config %} +{#- Change **arvados** to match with your formula's name and then remove this line #} +{%- set arvados = config %} {#- Post-processing for specific non-YAML customisations #} {%- if grains.os == 'MacOS' %} {%- set macos_group = salt['cmd.run']("stat -f '%Sg' /dev/console") %} -{%- do TEMPLATE.update({'rootgroup': macos_group}) %} +{%- do arvados.update({'rootgroup': macos_group}) %} {%- endif %} diff --git a/TEMPLATE/osarchmap.yaml b/arvados/osarchmap.yaml similarity index 100% rename from TEMPLATE/osarchmap.yaml rename to arvados/osarchmap.yaml diff --git a/TEMPLATE/osfamilymap.yaml b/arvados/osfamilymap.yaml similarity index 79% rename from TEMPLATE/osfamilymap.yaml rename to arvados/osfamilymap.yaml index 6b473a8..15cbd65 100644 --- a/TEMPLATE/osfamilymap.yaml +++ b/arvados/osfamilymap.yaml @@ -12,23 +12,23 @@ --- Debian: pkg: - name: TEMPLATE-debian - config: /etc/TEMPLATE.d/custom.conf + name: arvados-debian + config: /etc/arvados.d/custom.conf RedHat: pkg: - name: TEMPLATE-redhat - config: /etc/TEMPLATE.conf + name: arvados-redhat + config: /etc/arvados.conf Suse: pkg: - name: TEMPLATE-suse + name: arvados-suse Gentoo: {} Arch: pkg: - name: TEMPLATE-arch + name: arvados-arch service: name: service-arch diff --git a/TEMPLATE/osfingermap.yaml b/arvados/osfingermap.yaml similarity index 87% rename from TEMPLATE/osfingermap.yaml rename to arvados/osfingermap.yaml index 7bd9ba7..7cb3793 100644 --- a/TEMPLATE/osfingermap.yaml +++ b/arvados/osfingermap.yaml @@ -17,7 +17,7 @@ Debian-8: {} # os: Ubuntu Ubuntu-18.04: - config: /etc/TEMPLATE.d/custom-ubuntu-18.04.conf + config: /etc/arvados.d/custom-ubuntu-18.04.conf Ubuntu-16.04: {} # os: Fedora @@ -29,8 +29,8 @@ CentOS Linux-8: {} CentOS Linux-7: {} CentOS-6: pkg: - name: TEMPLATE-centos-6 - config: /etc/TEMPLATE.d/custom-centos-6.conf + name: arvados-centos-6 + config: /etc/arvados.d/custom-centos-6.conf # os: Amazon Amazon Linux-2: {} diff --git a/TEMPLATE/osmap.yaml b/arvados/osmap.yaml similarity index 87% rename from TEMPLATE/osmap.yaml rename to arvados/osmap.yaml index 9e2d89e..334eace 100644 --- a/TEMPLATE/osmap.yaml +++ b/arvados/osmap.yaml @@ -13,14 +13,14 @@ # os_family: Debian Ubuntu: pkg: - name: TEMPLATE-ubuntu - config: /etc/TEMPLATE.d/custom-ubuntu.conf + name: arvados-ubuntu + config: /etc/arvados.d/custom-ubuntu.conf Raspbian: {} # os_family: RedHat Fedora: pkg: - name: TEMPLATE-fedora + name: arvados-fedora service: name: service-fedora CentOS: {} diff --git a/TEMPLATE/package/clean.sls b/arvados/package/clean.sls similarity index 67% rename from TEMPLATE/package/clean.sls rename to arvados/package/clean.sls index 50b7718..446459b 100644 --- a/TEMPLATE/package/clean.sls +++ b/arvados/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 TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import arvados with context %} include: - {{ sls_config_clean }} -TEMPLATE-package-clean-pkg-removed: +arvados-package-clean-pkg-removed: pkg.removed: - - name: {{ TEMPLATE.pkg.name }} + - name: {{ arvados.pkg.name }} - require: - sls: {{ sls_config_clean }} diff --git a/TEMPLATE/package/init.sls b/arvados/package/init.sls similarity index 100% rename from TEMPLATE/package/init.sls rename to arvados/package/init.sls diff --git a/arvados/package/install.sls b/arvados/package/install.sls new file mode 100644 index 0000000..219ba17 --- /dev/null +++ b/arvados/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 arvados with context %} + +arvados-package-install-pkg-installed: + pkg.installed: + - name: {{ arvados.pkg.name }} diff --git a/TEMPLATE/service/clean.sls b/arvados/service/clean.sls similarity index 52% rename from TEMPLATE/service/clean.sls rename to arvados/service/clean.sls index 197aca6..7dbaf1b 100644 --- a/TEMPLATE/service/clean.sls +++ b/arvados/service/clean.sls @@ -3,9 +3,9 @@ {#- Get the `tplroot` from `tpldir` #} {%- set tplroot = tpldir.split('/')[0] %} -{%- from tplroot ~ "/map.jinja" import TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import arvados with context %} -TEMPLATE-service-clean-service-dead: +arvados-service-clean-service-dead: service.dead: - - name: {{ TEMPLATE.service.name }} + - name: {{ arvados.service.name }} - enable: False diff --git a/TEMPLATE/service/init.sls b/arvados/service/init.sls similarity index 100% rename from TEMPLATE/service/init.sls rename to arvados/service/init.sls diff --git a/TEMPLATE/service/running.sls b/arvados/service/running.sls similarity index 67% rename from TEMPLATE/service/running.sls rename to arvados/service/running.sls index fb3a3ab..f8dab85 100644 --- a/TEMPLATE/service/running.sls +++ b/arvados/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 TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import arvados with context %} include: - {{ sls_config_file }} -TEMPLATE-service-running-service-running: +arvados-service-running-service-running: service.running: - - name: {{ TEMPLATE.service.name }} + - name: {{ arvados.service.name }} - enable: True - watch: - sls: {{ sls_config_file }} diff --git a/TEMPLATE/subcomponent/clean.sls b/arvados/subcomponent/clean.sls similarity index 100% rename from TEMPLATE/subcomponent/clean.sls rename to arvados/subcomponent/clean.sls diff --git a/TEMPLATE/subcomponent/config/clean.sls b/arvados/subcomponent/config/clean.sls similarity index 64% rename from TEMPLATE/subcomponent/config/clean.sls rename to arvados/subcomponent/config/clean.sls index e469804..f108180 100644 --- a/TEMPLATE/subcomponent/config/clean.sls +++ b/arvados/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 TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import arvados with context %} include: - {{ sls_service_clean }} -TEMPLATE-subcomponent-config-clean-file-absent: +arvados-subcomponent-config-clean-file-absent: file.absent: - - name: {{ TEMPLATE.subcomponent.config }} + - name: {{ arvados.subcomponent.config }} - watch_in: - sls: {{ sls_service_clean }} diff --git a/TEMPLATE/subcomponent/config/file.sls b/arvados/subcomponent/config/file.sls similarity index 66% rename from TEMPLATE/subcomponent/config/file.sls rename to arvados/subcomponent/config/file.sls index 75b415a..251d859 100644 --- a/TEMPLATE/subcomponent/config/file.sls +++ b/arvados/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 TEMPLATE with context %} +{%- from tplroot ~ "/map.jinja" import arvados with context %} {%- from tplroot ~ "/libtofs.jinja" import files_switch with context %} include: - {{ sls_config_file }} -TEMPLATE-subcomponent-config-file-file-managed: +arvados-subcomponent-config-file-file-managed: file.managed: - - name: {{ TEMPLATE.subcomponent.config }} + - name: {{ arvados.subcomponent.config }} - source: {{ files_switch(['subcomponent-example.tmpl'], - lookup='TEMPLATE-subcomponent-config-file-file-managed', + lookup='arvados-subcomponent-config-file-file-managed', use_subpath=True ) }} - mode: 644 - user: root - - group: {{ TEMPLATE.rootgroup }} + - group: {{ arvados.rootgroup }} - makedirs: True - template: jinja - require_in: diff --git a/TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl b/arvados/subcomponent/config/files/default/subcomponent-example.tmpl similarity index 100% rename from TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl rename to arvados/subcomponent/config/files/default/subcomponent-example.tmpl diff --git a/TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl.jinja b/arvados/subcomponent/config/files/default/subcomponent-example.tmpl.jinja similarity index 100% rename from TEMPLATE/subcomponent/config/files/default/subcomponent-example.tmpl.jinja rename to arvados/subcomponent/config/files/default/subcomponent-example.tmpl.jinja diff --git a/TEMPLATE/subcomponent/config/init.sls b/arvados/subcomponent/config/init.sls similarity index 100% rename from TEMPLATE/subcomponent/config/init.sls rename to arvados/subcomponent/config/init.sls diff --git a/TEMPLATE/subcomponent/init.sls b/arvados/subcomponent/init.sls similarity index 100% rename from TEMPLATE/subcomponent/init.sls rename to arvados/subcomponent/init.sls diff --git a/bin/convert-formula.sh b/bin/convert-formula.sh deleted file mode 100755 index 03d3710..0000000 --- a/bin/convert-formula.sh +++ /dev/null @@ -1,59 +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 and numbers only." 1>&2 - echo " should not be any of 'bin' 'docs' 'test'." 1>&2 -} - -args() { - if [ $# -ne 1 ]; then - usage - exit 1 - fi - NEW_NAME=$1 - 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 - git mv TEMPLATE "${NEW_NAME}" - grep --recursive --files-with-matches --exclude-dir=.git TEMPLATE . \ - | xargs -L 1 ex -u NONE -sc '%s/TEMPLATE/'"${NEW_NAME}"'/g|x' - # Searching across multiple lines. - # See https://vim.fandom.com/wiki/Search_across_multiple_lines - ex -u NONE -sc '%s/^.. /None/g|x' docs/README.rst - ex -u NONE -sc '%s/^\s*# \n//g|x' .travis.yml - ex -u NONE -sc '%s/^\s*# \n//g|x' .rubocop.yml - ex -u NONE -sc '%s/^\(version:\).*/\1 1.0.0/g|x' FORMULA - # shellcheck disable=SC2016 # Expressions don't expand in single quotes - git commit --quiet --all \ - --message 'feat: convert `template-formula` to `'"${NEW_NAME}"'-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 42d9833..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 `_ - - 255 - * - :raw-html-m2r:`@aboe76` - - `@aboe76 `_ - - 27 - * - :raw-html-m2r:`@javierbertoli` - - `@javierbertoli `_ - - 18 - * - :raw-html-m2r:`@noelmcloughlin` - - `@noelmcloughlin `_ - - 11 - * - :raw-html-m2r:`@dafyddj` - - `@dafyddj `_ - - 10 - * - :raw-html-m2r:`@n-rodriguez` - - `@n-rodriguez `_ - - 8 - * - :raw-html-m2r:`@daks` - - `@daks `_ - - 7 - * - :raw-html-m2r:`@gravyboat` - - `@gravyboat `_ - - 6 - * - :raw-html-m2r:`@alxwr` - - `@alxwr `_ - - 5 - * - :raw-html-m2r:`@baby-gnu` - - `@baby-gnu `_ - - 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 2020-04-07. diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst deleted file mode 100644 index 1379e48..0000000 --- a/docs/CHANGELOG.rst +++ /dev/null @@ -1,1395 +0,0 @@ - -Changelog -========= - -`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 55673df..0000000 --- a/docs/CONTRIBUTING_DOCS.rst +++ /dev/null @@ -1,96 +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 7e252f8..0d5918a 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,14 +1,14 @@ .. _readme: -TEMPLATE-formula +arvados-formula ================ |img_travis| |img_sr| -.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/TEMPLATE-formula.svg?branch=master +.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/arvados-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/arvados-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% @@ -45,33 +45,7 @@ Please see `How to contribute -formula``, where ```` consists of lower-case alphabetic characters and numbers. - -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. - -.. REMOVEME> +None Available states ---------------- @@ -79,79 +53,79 @@ Available states .. contents:: :local: -``TEMPLATE`` +``arvados`` ^^^^^^^^^^^^ *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 arvados package, +manages the arvados configuration file and then +starts the associated arvados service. -``TEMPLATE.package`` +``arvados.package`` ^^^^^^^^^^^^^^^^^^^^ -This state will install the TEMPLATE package only. +This state will install the arvados package only. -``TEMPLATE.config`` +``arvados.config`` ^^^^^^^^^^^^^^^^^^^ -This state will configure the TEMPLATE service and has a dependency on ``TEMPLATE.install`` +This state will configure the arvados service and has a dependency on ``arvados.install`` via include list. -``TEMPLATE.service`` +``arvados.service`` ^^^^^^^^^^^^^^^^^^^^ -This state will start the TEMPLATE service and has a dependency on ``TEMPLATE.config`` +This state will start the arvados service and has a dependency on ``arvados.config`` via include list. -``TEMPLATE.clean`` +``arvados.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 ``arvados`` meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package. -``TEMPLATE.service.clean`` +``arvados.service.clean`` ^^^^^^^^^^^^^^^^^^^^^^^^^^ -This state will stop the TEMPLATE service and disable it at boot time. +This state will stop the arvados service and disable it at boot time. -``TEMPLATE.config.clean`` +``arvados.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 arvados service and has a +dependency on ``arvados.service.clean`` via include list. -``TEMPLATE.package.clean`` +``arvados.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 arvados package and has a depency on +``arvados.config.clean`` via include list. -``TEMPLATE.subcomponent`` +``arvados.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 arvados service. -``TEMPLATE.subcomponent.config`` +``arvados.subcomponent.config`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This state will configure the TEMPLATE subcomponent and has a -dependency on ``TEMPLATE.config`` via include list. +This state will configure the arvados subcomponent and has a +dependency on ``arvados.config`` via include list. -``TEMPLATE.subcomponent.config.clean`` +``arvados.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 arvados subcomponent +and reload the arvados service by a dependency on +``arvados.service.running`` via include list and ``watch_in`` requisite. Testing @@ -177,7 +151,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 ``arvados`` 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 4617efc..0000000 --- a/docs/_static/css/custom.css +++ /dev/null @@ -1,21 +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/kitchen.yml b/kitchen.yml index 08950d5..cca69c4 100644 --- a/kitchen.yml +++ b/kitchen.yml @@ -159,7 +159,7 @@ provisioner: log_level: debug salt_install: none require_chef: false - formula: TEMPLATE + formula: arvados salt_copy_filter: - .kitchen - .git @@ -180,15 +180,15 @@ suites: state_top: base: '*': - - TEMPLATE + - arvados pillars: top.sls: base: '*': - - TEMPLATE + - arvados - define_roles pillars_from_files: - TEMPLATE.sls: pillar.example + arvados.sls: pillar.example define_roles.sls: test/salt/pillar/define_roles.sls verifier: inspec_tests: @@ -200,15 +200,15 @@ suites: state_top: base: '*': - - TEMPLATE + - arvados pillars: top.sls: base: '*': - - TEMPLATE + - arvados - define_roles pillars_from_files: - TEMPLATE.sls: test/salt/pillar/centos6.sls + arvados.sls: test/salt/pillar/centos6.sls define_roles.sls: test/salt/pillar/define_roles.sls verifier: inspec_tests: diff --git a/pillar.example b/pillar.example index 995d8f7..96f3b5f 100644 --- a/pillar.example +++ b/pillar.example @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=yaml --- -TEMPLATE: +arvados: 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://arvados/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: + # arvados-config-file-file-managed: # - 'example_alt.tmpl' # - 'example_alt.tmpl.jinja' # For testing purposes source_files: - TEMPLATE-config-file-file-managed: + arvados-config-file-file-managed: - 'example.tmpl.jinja' - TEMPLATE-subcomponent-config-file-file-managed: + arvados-subcomponent-config-file-file-managed: - 'subcomponent-example.tmpl.jinja' # Just for testing purposes diff --git a/test/integration/default/controls/config_spec.rb b/test/integration/default/controls/config_spec.rb index 68b5b4b..7d0a8ce 100644 --- a/test/integration/default/controls/config_spec.rb +++ b/test/integration/default/controls/config_spec.rb @@ -1,6 +1,6 @@ # frozen_string_literal: true -control 'TEMPLATE configuration' do +control 'arvados configuration' do title 'should match desired lines' describe file('/etc/template-formula.conf') do @@ -24,8 +24,8 @@ control 'TEMPLATE configuration' 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": '\ + '{"arvados-config-file-file-managed": ["example.tmpl.jinja"], '\ + '"arvados-subcomponent-config-file-file-managed": '\ '["subcomponent-example.tmpl.jinja"]}' ) end diff --git a/test/integration/default/controls/packages_spec.rb b/test/integration/default/controls/packages_spec.rb index cc06d4e..aacd274 100644 --- a/test/integration/default/controls/packages_spec.rb +++ b/test/integration/default/controls/packages_spec.rb @@ -4,7 +4,7 @@ package_name = 'bash' package_name = 'cronie' if (os[:name] == 'centos') && os[:release].start_with?('6') -control 'TEMPLATE package' do +control 'arvados package' do title 'should be installed' describe package(package_name) do diff --git a/test/integration/default/controls/services_spec.rb b/test/integration/default/controls/services_spec.rb index 5d11276..58347b6 100644 --- a/test/integration/default/controls/services_spec.rb +++ b/test/integration/default/controls/services_spec.rb @@ -4,7 +4,7 @@ service_name = 'systemd-journald' service_name = 'crond' if (os[:name] == 'centos') && os[:release].start_with?('6') -control 'TEMPLATE service' do +control 'arvados service' do impact 0.5 title 'should be running and enabled' diff --git a/test/integration/default/controls/subcomponent_config_spec.rb b/test/integration/default/controls/subcomponent_config_spec.rb index f9c9108..edaab02 100644 --- a/test/integration/default/controls/subcomponent_config_spec.rb +++ b/test/integration/default/controls/subcomponent_config_spec.rb @@ -1,9 +1,9 @@ # frozen_string_literal: true -control 'TEMPLATE subcomponent configuration' do +control 'arvados subcomponent configuration' do title 'should match desired lines' - describe file('/etc/TEMPLATE-subcomponent-formula.conf') do + describe file('/etc/arvados-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 configuration' do its('content') do should include( '# File managed by Salt at '\ - '.' ) end diff --git a/test/integration/default/inspec.yml b/test/integration/default/inspec.yml index bf5b021..5fe9a8f 100644 --- a/test/integration/default/inspec.yml +++ b/test/integration/default/inspec.yml @@ -2,10 +2,10 @@ # vim: ft=yaml --- name: default -title: TEMPLATE formula +title: arvados formula maintainer: SaltStack Formulas license: Apache-2.0 -summary: Verify that the TEMPLATE formula is setup and configured correctly +summary: Verify that the arvados formula is setup and configured correctly supports: - platform-name: debian - platform-name: ubuntu diff --git a/test/salt/pillar/centos6.sls b/test/salt/pillar/centos6.sls index 7c5a4cf..4462955 100644 --- a/test/salt/pillar/centos6.sls +++ b/test/salt/pillar/centos6.sls @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # vim: ft=yaml --- -TEMPLATE: +arvados: lookup: master: template-master # Just for testing purposes @@ -45,9 +45,9 @@ TEMPLATE: # For testing purposes source_files: - TEMPLATE-config-file-file-managed: + arvados-config-file-file-managed: - 'example.tmpl.jinja' - TEMPLATE-subcomponent-config-file-file-managed: + arvados-subcomponent-config-file-file-managed: - 'subcomponent-example.tmpl.jinja' # Just for testing purposes -- 2.30.2