From 4d9e571bc349d6975e9aff30e9bca6fab510a49a Mon Sep 17 00:00:00 2001 From: N Date: Sat, 29 Jun 2019 00:04:55 +0100 Subject: [PATCH] feat(template): migrate to template-formula v3.0.0 --- .gitignore | 113 +++++ .travis.yml | 88 ++++ AUTHORS.md | 12 + CHANGELOG.md | 0 FORMULA | 9 + Gemfile | 6 + LICENSE | 2 +- README.rst | 116 ----- bin/kitchen | 29 ++ commitlint.config.js | 3 + deepsea/clean.sls | 8 + deepsea/config.sls | 12 - deepsea/config/clean.sls | 21 + deepsea/config/environ.sls | 29 ++ deepsea/config/init.sls | 5 + deepsea/defaults.yaml | 75 +-- deepsea/files/default/environ.sh.jinja | 6 + deepsea/init.sls | 10 +- deepsea/install.sls | 82 ---- deepsea/jinja/macros.jinja | 12 + deepsea/libtofs.jinja | 100 ++++ deepsea/map.jinja | 49 +- deepsea/osfamilymap.yaml | 79 ++-- deepsea/package/clean.sls | 27 ++ deepsea/package/init.sls | 5 + deepsea/package/install.sls | 23 + deepsea/package/repo/clean.sls | 10 + deepsea/package/repo/init.sls | 5 + deepsea/package/repo/install.sls | 15 + deepsea/remove.sls | 14 - deepsea/service.sls | 17 - deepsea/service/clean.sls | 5 + deepsea/service/dead.sls | 16 + deepsea/service/init.sls | 6 + deepsea/service/running.sls | 17 + deepsea/source/clean.sls | 21 + deepsea/source/init.sls | 5 + deepsea/source/install.sls | 52 ++ docs/CONTRIBUTING.rst | 155 ++++++ docs/README.rst | 165 +++++++ docs/TOFS_pattern.rst | 443 ++++++++++++++++++ kitchen.yml | 141 ++++++ pillar.example | 63 ++- pre-commit_semantic-release.sh | 30 ++ release-rules.js | 18 + release.config.js | 106 +++++ test/integration/default/README.md | 50 ++ .../default/controls/environ_spec.rb | 12 + .../default/controls/services_spec.rb | 14 + test/integration/default/inspec.yml | 12 + 50 files changed, 1966 insertions(+), 347 deletions(-) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 AUTHORS.md create mode 100644 CHANGELOG.md create mode 100644 FORMULA create mode 100644 Gemfile delete mode 100644 README.rst create mode 100755 bin/kitchen create mode 100644 commitlint.config.js create mode 100644 deepsea/clean.sls delete mode 100644 deepsea/config.sls create mode 100644 deepsea/config/clean.sls create mode 100644 deepsea/config/environ.sls create mode 100644 deepsea/config/init.sls create mode 100644 deepsea/files/default/environ.sh.jinja delete mode 100644 deepsea/install.sls create mode 100644 deepsea/jinja/macros.jinja create mode 100644 deepsea/libtofs.jinja create mode 100644 deepsea/package/clean.sls create mode 100644 deepsea/package/init.sls create mode 100644 deepsea/package/install.sls create mode 100644 deepsea/package/repo/clean.sls create mode 100644 deepsea/package/repo/init.sls create mode 100644 deepsea/package/repo/install.sls delete mode 100644 deepsea/remove.sls delete mode 100644 deepsea/service.sls create mode 100644 deepsea/service/clean.sls create mode 100644 deepsea/service/dead.sls create mode 100644 deepsea/service/init.sls create mode 100644 deepsea/service/running.sls create mode 100644 deepsea/source/clean.sls create mode 100644 deepsea/source/init.sls create mode 100644 deepsea/source/install.sls create mode 100644 docs/CONTRIBUTING.rst create mode 100644 docs/README.rst create mode 100644 docs/TOFS_pattern.rst create mode 100644 kitchen.yml create mode 100755 pre-commit_semantic-release.sh create mode 100644 release-rules.js create mode 100644 release.config.js create mode 100644 test/integration/default/README.md create mode 100644 test/integration/default/controls/environ_spec.rb create mode 100644 test/integration/default/controls/services_spec.rb create mode 100644 test/integration/default/inspec.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ba07ed8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,113 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a packager +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.kitchen +.kitchen.local.yml +kitchen.local.yml + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# dotenv +.env + +# virtualenv +.venv +venv/ +ENV/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +# Bundler +Gemfile.lock + +# copied `.md` files used for conversion to `.rst` using `m2r` +docs/*.md + +# Vim +*.sw? diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..476d64e --- /dev/null +++ b/.travis.yml @@ -0,0 +1,88 @@ +stages: + - test + - commitlint + - name: release + if: branch = master AND type != pull_request + +sudo: required +cache: bundler +language: ruby + +services: + - docker + +# Make sure the instances listed below match up with +# the `platforms` defined in `kitchen.yml` +# NOTE: Please try to select up to six instances that add some meaningful +# testing of the formula's behaviour. If possible, try to refrain from +# the classical "chosing all the instances because I want to test on +# another/all distro/s" trap: it will just add time to the testing (see +# the discussion on #121). As an example, the set chosen below covers +# the most used distros families, systemd and non-systemd and the latest +# three supported Saltstack versions with python2 and 3." +# As for `kitchen.yml`, that should still contain all of the platforms, +# to allow for comprehensive local testing +# Ref: https://github.com/saltstack-formulas/template-formula/issues/118 +# Ref: https://github.com/saltstack-formulas/template-formula/issues/121 +env: + matrix: + - INSTANCE: default-debian-9-develop-py3 + # - INSTANCE: default-ubuntu-1804-develop-py3 + # - INSTANCE: default-centos-7-develop-py3 + # - INSTANCE: default-fedora-29-develop-py3 + # - INSTANCE: default-opensuse-leap-15-develop-py3 + # - INSTANCE: default-debian-9-2019-2-py3 + - INSTANCE: default-ubuntu-1804-2019-2-py3 + - INSTANCE: default-centos-7-2019-2-py3 + # - INSTANCE: default-fedora-29-2019-2-py3 + # - INSTANCE: default-opensuse-leap-15-2019-2-py3 + # - INSTANCE: default-debian-9-2018-3-py2 + # - INSTANCE: default-ubuntu-1604-2018-3-py2 + # - INSTANCE: default-centos-7-2018-3-py2 + - INSTANCE: default-fedora-29-2018-3-py2 + # TODO: Use this when fixed instead of `opensuse-leap-42` + # Ref: https://github.com/netmanagers/salt-image-builder/issues/2 + # - INSTANCE: default-opensuse-leap-15-2018-3-py2 + - INSTANCE: default-opensuse-leap-42-2018-3-py2 + # - INSTANCE: default-debian-8-2017-7-py2 + # - INSTANCE: default-ubuntu-1604-2017-7-py2 + # TODO: Enable after improving the formula to work with other than `systemd` + - INSTANCE: default-centos-6-2017-7-py2 + # - INSTANCE: default-fedora-28-2017-7-py2 + # - INSTANCE: default-opensuse-leap-42-2017-7-py2 + +script: + - bundle exec kitchen verify ${INSTANCE} + +jobs: + include: + # Define the commitlint stage + - stage: commitlint + language: node_js + node_js: lts/* + before_install: skip + script: + - npm install @commitlint/config-conventional -D + - npm install @commitlint/travis-cli -D + - commitlint-travis + # Define the release stage that runs semantic-release + - stage: release + language: node_js + node_js: lts/* + before_install: skip + script: + # Update `AUTHORS.md` + - export MAINTAINER_TOKEN=${GH_TOKEN} + - go get github.com/myii/maintainer + - maintainer contributor + + # Install all dependencies required for `semantic-release` + - npm install @semantic-release/changelog@3 -D + - npm install @semantic-release/exec@3 -D + - npm install @semantic-release/git@7 -D + deploy: + provider: script + skip_cleanup: true + script: + # Run `semantic-release` + - npx semantic-release@15 diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..7526d62 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,12 @@ +# Authors + +This list is sorted by the number of commits per contributor in _descending_ order. + +Avatar|Contributor|Contributions +:-:|---|:-: +@noelmcloughlin|[@noelmcloughlin](https://github.com/noelmcloughlin)|2 +@alxwr|[@alxwr](https://github.com/alxwr)|1 + +--- + +Auto-generated by a [forked version](https://github.com/myii/maintainer) of [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-06-05. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e69de29 diff --git a/FORMULA b/FORMULA new file mode 100644 index 0000000..4df8cbd --- /dev/null +++ b/FORMULA @@ -0,0 +1,9 @@ +name: deepsea +os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, SmartOS +os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD +version: 1.0.0 +release: 1 +minimum_version: 2016.11 +summary: deepsea formula +description: Formula to download and install/remove deepsea software. +top_level_dir: deepsea diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..3b36de3 --- /dev/null +++ b/Gemfile @@ -0,0 +1,6 @@ +source "https://rubygems.org" + +gem 'kitchen-docker', '>= 2.9' +gem 'kitchen-salt', '>= 0.6.0' +gem 'kitchen-inspec', '>= 1.1' + diff --git a/LICENSE b/LICENSE index d919c41..57caf8d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ - Copyright (c) 2013-2015 Salt Stack Formulas + Copyright (c) 2019 Salt Stack Formulas Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.rst b/README.rst deleted file mode 100644 index f11727c..0000000 --- a/README.rst +++ /dev/null @@ -1,116 +0,0 @@ -======== -deepsea -======== - -Salt formula to deploy DeepSea (software defined storage) framework on GNU Linux. - -.. note:: - - See the full `Salt Formulas installation and usage instructions - `_. - -Available states -================ - -.. contents:: - :local: - -``deepsea`` ------------- - -Meta-state runs all other states (except remove). - -Afterwards, consult official DeepSea documentation at and - -``deepsea.install`` -------------------- - -Install DeepSea software on GNU Linux. Support git repo (default) or package repo (suse only). Includes the `config` and `service` states. - -``deepsea.config`` ------------------ - -Deepsea DEV_ENV=[true|false] support. - -``deepsea.services`` ------------------ - -Enable services needed by DeepSea, and disable services incompatible with DeepSea. - -``deepsea.remove`` ------------------ - -Basic remove state (suse only) - - - -Testing -================ - -DeepSea deployment verification on GNU Linux: Ubuntu, Centos, and Fedora with python2. - -TODO: DeepSea runtime verification (ensure deepsea commands work). - - -Integration with other formulae -=============================== - -The following formulae pillars support DeepSea- - -`firewalld-formula `_ - -.. code-block:: yaml - - extends: - firewalld: - services: - deepsea-formula: - short: deepsea - description: DeepSea firewall rules - ports: - tcp: - - 4505 - - 4506 - udp: - - 4505 - - 4506 - zones: - public: - services: - - deepsea - - -`packages-formula - `_ - -.. code-block:: bash - - extends: - packages: - pips: - wanted: - - tox - - click - pkgs: - unwanted: - - unattended-upgrades {# recommendation #} - wanted: - - python-setuptools - - salt-api - - git - - make - {% if grains.os_family == 'FreeBSD' %} - - devel/py-pip - {% elif grains.os_family == 'Debian' %} - - python-pip - {% elif grains.os_family == 'RedHat' %} - - python2-pip - - python-click - - python-tox - {% elif grains.os_family == 'Suse' %} - - python-pip - {% elif grains.os_family == 'Arch' %} - - python2-pip - {% endif %} - - diff --git a/bin/kitchen b/bin/kitchen new file mode 100755 index 0000000..1cd44f3 --- /dev/null +++ b/bin/kitchen @@ -0,0 +1,29 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'kitchen' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +require "pathname" +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", + Pathname.new(__FILE__).realpath) + +bundle_binstub = File.expand_path("../bundle", __FILE__) + +if File.file?(bundle_binstub) + if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/ + load(bundle_binstub) + else + abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run. +Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.") + end +end + +require "rubygems" +require "bundler/setup" + +load Gem.bin_path("test-kitchen", "kitchen") diff --git a/commitlint.config.js b/commitlint.config.js new file mode 100644 index 0000000..2f9d1aa --- /dev/null +++ b/commitlint.config.js @@ -0,0 +1,3 @@ +module.exports = { + extends: ['@commitlint/config-conventional'], +}; diff --git a/deepsea/clean.sls b/deepsea/clean.sls new file mode 100644 index 0000000..21ba697 --- /dev/null +++ b/deepsea/clean.sls @@ -0,0 +1,8 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +include: + - .service.clean + - .config.clean + - .package.clean + - .source.clean diff --git a/deepsea/config.sls b/deepsea/config.sls deleted file mode 100644 index 0340c84..0000000 --- a/deepsea/config.sls +++ /dev/null @@ -1,12 +0,0 @@ -# -*- coding: utf-8 -*- -# vim: ft=yaml - -{%- from "deepsea/map.jinja" import deepsea with context %} - -deepsea-config-global: - file.line: - - name: {{ deepsea.config.global }} - - mode: ensure - - indent: True - - content: DEV_ENV={{ deepsea.config.dev_env }} - - onlyif: test -f {{ deepsea.config.global }} diff --git a/deepsea/config/clean.sls b/deepsea/config/clean.sls new file mode 100644 index 0000000..dd9fc39 --- /dev/null +++ b/deepsea/config/clean.sls @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} +{%- set sls_source_clean = tplroot ~ '.source.clean' %} +{%- set sls_package_clean = tplroot ~ '.package.clean' %} +{%- set sls_service_clean = tplroot ~ '.service.clean' %} + +include: + - {{ sls_service_clean }} + - {{ sls_source_clean if deepsea.pkg.use_upstream_source else sls_package_clean }} + +deepsea-config-clean-file-absent: + file.absent: + - names: + - {{ deepsea.environ_file }} + - require: + - sls: {{ sls_service_clean }} + - sls: {{ sls_source_clean if deepsea.pkg.use_upstream_source else sls_package_clean }} diff --git a/deepsea/config/environ.sls b/deepsea/config/environ.sls new file mode 100644 index 0000000..14f0b72 --- /dev/null +++ b/deepsea/config/environ.sls @@ -0,0 +1,29 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- set sls_source_install = tplroot ~ '.source.install' %} +{%- set sls_package_install = tplroot ~ '.package.install' %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} +{%- from tplroot ~ "/libtofs.jinja" import files_switch with context %} + +include: + - {{ sls_source_install if deepsea.pkg.use_upstream_source else sls_package_install }} + +deepsea-config-file-file-managed-environ_file: + file.managed: + - name: {{ deepsea.environ_file }} + - source: {{ files_switch(['environ.sh.jinja'], + lookup='deepsea-config-file-file-managed-environ_file' + ) + }} + - mode: 640 + - user: root + - group: {{ deepsea.rootgroup }} + - makedirs: True + - template: jinja + - context: + config: {{ deepsea.environ }} + - require: + - sls: {{ sls_source_install if deepsea.pkg.use_upstream_source else sls_package_install }} diff --git a/deepsea/config/init.sls b/deepsea/config/init.sls new file mode 100644 index 0000000..4528c0e --- /dev/null +++ b/deepsea/config/init.sls @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +include: + - .environ diff --git a/deepsea/defaults.yaml b/deepsea/defaults.yaml index 2992f78..4a04771 100644 --- a/deepsea/defaults.yaml +++ b/deepsea/defaults.yaml @@ -1,45 +1,48 @@ # -*- coding: utf-8 -*- # vim: ft=yaml - +--- deepsea: - release: luminous - package: deepsea - use_upstream_pkgrepo: False - use_upstream_gitrepo: True - tmpdir: /tmp/deepsea_tmp - user: root - group: root - - repo: - base_uri: - base_url: - git_url: https://github.com/SUSE/DeepSea.git - git_rev: master - - services: - running: - - salt-minion - dead: - - apparmor - - config: - global: /srv/pillar/ceph/stack/global.yml - dev_env: True - - packages: - # should formula manage package dependencies? True means yes; False NO. - # ideally `DeepSea` (or `packages-formula`) handle package dependencies. - managed: False - required: - - python3-setuptools + dir: /usr/local + version: '0.9.22' + pkg: + name: deepsea + deps: - python3-boto - - python3-configobj - - python3-click - python3-rados - python3-tox - lsscsi - - jq # needs epel on centos + - jq - pciutils - salt-api - - git - - make + use_upstream_repo: False + use_upstream_source: True + repo: + comments: + - installed by salt + source: + name: /tmp/deepsea + uri: 'https://github.com/SUSE/DeepSea/archive/' + source: None + source_hash: 88faf687a56060bf08da6ec3cf26917351e843efc4de0489139391d7e6985733 #linux amd64 tarball + trim_output: True {# works in 2018.3.2. onwards #} + archive_suffix: tar.gz + archive_format: tar + enforce_toplevel: False + options: '--strip-components=1' + + kernel: '' + arch: '' + rootgroup: root + environ_file: /etc/default/deepsea.sh + environ: + export DEV_ENV=False + + service: + user: salt + group: salt + name: salt-minion + dead: [] + + linux: + #'Alternatives system' priority: zero disables (default) + altpriority: 0 diff --git a/deepsea/files/default/environ.sh.jinja b/deepsea/files/default/environ.sh.jinja new file mode 100644 index 0000000..f9e7fe7 --- /dev/null +++ b/deepsea/files/default/environ.sh.jinja @@ -0,0 +1,6 @@ +######################################################################## +# File managed by Salt at <{{ source }}>. +# Your changes may be overwritten. +######################################################################## + +{{ config|yaml }} diff --git a/deepsea/init.sls b/deepsea/init.sls index 7063a0e..9517127 100644 --- a/deepsea/init.sls +++ b/deepsea/init.sls @@ -1,7 +1,11 @@ # -*- coding: utf-8 -*- # vim: ft=sls +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} + include: - - deepsea.install - - deepsea.config - - deepsea.service + - {{ '.source' if deepsea.pkg.use_upstream_source else '.package' }} + - .config + - .service diff --git a/deepsea/install.sls b/deepsea/install.sls deleted file mode 100644 index 6915f77..0000000 --- a/deepsea/install.sls +++ /dev/null @@ -1,82 +0,0 @@ -# -*- coding: utf-8 -*- -# vim: ft=yaml - -{%- from "deepsea/map.jinja" import deepsea with context %} - -include: - - deepsea.config - - deepsea.service - -deepsea-directories: - file.directory: - - names: - - /etc/salt/master.d - - {{ deepsea.tmpdir }} - - force: True - - mode: 0755 - - user: {{ deepsea.user }} - - group: {{ deepsea.group }} - - recurse: - - user - - group - - mode - - require_in: - - file: deepsea-software - - {%- if deepsea.packages.managed and deepsea.packages.required %} -deepsea-packages-common-dependencies: - pkg.installed: - - pkgs: - - make - - {{ deepsea.packages.required|json }} - - require_in: - - cmd: deepsea-software - {% endif %} - -deepsea-software: - {%- if deepsea.use_upstream_pkgrepo %} - pkgrepo.managed: - - name: deepsea-{{ deepsea.release }} - - humanname: {{ deepsea.repo.name }} - - baseurl: {{ deepsea.repo.base_url }} - - key_url: {{ deepsea.repo.key_url }} - - gpgcheck: 1 - - gpgautoimport: True - - require: - - file: deepsea-directories - pkg.installed: - - name: deepsea - - {%- else %} - - pkgrepo.absent: - - name: deepsea-{{ deepsea.release }} - - require_in: - - file: deepsea-software - file.absent: - - name: {{ deepsea.tmpdir }}/DeepSea - - require_in: - - git: deepsea-software - git.latest: - - name: {{ deepsea.repo.git_url }} - - target: {{ deepsea.tmpdir }}/DeepSea - - rev: {{ deepsea.repo.get('git_rev', 'master') }} - - force_checkout: True - - force_clone: True - - force_fetch: True - - force_reset: True - - require_in: - - cmd: deepsea-software - cmd.run: - - name: make install - - cwd: {{ deepsea.tmpdir }}/DeepSea - {%- endif %} - - require_in: - - file: deepsea-config-global - - require: - - file: deepsea-directories - - pkg: deepsea-software - - pkgrepo: deepsea-software - {%- if deepsea.packages.managed and deepsea.packages.required %} - - pkg: deepsea-packages-common-dependencies - {%- endif %} diff --git a/deepsea/jinja/macros.jinja b/deepsea/jinja/macros.jinja new file mode 100644 index 0000000..aeeb852 --- /dev/null +++ b/deepsea/jinja/macros.jinja @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- +# vim: ft=jinja +# +# Collection of common macros + +{%- macro format_kwargs(kwarg) -%} + {%- filter indent(4) %} + {%- for k, v in kwarg|dictsort() %} +- {{ k }}: {{ v }} + {%- endfor %} + {%- endfilter %} +{%- endmacro %} diff --git a/deepsea/libtofs.jinja b/deepsea/libtofs.jinja new file mode 100644 index 0000000..ab0d0f6 --- /dev/null +++ b/deepsea/libtofs.jinja @@ -0,0 +1,100 @@ +{%- macro files_switch(source_files, + lookup=None, + default_files_switch=['id', 'os_family'], + indent_width=6, + v1_path_prefix='') %} + {#- + Returns a valid value for the "source" parameter of a "file.managed" + state function. This makes easier the usage of the Template Override and + Files Switch (TOFS) pattern. + + Params: + * source_files: ordered list of files to look for + * lookup: key under ':tofs:source_files' to override + list of source files + * default_files_switch: if there's no config (e.g. pillar) + ':tofs:files_switch' this is the ordered list of grains to + use as selector switch of the directories under + "/files" + * indent_witdh: indentation of the result value to conform to YAML + * v1_path_prefix: (deprecated) only used for injecting a path prefix into + the source, to support older TOFS configs + + Example (based on a `tplroot` of `xxx`): + + If we have a state: + + Deploy configuration: + file.managed: + - name: /etc/yyy/zzz.conf + - source: {{ files_switch(['/etc/yyy/zzz.conf', '/etc/yyy/zzz.conf.jinja'], + lookup='Deploy configuration' + ) }} + - template: jinja + + In a minion with id=theminion and os_family=RedHat, it's going to be + rendered as: + + Deploy configuration: + file.managed: + - name: /etc/yyy/zzz.conf + - source: + - salt://xxx/files/theminion/etc/yyy/zzz.conf + - salt://xxx/files/theminion/etc/yyy/zzz.conf.jinja + - salt://xxx/files/RedHat/etc/yyy/zzz.conf + - salt://xxx/files/RedHat/etc/yyy/zzz.conf.jinja + - salt://xxx/files/default/etc/yyy/zzz.conf + - salt://xxx/files/default/etc/yyy/zzz.conf.jinja + - template: jinja + #} + {#- Get the `tplroot` from `tpldir` #} + {%- set tplroot = tpldir.split('/')[0] %} + {%- set path_prefix = salt['config.get'](tplroot ~ ':tofs:path_prefix', tplroot) %} + {%- set files_dir = salt['config.get'](tplroot ~ ':tofs:dirs:files', 'files') %} + {%- set files_switch_list = salt['config.get']( + tplroot ~ ':tofs:files_switch', + default_files_switch + ) %} + {#- Lookup source_files (v2), files (v1), or fallback to source_files parameter #} + {%- set src_files = salt['config.get']( + tplroot ~ ':tofs:source_files:' ~ lookup, + salt['config.get']( + tplroot ~ ':tofs:files:' ~ lookup, + source_files + ) + ) %} + {#- Only add to [''] when supporting older TOFS implementations #} + {%- set path_prefix_exts = [''] %} + {%- if v1_path_prefix != '' %} + {%- do path_prefix_exts.append(v1_path_prefix) %} + {%- endif %} + {%- for path_prefix_ext in path_prefix_exts %} + {%- set path_prefix_inc_ext = path_prefix ~ path_prefix_ext %} + {#- For older TOFS implementation, use `files_switch` from the config #} + {#- Use the default, new method otherwise #} + {%- set fsl = salt['config.get']( + tplroot ~ path_prefix_ext|replace('/', ':') ~ ':files_switch', + files_switch_list + ) %} + {#- Append an empty value to evaluate as `default` in the loop below #} + {%- if '' not in fsl %} + {%- do fsl.append('') %} + {%- endif %} + {%- for fs in fsl %} + {%- for src_file in src_files %} + {%- if fs %} + {%- set fs_dir = salt['config.get'](fs, fs) %} + {%- else %} + {%- set fs_dir = salt['config.get'](tplroot ~ ':tofs:dirs:default', 'default') %} + {%- endif %} + {%- set url = '- salt://' ~ '/'.join([ + path_prefix_inc_ext, + files_dir, + fs_dir, + src_file.lstrip('/') + ]) %} +{{ url | indent(indent_width, true) }} + {%- endfor %} + {%- endfor %} + {%- endfor %} +{%- endmacro %} diff --git a/deepsea/map.jinja b/deepsea/map.jinja index b3e14b0..3339113 100644 --- a/deepsea/map.jinja +++ b/deepsea/map.jinja @@ -1,25 +1,36 @@ # -*- coding: utf-8 -*- # vim: ft=jinja -{% import_yaml 'deepsea/defaults.yaml' as defaults %} -{% import_yaml 'deepsea/osfamilymap.yaml' as osfamilymap %} +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{#- Start imports as #} +{%- import_yaml tplroot ~ "/defaults.yaml" as default_settings %} +{%- import_yaml tplroot ~ "/osfamilymap.yaml" as osfamilymap %} -{## Use grains['grain'] based logic to build config model ##} +{#- Retrieve the config dict only once #} +{#- set _config = salt['config.get'](tplroot, default={}) #} +{%- set _config = {} %} -{% set deepsea = salt['grains.filter_by']( - defaults, - merge=salt['grains.filter_by']( - osfamilymap, - grain='os_family', - merge=salt['grains.filter_by']( - { - 'Power': { 'myarch': '_Power', }, - 'default': { 'repoarch': ''}, - }, - grain='osarch', - merge=salt['pillar.get']('deepsea', {}), - ), - ), - base='deepsea', -) %} +{%- set defaults = salt['grains.filter_by']( default_settings, + default=tplroot, + merge=salt['grains.filter_by']( osfamilymap, grain='os_family', + merge=salt['grains.filter_by']( _config, default='lookup' + ) + ) + ) + %} +{#- Merge the deepsea pillar #} +{%- set deepsea = salt['pillar.get']('deepsea', default=defaults, merge=True) %} + +{#- source jinja #} +{%- if deepsea.pkg.use_upstream_source %} + {%- set name = 'v%s'|format(deepsea.version) %} + {%- set uri = deepsea.pkg.source.uri + '/' + name %} + {%- do deepsea.pkg.source.update({ + 'name': deepsea.pkg.source.name + '/' + 'DeepSea-' + name, + 'source': uri + '.' + deepsea.pkg.source.archive_suffix, + 'archive_format': deepsea.pkg.source.archive_format + }) %} + {%- do deepsea.update({'base_dir': deepsea.pkg.source.name}) %} +{%- endif %} diff --git a/deepsea/osfamilymap.yaml b/deepsea/osfamilymap.yaml index e79586a..a0b8e1d 100644 --- a/deepsea/osfamilymap.yaml +++ b/deepsea/osfamilymap.yaml @@ -1,42 +1,63 @@ # -*- coding: utf-8 -*- # vim: ft=yaml - -Suse: - use_upstream_pkgrepo: False - use_upstream_gitrepo: True - repo: - name: 'Filesystem tools and FUSE-related packages (openSUSE_Leap_$releasever)' - base_url: 'http://download.opensuse.org/repositories/filesystems/openSUSE_Leap_$releasever/$basearch' - key_url: 'http://download.opensuse.org/repositories/filesystems/openSUSE_Leap_42.3/repodata/repomd.xml.key' - user: salt - group: salt - services: - running: - - salt-minion - dead: - - apparmor - - SuSEfirewall2 - packages: - required: - - gptfdisk - - iperf - - lsof +# +# Setup variables using grains['os_family'] based logic. +# You just need to add the key:values for an `os_family` that differ +# from `defaults.yaml`. +# Only add an `os_family` which is/will be supported by the formula +# +# If you do not need to provide defaults via the `os_family` grain, +# you will need to provide at least an empty dict in this file, e.g. +# osfamilymap: {} +--- Debian: - packages: - required: + pkg: + deps: + - python3-tox - gdisk - iperf RedHat: - services: - running: - - ntpd - - salt-minion - packages: - required: + service: + name: deepsea + enabled: False + pkg: + deps: - python3-netaddr - iperf3 - gdisk - lshw - hwinfo + +Suse: + pkg: + use_upstream_repo: True + deps: + - python3-tox + - gptfdisk + - iperf + - lsof + repo: + name: 'Filesystem tools and FUSE-related packages (openSUSE_Leap_$releasever)' + humanname: 'Filesystem tools and FUSE-related packages' + baseurl: 'http://download.opensuse.org/repositories/filesystems/openSUSE_Leap_$releasever/$basearch' + gpgkey: 'http://download.opensuse.org/repositories/filesystems/openSUSE_Leap_42.3/repodata/repomd.xml.key' + gpgcheck: 1 + gpgautoimport: True + service: + dead: + - apparmor + - SuSEfirewall2 + +Gentoo: {} + +Arch: {} + +Alpine: {} + +FreeBSD: {} + +OpenBSD: {} + +MacOS: {} diff --git a/deepsea/package/clean.sls b/deepsea/package/clean.sls new file mode 100644 index 0000000..7097ad7 --- /dev/null +++ b/deepsea/package/clean.sls @@ -0,0 +1,27 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- set sls_config_clean = tplroot ~ '.config.clean' %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} + +include: + - {{ sls_config_clean }} + {%- if deepsea.pkg.use_upstream_repo %} + - .repo.clean + {%- endif %} + + {%- if deepsea.pkg.deps %} + +deepsea-package-install-deps-pkg-removed: + pkg.removed: + - name: {{ deepsea.pkg.deps }} + + {%- endif %} + +deepsea-package-clean-pkg-removed: + pkg.removed: + - name: {{ deepsea.pkg.name }} + - require: + - sls: {{ sls_config_clean }} diff --git a/deepsea/package/init.sls b/deepsea/package/init.sls new file mode 100644 index 0000000..d3e5518 --- /dev/null +++ b/deepsea/package/init.sls @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +include: + - .install diff --git a/deepsea/package/install.sls b/deepsea/package/install.sls new file mode 100644 index 0000000..210aed1 --- /dev/null +++ b/deepsea/package/install.sls @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} + + {%- if deepsea.pkg.use_upstream_repo %} +include: + - .repo + {%- endif %} + + {%- if deepsea.pkg.deps %} + +deepsea-package-install-deps-pkg-installed: + pkg.installed: + - name: {{ deepsea.pkg.deps }} + + {%- endif %} + +deepsea-package-install-pkg-installed: + pkg.installed: + - name: {{ deepsea.pkg.name }} diff --git a/deepsea/package/repo/clean.sls b/deepsea/package/repo/clean.sls new file mode 100644 index 0000000..0c6bbc5 --- /dev/null +++ b/deepsea/package/repo/clean.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 deepsea with context %} + +deepsea-package-repo-clean-pkgrepo-absent: + pkgrepo.absent: + - name: {{ deepsea.pkg.repo.name }} diff --git a/deepsea/package/repo/init.sls b/deepsea/package/repo/init.sls new file mode 100644 index 0000000..d3e5518 --- /dev/null +++ b/deepsea/package/repo/init.sls @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +include: + - .install diff --git a/deepsea/package/repo/install.sls b/deepsea/package/repo/install.sls new file mode 100644 index 0000000..b71c6f0 --- /dev/null +++ b/deepsea/package/repo/install.sls @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} + + {%- if deepsea.pkg.use_upstream_repo %} + {%- from tplroot ~ "/jinja/macros.jinja" import format_kwargs with context %} + +deepsea-package-repo-install-pkgrepo-managed: + pkgrepo.managed: + {{- format_kwargs(deepsea.pkg.repo) }} + + {%- endif %} diff --git a/deepsea/remove.sls b/deepsea/remove.sls deleted file mode 100644 index b50c6fa..0000000 --- a/deepsea/remove.sls +++ /dev/null @@ -1,14 +0,0 @@ -# -*- coding: utf-8 -*- -# vim: ft=yaml - -{%- from "deepsea/map.jinja" import deepsea with context %} - -deepsea-cleanup: - file.absent: - name: {{ deepsea.tmpdir }} - pkgrepo.absent: - name: deepsea-{{ deepsea.release }} - - gpgautoimport: True - pkg.purged: - - pkgs: {{ deepsea.packages.required }} - diff --git a/deepsea/service.sls b/deepsea/service.sls deleted file mode 100644 index 0370c0a..0000000 --- a/deepsea/service.sls +++ /dev/null @@ -1,17 +0,0 @@ -# -*- coding: utf-8 -*- -# vim: ft=sls -{% from "deepsea/map.jinja" import deepsea with context %} - - {%- for svc in deepsea.services.running %} -deepsea-{{ svc }}-running: - service.running: - - name: {{ svc }} - - enable: True - {% endfor %} - - {%- for svc in deepsea.services.dead %} -deepsea-{{ svc }}-notrunning: - service.dead: - - name: {{ svc }} - - enable: False - {% endfor %} diff --git a/deepsea/service/clean.sls b/deepsea/service/clean.sls new file mode 100644 index 0000000..8739149 --- /dev/null +++ b/deepsea/service/clean.sls @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +deepsea-service-clean-service-dead: + test.succeed_with_changes diff --git a/deepsea/service/dead.sls b/deepsea/service/dead.sls new file mode 100644 index 0000000..e9ce301 --- /dev/null +++ b/deepsea/service/dead.sls @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} + + {%- if deepsea.service.dead %} + +deepsea-service-dead-service-dead: + service.dead: + - names: {{ deepsea.service.dead }} + - enable: False + - onlyif: systemctl list-unit-files | grep {{ deepsea.service.name }} >/dev/null 2>&1 + + {%- endif %} diff --git a/deepsea/service/init.sls b/deepsea/service/init.sls new file mode 100644 index 0000000..079be82 --- /dev/null +++ b/deepsea/service/init.sls @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +include: + - .dead + - .running diff --git a/deepsea/service/running.sls b/deepsea/service/running.sls new file mode 100644 index 0000000..a357706 --- /dev/null +++ b/deepsea/service/running.sls @@ -0,0 +1,17 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} + +deepsea-service-running-service-unmasked: + service.unmasked: + - name: {{ deepsea.service.name }} + - onlyif: systemctl list-unit-files | grep {{ deepsea.service.name }} >/dev/null 2>&1 + +deepsea-service-running-service-running: + service.running: + - name: {{ deepsea.service.name }} + - enable: True + - onlyif: systemctl list-unit-files | grep {{ deepsea.service.name }} >/dev/null 2>&1 diff --git a/deepsea/source/clean.sls b/deepsea/source/clean.sls new file mode 100644 index 0000000..cb66f32 --- /dev/null +++ b/deepsea/source/clean.sls @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} + + {%- if deepsea.pkg.deps %} + +deepsea-package-source-clean-deps-pkg-absent: + pkg.absent: + - names: {{ deepsea.pkg.deps }} + - require_in: + - archive: deepsea-package-source-install-source-extracted + + {%- endif %} + +deepsea-package-source-clean-file-absent: + file.absent: + - names: + - {{ deepsea.pkg.source.name }} diff --git a/deepsea/source/init.sls b/deepsea/source/init.sls new file mode 100644 index 0000000..051d698 --- /dev/null +++ b/deepsea/source/init.sls @@ -0,0 +1,5 @@ +#.-*- coding: utf-8 -*- +# vim: ft=sls + +include: + - .install diff --git a/deepsea/source/install.sls b/deepsea/source/install.sls new file mode 100644 index 0000000..aad047a --- /dev/null +++ b/deepsea/source/install.sls @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# vim: ft=sls + +{#- Get the `tplroot` from `tpldir` #} +{%- set tplroot = tpldir.split('/')[0] %} +{%- from tplroot ~ "/map.jinja" import deepsea with context %} +{%- from tplroot ~ "/jinja/macros.jinja" import format_kwargs with context %} + +deepsea-package-source-install-file-directory: + file.directory: + - names: + - {{ deepsea.pkg.source.name }} + - /etc/salt/master.d + - user: root + - group: root + - mode: 755 + - makedirs: True + - require_in: + - source: deepsea-package-source-install-source-extracted + - recurse: + - user + - group + - mode + {%- if deepsea.pkg.deps %} + pkg.installed: + - names: {{ deepsea.pkg.deps }} + - require_in: + - archive: deepsea-package-source-install-source-extracted + {%- endif %} + +deepsea-package-source-install-source-extracted: + archive.extracted: + {{- format_kwargs(deepsea.pkg.source) }} + - retry: + attempts: 3 + until: True + interval: 60 + splay: 10 + - user: root + - group: root + - recurse: + - user + - group + +deepsea-package-source-install-cmd-run-make-install: + cmd.run: + - cwd: {{ deepsea.pkg.source.name }} + - name: make install + - unless: + - test -f /usr/local/bin/deepsea + - require: + - archive: deepsea-package-source-install-source-extracted diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst new file mode 100644 index 0000000..2de67c0 --- /dev/null +++ b/docs/CONTRIBUTING.rst @@ -0,0 +1,155 @@ +.. _contributing: + +How to contribute +================= + +This document will eventually outline all aspects of guidance to make your contributing experience a fruitful and enjoyable one. +What it already contains is information about *commit message formatting* and how that directly affects the numerous automated processes that are used for this repo. +It also covers how to contribute to this *formula's documentation*. + +.. contents:: **Table of Contents** + +Overview +-------- + +Submitting a pull request is more than just code! +To achieve a quality product, the *tests* and *documentation* need to be updated as well. +An excellent pull request will include these in the changes, wherever relevant. + +Commit message formatting +------------------------- + +Since every type of change requires making Git commits, +we will start by covering the importance of ensuring that all of your commit +messages are in the correct format. + +Automation of multiple processes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This formula uses `semantic-release `_ for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog. +The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation. + +Full details are available in the upstream docs regarding the `Angular Commit Message Conventions `_. +The key factor is that the first line of the commit message must follow this format: + +.. code-block:: + + type(scope): subject + + +* E.g. ``docs(contributing): add commit message formatting instructions``. + +Besides the version bump, the changelog and release notes are formatted accordingly. +So based on the example above: + +.. + + .. raw:: html + +

