saltstack-formulas/nfs-formula
1
0
Fork 0
mirror of https://github.com/saltstack-formulas/nfs-formula.git synced 2025-04-07 04:51:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
nfs-formula/docs
History
Exact
Georg Pfuetzenreuter 9b218074e5
fix(defaults): set enabled 
Avoid render failure if called without a defined pillar and assume
service should be enabled if not stated otherwise.

Signed-off-by: Georg Pfuetzenreuter <mail@georg-pfuetzenreuter.net>
2024-03-04 15:25:05 +01:00
..
AUTHORS.rst chore(release): 0.12.1 [skip ci] 2021-06-24 09:06:00 +00:00
CHANGELOG.rst chore(release): 0.12.1 [skip ci] 2021-06-24 09:06:00 +00:00
README.rst fix(defaults): set enabled 2024-03-04 15:25:05 +01:00

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
  • If nfs:enabled is set to true (the default), enable the NFS service - if set to false, ensure it is stopped

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.