A SaltStack formula to install and configure Mattermost.
Table of Contents
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.
Commit message formatting is significant!!
Please see How to contribute for more details.
None
Meta-state (This is a state that includes other states).
This installs the mattermost server package, manages the mattermost configuration file and then starts the associated mattermost service.
This state will install the mattermost package only.
This state will configure the mattermost configuration and has a dependency on mattermost.install
via include list.
This state will start the mattermost service and has a dependency on mattermost.config
via include list.
Meta-state (This is a state that includes other states).
this state will undo everything performed in the mattermost
meta-state in reverse order, i.e.
stops the service,
removes the configuration file and
then uninstalls the package.
This state will stop the mattermost service and disable it at boot time.
This state will remove the configuration of the mattermost service and has a
dependency on mattermost.service.clean
via include list.
This state will remove the mattermost package and has a depency on
mattermost.config.clean
via include list.
Linux testing is done with kitchen-salt
.
- 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
.
Creates the docker instance and runs the mattermost
main state, ready for testing.
Runs the inspec
tests on the actual instance.
Removes the docker instance.
Runs all of the stages above in one go: i.e. destroy
+ converge
+ verify
+ destroy
.
Gives you SSH access to the instance for manual testing.