strongswan-formula

Travis CI Build Status Semantic Release

A SaltStack formula to install, configure and manage Strongswan.

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

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

3. Available states

3.1. strongswan

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

This installs the strongswan package, configures and starts the associated strongswan service.

3.2. strongswan.install

This state will install the strongswan package only.

3.3. strongswan.config

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

Configuration is splitted

  • for connections:

    • in a main file for default options and %default connection. This file include files from 'dropin' directory

    • in a 'dropin' directory where each connection has its own config file

  • for secrets:

    • in a main file which include files from 'dropin' directory

    • in a 'dropin' directory where each connection has its own secret file

3.4. strongswan.service

This state manage the strongswan service.

4. Testing

Linux testing is done with kitchen-salt.

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

4.2. bin/kitchen converge

Creates the docker instance and runs the template main state, ready for testing.

4.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

4.4. bin/kitchen destroy

Removes the docker instance.

4.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

4.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.