Forge Home

dummy_service

Provides a dummy service implementation for use in building containers

42,081 downloads

41,714 latest version

4.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.2.0 (latest)
  • 0.1.0
released Jul 19th 2016

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-dummy_service', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-dummy_service
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-dummy_service --version 0.2.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/dummy_service — version 0.2.0 Jul 19th 2016

A simple dummy service implementation for Puppet. Useful in contexts where you don't want Service resources to do anything, for example when building containers.

Installation

dummy_service is packaged as a Puppet Module, and can be installed from the Forge like so:

puppet module install puppetlabs-dummy_service

You can also include in your Puppetfile if using r10k or librarian-puppet:

mod 'puppetlabs/dummy_service'

Usage

The module adds a new Service provider to Puppet. Although you can specify this on a per-resource basis it's probably more likely that you will use the resource defaults feature of Puppet like so:

Service {
  provider => dummy
}

Alternatively you can use resource collectors. This is useful in situations where a module explictly sets a provider value.

Service <| |> { provider => dummy }

As a useful shortcut you can also just include the included class:

include dummy_service

You may decide to include that in several modules and, for instance, gate it so that services are only clobbered when running under Docker:

if $virtual == 'docker' {
  include dummy_service
}

Demonstration

The module contains a quick example in the examples directory. You can see this in action easily with the puppet Docker images.

This example shows what happens when you try and ensure => running on a service which is not configured:

docker run --rm -it -v $(pwd):/src/dummy_service:ro puppet/puppet-agent-ubuntu apply /src/dummy_service/examples/without_dummy.pp --test --modulepath=/src
Notice: Compiled catalog for 55b183b19b57.local in environment
production in 0.29 seconds
Info: Applying configuration version '1468839204'
Error: Could not find init script for 'openssh'
Error: /Stage[main]/Main/Service[openssh]/ensure: change from stopped to
running failed: Could not find init script for 'openssh'
Info: Creating state file /opt/puppetlabs/puppet/cache/state/state.yaml
Notice: Applied catalog in 0.03 seconds

The following example shows the same resource, but with the dummy service provider specifed as noted above.

docker run --rm -it -v $(pwd):/src/dummy_service:ro puppet/puppet-agent-ubuntu apply /src/dummy_service/examples/with_dummy.pp --test --modulepath=/src
Notice: Compiled catalog for 693fba958896.local in environment
production in 0.30 seconds
Info: Applying configuration version '1468839318'
Info: Creating state file /opt/puppetlabs/puppet/cache/state/state.yaml
Notice: Applied catalog in 0.02 seconds

Thanks

Thanks to @larsks for originally documenting this idea.

Maintainers

This repository is maintained by: Gareth Rushgrove gareth@puppet.com.