Georg Pfuetzenreuter
5e4711d87c
Introduce 'nsd:opmode' pillar option, allowing the zone file management to be skipped on slave DNS servers. Signed-off-by: Georg Pfuetzenreuter <mail@georg-pfuetzenreuter.net> |
||
|---|---|---|
| .github/workflows | ||
| bin | ||
| docs | ||
| nsd | ||
| test | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .pre-commit-config.yaml | ||
| .rstcheck.cfg | ||
| .rubocop.yml | ||
| .salt-lint | ||
| .travis.yml | ||
| .yamllint | ||
| CODEOWNERS | ||
| FORMULA | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| commitlint.config.js | ||
| kitchen.yml | ||
| pillar.example | ||
| pre-commit_semantic-release.sh | ||
| release-rules.js | ||
| release.config.js | ||
docs/README.rst
nsd-formula
A SaltStack formula that manages NSD.
It intentionally provides only minimalistic configuration. Use the TOFS pattern<https://template-formula.readthedocs.io/en/latest/TOFS_pattern.html> to alter the configuration to your needs.
You'll need to write the zone files yourself, obviously. This formula will tell NSD to compile them into it's DB and provide a configuration file for you to include.
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.
If you need (non-default) configuration, please refer to:
- how to configure the formula with map.jinja
- the
pillar.examplefile - the Special notes section
Contributing to this repo
Commit messages
Commit message formatting is significant!!
Please see How to contribute for more details.
pre-commit
pre-commit is configured for
this formula, which you may optionally use to ease the steps involved in
submitting your changes. First install the pre-commit
package manager using the appropriate method, then run
bin/install-hooks and now pre-commit will run
automatically on each git commit. :
$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msgSpecial notes
None
Available states
nsd
Meta-state (This is a state that includes other states).
This installs the nsd package, manages the nsd configuration file and then starts the associated nsd service.
nsd.package
This state will install the nsd package only.
nsd.config
This state will configure the nsd service and has a dependency on
nsd.install via include list.
nsd.service
This state will start the nsd service and has a dependency on
nsd.config via include list.
nsd.clean
Meta-state (This is a state that includes other states).
this state will undo everything performed in the nsd
meta-state in reverse order, i.e. stops the service, removes the
configuration file and then uninstalls the package.
nsd.service.clean
This state will stop the nsd service and disable it at boot time.
nsd.config.clean
This state will remove the configuration of the nsd service and has a
dependency on nsd.service.clean via include list.
nsd.package.clean
This state will remove the nsd package and has a depency on
nsd.config.clean via include list.
Testing
Linux testing is done with kitchen-salt.
Requirements
- Ruby
- Docker
$ 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 nsd 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.