• Stars
    star
    116
  • Rank 303,894 (Top 6 %)
  • Language Jinja
  • License
    Other
  • Created about 11 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

SaltStack formula template filled with dummy content

TEMPLATE-formula

Travis CI Build Status Semantic Release pre-commit

A SaltStack formula that is empty. It has dummy content to help with a quick start on a new formula and it serves as a style guide.

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:

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

Using this template

The easiest way to use this template formula as a base for a new formula is to use GitHub's Use this template button to create a new repository. For consistency with the rest of the formula ecosystem, name your formula repository following the pattern <formula theme>-formula, where <formula theme> consists of lower-case alphabetic characters, numbers, '-' or '_'.

In the rest of this example we'll use example as the <formula theme>.

Follow these steps to complete the conversion from template-formula to example-formula.

$ git clone [email protected]:YOUR-USERNAME/example-formula.git
$ cd example-formula/
$ bin/convert-formula.sh example
$ git push --force

Alternatively, it's possible to clone template-formula into a new repository and perform the conversion there. For example:

$ git clone https://github.com/saltstack-formulas/template-formula example-formula
$ cd example-formula/
$ bin/convert-formula.sh example

To take advantage of semantic-release for automated changelog generation and release tagging, you will need a GitHub Personal Access Token with at least the public_repo scope.

In the Travis repository settings for your new repository, create an environment variable named GH_TOKEN with the personal access token as value, restricted to the master branch for security.

Note that this repository uses a CODEOWNERS file to assign ownership to various parts of the formula. The conversion process removes overall ownership, but you should consider assigning ownership to yourself or your organisation when contributing your new formula to the saltstack-formulas organisation.

Available states

TEMPLATE

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

This installs the TEMPLATE package, manages the TEMPLATE configuration file and then starts the associated TEMPLATE service.

TEMPLATE.package

This state will install the TEMPLATE package only.

TEMPLATE.config

This state will configure the TEMPLATE service and has a dependency on TEMPLATE.install via include list.

TEMPLATE.service

This state will start the TEMPLATE service and has a dependency on TEMPLATE.config via include list.

TEMPLATE.clean

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

this state will undo everything performed in the TEMPLATE meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package.

TEMPLATE.service.clean

This state will stop the TEMPLATE service and disable it at boot time.

TEMPLATE.config.clean

This state will remove the configuration of the TEMPLATE service and has a dependency on TEMPLATE.service.clean via include list.

TEMPLATE.package.clean

This state will remove the TEMPLATE package and has a depency on TEMPLATE.config.clean via include list.

TEMPLATE.subcomponent

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

This state installs a subcomponent configuration file before configuring and starting the TEMPLATE service.

TEMPLATE.subcomponent.config

This state will configure the TEMPLATE subcomponent and has a dependency on TEMPLATE.config via include list.

TEMPLATE.subcomponent.config.clean

This state will remove the configuration of the TEMPLATE subcomponent and reload the TEMPLATE service by a dependency on TEMPLATE.service.running via include list and watch_in requisite.

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 TEMPLATE 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.

More Repositories

1

salt-formula

Yes, Salt can Salt itself!
SaltStack
193
star
2

nginx-formula

Nginx Salt Formula
SaltStack
163
star
3

docker-formula

Install and set up Docker
SaltStack
137
star
4

users-formula

Configure users via pillar
SaltStack
98
star
5

openssh-formula

Jinja
90
star
6

mysql-formula

Install the MySQL client and/or server
SaltStack
81
star
7

ec2-autoscale-reactor

Autonomous Minion Management via EC2 Autoscaler
SaltStack
77
star
8

postgres-formula

SaltStack
75
star
9

php-formula

Jinja
57
star
10

zabbix-formula

Jinja
51
star
11

apache-formula

Set up and configure the Apache HTTP server
Jinja
49
star
12

django-formula

Python
42
star
13

jenkins-formula

SaltStack
42
star
14

os-hardening-formula

SaltStack
41
star
15

redis-formula

Redis state
Jinja
40
star
16

fail2ban-formula

SaltStack
40
star
17

sudoers-formula

Ruby
40
star
18

salt-cloud-reactor

Autonomous Minion Management via Salt Cloud
SaltStack
38
star
19

hadoop-formula

SaltStack
37
star
20

openvpn-formula

Setup and configure openvpn server and client.
Jinja
34
star
21

hostsfile-formula

Use minion IDs to keep /etc/hosts and hostnames consistent for clusters without DNS
Ruby
32
star
22

gitlab-formula

SaltStack
31
star
23

mongodb-formula

SaltStack
31
star
24

