saltstack-formulas/nfs-formula
1
0
Fork 0
mirror of https://github.com/saltstack-formulas/nfs-formula.git synced 2025-04-10 06:41:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
103 commits 4 branches 6 tags 387 KiB
Find a file
semantic-release-bot bcf1ad47f7 chore(release): 0.12.0 [skip ci] 
# [0.12.0](https://github.com/saltstack-formulas/nfs-formula/compare/v0.11.1...v0.12.0) (2021-04-03)

### Code Refactoring

* **service:** split out nfs service handling into dedicated state ([ad8d4b8](ad8d4b89dc))

### Continuous Integration

* **commitlint:** ensure `upstream/master` uses main repo URL [skip ci] ([3d81fea](3d81feaab3))
* **gemfile+lock:** use `ssf` customised `kitchen-docker` repo [skip ci] ([be724ae](be724aed00))
* **gitlab-ci:** add `rubocop` linter (with `allow_failure`) [skip ci] ([e0274da](e0274daa9a))
* **gitlab-ci:** use GitLab CI as Travis CI replacement ([4405b21](4405b21517))
* **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] ([8ef3472](8ef34725eb))
* **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] ([ef34ebb](ef34ebba22))
* **pre-commit:** add to formula [skip ci] ([b4b0896](b4b0896979))
* **pre-commit:** enable/disable `rstcheck` as relevant [skip ci] ([def21c3](def21c3ba0))
* **pre-commit:** finalise `rstcheck` configuration [skip ci] ([6bea9ea](6bea9eaedd))
* **pre-commit:** update hook for `rubocop` [skip ci] ([c298c9a](c298c9a7ce))

### Features

* **oscodenamemap:** add support for openSUSE Tumbleweed ([5c30f49](5c30f49cef))
* **osfamilymap:** add support for Gentoo ([aae6ce6](aae6ce6414))
* **service:** allow disabling of nfs services ([2bfffc0](2bfffc06a9))

### Tests

* standardise use of `share` suite & `_mapdata` state [skip ci] ([b3d113a](b3d113a49e))
2021-04-03 12:38:47 +00:00
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 2020-05-04 09:30:08 +01:00
bin ci(pre-commit): add to formula [skip ci] 2020-10-03 10:40:26 +01:00
docs chore(release): 0.12.0 [skip ci] 2021-04-03 12:38:47 +00:00
nfs feat(service): allow disabling of nfs services 2021-04-02 13:35:00 +02:00
test/integration test: standardise use of share suite & _mapdata state [skip ci] 2021-03-23 21:30:30 +00:00
.gitignore chore: standardise structure (.gitignore & _mapdata.rb) [skip ci] 2021-02-11 11:51:14 +00:00
.gitlab-ci.yml ci(kitchen+ci): use latest pre-salted images (after CVE) [skip ci] 2021-03-07 22:20:16 +00:00
.pre-commit-config.yaml chore(shellcheck): switch hook for shellcheck [skip ci] 2021-02-21 08:31:48 +00:00
.rstcheck.cfg ci(pre-commit): add to formula [skip ci] 2020-10-03 10:40:26 +01:00
.rubocop.yml test: standardise use of share suite & _mapdata state [skip ci] 2021-03-23 21:30:30 +00:00
.salt-lint style: fix linters errors 2019-11-20 21:45:37 +00:00
.travis.yml ci(kitchen+ci): use latest pre-salted images (after CVE) [skip ci] 2021-03-07 22:20:16 +00:00
.yamllint ci(kitchen+ci): use latest pre-salted images (after CVE) [skip ci] 2021-03-07 22:20:16 +00:00
AUTHORS.md chore(release): 0.12.0 [skip ci] 2021-04-03 12:38:47 +00:00
CHANGELOG.md chore(release): 0.12.0 [skip ci] 2021-04-03 12:38:47 +00:00
CODEOWNERS chore: standardise structure (.gitignore & _mapdata.rb) [skip ci] 2021-02-11 11:51:14 +00:00
commitlint.config.js chore(commitlint): add {body,footer,header}-max(-line)-length [skip ci] 2020-10-07 09:07:41 +01:00
FORMULA chore(release): 0.12.0 [skip ci] 2021-04-03 12:38:47 +00:00
Gemfile test: standardise use of share suite & _mapdata state [skip ci] 2021-03-23 21:30:30 +00:00
Gemfile.lock ci(gemfile+lock): use ssf customised kitchen-docker repo [skip ci] 2021-02-17 13:51:24 +00:00
kitchen.yml test: standardise use of share suite & _mapdata state [skip ci] 2021-03-23 21:30:30 +00:00
LICENSE Initial commit 2014-10-08 16:23:06 -07:00
pillar.example feat(service): allow disabling of nfs services 2021-04-02 13:35:00 +02:00
pre-commit_semantic-release.sh ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:36:16 +00:00
release-rules.js feat: implementing semantic release 2019-11-20 21:45:37 +00:00
release.config.js ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:36:16 +00:00

docs/README.rst

nfs-formula

Travis CI Build Status Semantic Release

A SaltStack formula to install and configure nfs server and client.

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 pay attention to the pillar.example file and/or Special notes section.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Special notes

None

Available states

nfs.server

Install nfs server components

nfs.client

Install nfs client components

nfs.mount

Mount nfs shares via. pillar using the following parameters:

  • mountpoint
  • location
  • opts: default => "vers=3"
  • persist: default => True
  • mkmnt: default => True

nfs.unmount

Unmount nfs shares via. pillar using the following parameters:

  • mountpoint
  • location
  • persist: default => False

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 nfs.server 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.