Documentation

+ + * **contributing:** add commit message formatting instructions + + +* The ``type`` translates into a ``Documentation`` sub-heading. +* The ``(scope):`` will be shown in bold text without the brackets. +* The ``subject`` follows the ``scope`` as standard text. + +Linting commit messages in Travis CI +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This formula uses `commitlint `_ for checking commit messages during CI testing. +This ensures that they are in accordance with the ``semantic-release`` settings. + +For more details about the default settings, refer back to the ``commitlint`` `reference rules `_. + +Relationship between commit type and version bump +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This formula applies some customisations to the defaults, as outlined in the table below, +based upon the `type `_ of the commit: + +.. list-table:: + :name: commit-type-vs-version-bump + :header-rows: 1 + :stub-columns: 0 + :widths: 1,2,3,1,1 + + * - Type + - Heading + - Description + - Bump (default) + - Bump (custom) + * - ``build`` + - Build System + - Changes related to the build system + - – + - + * - ``chore`` + - – + - Changes to the build process or auxiliary tools and libraries such as + documentation generation + - – + - + * - ``ci`` + - Continuous Integration + - Changes to the continuous integration configuration + - – + - + * - ``docs`` + - Documentation + - Documentation only changes + - – + - 0.0.1 + * - ``feat`` + - Features + - A new feature + - 0.1.0 + - + * - ``fix`` + - Bug Fixes + - A bug fix + - 0.0.1 + - + * - ``perf`` + - Performance Improvements + - A code change that improves performance + - 0.0.1 + - + * - ``refactor`` + - Code Refactoring + - A code change that neither fixes a bug nor adds a feature + - – + - 0.0.1 + * - ``revert`` + - Reverts + - A commit used to revert a previous commit + - – + - 0.0.1 + * - ``style`` + - Styles + - Changes that do not affect the meaning of the code (white-space, + formatting, missing semi-colons, etc.) + - – + - 0.0.1 + * - ``test`` + - Tests + - Adding missing or correcting existing tests + - – + - 0.0.1 + +Use ``BREAKING CHANGE`` to trigger a ``major`` version change +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Adding ``BREAKING CHANGE`` to the footer of the extended description of the commit message will **always** trigger a ``major`` version change, no matter which type has been used. +This will be appended to the changelog and release notes as well. +To preserve good formatting of these notes, the following format is prescribed: + +* ``BREAKING CHANGE: .`` + +An example of that: + +.. code-block:: git + + ... + diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 0000000..2a52cb1 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,165 @@ +.. _readme: + +deepsea-formula +=============== + +|img_travis| |img_sr| + +.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/deepsea-formula.svg?branch=master + :alt: Travis CI Build Status + :scale: 100% + :target: https://travis-ci.com/saltstack-formulas/deepsea-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% + :target: https://github.com/semantic-release/semantic-release + +Salt formula to deploy DeepSea (software defined storage) framework on GNU Linux. + +.. contents:: **Table of Contents** + +General notes +------------- + +See the full `SaltStack Formulas installation and usage instructions +`_. + +If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section +`_. + +If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, +which contains the currently released version. This formula is versioned according to `Semantic Versioning `_. + +See `Formula Versioning Section `_ for more details. + +Contributing to this repo +------------------------- + +**Commit message formatting is significant!!** + +Please see :ref:`How to contribute ` for more details. + +Available states +---------------- + +.. contents:: + :local: + +``deepsea`` +^^^^^^^^^^^ + +*Meta-state (This is a state that includes other states)*. + +This installs the deepsea package, +manages the deepsea configuration file and then +starts the associated deepsea service. + +``deepsea.package`` +^^^^^^^^^^^^^^^^^^^ + +This state will install the deepsea package only. + +``deepsea.package.repo`` +^^^^^^^^^^^^^^^^^^^^^^^^ + +This state will install the deepsea package repository. + +``deepsea.source`` +^^^^^^^^^^^^^^^^^^ + +This state will install deepsea from source only. + +``deepsea.config`` +^^^^^^^^^^^^^^^^^^ + +This state configures deepsea defaults and depends on ``deepsea.install`` +via include list. + +``deepsea.service`` +^^^^^^^^^^^^^^^^^^^ + +This state will start the deepsea service and has a dependency on ``deepsea.config`` +via include list. + +``deepsea.clean`` +^^^^^^^^^^^^^^^^^ + +*Meta-state (This is a state that includes other states)*. + +this state will undo everything performed in the ``deepsea`` meta-state in reverse order, i.e. +stops the service, +removes the configuration file and +then uninstalls the package. + +``deepsea.service.clean`` +^^^^^^^^^^^^^^^^^^^^^^^^^ + +This state will stop the deepsea service and disable it at boot time. + +``deepsea.config.clean`` +^^^^^^^^^^^^^^^^^^^^^^^^ + +This state will remove the configuration of the deepsea service and has a +dependency on ``deepsea.service.clean`` via include list. + +``deepsea.package.clean`` +^^^^^^^^^^^^^^^^^^^^^^^^^ + +This state will remove the deepsea package and has a depency on + +``deepsea.package.repo.clean`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +This state will remove the deepsea package repository. + +``deepsea.source.clean`` +^^^^^^^^^^^^^^^^^^^^^^^^ + +This state will remove the deepsea package and has a depency on +``deepsea.config.clean`` via include list. + +Testing +------- + +Linux testing is done with ``kitchen-salt``. + +Requirements +^^^^^^^^^^^^ + +* Ruby +* Docker + +.. code-block:: bash + + $ gem install bundler + $ bundle install + $ bin/kitchen test [platform] + +Where ``[platform]`` is the platform name defined in ``kitchen.yml``, +e.g. ``debian-9-2019-2-py3``. + +``bin/kitchen converge`` +^^^^^^^^^^^^^^^^^^^^^^^^ + +Creates the docker instance and runs the ``deepsea`` main state, ready for testing. + +``bin/kitchen verify`` +^^^^^^^^^^^^^^^^^^^^^^ + +Runs the ``inspec`` tests on the actual instance. + +``bin/kitchen destroy`` +^^^^^^^^^^^^^^^^^^^^^^^ + +Removes the docker instance. + +``bin/kitchen test`` +^^^^^^^^^^^^^^^^^^^^ + +Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``. + +``bin/kitchen login`` +^^^^^^^^^^^^^^^^^^^^^ + +Gives you SSH access to the instance for manual testing. + diff --git a/docs/TOFS_pattern.rst b/docs/TOFS_pattern.rst new file mode 100644 index 0000000..13c01e9 --- /dev/null +++ b/docs/TOFS_pattern.rst @@ -0,0 +1,443 @@ +.. _tofs_pattern: + +TOFS: A pattern for using SaltStack +=================================== + +.. list-table:: + :name: tofs-authors + :header-rows: 1 + :stub-columns: 1 + :widths: 2,2,3,2 + + * - + - Person + - Contact + - Date + * - Authored by + - Roberto Moreda + - moreda@allenta.com + - 29/12/2014 + * - Modified by + - Daniel Dehennin + - daniel.dehennin@baby-gnu.org + - 07/02/2019 + * - Modified by + - Imran Iqbal + - https://github.com/myii + - 23/02/2019 + +All that follows is a proposal based on my experience with `SaltStack `_. The good thing of a piece of software like this is that you can "bend it" to suit your needs in many possible ways, and this is one of them. All the recommendations and thoughts are given "as it is" with no warranty of any type. + +.. contents:: **Table of Contents** + +Usage of values in pillar vs templates in ``file_roots`` +-------------------------------------------------------- + +Among other functions, the *master* (or *salt-master*) serves files to the *minions* (or *salt-minions*). The `file_roots `_ is the list of directories used in sequence to find a file when a minion requires it: the first match is served to the minion. Those files could be `state files `_ or configuration templates, among others. + +Using SaltStack is a simple and effective way to implement configuration management, but even in a `non-multitenant `_ scenario, it is not a good idea to generally access some data (e.g. the database password in our `Zabbix `_ server configuration file or the private key of our `Nginx `_ TLS certificate). + +To avoid this situation we can use the `pillar mechanism `_, which is designed to provide controlled access to data from the minions based on some selection rules. As pillar data could be easily integrated in the `Jinja `_ templates, it is a good mechanism to store values to be used in the final rendering of state files and templates. + +There are a variety of approaches on the usage of pillar and templates as seen in the `saltstack-formulas `_' repositories. `Some `_ `developments `_ stress the initial purpose of pillar data into a storage for most of the possible variables for a determined system configuration. This, in my opinion, is shifting too much load from the original template files approach. Adding up some `non-trivial Jinja `_ code as essential part of composing the state file definitely makes SaltStack state files (hence formulas) more difficult to read. The extreme of this approach is that we could end up with a new render mechanism, implemented in Jinja, storing everything needed in pillar data to compose configurations. Additionally, we are establishing a strong dependency with the Jinja renderer. + +In opposition to the *put the code in file_roots and the data in pillars* approach, there is the *pillar as a store for a set of key-values* approach. A full-blown configuration file abstracted in pillar and jinja is complicated to develop, understand and maintain. I think a better and simpler approach is to keep a configuration file templated using just a basic (non-extensive but extensible) set of pillar values. + +On the reusability of SaltStack state files +------------------------------------------- + +There is a brilliant initiative of the SaltStack community called `salt-formulas `_. Their goal is to provide state files, pillar examples and configuration templates ready to be used for provisioning. I am a contributor for two small ones: `zabbix-formula `_ and `varnish-formula `_. + +The `design guidelines `_ for formulas are clear in many aspects and it is a recommended reading for anyone willing to write state files, even non-formulaic ones. + +In the next section, I am going to describe my proposal to extend further the reusability of formulas, suggesting some patterns of usage. + +The Template Override and Files Switch (TOFS) pattern +----------------------------------------------------- + +I understand a formula as a **complete, independent set of SaltStack state and configuration template files sufficient to configure a system**. A system could be something as simple as an NTP server or some other much more complex service that requires many state and configuration template files. + +The customization of a formula should be done mainly by providing pillar data used later to render either the state or the configuration template files. + +Example: NTP before applying TOFS +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Let's work with the NTP example. A basic formula that follows the `design guidelines `_ has the following files and directories tree: + +.. code-block:: + + /srv/saltstack/salt-formulas/ntp-saltstack-formula/ + ntp/ + map.jinja + init.sls + conf.sls + files/ + default/ + etc/ + ntp.conf.jinja + +In order to use it, let's assume a `masterless configuration `_ and this relevant section of ``/etc/salt/minion``: + +.. code-block:: yaml + + pillar_roots: + base: + - /srv/saltstack/pillar + file_client: local + file_roots: + base: + - /srv/saltstack/salt + - /srv/saltstack/salt-formulas/ntp-saltstack-formula + +.. code-block:: jinja + + {#- /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/map.jinja #} + {%- set ntp = salt['grains.filter_by']({ + 'default': { + 'pkg': 'ntp', + 'service': 'ntp', + 'config': '/etc/ntp.conf', + }, + }, merge=salt['pillar.get']('ntp:lookup')) %} + +In ``init.sls`` we have the minimal states required to have NTP configured. In many cases ``init.sls`` is almost equivalent to an ``apt-get install`` or a ``yum install`` of the package. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/init.sls + {%- from 'ntp/map.jinja' import ntp with context %} + + Install NTP: + pkg.installed: + - name: {{ ntp.pkg }} + + Enable and start NTP: + service.running: + - name: {{ ntp.service }} + - enabled: True + - require: + - pkg: Install NTP package + +In ``conf.sls`` we have the configuration states. In most cases, that is just managing configuration file templates and making them to be watched by the service. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- from 'ntp/map.jinja' import ntp with context %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: salt://ntp/files/default/etc/ntp.conf.jinja + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + +Under ``files/default``, there is a structure that mimics the one in the minion in order to avoid clashes and confusion on where to put the needed templates. There you can find a mostly standard template for the configuration file. + +.. code-block:: jinja + + {#- /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/default/etc/ntp.conf.jinja #} + {#- Managed by saltstack #} + {#- Edit pillars or override this template in saltstack if you need customization #} + {%- set settings = salt['pillar.get']('ntp', {}) %} + {%- set default_servers = ['0.ubuntu.pool.ntp.org', + '1.ubuntu.pool.ntp.org', + '2.ubuntu.pool.ntp.org', + '3.ubuntu.pool.ntp.org'] %} + + driftfile /var/lib/ntp/ntp.drift + statistics loopstats peerstats clockstats + filegen loopstats file loopstats type day enable + filegen peerstats file peerstats type day enable + filegen clockstats file clockstats type day enable + + {%- for server in settings.get('servers', default_servers) %} + server {{ server }} + {%- endfor %} + + restrict -4 default kod notrap nomodify nopeer noquery + restrict -6 default kod notrap nomodify nopeer noquery + + restrict 127.0.0.1 + restrict ::1 + +With all this, it is easy to install and configure a simple NTP server by just running ``salt-call state.sls ntp.conf``: the package will be installed, the service will be running and the configuration should be correct for most of cases, even without pillar data. + +Alternatively, you can define a highstate in ``/srv/saltstack/salt/top.sls`` and run ``salt-call state.highstate``. + +.. code-block:: sls + + ## /srv/saltstack/salt/top.sls + base: + '*': + - ntp.conf + +**Customizing the formula just with pillar data**, we have the option to define the NTP servers. + +.. code-block:: sls + + ## /srv/saltstack/pillar/top.sls + base: + '*': + - ntp + +.. code-block:: sls + + ## /srv/saltstack/pillar/ntp.sls + ntp: + servers: + - 0.ch.pool.ntp.org + - 1.ch.pool.ntp.org + - 2.ch.pool.ntp.org + - 3.ch.pool.ntp.org + +Template Override +^^^^^^^^^^^^^^^^^ + +If the customization based on pillar data is not enough, we can override the template by creating a new one in ``/srv/saltstack/salt/ntp/files/default/etc/ntp.conf.jinja`` + +.. code-block:: jinja + + {#- /srv/saltstack/salt/ntp/files/default/etc/ntp.conf.jinja #} + {#- Managed by saltstack #} + {#- Edit pillars or override this template in saltstack if you need customization #} + + {#- Some bizarre configurations here #} + {#- ... #} + + {%- for server in settings.get('servers', default_servers) %} + server {{ server }} + {%- endfor %} + +This way we are locally **overriding the template files** offered by the formula in order to make a more complex adaptation. Of course, this could be applied as well to any of the files, including the state files. + +Files Switch +^^^^^^^^^^^^ + +To bring some order into the set of template files included in a formula, as we commented, we suggest having a similar structure to a normal final file system under ``files/default``. + +We can make different templates coexist for different minions, classified by any `grain `_ value, by simply creating new directories under ``files``. This mechanism is based on **using values of some grains as a switch for the directories under** ``files/``. + +If we decide that we want ``os_family`` as switch, then we could provide the formula template variants for both the ``RedHat`` and ``Debian`` families. + +.. code-block:: + + /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/ + default/ + etc/ + ntp.conf.jinja + RedHat/ + etc/ + ntp.conf.jinja + Debian/ + etc/ + ntp.conf.jinja + +To make this work we need a ``conf.sls`` state file that takes a list of possible files as the configuration template. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- from 'ntp/map.jinja' import ntp with context %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: + - salt://ntp/files/{{ grains.get('os_family', 'default') }}/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + +If we want to cover the possibility of a special template for a minion identified by ``node01`` then we could have a specific template in ``/srv/saltstack/salt/ntp/files/node01/etc/ntp.conf.jinja``. + +.. code-block:: jinja + + {#- /srv/saltstack/salt/ntp/files/node01/etc/ntp.conf.jinja #} + {#- Managed by saltstack #} + {#- Edit pillars or override this template in saltstack if you need customization #} + + {#- Some crazy configurations here for node01 #} + {#- ... #} + +To make this work we could write a specially crafted ``conf.sls``. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- from 'ntp/map.jinja' import ntp with context %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: + - salt://ntp/files/{{ grains.get('id') }}/etc/ntp.conf.jinja + - salt://ntp/files/{{ grains.get('os_family') }}/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + +Using the ``files_switch`` macro +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +We can simplify the ``conf.sls`` with the new ``files_switch`` macro to use in the ``source`` parameter for the ``file.managed`` state. + +.. code-block:: sls + + ## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls + include: + - ntp + + {%- set tplroot = tpldir.split('/')[0] %} + {%- from 'ntp/map.jinja' import ntp with context %} + {%- from 'ntp/libtofs.jinja' import files_switch %} + + Configure NTP: + file.managed: + - name: {{ ntp.config }} + - template: jinja + - source: {{ files_switch(['/etc/ntp.conf.jinja'], + lookup='Configure NTP' + ) + }} + - watch_in: + - service: Enable and start NTP service + - require: + - pkg: Install NTP package + + +* This uses ``config.get``, searching for ``ntp:tofs:source_files:Configure NTP`` to determine the list of template files to use. +* If this does not yield any results, the default of ``['/etc/ntp.conf.jinja']`` will be used. + +In ``libtofs.jinja``, we define this new macro ``files_switch``. + +.. literalinclude:: ../template/libtofs.jinja + :caption: /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/libtofs.jinja + :language: jinja + +How to customise the ``source`` further +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The examples below are based on an ``Ubuntu`` minion called ``theminion`` being configured via. pillar. + +Using the default settings of the ``files_switch`` macro above, +the ``source`` will be: + +.. code-block:: sls + + - source: + - salt://ntp/files/theminion/etc/ntp.conf.jinja + - salt://ntp/files/Debian/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + +Customise ``files`` +~~~~~~~~~~~~~~~~~~~ + +The ``files`` portion can be customised: + +.. code-block:: sls + + ntp: + tofs: + dirs: + files: files_alt + +Resulting in: + +.. code-block:: sls + + - source: + - salt://ntp/files_alt/theminion/etc/ntp.conf.jinja + - salt://ntp/files_alt/Debian/etc/ntp.conf.jinja + - salt://ntp/files_alt/default/etc/ntp.conf.jinja + +Customise the use of grains +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Grains can be customised and even arbitrary paths can be supplied: + +.. code-block:: sls + + ntp: + tofs: + files_switch: + - any/path/can/be/used/here + - id + - os + - os_family + +Resulting in: + +.. code-block:: sls + + - source: + - salt://ntp/files/any/path/can/be/used/here/etc/ntp.conf.jinja + - salt://ntp/files/theminion/etc/ntp.conf.jinja + - salt://ntp/files/Ubuntu/etc/ntp.conf.jinja + - salt://ntp/files/Debian/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + +Customise the ``default`` path +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The ``default`` portion of the path can be customised: + +.. code-block:: sls + + ntp: + tofs: + dirs: + default: default_alt + +Resulting in: + +.. code-block:: sls + + - source: + ... + - salt://ntp/files/default_alt/etc/ntp.conf.jinja + +Customise the list of ``source_files`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The list of ``source_files`` can be given: + +.. code-block:: sls + + ntp: + tofs: + source_files: + Configure NTP: + - '/etc/ntp.conf.jinja' + - '/etc/ntp.conf_alt.jinja' + +Resulting in: + +.. code-block:: sls + + - source: + - salt://ntp/files/theminion/etc/ntp.conf.jinja + - salt://ntp/files/theminion/etc/ntp.conf_alt.jinja + - salt://ntp/files/Debian/etc/ntp.conf.jinja + - salt://ntp/files/Debian/etc/ntp.conf_alt.jinja + - salt://ntp/files/default/etc/ntp.conf.jinja + - salt://ntp/files/default/etc/ntp.conf_alt.jinja + diff --git a/kitchen.yml b/kitchen.yml new file mode 100644 index 0000000..443bb12 --- /dev/null +++ b/kitchen.yml @@ -0,0 +1,141 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml +--- +# For help on this file's format, see https://kitchen.ci/ +driver: + name: docker + use_sudo: false + privileged: true + run_command: /lib/systemd/systemd + +# Make sure the platforms listed below match up with +# the `env.matrix` instances defined in `.travis.yml` +platforms: + ## SALT `develop` + - name: debian-9-develop-py3 + driver: + image: netmanagers/salt-develop-py3:debian-9 + provision_command: + - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com + - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop + - name: ubuntu-1804-develop-py3 + driver: + image: netmanagers/salt-develop-py3:ubuntu-18.04 + provision_command: + - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com + - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop + - name: centos-7-develop-py3 + driver: + image: netmanagers/salt-develop-py3:centos-7 + provision_command: + - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com + - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop + - name: fedora-29-develop-py3 + driver: + image: netmanagers/salt-develop-py3:fedora-29 + provision_command: + - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com + - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop + - name: opensuse-leap-15-develop-py3 + driver: + image: netmanagers/salt-develop-py3:opensuse-leap-15 + provision_command: + - curl -o bootstrap-salt.sh -L https://bootstrap.saltstack.com + - sh bootstrap-salt.sh -XdPbfrq -x python3 git develop + run_command: /usr/lib/systemd/systemd + + ## SALT 2019.2 + - name: debian-9-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:debian-9 + - name: ubuntu-1804-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:ubuntu-18.04 + - name: centos-7-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:centos-7 + - name: fedora-29-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:fedora-29 + - name: opensuse-leap-15-2019-2-py3 + driver: + image: netmanagers/salt-2019.2-py3:opensuse-leap-15 + run_command: /usr/lib/systemd/systemd + + ## SALT 2018.3 + - name: debian-9-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:debian-9 + - name: ubuntu-1604-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:ubuntu-16.04 + - name: centos-7-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:centos-7 + - name: fedora-29-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:fedora-29 + # TODO: Use this when fixed instead of `opensuse-leap-42` + # Ref: https://github.com/netmanagers/salt-image-builder/issues/2 + # - name: opensuse-leap-15-2018-3-py2 + # driver: + # image: netmanagers/salt-2018.3-py2:opensuse-leap-15 + # run_command: /usr/lib/systemd/systemd + - name: opensuse-leap-42-2018-3-py2 + driver: + image: netmanagers/salt-2018.3-py2:opensuse-leap-42 + run_command: /usr/lib/systemd/systemd + + ## SALT 2017.7 + - name: debian-8-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:debian-8 + - name: ubuntu-1604-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:ubuntu-16.04 + # TODO: Modify the formula to work for non-`systemd` platforms + - name: centos-6-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:centos-6 + run_command: /sbin/init + - name: fedora-28-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:fedora-28 + - name: opensuse-leap-42-2017-7-py2 + driver: + image: netmanagers/salt-2017.7-py2:opensuse-leap-42 + run_command: /usr/lib/systemd/systemd + +provisioner: + name: salt_solo + log_level: info + salt_install: none + require_chef: false + formula: deepsea + salt_copy_filter: + - .kitchen + - .git + state_top: + base: + '*': + - deepsea + pillars: + top.sls: + base: + '*': + - deepsea + pillars_from_files: + deepsea.sls: pillar.example + +verifier: + # https://www.inspec.io/ + name: inspec + sudo: true + # cli, documentation, html, progress, json, json-min, json-rspec, junit + reporter: + - cli + inspec_tests: + - path: test/integration/default + +suites: + - name: default diff --git a/pillar.example b/pillar.example index 9271194..44ad7a9 100644 --- a/pillar.example +++ b/pillar.example @@ -1,22 +1,49 @@ +# -*- coding: utf-8 -*- +# vim: ft=yaml +--- deepsea: - release: nautilus - # clone software from git (default: True) - use_upstream_gitrepo: True - # or use a package repo (default: False) - use_upstream_pkgrepo: False - dev_env: False + version: '12.1.5' + pkg: + use_upstream_source: False + archive: + uri: https://dl.deepsea.com/oss/release - repo: - git_url: https://git.example.com/repos/github/SUSE/DeepSea.git - git_rev: experimental - + # Pillar-based config + # See also https://deepsea.com/docs/installation/configuration/ + environ: + - 'export PATH=${PATH}:/opt/deepsea-6.2.2.darwin-amd64' config: - global: /srv/pillar/ceph/stack/global.yml - dev_env: False + default: + instance_name: ${HOSTNAME} + security: + admin_user: admin + auth.google: + client_secret: 0ldS3cretKey + + tofs: + # The files_switch key serves as a selector for alternative + # directories under the formula files directory. See TOFS pattern + # doc for more info. + # Note: Any value not evaluated by `config.get` will be used literally. + # This can be used to set custom paths, as many levels deep as required. + files_switch: + - any/path/can/be/used/here + - id + - osfinger + - os + - os_family + # All aspects of path/file resolution are customisable using the options below. + # This is unnecessary in most cases; there are sensible defaults. + # path_prefix: deepsea_alt + # dirs: + # files: files_alt + # default: default_alt + # source_files: + # deepsea-config-file-file-managed: + # - 'example_alt.tmpl' + # - 'example_alt.tmpl.jinja' + + linux: + #'Alternatives system' priority: zero disables (default) + altpriority: 1000 - packages: - # Manage dependency packages with https://github.com/saltstack-formulas/packages-formula - formula: False - # Manage packages with this formula - managed: True - required: [] diff --git a/pre-commit_semantic-release.sh b/pre-commit_semantic-release.sh new file mode 100755 index 0000000..9d34d74 --- /dev/null +++ b/pre-commit_semantic-release.sh @@ -0,0 +1,30 @@ +#!/bin/sh + +############################################################################### +# (A) Update `FORMULA` with `${nextRelease.version}` +############################################################################### +sed -i -e "s_^\(version:\).*_\1 ${1}_" FORMULA + + +############################################################################### +# (B) Use `m2r` to convert automatically produced `.md` docs to `.rst` +############################################################################### + +# Install `m2r` +sudo -H pip install m2r + +# Copy and then convert the `.md` docs +cp *.md docs/ +cd docs/ +m2r --overwrite *.md + +# Change excess `H1` headings to `H2` in converted `CHANGELOG.rst` +sed -i -e '/^=.*$/s/=/-/g' CHANGELOG.rst +sed -i -e '1,4s/-/=/g' CHANGELOG.rst + +# Use for debugging output, when required +# cat AUTHORS.rst +# cat CHANGELOG.rst + +# Return back to the main directory +cd .. diff --git a/release-rules.js b/release-rules.js new file mode 100644 index 0000000..c63c850 --- /dev/null +++ b/release-rules.js @@ -0,0 +1,18 @@ +// No release is triggered for the types commented out below. +// Commits using these types will be incorporated into the next release. +// +// NOTE: Any changes here must be reflected in `CONTRIBUTING.md`. +module.exports = [ + {breaking: true, release: 'major'}, + // {type: 'build', release: 'patch'}, + // {type: 'chore', release: 'patch'}, + // {type: 'ci', release: 'patch'}, + {type: 'docs', release: 'patch'}, + {type: 'feat', release: 'minor'}, + {type: 'fix', release: 'patch'}, + {type: 'perf', release: 'patch'}, + {type: 'refactor', release: 'patch'}, + {type: 'revert', release: 'patch'}, + {type: 'style', release: 'patch'}, + {type: 'test', release: 'patch'}, +]; diff --git a/release.config.js b/release.config.js new file mode 100644 index 0000000..afa0cb1 --- /dev/null +++ b/release.config.js @@ -0,0 +1,106 @@ +module.exports = { + branch: 'master', + plugins: [ + ['@semantic-release/commit-analyzer', { + preset: 'angular', + releaseRules: './release-rules.js', + }], + '@semantic-release/release-notes-generator', + ['@semantic-release/changelog', { + changelogFile: 'CHANGELOG.md', + changelogTitle: '# Changelog', + }], + ['@semantic-release/exec', { + prepareCmd: 'sh ./pre-commit_semantic-release.sh ${nextRelease.version}', + }], + ['@semantic-release/git', { + assets: ['*.md', 'docs/*.rst', 'FORMULA'], + }], + '@semantic-release/github', + ], + generateNotes: { + preset: 'angular', + writerOpts: { + // Required due to upstream bug preventing all types being displayed. + // Bug: https://github.com/conventional-changelog/conventional-changelog/issues/317 + // Fix: https://github.com/conventional-changelog/conventional-changelog/pull/410 + transform: (commit, context) => { + const issues = [] + + commit.notes.forEach(note => { + note.title = `BREAKING CHANGES` + }) + + // NOTE: Any changes here must be reflected in `CONTRIBUTING.md`. + if (commit.type === `feat`) { + commit.type = `Features` + } else if (commit.type === `fix`) { + commit.type = `Bug Fixes` + } else if (commit.type === `perf`) { + commit.type = `Performance Improvements` + } else if (commit.type === `revert`) { + commit.type = `Reverts` + } else if (commit.type === `docs`) { + commit.type = `Documentation` + } else if (commit.type === `style`) { + commit.type = `Styles` + } else if (commit.type === `refactor`) { + commit.type = `Code Refactoring` + } else if (commit.type === `test`) { + commit.type = `Tests` + } else if (commit.type === `build`) { + commit.type = `Build System` + // } else if (commit.type === `chore`) { + // commit.type = `Maintenance` + } else if (commit.type === `ci`) { + commit.type = `Continuous Integration` + } else { + return + } + + if (commit.scope === `*`) { + commit.scope = `` + } + + if (typeof commit.hash === `string`) { + commit.hash = commit.hash.substring(0, 7) + } + + if (typeof commit.subject === `string`) { + let url = context.repository + ? `${context.host}/${context.owner}/${context.repository}` + : context.repoUrl + if (url) { + url = `${url}/issues/` + // Issue URLs. + commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => { + issues.push(issue) + return `[#${issue}](${url}${issue})` + }) + } + if (context.host) { + // User URLs. + commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => { + if (username.includes('/')) { + return `@${username}` + } + + return `[@${username}](${context.host}/${username})` + }) + } + } + + // remove references that already appear in the subject + commit.references = commit.references.filter(reference => { + if (issues.indexOf(reference.issue) === -1) { + return true + } + + return false + }) + + return commit + }, + }, + }, +}; diff --git a/test/integration/default/README.md b/test/integration/default/README.md new file mode 100644 index 0000000..8019607 --- /dev/null +++ b/test/integration/default/README.md @@ -0,0 +1,50 @@ +# Default InSpec Profile + +This shows the implementation of the Default InSpec [profile](https://github.com/inspec/inspec/blob/master/docs/profiles.md). + +## Verify a profile + +InSpec ships with built-in features to verify a profile structure. + +```bash +$ inspec check default +Summary +------- +Location: default +Profile: profile +Controls: 4 +Timestamp: 2019-06-24T23:09:01+00:00 +Valid: true + +Errors +------ + +Warnings +-------- +``` + +## Execute a profile + +To run all **supported** controls on a local machine use `inspec exec /path/to/profile`. + +```bash +$ inspec exec default +.. + +Finished in 0.0025 seconds (files took 0.12449 seconds to load) +8 examples, 0 failures +``` + +## Execute a specific control from a profile + +To run one control from the profile use `inspec exec /path/to/profile --controls name`. + +```bash +$ inspec exec default --controls package +. + +Finished in 0.0025 seconds (files took 0.12449 seconds to load) +1 examples, 0 failures +``` + +See an [example control here](https://github.com/inspec/inspec/blob/master/examples/profile/controls/example.rb). diff --git a/test/integration/default/controls/environ_spec.rb b/test/integration/default/controls/environ_spec.rb new file mode 100644 index 0000000..9f6c3ba --- /dev/null +++ b/test/integration/default/controls/environ_spec.rb @@ -0,0 +1,12 @@ +control 'deepsea configuration environment' do + title 'should match desired lines' + + describe file('/etc/default/deepsea.sh') do + it { should be_file } + it { should be_owned_by 'root' } + it { should be_grouped_into 'root' } + its('mode') { should cmp '0640' } + its('content') { should include 'Your changes may be overwritten' } + its('content') { should include 'export DEV_ENV=' } + end +end diff --git a/test/integration/default/controls/services_spec.rb b/test/integration/default/controls/services_spec.rb new file mode 100644 index 0000000..e0fd8ce --- /dev/null +++ b/test/integration/default/controls/services_spec.rb @@ -0,0 +1,14 @@ +control 'salt-minion service' do + impact 0.5 + title 'should be running and enabled' + + describe service('salt-minion') do + it { should be_enabled } + it { should be_running } + end + + describe command('service salt-minion status') do + its('stdout') { should match 'running' } + its('exit_status') { should eq 0 } + end +end diff --git a/test/integration/default/inspec.yml b/test/integration/default/inspec.yml new file mode 100644 index 0000000..be653d0 --- /dev/null +++ b/test/integration/default/inspec.yml @@ -0,0 +1,12 @@ +name: deepsea +title: deepsea Formula +maintainer: Saltstack Formulas Community +license: Apache-2.0 +summary: Verify that the deepsea formula is setup and configured correctly +supports: + - platform-name: debian + - platform-name: ubuntu + - platform-name: centos + - platform-name: fedora + - platform-name: opensuse + - platform-name: freebsd