https://github.com/saltstack-formulas/nfs-formula
https://github.com/saltstack-formulas/nfs-formula
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/saltstack-formulas/nfs-formula
- Owner: saltstack-formulas
- License: apache-2.0
- Created: 2014-10-08T23:23:06.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T23:09:20.000Z (about 1 year ago)
- Last Synced: 2025-03-29T20:04:17.735Z (11 months ago)
- Language: Ruby
- Homepage: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
- Size: 236 KB
- Stars: 18
- Watchers: 37
- Forks: 84
- Open Issues: 6
-
Metadata Files:
- Readme: docs/README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
.. _readme:
nfs-formula
================
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/nfs-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/nfs-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
A SaltStack formula to install and configure nfs server and client.
.. 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.
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
----------------
.. contents::
:local:
``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
.. 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 ``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.