pam-mount-formula

Configure automounting with pam-mount.

Table of Contents

• General notes
• Contributing to this repo
• Special notes
• Available states
• Testing

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.example file
• 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-msg

Special notes

None

Available states

• pam-mount
• pam-mount.package
• pam-mount.package.install
• pam-mount.config
• pam-mount.clean
• pam-mount.config.clean
• pam-mount.package.clean

pam-mount

Meta-state (This is a state that includes other states).

This installs the required packages and manages the pam-mount configuration file.

It depends on:

• pam-mount.package
• pam-mount.config

pam-mount.package

Meta-state (This is a state that includes other states).

Managage packages required to use pam-mount.

pam-mount.package.install

This state will install the pam-mount package and the declared dependencies.

pam-mount.config

This state will configure pam_mount.conf.xml for the declared volumes.

It depends on:

• pam-mount.package.install

pam-mount.clean

Meta-state (This is a state that includes other states).

This state will undo everything performed in the pam-mount meta-state in reverse order, i.e. removes the configuration file and then uninstalls the packages.

It depends on:

• pam-mount.config.clean
• pam-mount.package.clean

pam-mount.config.clean

This state will remove the pam-mount configuration file.

pam-mount.package.clean

This state will remove the pam-mount package.

It depends on:

• pam-mount.config.clean

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 pam-mount 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.