Deploy and manage golang using Salt.

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.

If you need (non-default) configuration, please pay attention to the pillar.example file and/or Special notes section.

See Formula Versioning Section for more details.

Commit message formatting is significant!!

Please see How to contribute for more details.

This formula uses (non-default) GOPATH environment variable on Unix by default; see go_path key in defaults.yaml and pillar.example files. Normally GOPATH defaults to $HOME/go on Unix/Darwin, $home/go on Plan9, and %USERPROFILE%\go on Windows; another common setup is GOPATH=$HOME && export PATH=$PATH:$(go env GOPATH)/bin too.

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

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

This state will install the golang package only.

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

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

This is a metastate for go command tasks.

This state runs go clean -i <item>... for each item in cmd.clean dict.

This state runs go get <item>... for each item in cmd.get dict.

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

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

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

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

This state will remove the golang package and has a depency on golang.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 golang 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.

Windows/FreeBSD/OpenBSD testing is done with kitchen-salt.

• Ruby
• Virtualbox
• Vagrant

$ gem install bundler
$ bundle install --with=vagrant
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.vagrant.yml, e.g. windows-81-latest-py3.

When testing using Vagrant you must set the environment variable KITCHEN_LOCAL_YAML to kitchen.vagrant.yml. For example:

$ KITCHEN_LOCAL_YAML=kitchen.vagrant.yml bin/kitchen test      # Alternatively,
$ export KITCHEN_LOCAL_YAML=kitchen.vagrant.yml
$ bin/kitchen test

Then run the following commands as needed.

Creates the Vagrant instance and runs the golang main states, ready for testing.

Runs the inspec tests on the actual instance.

Removes the Vagrant instance.

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

Gives you RDP/SSH access to the instance for manual testing.