vim-formula

Trick out vim
Vim Script
31
star
25

iptables-formula

SaltStack
31
star
26

bind-formula

Ruby
30
star
27

prometheus-formula

Manage a Prometheus installation
SaltStack
27
star
28

haproxy-formula

Jinja
27
star
29

zookeeper-formula

Jinja
27
star
30

node-formula

Manage node.js with SaltStack
SaltStack
26
star
31

postfix-formula

Ruby
26
star
32

logstash-formula

SaltStack
24
star
33

sun-java-formula

Flexible provisioning for JDK and JRE tarballs
SaltStack
24
star
34

epel-formula

Install the EPEL RPM and GPG key
Ruby
23
star
35

ntp-formula

Ruby
23
star
36

systemd-formula

SaltStack
23
star
37

consul-formula

Formula to install and configure Hashicorp Consul
Jinja
23
star
38

logrotate-formula

Ruby
22
star
39

rabbitmq-formula

SaltStack
22
star
40

nagios-formula

nagios-formula
SaltStack
22
star
41

openstack-standalone-formula

Single Server OpenStack
SaltStack
22
star
42

lxd-formula

Python
21
star
43

elasticsearch-formula

SaltStack
21
star
44

collectd-formula

SaltStack
20
star
45

kubernetes-formula

Salt formula to manage kubernetes
SaltStack
20
star
46

aptly-formula

SaltStack
18
star
47

libvirt-formula

Jinja
18
star
48

sysctl-formula

Saltstack sysctl formula,
Ruby
18
star
49

icinga2-formula

SaltStack
18
star
50

snmp-formula

Ruby
17
star
51

nfs-formula

Ruby
17
star
52

samba-formula

Jinja
17
star
53

tomcat-formula

Ruby
16
star
54

graphite-formula

SaltStack
16
star
55

vault-formula

Ruby
15
star
56

git-formula

SaltStack
14
star
57

syslog-ng-formula

Jinja
14
star
58

memcached-formula

SaltStack
14
star
59

vmware-tools-formula

SaltStack
13
star
60

ceph-formula

HTML
13
star
61

virtualenv-formula

SaltStack
11
star
62

resolver-formula

SaltStack
11
star
63

openldap-formula

Ruby
11
star
64

packages-formula

A simple 'packages manager' formula, to install/remove packages without further ado.
SaltStack
11
star
65

java-formula

Jinja
11
star
66

tinc-formula

tinc formula
Shell
11
star
67

tmux-formula

HTML
11
star
68

grafana-formula

Manage Grafana via Salt
SaltStack
10
star
69

squid-formula

Ruby
10
star
70

openvpn-client-formula

A saltstack formula for pushing keys and config to openvpn clients.
SaltStack
9
star
71

reverse-users-formula

9
star
72

uwsgi-formula

Salt formula to manage uwsgi
SaltStack
9
star
73

kafka-formula

SaltStack
8
star
74

screen-formula

SaltStack
8
star
75

python2-formula

SaltStack
8
star
76

dhcpd-formula

Ruby
8
star
77

dnsmasq-formula

Ruby
8
star
78

pip-formula

SaltStack
7
star
79

backuptocloud-formula

http://docs.saltstack.com/topics/conventions/formulas.html
SaltStack
7
star
80

opendkim-formula

Salt-Stack formula for opendkim
SaltStack
7
star
81

cloudstack-formula

SaltStack
7
star
82

hosts-formula

Manage your hosts file
Python
7
star
83

munin-formula

Saltstack formula for munin and munin-node
SaltStack
7
star
84

newrelic-formula

SaltStack
7
star
85

piwik-formula

SaltStack
7
star
86

beaver-formula

Shell
7
star
87

owncloud-formula

SaltStack
7
star
88

nexus-formula

Provision Sonatype Nexus with Saltstack
Shell
7
star
89

crontab-formula

saltstack formula to manage crontab
HTML
6
star
90

wireguard-formula

Manages wireguard installations
Jinja
6
star
91

dovecot-formula

SaltStack
6
star
92

varnish-formula

SaltStack
6
star
93

mounts-formula

SaltStack formula for managing mounts
SaltStack
6
star
94

bareos-formula

A Saltstack formula to install and configure Bareos
SaltStack
5
star
95

linux-dev-formula

Development files for linux
Scheme
5
star
96

nano-formula

Scheme
5
star
97

eramba-formula

Scheme
5
star
98

mediawiki-formula

MediaWiki
PHP
5
star
99

reverse-grains-formula

SaltStack
5
star
100

ruby-formula

SaltStack
5
star